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

FX::FXTopWindow Class Reference

#include <FXTopWindow.h>

Inheritance diagram for FX::FXTopWindow:
FX::FXShell FX::FXComposite FX::FXWindow FX::FXDrawable FX::FXId FX::FXObject FX::FXDialogBox FX::FXMainWindow FX::FXSplashWindow FX::FXToolBarShell FX::FXChoiceBox FX::FXColorDialog FX::FXDirDialog FX::FXFileDialog FX::FXFontDialog FX::FXInputDialog FX::FXMessageBox FX::FXPrintDialog FX::FXProgressDialog FX::FXReplaceDialog FX::FXWizard

Public Types

enum  {
  ID_MAXIMIZE =FXShell::ID_LAST,
  ID_MINIMIZE,
  ID_RESTORE,
  ID_CLOSE,
  ID_QUERY_DOCK,
  ID_LAST
}
 
- 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
}
 

Public Member Functions

virtual void create ()
 
virtual void detach ()
 
virtual void destroy ()
 
virtual void layout ()
 
virtual void setFocus ()
 
virtual void killFocus ()
 
virtual void show ()
 
virtual void hide ()
 
virtual void show (FXuint placement)
 
void place (FXuint placement)
 
virtual FXint getDefaultWidth ()
 
virtual FXint getDefaultHeight ()
 
FXbool getWMBorders (FXint &left, FXint &right, FXint &top, FXint &bottom)
 
virtual void raise ()
 
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 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
 
void setTitle (const FXString &name)
 
FXString getTitle () const
 
void setPadTop (FXint pt)
 
FXint getPadTop () const
 
void setPadBottom (FXint pb)
 
FXint getPadBottom () const
 
void setPadLeft (FXint pl)
 
FXint getPadLeft () const
 
void setPadRight (FXint pr)
 
FXint getPadRight () const
 
FXint getHSpacing () const
 
FXint getVSpacing () const
 
void setHSpacing (FXint hs)
 
void setVSpacing (FXint vs)
 
void setPackingHints (FXuint ph)
 
FXuint getPackingHints () const
 
void setDecorations (FXuint decorations)
 
FXuint getDecorations () const
 
FXIcongetIcon () const
 
void setIcon (FXIcon *ic)
 
FXIcongetMiniIcon () const
 
void setMiniIcon (FXIcon *ic)
 
virtual void save (FXStream &store) const
 
virtual void load (FXStream &store)
 
virtual ~FXTopWindow ()
 
- Public Member Functions inherited from FX::FXShell
virtual void recalc ()
 
virtual ~FXShell ()
 
- 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)
 
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
 
virtual bool canFocus () const
 
bool hasFocus () const
 
bool inFocusChain () const
 
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 lower ()
 
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
 
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
virtual long onDefault (FXObject *, FXSelector, void *)
 
const FXchargetClassName () const
 
bool isMemberOf (const FXMetaClass *metaclass) const
 
virtual long tryHandle (FXObject *sender, FXSelector sel, void *ptr)
 
virtual ~FXObject ()
 

Additional Inherited Members

- 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

Abstract base class for all top-level windows.

TopWindows are usually managed by a Window Manager under X11 and therefore borders and window-menus and other decorations like resize- handles are subject to the Window Manager's interpretation of the decoration hints. When a TopWindow is closed, it sends a SEL_CLOSE message to its target. The target should return 0 in response to this message if there is no objection to proceed with the closing of the window, and return 1 otherwise. After the SEL_CLOSE message has been sent and no objection was raised, the window will delete itself. When the session is closed, the window will send a SEL_SESSION_NOTIFY message to its target, allowing the application to write any unsaved data to the disk. If the target returns 0, then the system will proceed to close the session. Subsequently a SEL_SESSION_CLOSED will be received which causes the window to be closed with prejudice by calling the function close(FALSE). When receiving a SEL_UPDATE, the target can update the title string of the window, so that the title of the window reflects the name of the document, for example. For convenience, TopWindow provides the same layout behavior as the Packer widget, as well as docking and undocking of toolbars. TopWindows can be owned by other windows, or be free-floating. Owned TopWindows will usually remain stacked on top of the owner windows. The lifetime of an owned window should not exceed that of the owner.

See also:

Member Enumeration Documentation

anonymous enum
Enumerator
ID_MAXIMIZE 

Maximize the window.

ID_MINIMIZE 

Minimize the window.

ID_RESTORE 

Restore the window.

ID_CLOSE 

Close the window.

ID_QUERY_DOCK 

Toolbar asks to dock.

ID_LAST 

Constructor & Destructor Documentation

virtual FX::FXTopWindow::~FXTopWindow ( )
virtual

Destructor.

Member Function Documentation

virtual void FX::FXTopWindow::create ( )
virtual

Create server-side resources.

Reimplemented from FX::FXShell.

Reimplemented in FX::FXPrintDialog, FX::FXSplashWindow, FX::FXMainWindow, and FX::FXToolBarShell.

virtual void FX::FXTopWindow::detach ( )
virtual

Detach the server-side resources for this window.

Reimplemented from FX::FXComposite.

Reimplemented in FX::FXSplashWindow.

virtual void FX::FXTopWindow::destroy ( )
virtual

Destroy the server-side resources for this window.

Reimplemented from FX::FXComposite.

virtual void FX::FXTopWindow::layout ( )
virtual

Perform layout.

Reimplemented from FX::FXComposite.

Reimplemented in FX::FXToolBarShell.

virtual void FX::FXTopWindow::setFocus ( )
virtual

Move the focus to this window.

Reimplemented from FX::FXShell.

virtual void FX::FXTopWindow::killFocus ( )
virtual

Remove the focus from this window.

Reimplemented from FX::FXShell.

virtual void FX::FXTopWindow::show ( )
virtual

Show this window.

Reimplemented from FX::FXWindow.

Reimplemented in FX::FXSplashWindow.

virtual void FX::FXTopWindow::hide ( )
virtual

Hide this window.

Reimplemented from FX::FXWindow.

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

virtual void FX::FXTopWindow::show ( FXuint  placement)
virtual

Show this window with given placement.

Reimplemented in FX::FXSplashWindow.

void FX::FXTopWindow::place ( FXuint  placement)

Position the window based on placement.

virtual FXint FX::FXTopWindow::getDefaultWidth ( )
virtual

Return the default width of this window.

Reimplemented from FX::FXComposite.

Reimplemented in FX::FXSplashWindow, and FX::FXToolBarShell.

virtual FXint FX::FXTopWindow::getDefaultHeight ( )
virtual

Return the default height of this window.

Reimplemented from FX::FXComposite.

Reimplemented in FX::FXSplashWindow, and FX::FXToolBarShell.

FXbool FX::FXTopWindow::getWMBorders ( FXint left,
FXint right,
FXint top,
FXint bottom 
)

Obtain border sizes added to our window by the window manager.

virtual void FX::FXTopWindow::raise ( )
virtual

Raise this window to the top of the stacking order.

Reimplemented from FX::FXWindow.

virtual void FX::FXTopWindow::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::FXTopWindow::resize ( FXint  w,
FXint  h 
)
virtual

Resize this window to the specified width and height.

Reimplemented from FX::FXWindow.

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

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

Reimplemented from FX::FXWindow.

virtual FXbool FX::FXTopWindow::maximize ( FXbool  notify = FALSE)
virtual

Maximize window, return TRUE if maximized.

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

Minimize or iconify window, return TRUE if minimized.

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

Restore window to normal, return TRUE if restored.

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

Close the window, return TRUE if actually closed.

If notify=TRUE, the target will receive a SEL_CLOSE message to determine if it is OK to close the window. If the target ignores the SEL_CLOSE message or returns 0, the window will be closed, and subsequently deleted. When the last main window has been closed, the application will receive an ID_QUIT message and will be closed.

FXbool FX::FXTopWindow::isMaximized ( ) const

Return TRUE if maximized.

FXbool FX::FXTopWindow::isMinimized ( ) const

Return TRUE if minimized.

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

Change window title.

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

Return window title.

void FX::FXTopWindow::setPadTop ( FXint  pt)

Change top padding.

FXint FX::FXTopWindow::getPadTop ( ) const
inline

Get top interior padding.

void FX::FXTopWindow::setPadBottom ( FXint  pb)

Change bottom padding.

FXint FX::FXTopWindow::getPadBottom ( ) const
inline

Get bottom interior padding.

void FX::FXTopWindow::setPadLeft ( FXint  pl)

Change left padding.

FXint FX::FXTopWindow::getPadLeft ( ) const
inline

Get left interior padding.

void FX::FXTopWindow::setPadRight ( FXint  pr)

Change right padding.

FXint FX::FXTopWindow::getPadRight ( ) const
inline

Get right interior padding.

FXint FX::FXTopWindow::getHSpacing ( ) const
inline

Return horizontal spacing between children.

FXint FX::FXTopWindow::getVSpacing ( ) const
inline

Return vertical spacing between children.

void FX::FXTopWindow::setHSpacing ( FXint  hs)

Change horizontal spacing between children.

void FX::FXTopWindow::setVSpacing ( FXint  vs)

Change vertical spacing between children.

void FX::FXTopWindow::setPackingHints ( FXuint  ph)

Change packing hints for children.

FXuint FX::FXTopWindow::getPackingHints ( ) const

Return packing hints for children.

void FX::FXTopWindow::setDecorations ( FXuint  decorations)

Change title and border decorations.

FXuint FX::FXTopWindow::getDecorations ( ) const

Return current title and border decorations.

FXIcon* FX::FXTopWindow::getIcon ( ) const
inline

Return window icon.

void FX::FXTopWindow::setIcon ( FXIcon ic)

Change window icon.

FXIcon* FX::FXTopWindow::getMiniIcon ( ) const
inline

Return window mini (title) icon.

void FX::FXTopWindow::setMiniIcon ( FXIcon ic)

Change window mini (title) icon.

virtual void FX::FXTopWindow::save ( FXStream store) const
virtual
virtual void FX::FXTopWindow::load ( FXStream store)
virtual

Copyright © 1997-2005 Jeroen van der Zijp