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

FX::FXWindow

FX::FXWindow Class Reference

Base class for all windows. More...

#include <FXWindow.h>

Inheritance diagram for FX::FXWindow:


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.

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 <

FX::FXWindow Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Friends

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation