FX::FXMDIClient Class Reference

#include <FXMDIClient.h>

Inheritance diagram for FX::FXMDIClient:

Inheritance graph
[legend]

List of all members.


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 controls by delegation via the MDI client. This is accomplished by making the MDI client window the target for most GUI controls. The MDI client filters out messages intented for itself, and delegates the remaining messages to its currently active MDI child, if any. If you use the auto-gray or auto-hide feature available in some GUI controls, these controls can be automatically grayed out or hidden when there is no active MDI child. When delegating messages via MDI client to MDI child windows of different types, care should be taken that message ID's do not overlap, so that all message ID's only map to the intented handlers no matter which MDI child window type is active. The MDI client sends a SEL_CHANGED message to its target when the active MDI child is switched, with the void* pointer refering to the new MDI child. A MDI Window selection dialog can be brought up through the ID_MDI_OVER_X messages; a menu button connected to the MDI client with the ID_MDI_OVER_X message will be automatically grayed out if there are less than X MDI child windows.

Public Types

enum  {
  ID_MDI_ANY, 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
}
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
}

Public Member Functions

long onCmdActivateNext (FXObject *, FXSelector, void *)
long onCmdActivatePrev (FXObject *, FXSelector, void *)
long onCmdTileHorizontal (FXObject *, FXSelector, void *)
long onCmdTileVertical (FXObject *, FXSelector, void *)
long onCmdCascade (FXObject *, FXSelector, void *)
long onUpdActivateNext (FXObject *, FXSelector, void *)
long onUpdActivatePrev (FXObject *, FXSelector, void *)
long onUpdTileVertical (FXObject *, FXSelector, void *)
long onUpdTileHorizontal (FXObject *, FXSelector, void *)
long onUpdCascade (FXObject *, FXSelector, void *)
long onUpdClose (FXObject *, FXSelector, void *)
long onUpdMenuClose (FXObject *, FXSelector, void *)
long onUpdRestore (FXObject *, FXSelector, void *)
long onUpdMenuRestore (FXObject *, FXSelector, void *)
long onUpdMinimize (FXObject *, FXSelector, void *)
long onUpdMenuMinimize (FXObject *, FXSelector, void *)
long onUpdMaximize (FXObject *, FXSelector, void *)
long onUpdMenuWindow (FXObject *, FXSelector, void *)
long onCmdWindowSelect (FXObject *, FXSelector, void *)
long onUpdWindowSelect (FXObject *, FXSelector, void *)
long onCmdOthersWindows (FXObject *, FXSelector, void *)
long onUpdOthersWindows (FXObject *, FXSelector, void *)
long onUpdAnyWindows (FXObject *, FXSelector, void *)
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)
FXMDIChildgetActiveChild () 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 ()
long onKeyPress (FXObject *, FXSelector, void *)
long onKeyRelease (FXObject *, FXSelector, void *)
long onFocusNext (FXObject *, FXSelector, void *)
long onFocusPrev (FXObject *, FXSelector, void *)
long onCmdUpdate (FXObject *, FXSelector, void *)
virtual void create ()
virtual void detach ()
virtual void destroy ()
FXint maxChildWidth () const
FXint maxChildHeight () const
virtual bool isComposite () const
long onPaint (FXObject *, FXSelector, void *)
long onMap (FXObject *, FXSelector, void *)
long onUnmap (FXObject *, FXSelector, void *)
long onConfigure (FXObject *, FXSelector, void *)
long onUpdate (FXObject *, FXSelector, void *)
long onMotion (FXObject *, FXSelector, void *)
long onMouseWheel (FXObject *, FXSelector, void *)
long onEnter (FXObject *, FXSelector, void *)
long onLeave (FXObject *, FXSelector, void *)
long onLeftBtnPress (FXObject *, FXSelector, void *)
long onLeftBtnRelease (FXObject *, FXSelector, void *)
long onMiddleBtnPress (FXObject *, FXSelector, void *)
long onMiddleBtnRelease (FXObject *, FXSelector, void *)
long onRightBtnPress (FXObject *, FXSelector, void *)
long onRightBtnRelease (FXObject *, FXSelector, void *)
long onBeginDrag (FXObject *, FXSelector, void *)
long onEndDrag (FXObject *, FXSelector, void *)
long onDragged (FXObject *, FXSelector, void *)
long onUngrabbed (FXObject *, FXSelector, void *)
long onDestroy (FXObject *, FXSelector, void *)
long onFocusSelf (FXObject *, FXSelector, void *)
long onFocusIn (FXObject *, FXSelector, void *)
long onFocusOut (FXObject *, FXSelector, void *)
long onSelectionLost (FXObject *, FXSelector, void *)
long onSelectionGained (FXObject *, FXSelector, void *)
long onSelectionRequest (FXObject *, FXSelector, void *)
long onClipboardLost (FXObject *, FXSelector, void *)
long onClipboardGained (FXObject *, FXSelector, void *)
long onClipboardRequest (FXObject *, FXSelector, void *)
long onDNDEnter (FXObject *, FXSelector, void *)
long onDNDLeave (FXObject *, FXSelector, void *)
long onDNDMotion (FXObject *, FXSelector, void *)
long onDNDDrop (FXObject *, FXSelector, void *)
long onDNDRequest (FXObject *, FXSelector, void *)
long onQueryHelp (FXObject *, FXSelector, void *)
long onQueryTip (FXObject *, FXSelector, void *)
long onCmdShow (FXObject *, FXSelector, void *)
long onCmdHide (FXObject *, FXSelector, void *)
long onUpdToggleShown (FXObject *, FXSelector, void *)
long onCmdToggleShown (FXObject *, FXSelector, void *)
long onCmdRaise (FXObject *, FXSelector, void *)
long onCmdLower (FXObject *, FXSelector, void *)
long onCmdEnable (FXObject *, FXSelector, void *)
long onCmdDisable (FXObject *, FXSelector, void *)
long onUpdToggleEnabled (FXObject *, FXSelector, void *)
long onCmdToggleEnabled (FXObject *, FXSelector, void *)
long onUpdYes (FXObject *, FXSelector, void *)
long onCmdDelete (FXObject *, FXSelector, void *)
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 isPopup () 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 setSavedCursor (FXCursor *cur)
FXCursorgetSavedCursor () 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
virtual bool canFocus () const
bool hasFocus () const
bool inFocusChain () const
virtual void setFocus ()
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 move (FXint x, FXint y)
virtual void resize (FXint w, FXint h)
virtual void position (FXint x, FXint y, FXint w, FXint h)
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
FXint getWidth () const
FXint getHeight () const
FXVisualgetVisual () const
void setVisual (FXVisual *vis)
FXAppgetApp () const
FXEventLoopgetEventLoop () const
FXID id () const
void setUserData (void *ptr)
void * getUserData () const
const FXchar * getClassName () const
bool isMemberOf (const FXMetaClass *metaclass) const
virtual long tryHandle (FXObject *sender, FXSelector sel, void *ptr)
QTransString tr (const char *text, const char *hint=0)
virtual void * getPythonObject () const
virtual void decouplePythonObject () const

Static Public Member Functions

static FXuint userHandednessLayout ()
static FXuint defaultPadding ()
static FXuint defaultSpacing ()
static FXuint scaleLayoutValue (FXuint value)
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

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

Protected Types

enum  {
  FLAG_SHOWN, FLAG_ENABLED, FLAG_UPDATE, FLAG_DROPTARGET,
  FLAG_FOCUSED, FLAG_DIRTY, FLAG_RECALC, FLAG_TIP,
  FLAG_HELP, FLAG_DEFAULT, FLAG_INITIAL, FLAG_SHELL,
  FLAG_ACTIVE, FLAG_PRESSED, FLAG_KEY, FLAG_CARET,
  FLAG_CHANGED, FLAG_LASSO, FLAG_TRYDRAG, FLAG_DODRAG,
  FLAG_SCROLLINSIDE, FLAG_SCROLLING, FLAG_OWNED, FLAG_POPUP
}

Protected Member Functions

virtual bool doesOverrideRedirect () const
void addColormapWindows ()
void remColormapWindows ()

Static Protected Member Functions

static FXWindowfindDefault (FXWindow *window)
static FXWindowfindInitial (FXWindow *window)

Protected Attributes

FXMDIChildactive
FXint cascadex
FXint cascadey
FXComposeContextcomposeContext
FXCursordefaultCursor
FXCursorsavedCursor
FXCursordragCursor
FXAccelTableaccelTable
FXObjecttarget
FXSelector message
FXint xpos
FXint ypos
FXColor backColor
FXString tag
FXuint flags
FXuint options
FXVisualvisual
FXint width
FXint height
FXID xid

Friends

class FXMDIChild

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!

virtual void FX::FXMDIClient::cascade ( FXbool  notify = FALSE  )  [virtual]

Cascade windows.

virtual void FX::FXMDIClient::horizontal ( FXbool  notify = FALSE  )  [virtual]

Layout horizontally.

virtual void FX::FXMDIClient::vertical ( FXbool  notify = FALSE  )  [virtual]

Layout vertically.

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.

virtual void FX::FXComposite::create (  )  [virtual, inherited]

virtual void FX::FXComposite::detach (  )  [virtual, inherited]

virtual void FX::FXComposite::destroy (  )  [virtual, inherited]

FXint FX::FXComposite::maxChildWidth (  )  const [inherited]

Return the width of the widest child window.

FXint FX::FXComposite::maxChildHeight (  )  const [inherited]

Return the height of the tallest child window.

virtual bool FX::FXComposite::isComposite (  )  const [virtual, inherited]

Overrides this virtual function to return TRUE.

Reimplemented from FX::FXWindow.

static FXuint FX::FXWindow::userHandednessLayout (  )  [inline, static, inherited]

Returns LAYOUT_RIGHT or LAYOUT_LEFT suitable for the current user's handedness.

References FX::FXProcess::userHandedness().

static FXuint FX::FXWindow::defaultPadding (  )  [inline, static, inherited]

Returns the default padding quantity.

References FX::FXProcess::screenScale().

static FXuint FX::FXWindow::defaultSpacing (  )  [inline, static, inherited]

Returns the default child spacing quantity.

References FX::FXProcess::screenScale().

static FXuint FX::FXWindow::scaleLayoutValue ( FXuint  value  )  [inline, static, inherited]

Scales a layout value by a factor.

References FX::FXProcess::screenScale().

FXWindow* FX::FXWindow::getParent (  )  const [inline, inherited]

Return a pointer to the parent window.

FXWindow* FX::FXWindow::getOwner (  )  const [inline, inherited]

Return a pointer to the owner window.

FXWindow* FX::FXWindow::getShell (  )  const [inherited]

Return a pointer to the shell window.

FXWindow* FX::FXWindow::getRoot (  )  const [inherited]

Return a pointer to the root window.

FXWindow* FX::FXWindow::getNext (  )  const [inline, inherited]

Return a pointer to the next (sibling) window, if any.

FXWindow* FX::FXWindow::getPrev (  )  const [inline, inherited]

Return a pointer to the previous (sibling) window , if any.

FXWindow* FX::FXWindow::getFirst (  )  const [inline, inherited]

Return a pointer to this window's first child window , if any.

FXWindow* FX::FXWindow::getLast (  )  const [inline, inherited]

Return a pointer to this window's last child window, if any.

FXWindow* FX::FXWindow::getFocus (  )  const [inline, inherited]

Return a pointer to the currently focused child window.

void FX::FXWindow::setKey ( FXuint  k  )  [inline, inherited]

Change window key.

FXuint FX::FXWindow::getKey (  )  const [inline, inherited]

Return window key.

void FX::FXWindow::setTarget ( FXObject t  )  [inline, inherited]

Set the message target object for this window.

FXObject* FX::FXWindow::getTarget (  )  const [inline, inherited]

Get the message target object for this window, if any.

void FX::FXWindow::setSelector ( FXSelector  sel  )  [inline, inherited]

Set the message identifier for this window.

FXSelector FX::FXWindow::getSelector (  )  const [inline, inherited]

Get the message identifier for this window.

FXint FX::FXWindow::getX (  )  const [inline, inherited]

Get this window's x-coordinate, in the parent's coordinate system.

FXint FX::FXWindow::getY (  )  const [inline, inherited]

Get this window's y-coordinate, in the parent's coordinate system.

virtual FXint FX::FXWindow::getWidthForHeight ( FXint  givenheight  )  [virtual, inherited]

Return width for given height.

Reimplemented in FX::FXDockSite.

virtual FXint FX::FXWindow::getHeightForWidth ( FXint  givenwidth  )  [virtual, inherited]

Return height for given width.

Reimplemented in FX::FXDockSite.

void FX::FXWindow::setX ( FXint  x  )  [inherited]

Set this window's x-coordinate, in the parent's coordinate system.

void FX::FXWindow::setY ( FXint  y  )  [inherited]

Set this window's y-coordinate, in the parent's coordinate system.

void FX::FXWindow::setWidth ( FXint  w  )  [inherited]

Set the window width; and flag the widget as being in need of layout by its parent. This does not immediately update the server- side representation of the widget.

void FX::FXWindow::setHeight ( FXint  h  )  [inherited]

Set the window height; and flag the widget as being in need of layout by its parent. This does not immediately update the server- side representation of the widget.

void FX::FXWindow::setLayoutHints ( FXuint  lout  )  [inherited]

Set layout hints for this window.

FXuint FX::FXWindow::getLayoutHints (  )  const [inherited]

Get layout hints for this window.

FXAccelTable* FX::FXWindow::getAccelTable (  )  const [inline, inherited]

Return a pointer to the accelerator table.

void FX::FXWindow::setAccelTable ( FXAccelTable acceltable  )  [inline, inherited]

Set the accelerator table.

void FX::FXWindow::addHotKey ( FXHotKey  code  )  [inherited]

Add a hot key.

void FX::FXWindow::remHotKey ( FXHotKey  code  )  [inherited]

Remove a hot key.

void FX::FXWindow::setHelpTag ( const FXString text  )  [inline, inherited]

Change help tag for this widget.

const FXString& FX::FXWindow::getHelpTag (  )  const [inline, inherited]

Get the help tag for this widget.

bool FX::FXWindow::isShell (  )  const [inherited]

Return true if window is a shell window.

bool FX::FXWindow::isPopup (  )  const [inherited]

Return true if window is a popup window.

bool FX::FXWindow::isOwnerOf ( const FXWindow window  )  const [inherited]

Return true if specified window is owned by this window.

bool FX::FXWindow::isChildOf ( const FXWindow window  )  const [inherited]

Return true if specified window is ancestor of this window.

bool FX::FXWindow::containsChild ( const FXWindow child  )  const [inherited]

Return true if this window contains child in its subtree.

FXWindow* FX::FXWindow::getChildAt ( FXint  x,
FXint  y 
) const [inherited]

Return the child window at specified coordinates.

FXint FX::FXWindow::numChildren (  )  const [inherited]

Return the number of child windows for this window.

FXint FX::FXWindow::indexOfChild ( const FXWindow window  )  const [inherited]

Return the index (starting from zero) of the specified child window, or -1 if the window is not a child or NULL

FXWindow* FX::FXWindow::childAtIndex ( FXint  index  )  const [inherited]

Return the child window at specified index, or NULL if the index is negative or out of range

static FXWindow* FX::FXWindow::commonAncestor ( FXWindow a,
FXWindow b 
) [static, inherited]

Return the common ancestor of window a and window b.

static bool FX::FXWindow::before ( const FXWindow a,
const FXWindow b 
) [static, inherited]

Return TRUE if sibling a <= sibling b in list.

static bool FX::FXWindow::after ( const FXWindow a,
const FXWindow b 
) [static, inherited]

Return TRUE if sibling a >= sibling b in list.

FXComposeContext* FX::FXWindow::getComposeContext (  )  const [inline, inherited]

Return compose context.

void FX::FXWindow::createComposeContext (  )  [inherited]

Create compose context.

void FX::FXWindow::destroyComposeContext (  )  [inherited]

Destroy compose context.

void FX::FXWindow::setDefaultCursor ( FXCursor cur  )  [inherited]

Set the default cursor for this window.

FXCursor* FX::FXWindow::getDefaultCursor (  )  const [inline, inherited]

Return the default cursor for this window.

void FX::FXWindow::setSavedCursor ( FXCursor cur  )  [inline, inherited]

Set the saved cursor for this window.

FXCursor* FX::FXWindow::getSavedCursor (  )  const [inline, inherited]

Return the saved cursor for this window.

void FX::FXWindow::setDragCursor ( FXCursor cur  )  [inherited]

Set the drag cursor for this window.

FXCursor* FX::FXWindow::getDragCursor (  )  const [inline, inherited]

Return the drag cursor for this window.

FXint FX::FXWindow::getCursorPosition ( FXint &  x,
FXint &  y,
FXuint &  buttons 
) const [inherited]

Return the cursor position and mouse button-state.

FXint FX::FXWindow::setCursorPosition ( FXint  x,
FXint  y 
) [inherited]

Warp the cursor to the new position.

bool FX::FXWindow::isEnabled (  )  const [inherited]

Return true if this window is able to receive mouse and keyboard events.

bool FX::FXWindow::isActive (  )  const [inherited]

Return true if the window is active.

virtual bool FX::FXWindow::canFocus (  )  const [virtual, inherited]

bool FX::FXWindow::hasFocus (  )  const [inherited]

Return true if this window has the focus.

bool FX::FXWindow::inFocusChain (  )  const [inherited]

Return true if this window is in focus chain.

virtual void FX::FXWindow::setFocus (  )  [virtual, inherited]

virtual void FX::FXWindow::killFocus (  )  [virtual, inherited]

virtual void FX::FXWindow::changeFocus ( FXWindow child  )  [virtual, inherited]

Notification that focus moved to new child.

Reimplemented in FX::FXTable.

virtual void FX::FXWindow::setDefault ( FXbool  enable = TRUE  )  [virtual, inherited]

This changes the default window which responds to the Return key in a dialog. If enable is TRUE, this window becomes the default window; when enable is FALSE, this window will be no longer the default window. Finally, when enable is MAYBE, the default window will revert to the initial default window.

Reimplemented in FX::FXButton.

bool FX::FXWindow::isDefault (  )  const [inherited]

Return true if this is the default window.

void FX::FXWindow::setInitial ( bool  enable = true  )  [inherited]

Make this window the initial default window.

bool FX::FXWindow::isInitial (  )  const [inherited]

Return true if this is the initial default window.

virtual void FX::FXWindow::enable (  )  [virtual, inherited]

virtual void FX::FXWindow::disable (  )  [virtual, inherited]

virtual void FX::FXWindow::attach ( FXID  w  )  [virtual, inherited]

Attach foreign window handle to this window.

virtual void FX::FXWindow::setShape ( const FXRegion region  )  [virtual, inherited]

Set window shape by means of region.

virtual void FX::FXWindow::setShape ( FXBitmap bitmap  )  [virtual, inherited]

Set window shape by means of bitmap.

virtual void FX::FXWindow::setShape ( FXIcon icon  )  [virtual, inherited]

Set window shape by means of icon.

virtual void FX::FXWindow::clearShape (  )  [virtual, inherited]

Clear window shape.

virtual void FX::FXWindow::raise (  )  [virtual, inherited]

Raise this window to the top of the stacking order.

Reimplemented in FX::FXTopWindow.

virtual void FX::FXWindow::lower (  )  [virtual, inherited]

Lower this window to the bottom of the stacking order.

virtual void FX::FXWindow::move ( FXint  x,
FXint  y 
) [virtual, inherited]

Move the window immediately, in the parent's coordinate system. Update the server representation as well if the window is realized. Perform layout of the children when necessary.

Reimplemented in FX::FXMDIChild, FX::FXRootWindow, and FX::FXTopWindow.

virtual void FX::FXWindow::resize ( FXint  w,
FXint  h 
) [virtual, inherited]

Resize the window to the specified width and height immediately, updating the server representation as well, if the window was realized. Perform layout of the children when necessary.

Reimplemented from FX::FXDrawable.

Reimplemented in FX::FXIconList, FX::FXMDIChild, FX::FXRootWindow, and FX::FXTopWindow.

virtual void FX::FXWindow::position ( FXint  x,
FXint  y,
FXint  w,
FXint  h 
) [virtual, inherited]

Move and resize the window immediately, in the parent's coordinate system. Update the server representation as well if the window is realized. Perform layout of the children when necessary.

Reimplemented in FX::FXIconList, FX::FXMDIChild, FX::FXRootWindow, and FX::FXTopWindow.

virtual void FX::FXWindow::recalc (  )  [virtual, inherited]

Mark this window's layout as dirty for later layout.

Reimplemented in FX::FXFoldingList, FX::FXIconList, FX::FXList, FX::FXRootWindow, FX::FXShell, FX::FXTable, FX::FXText, and FX::FXTreeList.

void FX::FXWindow::forceRefresh (  )  [inherited]

Generate a SEL_UPDATE message for the window and its children.

virtual void FX::FXWindow::reparent ( FXWindow father,
FXWindow other = NULL 
) [virtual, inherited]

Reparent this window under new father before other.

void FX::FXWindow::scroll ( FXint  x,
FXint  y,
FXint  w,
FXint  h,
FXint  dx,
FXint  dy 
) const [inherited]

Scroll rectangle x,y,w,h by a shift of dx,dy.

void FX::FXWindow::update ( FXint  x,
FXint  y,
FXint  w,
FXint  h 
) const [inherited]

Mark the specified rectangle to be repainted later.

void FX::FXWindow::update (  )  const [inherited]

Mark the entire window to be repainted later.

void FX::FXWindow::repaint ( FXint  x,
FXint  y,
FXint  w,
FXint  h 
) const [inherited]

Process any outstanding repaint messages immediately, for the given rectangle.

void FX::FXWindow::repaint (  )  const [inherited]

Process any outstanding repaint messages immediately.

void FX::FXWindow::grab (  )  [inherited]

Grab the mouse to this window; future mouse events will be reported to this window even while the cursor goes outside of this window

void FX::FXWindow::ungrab (  )  [inherited]

Release the mouse grab.

bool FX::FXWindow::grabbed (  )  const [inherited]

Return true if the window has been grabbed.

void FX::FXWindow::grabKeyboard (  )  [inherited]

Grab keyboard device.

void FX::FXWindow::ungrabKeyboard (  )  [inherited]

Ungrab keyboard device.

bool FX::FXWindow::grabbedKeyboard (  )  const [inherited]

Return true if active grab is in effect.

virtual void FX::FXWindow::show (  )  [virtual, inherited]

Show this window.

Reimplemented in FX::FXPopup, FX::FXScrollPane, FX::FXSplashWindow, FX::FXToolTip, and FX::FXTopWindow.

virtual void FX::FXWindow::hide (  )  [virtual, inherited]

Hide this window.

Reimplemented in FX::FXDirDialog, FX::FXFileDialog, FX::FXPopup, FX::FXSplashWindow, and FX::FXTopWindow.

bool FX::FXWindow::shown (  )  const [inherited]

Return true if the window is shown.

bool FX::FXWindow::underCursor (  )  const [inherited]

Return true if the window is under the cursor.

bool FX::FXWindow::hasSelection (  )  const [inherited]

Return true if this window owns the primary selection.

bool FX::FXWindow::acquireSelection ( const FXDragType *  types,
FXuint  numtypes 
) [inherited]

Try to acquire the primary selection, given a list of drag types.

bool FX::FXWindow::releaseSelection (  )  [inherited]

Release the primary selection.

bool FX::FXWindow::hasClipboard (  )  const [inherited]

Return true if this window owns the clipboard.

bool FX::FXWindow::acquireClipboard ( const FXDragType *  types,
FXuint  numtypes 
) [inherited]

Try to acquire the clipboard, given a list of drag types.

bool FX::FXWindow::releaseClipboard (  )  [inherited]

Release the clipboard.

virtual void FX::FXWindow::dropEnable (  )  [virtual, inherited]

Enable this window to receive drops.

virtual void FX::FXWindow::dropDisable (  )  [virtual, inherited]

Disable this window from receiving drops.

bool FX::FXWindow::isDropEnabled (  )  const [inherited]

Return true if this window is able to receive drops.

bool FX::FXWindow::isDragging (  )  const [inherited]

Return true if a drag operaion has been initiated from this window.

bool FX::FXWindow::beginDrag ( const FXDragType *  types,
FXuint  numtypes 
) [inherited]

Initiate a drag operation with a list of previously registered drag types.

bool FX::FXWindow::handleDrag ( FXint  x,
FXint  y,
FXDragAction  action = DRAG_COPY 
) [inherited]

When dragging, inform the drop-target of the new position and the drag action

FXDragAction FX::FXWindow::endDrag ( bool  drop = true  )  [inherited]

Terminate the drag operation with or without actually dropping the data Returns the action performed by the target

bool FX::FXWindow::isDropTarget (  )  const [inherited]

Return true if this window is the target of a drop.

void FX::FXWindow::setDragRectangle ( FXint  x,
FXint  y,
FXint  w,
FXint  h,
bool  wantupdates = true 
) const [inherited]

When being dragged over, indicate that no further SEL_DND_MOTION messages are required while the cursor is inside the given rectangle

void FX::FXWindow::clearDragRectangle (  )  const [inherited]

When being dragged over, indicate we want to receive SEL_DND_MOTION messages every time the cursor moves

void FX::FXWindow::acceptDrop ( FXDragAction  action = DRAG_ACCEPT  )  const [inherited]

When being dragged over, indicate acceptance or rejection of the dragged data.

FXDragAction FX::FXWindow::didAccept (  )  const [inherited]

The target accepted our drop.

void FX::FXWindow::dropFinished ( FXDragAction  action = DRAG_REJECT  )  const [inherited]

Sent by the drop target in response to SEL_DND_DROP. The drag action should be the same as the action the drop target reported to the drag source in reponse to the SEL_DND_MOTION message. This function notifies the drag source that its part of the drop transaction is finished, and that it is free to release any resources involved in the drag operation. Calling dropFinished() is advisable in cases where the drop target needs to perform complex processing on the data received from the drag source, prior to returning from the SEL_DND_DROP message handler.

bool FX::FXWindow::inquireDNDTypes ( FXDNDOrigin  origin,
FXDragType *&  types,
FXuint &  numtypes 
) const [inherited]

When being dragged over, inquire the drag types which are being offered.

bool FX::FXWindow::offeredDNDType ( FXDNDOrigin  origin,
FXDragType  type 
) const [inherited]

When being dragged over, return true if we are offered the given drag type.

FXDragAction FX::FXWindow::inquireDNDAction (  )  const [inherited]

When being dragged over, return the drag action.

bool FX::FXWindow::setDNDData ( FXDNDOrigin  origin,
FXDragType  type,
FXuchar *  data,
FXuint  size 
) const [inherited]

Set DND data; the array must be allocated with FXMALLOC and ownership is transferred to the system

bool FX::FXWindow::setDNDData ( FXDNDOrigin  origin,
FXDragType  type,
const FXString string 
) const [inherited]

Set DND data from string value.

bool FX::FXWindow::getDNDData ( FXDNDOrigin  origin,
FXDragType  type,
FXuchar *&  data,
FXuint &  size 
) const [inherited]

Get DND data; the caller becomes the owner of the array and must free it with FXFREE

bool FX::FXWindow::getDNDData ( FXDNDOrigin  origin,
FXDragType  type,
FXString string 
) const [inherited]

Get DND data into string value.

virtual bool FX::FXWindow::contains ( FXint  parentx,
FXint  parenty 
) const [virtual, inherited]

Return true if window logically contains the given point.

Reimplemented in FX::FXMenuBar, FX::FXMenuButton, FX::FXMenuCascade, FX::FXMenuPane, FX::FXMenuTitle, and FX::FXOptionMenu.

void FX::FXWindow::translateCoordinatesFrom ( FXint &  tox,
FXint &  toy,
const FXWindow fromwindow,
FXint  fromx,
FXint  fromy 
) const [inherited]

Translate coordinates from fromwindow's coordinate space to this window's coordinate space.

void FX::FXWindow::translateCoordinatesTo ( FXint &  tox,
FXint &  toy,
const FXWindow towindow,
FXint  fromx,
FXint  fromy 
) const [inherited]

Translate coordinates from this window's coordinate space to towindow's coordinate space.

virtual void FX::FXWindow::setBackColor ( FXColor  clr  )  [virtual, inherited]

Set window background color.

Reimplemented in FX::FXComboBox, and FX::FXListBox.

FXColor FX::FXWindow::getBackColor (  )  const [inline, inherited]

Get background color.

Reimplemented in FX::FXComboBox, and FX::FXListBox.

FXint FX::FXDrawable::getWidth (  )  const [inline, inherited]

Width of drawable.

FXint FX::FXDrawable::getHeight (  )  const [inline, inherited]

Height of drawable.

FXVisual* FX::FXDrawable::getVisual (  )  const [inline, inherited]

Get the visual.

void FX::FXDrawable::setVisual ( FXVisual vis  )  [inherited]

Change visual.

FXApp* FX::FXId::getApp (  )  const [inline, inherited]

Get application.

FXEventLoop* FX::FXId::getEventLoop (  )  const [inline, inherited]

Get event loop which owns this.

FXID FX::FXId::id (  )  const [inline, inherited]

Get XID handle.

void FX::FXId::setUserData ( void *  ptr  )  [inline, inherited]

Set user data pointer.

void* FX::FXId::getUserData (  )  const [inline, inherited]

Get user data pointer.

const FXchar* FX::FXObject::getClassName (  )  const [inherited]

Get class name of some object.

bool FX::FXObject::isMemberOf ( const FXMetaClass metaclass  )  const [inherited]

Check if object is member of metaclass.

virtual long FX::FXObject::tryHandle ( FXObject sender,
FXSelector  sel,
void *  ptr 
) [virtual, inherited]

Try handle message safely.

QTransString FX::FXObject::tr ( const char *  text,
const char *  hint = 0 
) [inherited]

Returns a human translated version of the text to the locale language (warning: uses a virtual method call, so can't use before construction)

virtual void* FX::FXObject::getPythonObject (  )  const [inline, virtual, inherited]

Returns the python object representing this instance (if created in python).

virtual void FX::FXObject::decouplePythonObject (  )  const [inline, virtual, inherited]

Causes decoupling of python object from this object (deletes self).


The documentation for this class was generated from the following file:

(C) 2002-2008 Niall Douglas. Some parts (C) to assorted authors.
Generated on Fri Jun 13 22:05:31 2008 for TnFOX by doxygen v1.5.6