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

FX::FXMDIChild Class Reference

#include <FXMDIChild.h>

Inheritance diagram for FX::FXMDIChild:
FX::FXComposite FX::FXWindow FX::FXDrawable FX::FXId FX::FXObject

Public Member Functions

virtual long onDefault (FXObject *, FXSelector, void *)
 
 FXMDIChild (FXMDIClient *p, const FXString &name, FXIcon *ic=NULL, FXPopup *pup=NULL, FXuint opts=0, FXint x=0, FXint y=0, FXint w=0, FXint h=0)
 
virtual void create ()
 
virtual void detach ()
 
virtual void layout ()
 
virtual FXint getDefaultWidth ()
 
virtual FXint getDefaultHeight ()
 
virtual void setFocus ()
 
virtual bool canFocus () const
 
virtual void move (FXint x, FXint y)
 
virtual void resize (FXint w, FXint h)
 
virtual void position (FXint x, FXint y, FXint w, FXint h)
 
void setNormalX (FXint x)
 
void setNormalY (FXint y)
 
void setNormalWidth (FXint w)
 
void setNormalHeight (FXint h)
 
FXint getNormalX () const
 
FXint getNormalY () const
 
FXint getNormalWidth () const
 
FXint getNormalHeight () const
 
void setIconX (FXint x)
 
void setIconY (FXint y)
 
void setIconWidth (FXint w)
 
void setIconHeight (FXint h)
 
FXint getIconX () const
 
FXint getIconY () const
 
FXint getIconWidth () const
 
FXint getIconHeight () const
 
FXWindowcontentWindow () const
 
void setTitle (const FXString &name)
 
FXString getTitle () const
 
FXColor getHiliteColor () const
 
FXColor getShadowColor () const
 
FXColor getBaseColor () const
 
FXColor getBorderColor () const
 
FXColor getTitleColor () const
 
FXColor getTitleBackColor () const
 
void setHiliteColor (FXColor clr)
 
void setShadowColor (FXColor clr)
 
void setBaseColor (FXColor clr)
 
void setBorderColor (FXColor clr)
 
void setTitleColor (FXColor clr)
 
void setTitleBackColor (FXColor clr)
 
virtual FXbool maximize (FXbool notify=FALSE)
 
virtual FXbool minimize (FXbool notify=FALSE)
 
virtual FXbool restore (FXbool notify=FALSE)
 
virtual FXbool close (FXbool notify=FALSE)
 
FXbool isMaximized () const
 
FXbool isMinimized () const
 
FXIcongetIcon () const
 
void setIcon (FXIcon *icon)
 
FXPopupgetMenu () const
 
void setMenu (FXPopup *menu)
 
void setTracking (FXbool tracking=TRUE)
 
FXbool getTracking () const
 
void setFont (FXFont *fnt)
 
FXFontgetFont () const
 
virtual void save (FXStream &store) const
 
virtual void load (FXStream &store)
 
virtual ~FXMDIChild ()
 
- Public Member Functions inherited from FX::FXComposite
 FXComposite (FXComposite *p, FXuint opts=0, FXint x=0, FXint y=0, FXint w=0, FXint h=0)
 
virtual void destroy ()
 
FXint maxChildWidth () const
 
FXint maxChildHeight () const
 
virtual bool isComposite () const
 
virtual ~FXComposite ()
 
- Public Member Functions inherited from FX::FXWindow
 FXWindow (FXComposite *p, FXuint opts=0, FXint x=0, FXint y=0, FXint w=0, FXint h=0)
 
FXWindowgetParent () const
 
FXWindowgetOwner () const
 
FXWindowgetShell () const
 
FXWindowgetRoot () const
 
FXWindowgetNext () const
 
FXWindowgetPrev () const
 
FXWindowgetFirst () const
 
FXWindowgetLast () const
 
FXWindowgetFocus () const
 
void setKey (FXuint k)
 
FXuint getKey () const
 
void setTarget (FXObject *t)
 
FXObjectgetTarget () const
 
void setSelector (FXSelector sel)
 
FXSelector getSelector () const
 
FXint getX () const
 
FXint getY () const
 
virtual FXint getWidthForHeight (FXint givenheight)
 
virtual FXint getHeightForWidth (FXint givenwidth)
 
void setX (FXint x)
 
void setY (FXint y)
 
void setWidth (FXint w)
 
void setHeight (FXint h)
 
void setLayoutHints (FXuint lout)
 
FXuint getLayoutHints () const
 
FXAccelTablegetAccelTable () const
 
void setAccelTable (FXAccelTable *acceltable)
 
void addHotKey (FXHotKey code)
 
void remHotKey (FXHotKey code)
 
void setHelpTag (const FXString &text)
 
const FXStringgetHelpTag () const
 
bool isShell () const
 
bool isOwnerOf (const FXWindow *window) const
 
bool isChildOf (const FXWindow *window) const
 
bool containsChild (const FXWindow *child) const
 
FXWindowgetChildAt (FXint x, FXint y) const
 
FXint numChildren () const
 
FXint indexOfChild (const FXWindow *window) const
 
FXWindowchildAtIndex (FXint index) const
 
FXComposeContextgetComposeContext () const
 
void createComposeContext ()
 
void destroyComposeContext ()
 
void setDefaultCursor (FXCursor *cur)
 
FXCursorgetDefaultCursor () const
 
void setDragCursor (FXCursor *cur)
 
FXCursorgetDragCursor () const
 
FXint getCursorPosition (FXint &x, FXint &y, FXuint &buttons) const
 
FXint setCursorPosition (FXint x, FXint y)
 
bool isEnabled () const
 
bool isActive () const
 
bool hasFocus () const
 
bool inFocusChain () const
 
virtual void killFocus ()
 
virtual void changeFocus (FXWindow *child)
 
virtual void setDefault (FXbool enable=TRUE)
 
bool isDefault () const
 
void setInitial (bool enable=true)
 
bool isInitial () const
 
virtual void enable ()
 
virtual void disable ()
 
virtual void attach (FXID w)
 
virtual void setShape (const FXRegion &region)
 
virtual void setShape (FXBitmap *bitmap)
 
virtual void setShape (FXIcon *icon)
 
virtual void clearShape ()
 
virtual void raise ()
 
virtual void lower ()
 
virtual void recalc ()
 
void forceRefresh ()
 
virtual void reparent (FXWindow *father, FXWindow *other=NULL)
 
void scroll (FXint x, FXint y, FXint w, FXint h, FXint dx, FXint dy) const
 
void update (FXint x, FXint y, FXint w, FXint h) const
 
void update () const
 
void repaint (FXint x, FXint y, FXint w, FXint h) const
 
void repaint () const
 
void grab ()
 
void ungrab ()
 
bool grabbed () const
 
void grabKeyboard ()
 
void ungrabKeyboard ()
 
bool grabbedKeyboard () const
 
virtual void show ()
 
virtual void hide ()
 
bool shown () const
 
bool underCursor () const
 
bool hasSelection () const
 
bool acquireSelection (const FXDragType *types, FXuint numtypes)
 
bool releaseSelection ()
 
bool hasClipboard () const
 
bool acquireClipboard (const FXDragType *types, FXuint numtypes)
 
bool releaseClipboard ()
 
virtual void dropEnable ()
 
virtual void dropDisable ()
 
bool isDropEnabled () const
 
bool isDragging () const
 
bool beginDrag (const FXDragType *types, FXuint numtypes)
 
bool handleDrag (FXint x, FXint y, FXDragAction action=DRAG_COPY)
 
FXDragAction endDrag (bool drop=true)
 
bool isDropTarget () const
 
void setDragRectangle (FXint x, FXint y, FXint w, FXint h, bool wantupdates=true) const
 
void clearDragRectangle () const
 
void acceptDrop (FXDragAction action=DRAG_ACCEPT) const
 
FXDragAction didAccept () const
 
void dropFinished (FXDragAction action=DRAG_REJECT) const
 
bool inquireDNDTypes (FXDNDOrigin origin, FXDragType *&types, FXuint &numtypes) const
 
bool offeredDNDType (FXDNDOrigin origin, FXDragType type) const
 
FXDragAction inquireDNDAction () const
 
bool setDNDData (FXDNDOrigin origin, FXDragType type, FXuchar *data, FXuint size) const
 
bool setDNDData (FXDNDOrigin origin, FXDragType type, const FXString &string) const
 
bool getDNDData (FXDNDOrigin origin, FXDragType type, FXuchar *&data, FXuint &size) const
 
bool getDNDData (FXDNDOrigin origin, FXDragType type, FXString &string) const
 
virtual bool contains (FXint parentx, FXint parenty) const
 
void translateCoordinatesFrom (FXint &tox, FXint &toy, const FXWindow *fromwindow, FXint fromx, FXint fromy) const
 
void translateCoordinatesTo (FXint &tox, FXint &toy, const FXWindow *towindow, FXint fromx, FXint fromy) const
 
virtual void setBackColor (FXColor clr)
 
FXColor getBackColor () const
 
virtual bool doesSaveUnder () const
 
virtual const FXchartr (const FXchar *message, const FXchar *hint=NULL) const
 
virtual ~FXWindow ()
 
- Public Member Functions inherited from FX::FXDrawable
FXint getWidth () const
 
FXint getHeight () const
 
FXVisualgetVisual () const
 
void setVisual (FXVisual *vis)
 
virtual ~FXDrawable ()
 
- Public Member Functions inherited from FX::FXId
FXAppgetApp () const
 
FXID id () const
 
void setUserData (void *ptr)
 
void * getUserData () const
 
virtual ~FXId ()
 
- Public Member Functions inherited from FX::FXObject
const FXchargetClassName () const
 
bool isMemberOf (const FXMetaClass *metaclass) const
 
virtual long tryHandle (FXObject *sender, FXSelector sel, void *ptr)
 
virtual ~FXObject ()
 

Additional Inherited Members

- Public Types inherited from FX::FXWindow
enum  {
  ID_NONE,
  ID_HIDE,
  ID_SHOW,
  ID_TOGGLESHOWN,
  ID_LOWER,
  ID_RAISE,
  ID_DELETE,
  ID_DISABLE,
  ID_ENABLE,
  ID_TOGGLEENABLED,
  ID_UNCHECK,
  ID_CHECK,
  ID_UNKNOWN,
  ID_UPDATE,
  ID_AUTOSCROLL,
  ID_TIPTIMER,
  ID_HSCROLLED,
  ID_VSCROLLED,
  ID_SETVALUE,
  ID_SETINTVALUE,
  ID_SETREALVALUE,
  ID_SETSTRINGVALUE,
  ID_SETICONVALUE,
  ID_SETINTRANGE,
  ID_SETREALRANGE,
  ID_GETINTVALUE,
  ID_GETREALVALUE,
  ID_GETSTRINGVALUE,
  ID_GETICONVALUE,
  ID_GETINTRANGE,
  ID_GETREALRANGE,
  ID_SETHELPSTRING,
  ID_GETHELPSTRING,
  ID_SETTIPSTRING,
  ID_GETTIPSTRING,
  ID_QUERY_MENU,
  ID_HOTKEY,
  ID_ACCEL,
  ID_UNPOST,
  ID_POST,
  ID_MDI_TILEHORIZONTAL,
  ID_MDI_TILEVERTICAL,
  ID_MDI_CASCADE,
  ID_MDI_MAXIMIZE,
  ID_MDI_MINIMIZE,
  ID_MDI_RESTORE,
  ID_MDI_CLOSE,
  ID_MDI_WINDOW,
  ID_MDI_MENUWINDOW,
  ID_MDI_MENUMINIMIZE,
  ID_MDI_MENURESTORE,
  ID_MDI_MENUCLOSE,
  ID_MDI_NEXT,
  ID_MDI_PREV,
  ID_LAST
}
 
- Static Public Member Functions inherited from FX::FXWindow
static FXWindowcommonAncestor (FXWindow *a, FXWindow *b)
 
static bool before (const FXWindow *a, const FXWindow *b)
 
static bool after (const FXWindow *a, const FXWindow *b)
 
- Static Public Attributes inherited from FX::FXWindow
static FXDragType octetType
 
static FXDragType deleteType
 
static FXDragType textType
 
static FXDragType utf8Type
 
static FXDragType utf16Type
 
static FXDragType colorType
 
static FXDragType urilistType
 
static const FXDragType stringType
 
static const FXDragType imageType
 
static const FXchar octetTypeName []
 
static const FXchar deleteTypeName []
 
static const FXchar textTypeName []
 
static const FXchar colorTypeName []
 
static const FXchar urilistTypeName []
 
static const FXchar utf8TypeName []
 
static const FXchar utf16TypeName []
 

Detailed Description

The MDI child window contains the application work area in a Multiple Document Interface application.

GUI Controls are connected to the MDI child via delegation through the MDI client, which forwards messages it receives to the active MDI child. The MDI child itself tries to further delegate messages to its single content window, and if not handled there, to its target object. When the MDI child is maximized, it sends a SEL_MAXIMIZE message; when the MDI child is minimized, it sends a SEL_MINIMIZE message. When it is restored, it sends a SEL_RESTORE message to its target. The MDI child also notifies its target when it becomes the active MDI child, via the SEL_SELECTED message. The void* in the SEL_SELECTED message refers to the previously active MDI child, if any. When an MDI child ceases to be the active one, a SEL_DESELECTED message is sent. The void* in the SEL_DESELECTED message refers to the newly activated MDI child, if any. Thus, interception of SEL_SELECTED and SEL_DESELECTED allows the target object to determine whether the user switched between MDI windows of the same document (target) or between MDI windows belonging to the same document. When the MDI child is closed, it sends a SEL_CLOSE message to its target. The target has an opportunity to object to the closing; if the MDI child should not be closed, it should return 1 (objection). If the MDI child should be closed, the target can either just return 0 or simply not handle the SEL_CLOSE message. The SEL_UPDATE message can be used to modify the MDI child's title (via ID_SETSTRINGVALUE), and window icon (via ID_SETICONVALUE).

See also:

Constructor & Destructor Documentation

FX::FXMDIChild::FXMDIChild ( FXMDIClient p,
const FXString name,
FXIcon ic = NULL,
FXPopup pup = NULL,
FXuint  opts = 0,
FXint  x = 0,
FXint  y = 0,
FXint  w = 0,
FXint  h = 0 
)

Construct MDI Child window with given name and icon.

virtual FX::FXMDIChild::~FXMDIChild ( )
virtual

Destroy.

Member Function Documentation

virtual long FX::FXMDIChild::onDefault ( FXObject ,
FXSelector  ,
void *   
)
virtual

Called for unhandled messages.

Reimplemented from FX::FXObject.

virtual void FX::FXMDIChild::create ( )
virtual

Create window.

Reimplemented from FX::FXComposite.

virtual void FX::FXMDIChild::detach ( )
virtual

Detach window.

Reimplemented from FX::FXComposite.

virtual void FX::FXMDIChild::layout ( )
virtual

Perform layout.

Reimplemented from FX::FXComposite.

virtual FXint FX::FXMDIChild::getDefaultWidth ( )
virtual

Return the default width of this window.

Reimplemented from FX::FXComposite.

virtual FXint FX::FXMDIChild::getDefaultHeight ( )
virtual

Return the default height of this window.

Reimplemented from FX::FXComposite.

virtual void FX::FXMDIChild::setFocus ( )
virtual

Move the focus to this window.

Reimplemented from FX::FXWindow.

virtual bool FX::FXMDIChild::canFocus ( ) const
virtual

MDI Child can receive focus.

Reimplemented from FX::FXWindow.

virtual void FX::FXMDIChild::move ( FXint  x,
FXint  y 
)
virtual

Move this window to the specified position in the parent's coordinates.

Reimplemented from FX::FXWindow.

virtual void FX::FXMDIChild::resize ( FXint  w,
FXint  h 
)
virtual

Resize this window to the specified width and height.

Reimplemented from FX::FXWindow.

virtual void FX::FXMDIChild::position ( FXint  x,
FXint  y,
FXint  w,
FXint  h 
)
virtual

Move and resize this window in the parent's coordinates.

Reimplemented from FX::FXWindow.

void FX::FXMDIChild::setNormalX ( FXint  x)
inline

Change normal (restored) position.

void FX::FXMDIChild::setNormalY ( FXint  y)
inline
void FX::FXMDIChild::setNormalWidth ( FXint  w)
inline
void FX::FXMDIChild::setNormalHeight ( FXint  h)
inline
FXint FX::FXMDIChild::getNormalX ( ) const
inline

Return normal (restored) position.

FXint FX::FXMDIChild::getNormalY ( ) const
inline
FXint FX::FXMDIChild::getNormalWidth ( ) const
inline
FXint FX::FXMDIChild::getNormalHeight ( ) const
inline
void FX::FXMDIChild::setIconX ( FXint  x)
inline

Change iconified position.

void FX::FXMDIChild::setIconY ( FXint  y)
inline
void FX::FXMDIChild::setIconWidth ( FXint  w)
inline
void FX::FXMDIChild::setIconHeight ( FXint  h)
inline
FXint FX::FXMDIChild::getIconX ( ) const
inline

Return iconified position.

FXint FX::FXMDIChild::getIconY ( ) const
inline
FXint FX::FXMDIChild::getIconWidth ( ) const
inline
FXint FX::FXMDIChild::getIconHeight ( ) const
inline
FXWindow* FX::FXMDIChild::contentWindow ( ) const

Return content window.

void FX::FXMDIChild::setTitle ( const FXString name)

Change MDI Child's title.

FXString FX::FXMDIChild::getTitle ( ) const
inline

Get current title.

FXColor FX::FXMDIChild::getHiliteColor ( ) const
inline

Get colors.

FXColor FX::FXMDIChild::getShadowColor ( ) const
inline
FXColor FX::FXMDIChild::getBaseColor ( ) const
inline
FXColor FX::FXMDIChild::getBorderColor ( ) const
inline
FXColor FX::FXMDIChild::getTitleColor ( ) const
inline
FXColor FX::FXMDIChild::getTitleBackColor ( ) const
inline
void FX::FXMDIChild::setHiliteColor ( FXColor  clr)

Change colors.

void FX::FXMDIChild::setShadowColor ( FXColor  clr)
void FX::FXMDIChild::setBaseColor ( FXColor  clr)
void FX::FXMDIChild::setBorderColor ( FXColor  clr)
void FX::FXMDIChild::setTitleColor ( FXColor  clr)
void FX::FXMDIChild::setTitleBackColor ( FXColor  clr)
virtual FXbool FX::FXMDIChild::maximize ( FXbool  notify = FALSE)
virtual

Maximize MDI window, return TRUE if maximized.

virtual FXbool FX::FXMDIChild::minimize ( FXbool  notify = FALSE)
virtual

Minimize/iconify MDI window, return TRUE if minimized.

virtual FXbool FX::FXMDIChild::restore ( FXbool  notify = FALSE)
virtual

Restore MDI window to normal, return TRUE if restored.

virtual FXbool FX::FXMDIChild::close ( FXbool  notify = FALSE)
virtual

Close MDI window, return TRUE if actually closed.

FXbool FX::FXMDIChild::isMaximized ( ) const

Return TRUE if maximized.

FXbool FX::FXMDIChild::isMinimized ( ) const

Return TRUE if minimized.

FXIcon* FX::FXMDIChild::getIcon ( ) const

Get window icon.

void FX::FXMDIChild::setIcon ( FXIcon icon)

Set window icon.

FXPopup* FX::FXMDIChild::getMenu ( ) const

Get window menu.

void FX::FXMDIChild::setMenu ( FXPopup menu)

Set window menu.

void FX::FXMDIChild::setTracking ( FXbool  tracking = TRUE)

Set tracking instead of just outline.

FXbool FX::FXMDIChild::getTracking ( ) const

Return true if tracking.

void FX::FXMDIChild::setFont ( FXFont fnt)

Set title font.

FXFont* FX::FXMDIChild::getFont ( ) const
inline

Get title font.

virtual void FX::FXMDIChild::save ( FXStream store) const
virtual

Save to stream.

Reimplemented from FX::FXWindow.

virtual void FX::FXMDIChild::load ( FXStream store)
virtual

Load from stream.

Reimplemented from FX::FXWindow.

Copyright © 1997-2005 Jeroen van der Zijp