Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members

FX::FXMDIClient Class Reference

The MDI client window manages a number of MDI child windows in a multiple-document interface (MDI) application. More...

#include <FXMDIClient.h>

Inheritance diagram for FX::FXMDIClient:

FX::FXComposite FX::FXWindow FX::FXDrawable FX::FXId FX::FXObject List of all members.

Public Types

enum  {
  ID_MDI_ANY = 65400,
  ID_MDI_1,
  ID_MDI_2,
  ID_MDI_3,
  ID_MDI_4,
  ID_MDI_5,
  ID_MDI_6,
  ID_MDI_7,
  ID_MDI_8,
  ID_MDI_9,
  ID_MDI_10,
  ID_MDI_OVER_1,
  ID_MDI_OVER_2,
  ID_MDI_OVER_3,
  ID_MDI_OVER_4,
  ID_MDI_OVER_5,
  ID_MDI_OVER_6,
  ID_MDI_OVER_7,
  ID_MDI_OVER_8,
  ID_MDI_OVER_9,
  ID_MDI_OVER_10,
  ID_LAST
}

Public Member Functions

virtual long onDefault (FXObject *, FXSelector, void *)
 FXMDIClient (FXComposite *p, FXuint opts=0, FXint x=0, FXint y=0, FXint w=0, FXint h=0)
virtual FXint getDefaultWidth ()
virtual FXint getDefaultHeight ()
virtual void layout ()
long forallWindows (FXObject *sender, FXSelector sel, void *ptr)
long forallDocuments (FXObject *sender, FXSelector sel, void *ptr)
long forallDocWindows (FXObject *document, FXObject *sender, FXSelector sel, void *ptr)
virtual FXbool setActiveChild (FXMDIChild *child=NULL, FXbool notify=TRUE)
FXMDIChild * getActiveChild () const
virtual void cascade (FXbool notify=FALSE)
virtual void horizontal (FXbool notify=FALSE)
virtual void vertical (FXbool notify=FALSE)
void setCascadeX (FXint off)
void setCascadeY (FXint off)
FXint getCascadeX () const
FXint getCascadeY () const
virtual void save (FXStream &store) const
virtual void load (FXStream &store)
virtual ~FXMDIClient ()

Detailed Description

The MDI client window manages a number of MDI child windows in a multiple-document interface (MDI) application.

MDI child windows usually receive messages from the GUI through delegation via the MDI client, i.e. the MDI client window is set as the target for most GUI commands; the MDI client filters out a few messages and forwards all other messages to the active MDI child. MDI client can arrange the MDI child windows in various ways:- it may maximize one of the MDI child windows, arrange them side-by-side, cascade them, or iconify them. MDI child windows are notified about changes in the active MDI child window by the MDI client.

Member Enumeration Documentation

anonymous enum
 

Enumeration values:
ID_MDI_1  Select MDI child 1.
ID_MDI_OVER_1  Sensitize MDI menu when 1 or more children.

Constructor & Destructor Documentation

FX::FXMDIClient::FXMDIClient (  FXComposite *  p,
FXuint  opts = 0,
FXint  x = 0,
FXint  y = 0,
FXint  w = 0,
FXint  h = 0
) 
 

Construct MDI Client window.

virtual FX::FXMDIClient::~FXMDIClient (   )  [virtual]
 

Destructor.

Member Function Documentation

virtual long FX::FXMDIClient::onDefault (  FXObject *  ,
FXSelector  ,
void * 
)  [virtual]
 

Called for unhandled messages.

Reimplemented from FX::FXObject.

virtual FXint FX::FXMDIClient::getDefaultWidth (   )  [virtual]
 

Return default width.

Reimplemented from FX::FXComposite.

virtual FXint FX::FXMDIClient::getDefaultHeight (   )  [virtual]
 

Return default height.

Reimplemented from FX::FXComposite.

virtual void FX::FXMDIClient::layout (   )  [virtual]
 

Perform layout.

Reimplemented from FX::FXComposite.

long FX::FXMDIClient::forallWindows (  FXObject *  sender,
FXSelector  sel,
void *  ptr
) 
 

Pass message to all MDI windows, stopping when one of the MDI windows fails to handle the message.

long FX::FXMDIClient::forallDocuments (  FXObject *  sender,
FXSelector  sel,
void *  ptr
) 
 

Pass message once to all MDI windows with the same document, stopping when one of the MDI windows fails to handle the message.

long FX::FXMDIClient::forallDocWindows (  FXObject *  document,
FXObject *  sender,
FXSelector  sel,
void *  ptr
) 
 

Pass message to all MDI Child windows whose target is document, stopping when one of the MDI windows fails to handle the message.

virtual FXbool FX::FXMDIClient::setActiveChild (  FXMDIChild *  child = NULL,
FXbool  notify = TRUE
)  [virtual]
 

Set active MDI Child.

FXMDIChild* FX::FXMDIClient::getActiveChild (   )  const [inline]
 

Get current active child; may be NULL!

void FX::FXMDIClient::setCascadeX (  FXint  off  )  [inline]
 

Change cascade offset X.

void FX::FXMDIClient::setCascadeY (  FXint  off  )  [inline]
 

Change cascade offset Y.

FXint FX::FXMDIClient::getCascadeX (   )  const [inline]
 

Get cascade offset X.

FXint FX::FXMDIClient::getCascadeY (   )  const [inline]
 

Get cascade offset Y.

virtual void FX::FXMDIClient::save (  FXStream &  store  )  const [virtual]
 

Save object to a stream.

Reimplemented from FX::FXWindow.

virtual void FX::FXMDIClient::load (  FXStream &  store  )  [virtual]
 

Load object from a stream.

Reimplemented from FX::FXWindow.

Copyright © 1997-2004 Jeroen van der Zijp