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

FX::FXWindow Class Reference

Base class for all windows. More...

#include <FXWindow.h>

Inheritance diagram for FX::FXWindow:

FX::FXDrawable FX::FXId FX::FXObject FX::FXCanvas FX::FXComposite FX::FXDragCorner FX::FXFrame FX::FXMenuCaption FX::FXMenuSeparator FX::FXScrollBar FX::FXScrollCorner List of all members.

Public Types

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

 FXWindow (FXComposite *p, FXuint opts=0, FXint x=0, FXint y=0, FXint w=0, FXint h=0)
FXWindow * getParent () const
FXWindow * getOwner () const
FXWindow * getShell () const
FXWindow * getRoot () const
FXWindow * getNext () const
FXWindow * getPrev () const
FXWindow * getFirst () const
FXWindow * getLast () const
FXWindow * getFocus () const
void setKey (FXuint k)
FXuint getKey () const
void setTarget (FXObject *t)
FXObject * getTarget () const
void setSelector (FXSelector sel)
FXSelector getSelector () const
FXint getX () const
FXint getY () const
virtual FXint getDefaultWidth ()
virtual FXint getDefaultHeight ()
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
FXAccelTable * getAccelTable () const
void setAccelTable (FXAccelTable *acceltable)
void addHotKey (FXHotKey code)
void remHotKey (FXHotKey code)
void setHelpTag (const FXString &text)
const FXString & getHelpTag () const
bool isShell () const
bool isOwnerOf (const FXWindow *window) const
bool isChildOf (const FXWindow *window) const
bool containsChild (const FXWindow *child) const
FXWindow * getChildAt (FXint x, FXint y) const
FXint numChildren () const
FXint indexOfChild (const FXWindow *window) const
FXWindow * childAtIndex (FXint index) const
FXComposeContext * getComposeContext () const
void createComposeContext ()
void destroyComposeContext ()
void setDefaultCursor (FXCursor *cur)
FXCursor * getDefaultCursor () const
void setDragCursor (FXCursor *cur)
FXCursor * getDragCursor () 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 create ()
virtual void attach (FXID w)
virtual void detach ()
virtual void destroy ()
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 ()
virtual void layout ()
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
virtual bool isComposite () 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 FXchar * tr (const FXchar *message, const FXchar *hint=NULL) const
virtual void save (FXStream &store) const
virtual void load (FXStream &store)
virtual ~FXWindow ()

Static Public Member Functions

static FXWindow * commonAncestor (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 []

Friends

class FXApp

Detailed Description

Base class for all windows.

See also:


Member Enumeration Documentation

anonymous enum
 

Enumeration values:
ID_NONE 
ID_HIDE  ID_HIDE+FALSE.
ID_SHOW  ID_HIDE+TRUE.
ID_TOGGLESHOWN 
ID_LOWER 
ID_RAISE 
ID_DELETE 
ID_DISABLE  ID_DISABLE+FALSE.
ID_ENABLE  ID_DISABLE+TRUE.
ID_TOGGLEENABLED 
ID_UNCHECK  ID_UNCHECK+FALSE.
ID_CHECK  ID_UNCHECK+TRUE.
ID_UNKNOWN  ID_UNCHECK+MAYBE.
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 


Constructor & Destructor Documentation

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

Constructor.

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

Destroy window.


Member Function Documentation

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

Return a pointer to the parent window.

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

Return a pointer to the owner window.

FXWindow* FX::FXWindow::getShell (   )  const
 

Return a pointer to the shell window.

FXWindow* FX::FXWindow::getRoot (   )  const
 

Return a pointer to the root window.

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

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

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

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

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

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

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

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

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

Return a pointer to the currently focused child window.

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

Change window key.

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

Return window key.

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

Set the message target object for this window.

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

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

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

Set the message identifier for this window.

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

Get the message identifier for this window.

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

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

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

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

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

Return the default width of this window.

Reimplemented in FX::FX4Splitter, FX::FX7Segment, FX::FXArrowButton, FX::FXBitmapFrame, FX::FXCheckButton, FX::FXColorBar, FX::FXColorRing, FX::FXColorWell, FX::FXColorWheel, FX::FXComboBox, FX::FXComposite, FX::FXDial, FX::FXDockSite, FX::FXDockTitle, FX::FXDragCorner, FX::FXFoldingList, FX::FXFrame, FX::FXGradientBar, FX::FXGroupBox, FX::FXHeader, FX::FXHorizontalFrame, FX::FXImageFrame, FX::FXKnob, FX::FXLabel, FX::FXList, FX::FXListBox, FX::FXMatrix, FX::FXMDIDeleteButton, FX::FXMDIRestoreButton, FX::FXMDIMaximizeButton, FX::FXMDIMinimizeButton, FX::FXMDIWindowButton, FX::FXMDIChild, FX::FXMDIClient, FX::FXMenuButton, FX::FXMenuCaption, FX::FXMenuCheck, FX::FXMenuCommand, FX::FXMenuRadio, FX::FXMenuSeparator, FX::FXMenuTitle, FX::FXOption, FX::FXOptionMenu, FX::FXPacker, FX::FXPopup, FX::FXProgressBar, FX::FXRadioButton, FX::FXRealSlider, FX::FXRealSpinner, FX::FXRootWindow, FX::FXRuler, FX::FXScrollArea, FX::FXScrollBar, FX::FXScrollPane, FX::FXSeparator, FX::FXSlider, FX::FXSpinner, FX::FXSplashWindow, FX::FXSplitter, FX::FXSpring, FX::FXStatusBar, FX::FXStatusLine, FX::FXSwitcher, FX::FXTabBar, FX::FXTabBook, FX::FXTable, FX::FXText, FX::FXTextField, FX::FXToggleButton, FX::FXToolBar, FX::FXToolBarGrip, FX::FXToolBarShell, FX::FXToolBarTab, FX::FXToolTip, FX::FXTopWindow, FX::FXTreeList, FX::FXTreeListBox, FX::FXTriStateButton, and FX::FXVerticalFrame.

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

Return the default height of this window.

Reimplemented in FX::FX4Splitter, FX::FX7Segment, FX::FXArrowButton, FX::FXBitmapFrame, FX::FXCheckButton, FX::FXColorBar, FX::FXColorRing, FX::FXColorWell, FX::FXColorWheel, FX::FXComboBox, FX::FXComposite, FX::FXDial, FX::FXDockSite, FX::FXDockTitle, FX::FXDragCorner, FX::FXFoldingList, FX::FXFrame, FX::FXGradientBar, FX::FXGroupBox, FX::FXHeader, FX::FXHorizontalFrame, FX::FXImageFrame, FX::FXKnob, FX::FXLabel, FX::FXList, FX::FXListBox, FX::FXMatrix, FX::FXMDIDeleteButton, FX::FXMDIRestoreButton, FX::FXMDIMaximizeButton, FX::FXMDIMinimizeButton, FX::FXMDIWindowButton, FX::FXMDIChild, FX::FXMDIClient, FX::FXMenuButton, FX::FXMenuCaption, FX::FXMenuCheck, FX::FXMenuCommand, FX::FXMenuRadio, FX::FXMenuSeparator, FX::FXMenuTitle, FX::FXOption, FX::FXOptionMenu, FX::FXPacker, FX::FXPopup, FX::FXProgressBar, FX::FXRadioButton, FX::FXRealSlider, FX::FXRealSpinner, FX::FXRootWindow, FX::FXRuler, FX::FXScrollArea, FX::FXScrollBar, FX::FXScrollPane, FX::FXSeparator, FX::FXSlider, FX::FXSpinner, FX::FXSplashWindow, FX::FXSplitter, FX::FXSpring, FX::FXStatusBar, FX::FXStatusLine, FX::FXSwitcher, FX::FXTabBar, FX::FXTabBook, FX::FXTable, FX::FXText, FX::FXTextField, FX::FXToggleButton, FX::FXToolBar, FX::FXToolBarGrip, FX::FXToolBarShell, FX::FXToolBarTab, FX::FXToolTip, FX::FXTopWindow, FX::FXTreeList, FX::FXTreeListBox, FX::FXTriStateButton, and FX::FXVerticalFrame.

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

Return width for given height.

Reimplemented in FX::FXDockSite.

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

Return height for given width.

Reimplemented in FX::FXDockSite.

void FX::FXWindow::setX (  FXint  x  ) 
 

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

void FX::FXWindow::setY (  FXint  y  ) 
 

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

void FX::FXWindow::setWidth (  FXint  w  ) 
 

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  ) 
 

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  ) 
 

Set layout hints for this window.

FXuint FX::FXWindow::getLayoutHints (   )  const
 

Get layout hints for this window.

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

Return a pointer to the accelerator table.

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

Set the accelerator table.

void FX::FXWindow::addHotKey (  FXHotKey  code  ) 
 

Add a hot key.

void FX::FXWindow::remHotKey (  FXHotKey  code  ) 
 

Remove a hot key.

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

Change help tag for this widget.

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

Get the help tag for this widget.

bool FX::FXWindow::isShell (   )  const
 

Return true if window is a shell window.

bool FX::FXWindow::isOwnerOf (  const FXWindow *  window  )  const
 

Return true if specified window is owned by this window.

bool FX::FXWindow::isChildOf (  const FXWindow *  window  )  const
 

Return true if specified window is ancestor of this window.

bool FX::FXWindow::containsChild (  const FXWindow *  child  )  const
 

Return true if this window contains child in its subtree.

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

Return the child window at specified coordinates.

FXint FX::FXWindow::numChildren (   )  const
 

Return the number of child windows for this window.

FXint FX::FXWindow::indexOfChild (  const FXWindow *  window  )  const
 

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
 

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]
 

Return the common ancestor of window a and window b.

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

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

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

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

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

Return compose context.

void FX::FXWindow::createComposeContext (   ) 
 

Create compose context.

void FX::FXWindow::destroyComposeContext (   ) 
 

Destroy compose context.

void FX::FXWindow::setDefaultCursor (  FXCursor *  cur  ) 
 

Set the default cursor for this window.

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

Return the default cursor for this window.

void FX::FXWindow::setDragCursor (  FXCursor *  cur  ) 
 

Set the drag cursor for this window.

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

Return the drag cursor for this window.

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

Return the cursor position and mouse button-state.

FXint FX::FXWindow::setCursorPosition (  FXint  x,
FXint  y
) 
 

Warp the cursor to the new position.

bool FX::FXWindow::isEnabled (   )  const
 

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

bool FX::FXWindow::isActive (   )  const
 

Return true if the window is active.

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

Return true if this window is a control capable of receiving the focus.

Reimplemented in FX::FXArrowButton, FX::FXBitmapView, FX::FXButton, FX::FXCanvas, FX::FXCheckButton, FX::FXColorWell, FX::FXDial, FX::FXDockHandler, FX::FXFoldingList, FX::FXIconList, FX::FXImageView, FX::FXKnob, FX::FXList, FX::FXMDIChild, FX::FXMenuButton, FX::FXMenuCascade, FX::FXMenuCommand, FX::FXMenuTitle, FX::FXOption, FX::FXOptionMenu, FX::FXRadioButton, FX::FXRealSlider, FX::FXSlider, FX::FXTabItem, FX::FXTable, FX::FXText, FX::FXTextField, FX::FXToggleButton, FX::FXToolBarGrip, FX::FXToolBarTab, and FX::FXTreeList.

bool FX::FXWindow::hasFocus (   )  const
 

Return true if this window has the focus.

bool FX::FXWindow::inFocusChain (   )  const
 

Return true if this window is in focus chain.

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

Move the focus to this window.

Reimplemented in FX::FXButton, FX::FXColorWell, FX::FXFoldingList, FX::FXIconList, FX::FXList, FX::FXMDIChild, FX::FXMenuCascade, FX::FXMenuCommand, FX::FXMenuTitle, FX::FXOption, FX::FXPopup, FX::FXRootWindow, FX::FXShell, FX::FXTable, FX::FXText, FX::FXTextField, FX::FXTopWindow, and FX::FXTreeList.

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

Remove the focus from this window.

Reimplemented in FX::FXButton, FX::FXColorWell, FX::FXFoldingList, FX::FXIconList, FX::FXList, FX::FXMenuButton, FX::FXMenuCascade, FX::FXMenuCommand, FX::FXMenuTitle, FX::FXOption, FX::FXOptionMenu, FX::FXPopup, FX::FXRootWindow, FX::FXShell, FX::FXTable, FX::FXText, FX::FXTextField, FX::FXTopWindow, and FX::FXTreeList.

virtual void FX::FXWindow::changeFocus (  FXWindow *  child  )  [virtual]
 

Notification that focus moved to new child.

Reimplemented in FX::FXTable.

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

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
 

Return true if this is the default window.

void FX::FXWindow::setInitial (  bool  enable = true  ) 
 

Make this window the initial default window.

bool FX::FXWindow::isInitial (   )  const
 

Return true if this is the initial default window.

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

Enable the window to receive mouse and keyboard events.

Reimplemented in FX::FXArrowButton, FX::FXComboBox, FX::FXGroupBox, FX::FXKnob, FX::FXLabel, FX::FXListBox, FX::FXMenuCaption, FX::FXRealSlider, FX::FXRealSpinner, FX::FXScrollCorner, FX::FXSlider, FX::FXSpinner, FX::FXText, FX::FXTextField, FX::FXToolBarTab, and FX::FXTreeListBox.

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

Disable the window from receiving mouse and keyboard events.

Reimplemented in FX::FXArrowButton, FX::FXComboBox, FX::FXGroupBox, FX::FXKnob, FX::FXLabel, FX::FXListBox, FX::FXMenuCaption, FX::FXRealSlider, FX::FXRealSpinner, FX::FXScrollCorner, FX::FXSlider, FX::FXSpinner, FX::FXText, FX::FXTextField, FX::FXToolBarTab, and FX::FXTreeListBox.

virtual void FX::FXWindow::create (   )  [virtual]
 

Create all of the server-side resources for this window.

Reimplemented from FX::FXId.

Reimplemented in FX::FXBitmapFrame, FX::FXBitmapView, FX::FXColorBar, FX::FXColorRing, FX::FXColorSelector, FX::FXColorWell, FX::FXColorWheel, FX::FXComboBox, FX::FXComposite, FX::FXDirBox, FX::FXDirList, FX::FXDockTitle, FX::FXDragCorner, FX::FXDriveBox, FX::FXFileList, FX::FXFoldingList, FX::FXFontSelector, FX::FXGLCanvas, FX::FXGLViewer, FX::FXGradientBar, FX::FXGroupBox, FX::FXHeader, FX::FXIconList, FX::FXImageFrame, FX::FXImageView, FX::FXLabel, FX::FXList, FX::FXListBox, FX::FXMainWindow, FX::FXMDIChild, FX::FXMenuButton, FX::FXMenuCaption, FX::FXMenuCascade, FX::FXMenuTitle, FX::FXOptionMenu, FX::FXPrintDialog, FX::FXProgressBar, FX::FXRootWindow, FX::FXRuler, FX::FXShell, FX::FXSplashWindow, FX::FXStatusLine, FX::FXTable, FX::FXText, FX::FXTextField, FX::FXToggleButton, FX::FXToolBarShell, FX::FXToolTip, FX::FXTopWindow, FX::FXTreeList, FX::FXTreeListBox, and FX::FXTriStateButton.

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

Attach foreign window handle to this window.

virtual void FX::FXWindow::detach (   )  [virtual]
 

Detach the server-side resources for this window.

Reimplemented from FX::FXId.

Reimplemented in FX::FXBitmapView, FX::FXColorBar, FX::FXColorRing, FX::FXColorWell, FX::FXColorWheel, FX::FXComboBox, FX::FXComposite, FX::FXDirBox, FX::FXDirList, FX::FXDockTitle, FX::FXDriveBox, FX::FXFileList, FX::FXFoldingList, FX::FXGLCanvas, FX::FXGLViewer, FX::FXGroupBox, FX::FXHeader, FX::FXIconList, FX::FXImageView, FX::FXLabel, FX::FXList, FX::FXListBox, FX::FXMDIChild, FX::FXMenuButton, FX::FXMenuCaption, FX::FXMenuCascade, FX::FXMenuTitle, FX::FXOptionMenu, FX::FXProgressBar, FX::FXRootWindow, FX::FXRuler, FX::FXSplashWindow, FX::FXStatusLine, FX::FXTable, FX::FXText, FX::FXToggleButton, FX::FXToolTip, FX::FXTopWindow, FX::FXTreeList, FX::FXTreeListBox, and FX::FXTriStateButton.

virtual void FX::FXWindow::destroy (   )  [virtual]
 

Destroy the server-side resources for this window.

Reimplemented from FX::FXId.

Reimplemented in FX::FXComboBox, FX::FXComposite, FX::FXDirBox, FX::FXDirList, FX::FXDriveBox, FX::FXFileList, FX::FXGLCanvas, FX::FXListBox, FX::FXMenuCascade, FX::FXOptionMenu, FX::FXRootWindow, FX::FXTopWindow, and FX::FXTreeListBox.

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

Set window shape by means of region.

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

Set window shape by means of bitmap.

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

Set window shape by means of icon.

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

Clear window shape.

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

Raise this window to the top of the stacking order.

Reimplemented in FX::FXTopWindow.

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

Lower this window to the bottom of the stacking order.

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

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]
 

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]
 

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]
 

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.

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

Perform layout immediately.

Reimplemented in FX::FX4Splitter, FX::FXBitmapView, FX::FXColorBar, FX::FXColorRing, FX::FXColorWheel, FX::FXComboBox, FX::FXComposite, FX::FXDockSite, FX::FXFoldingList, FX::FXGLViewer, FX::FXGradientBar, FX::FXGroupBox, FX::FXHeader, FX::FXHorizontalFrame, FX::FXIconList, FX::FXImageView, FX::FXKnob, FX::FXList, FX::FXListBox, FX::FXMatrix, FX::FXMDIChild, FX::FXMDIClient, FX::FXOptionMenu, FX::FXPacker, FX::FXPopup, FX::FXRealSlider, FX::FXRealSpinner, FX::FXRootWindow, FX::FXRuler, FX::FXRulerView, FX::FXScrollArea, FX::FXScrollBar, FX::FXScrollPane, FX::FXScrollWindow, FX::FXShutter, FX::FXSlider, FX::FXSpinner, FX::FXSplitter, FX::FXStatusBar, FX::FXSwitcher, FX::FXTabBar, FX::FXTabBook, FX::FXTable, FX::FXText, FX::FXTextField, FX::FXToolBar, FX::FXToolBarShell, FX::FXTopWindow, FX::FXTreeList, FX::FXTreeListBox, and FX::FXVerticalFrame.

void FX::FXWindow::forceRefresh (   ) 
 

Generate a SEL_UPDATE message for the window and its children.

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

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
 

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
 

Mark the specified rectangle to be repainted later.

void FX::FXWindow::update (   )  const
 

Mark the entire window to be repainted later.

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

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

void FX::FXWindow::repaint (   )  const
 

Process any outstanding repaint messages immediately.

void FX::FXWindow::grab (   ) 
 

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 (   ) 
 

Release the mouse grab.

bool FX::FXWindow::grabbed (   )  const
 

Return true if the window has been grabbed.

void FX::FXWindow::grabKeyboard (   ) 
 

Grab keyboard device.

void FX::FXWindow::ungrabKeyboard (   ) 
 

Ungrab keyboard device.

bool FX::FXWindow::grabbedKeyboard (   )  const
 

Return true if active grab is in effect.

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

Show this window.

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

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

Hide this window.

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

bool FX::FXWindow::shown (   )  const
 

Return true if the window is shown.

virtual bool FX::FXWindow::isComposite (   )  const [virtual]
 

Return true if the window is composite.

Reimplemented in FX::FXComposite.

bool FX::FXWindow::underCursor (   )  const
 

Return true if the window is under the cursor.

bool FX::FXWindow::hasSelection (   )  const
 

Return true if this window owns the primary selection.

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

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

bool FX::FXWindow::releaseSelection (   ) 
 

Release the primary selection.

bool FX::FXWindow::hasClipboard (   )  const
 

Return true if this window owns the clipboard.

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

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

bool FX::FXWindow::releaseClipboard (   ) 
 

Release the clipboard.

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

Enable this window to receive drops.

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

Disable this window from receiving drops.

bool FX::FXWindow::isDropEnabled (   )  const
 

Return true if this window is able to receive drops.

bool FX::FXWindow::isDragging (   )  const
 

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

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

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

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

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

FXDragAction FX::FXWindow::endDrag (  bool  drop = true  ) 
 

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

bool FX::FXWindow::isDropTarget (   )  const
 

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
 

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
 

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
 

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

FXDragAction FX::FXWindow::didAccept (   )  const
 

The target accepted our drop.

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

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
 

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

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

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

FXDragAction FX::FXWindow::inquireDNDAction (   )  const
 

When being dragged over, return the drag action.

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

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
 

Set DND data from string value.

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

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
 

Get DND data into string value.

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

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
 

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
 

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

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

Set window background color.

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

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

Get background color.

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

virtual bool FX::FXWindow::doesSaveUnder (   )  const [virtual]
 

Reimplemented in FX::FXPopup, and FX::FXToolTip.

virtual const FXchar* FX::FXWindow::tr (  const FXchar *  message,
const FXchar *  hint = NULL
)  const [virtual]
 

Translate message for localization; using the current FXTranslator, an attempt is made to translate the given message into the current language.

An optional hint may be passed to break any ties in case more than one tranlation is possible for the given message text. In addition, the name of the widget is passed as context name so that controls in a single dialog may be grouped together.

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

Save window to stream.

Reimplemented from FX::FXDrawable.

Reimplemented in FX::FX4Splitter, FX::FX7Segment, FX::FXArrowButton, FX::FXBitmapFrame, FX::FXBitmapView, FX::FXCheckButton, FX::FXChoiceBox, FX::FXColorBar, FX::FXColorDialog, FX::FXColorRing, FX::FXColorSelector, FX::FXColorWell, FX::FXColorWheel, FX::FXComboBox, FX::FXDial, FX::FXDirBox, FX::FXDirDialog, FX::FXDirList, FX::FXDirSelector, FX::FXDockBar, FX::FXDockHandler, FX::FXDockTitle, FX::FXDragCorner, FX::FXDriveBox, FX::FXFileDialog, FX::FXFileList, FX::FXFileSelector, FX::FXFoldingList, FX::FXFontDialog, FX::FXFontSelector, FX::FXFrame, FX::FXGLCanvas, FX::FXGLViewer, FX::FXGradientBar, FX::FXGroupBox, FX::FXHeader, FX::FXIconList, FX::FXImageFrame, FX::FXImageView, FX::FXKnob, FX::FXLabel, FX::FXList, FX::FXListBox, FX::FXMDIChild, FX::FXMDIClient, FX::FXMenuButton, FX::FXMenuCaption, FX::FXMenuCascade, FX::FXMenuCheck, FX::FXMenuCommand, FX::FXMenuRadio, FX::FXMenuSeparator, FX::FXMenuTitle, FX::FXOptionMenu, FX::FXPacker, FX::FXPrintDialog, FX::FXProgressBar, FX::FXRadioButton, FX::FXRealSlider, FX::FXRealSpinner, FX::FXReplaceDialog, FX::FXRuler, FX::FXRulerView, FX::FXScrollBar, FX::FXSlider, FX::FXSpinner, FX::FXSplashWindow, FX::FXSplitter, FX::FXSpring, FX::FXStatusBar, FX::FXStatusLine, FX::FXSwitcher, FX::FXTabBar, FX::FXTable, FX::FXText, FX::FXTextField, FX::FXToggleButton, FX::FXToolBarGrip, FX::FXToolBarShell, FX::FXToolBarTab, FX::FXToolTip, FX::FXTopWindow, FX::FXTreeList, FX::FXTreeListBox, FX::FXTriStateButton, and FX::FXWizard.

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

Restore window from stream.

Reimplemented from FX::FXDrawable.

Reimplemented in FX::FX4Splitter, FX::FX7Segment, FX::FXArrowButton, FX::FXBitmapFrame, FX::FXBitmapView, FX::FXCheckButton, FX::FXChoiceBox, FX::FXColorBar, FX::FXColorDialog, FX::FXColorRing, FX::FXColorSelector, FX::FXColorWell, FX::FXColorWheel, FX::FXComboBox, FX::FXDial, FX::FXDirBox, FX::FXDirDialog, FX::FXDirList, FX::FXDirSelector, FX::FXDockBar, FX::FXDockHandler, FX::FXDockTitle, FX::FXDragCorner, FX::FXDriveBox, FX::FXFileDialog, FX::FXFileList, FX::FXFileSelector, FX::FXFoldingList, FX::FXFontDialog, FX::FXFontSelector, FX::FXFrame, FX::FXGLCanvas, FX::FXGLViewer, FX::FXGradientBar, FX::FXGroupBox, FX::FXHeader, FX::FXIconList, FX::FXImageFrame, FX::FXImageView, FX::FXKnob, FX::FXLabel, FX::FXList, FX::FXListBox, FX::FXMDIChild, FX::FXMDIClient, FX::FXMenuButton, FX::FXMenuCaption, FX::FXMenuCascade, FX::FXMenuCheck, FX::FXMenuCommand, FX::FXMenuRadio, FX::FXMenuSeparator, FX::FXMenuTitle, FX::FXOptionMenu, FX::FXPacker, FX::FXPrintDialog, FX::FXProgressBar, FX::FXRadioButton, FX::FXRealSlider, FX::FXRealSpinner, FX::FXReplaceDialog, FX::FXRuler, FX::FXRulerView, FX::FXScrollBar, FX::FXSlider, FX::FXSpinner, FX::FXSplashWindow, FX::FXSplitter, FX::FXSpring, FX::FXStatusBar, FX::FXStatusLine, FX::FXSwitcher, FX::FXTabBar, FX::FXTable, FX::FXText, FX::FXTextField, FX::FXToggleButton, FX::FXToolBarGrip, FX::FXToolBarShell, FX::FXToolBarTab, FX::FXToolTip, FX::FXTopWindow, FX::FXTreeList, FX::FXTreeListBox, FX::FXTriStateButton, and FX::FXWizard.


Friends And Related Function Documentation

friend class FXApp [friend]
 


Member Data Documentation

FXDragType FX::FXWindow::octetType [static]
 

FXDragType FX::FXWindow::deleteType [static]
 

FXDragType FX::FXWindow::textType [static]
 

FXDragType FX::FXWindow::utf8Type [static]
 

FXDragType FX::FXWindow::utf16Type [static]
 

FXDragType FX::FXWindow::colorType [static]
 

FXDragType FX::FXWindow::urilistType [static]
 

const FXDragType FX::FXWindow::stringType [static]
 

const FXDragType FX::FXWindow::imageType [static]
 

const FXchar FX::FXWindow::octetTypeName[] [static]
 

const FXchar FX::FXWindow::deleteTypeName[] [static]
 

const FXchar FX::FXWindow::textTypeName[] [static]
 

const FXchar FX::FXWindow::colorTypeName[] [static]
 

const FXchar FX::FXWindow::urilistTypeName[] [static]
 

const FXchar FX::FXWindow::utf8TypeName[] [static]
 

const FXchar FX::FXWindow::utf16TypeName[] [static]
 

Copyright © 1997-2005 Jeroen van der Zijp