FXWindow

Base class for all windows

FXWindow(p, opts=0, x=0, y=0, w=0, h=0)

Constructor.

Argument	Type	Default	Description
p	FXComposite
opts	Int	0
x	Int	0
y	Int	0
w	Int	0
h	Int	0

canFocus()

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

Reimplemented in AFXBaseTable, AFXFloatSpinner, AFXFlyoutButton, AFXFlyoutItem, AFXSlider, FXArrowButton, FXButton, FXCanvas, FXCheckButton, FXColorWell, FXDockHandler, FXIconList, FXImageView, FXList, FXMDIChild, FXMenuButton, FXMenuCascade, FXMenuCommand, FXMenuTitle, FXOption, FXOptionMenu, FXRadioButton, FXSlider, FXTabItem, FXTable, FXText, FXTextField, FXToggleButton, FXToolbarTab, and FXTreeList.

childAtIndex(index)

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

Reimplemented in AFXOptionTreeItem.

Argument	Type	Default	Description
index	Int

containsChild(child)

Return True if specified window is a child of this window.

Argument	Type	Default	Description
child	FXWindow

create()

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

Reimplemented from FXId.

Reimplemented in AFXMainWindow, AFXManagerMenuPane, AFXPromptArea, AFXBaseTable, AFXColorButton, AFXColorFlyout, AFXComboBox, AFXDialog, AFXFloatSpinner, AFXFlyoutButton, AFXListBox, AFXNote, AFXOptionTreeItem, AFXPrimFloatSpinner, AFXProgressBar, AFXSpinner, AFXTable, AFXTextField, AFXVerticalAligner, FXColorBar, FXColorSelector, FXColorWell, FXColorWheel, FXComboBox, FXComposite, FXDirBox, FXDirList, FXDockTitle, FXDriveBox, FXFileList, FXFontSelector, FXGroupBox, FXHeader, FXIconList, FXImageView, FXLabel, FXList, FXListBox, FXMDIChild, FXMenuButton, FXMenuCaption, FXMenuCascade, FXMenuTitle, FXOptionMenu, FXPrintDialog, FXProgressBar, FXRootWindow, FXScrollWindow, FXShell, FXSpinner, FXStatusline, FXTabBar, FXTable, FXText, FXTextField, FXToggleButton, FXToolbarShell, FXTooltip, FXTopWindow, FXTreeList, and FXTreeListBox.

destroy()

Destroy the server-side resources for this window.

Reimplemented from FXId.

Reimplemented in AFXManagerMenuCascade, AFXColorFlyout, AFXTable, FXComboBox, FXComposite, FXDirBox, FXDirList, FXDriveBox, FXFileList, FXListBox, FXMenuCascade, FXOptionMenu, FXRootWindow, FXTreeList, and FXTreeListBox.

detach()

Detach the server-side resources for this window.

Reimplemented from FXId.

Reimplemented in AFXBaseTable, AFXColorFlyout, AFXFlyoutButton, AFXNote, AFXTable, FXColorBar, FXColorWell, FXColorWheel, FXComboBox, FXComposite, FXDirBox, FXDirList, FXDockTitle, FXDriveBox, FXFileList, FXGroupBox, FXHeader, FXIconList, FXImageView, FXLabel, FXList, FXListBox, FXMDIChild, FXMenuButton, FXMenuCaption, FXMenuCascade, FXMenuTitle, FXOptionMenu, FXProgressBar, FXRootWindow, FXStatusline, FXTable, FXText, FXToggleButton, FXTooltip, FXTopWindow, FXTreeList, and FXTreeListBox.

disable()

Disable the window from receiving mouse and keyboard events.

Reimplemented in AFXAutoComputeGroup, AFXManagerMenuDB, AFXColorButton, AFXColorFlyout, AFXComboBox, AFXFloatSpinner, AFXFlyoutButton, AFXList, AFXListBox, AFXNote, AFXOptionTreeItem, AFXPrimFloatSpinner, AFXSlider, AFXSpinner, AFXTable, AFXTextField, FXArrowButton, FXComboBox, FXGroupBox, FXLabel, FXListBox, FXMenuCaption, FXScrollCorner, FXSlider, FXSpinner, FXText, FXTextField, FXToolbarTab, and FXTreeListBox.

enable()

Enable the window to receive mouse and keyboard events.

forceRefresh()

Force a GUI update of this window and its children.

getBackColor()

Get background color.

Reimplemented in FXComboBox, and FXListBox.

getCursorPosition()

Returns a sequence of (status, x, y, mouseButtonState) representing the relative location of the cursor in the widget.

getDefaultHeight()

Return the default height of this window.

Reimplemented in AFXMainWindow, AFXToolbarGroup, AFXBaseTable, AFXList, AFXOptionTreeList, AFXPrimFloatSpinner, AFXProgressBar, AFXSlider, AFXTable, AFXTreeTable, AFXVerticalAligner, FX4Splitter, FXArrowButton, FXCheckButton, FXColorBar, FXColorWell, FXColorWheel, FXComboBox, FXComposite, FXDial, FXDockSite, FXDockTitle, FXDragCorner, FXFrame, FXGroupBox, FXHeader, FXHorizontalFrame, FXLabel, FXList, FXListBox, FXMatrix, FXMDIDeleteButton, FXMDIRestoreButton, FXMDIMaximizeButton, FXMDIMinimizeButton, FXMDIWindowButton, FXMDIChild, FXMenuButton, FXMenuCaption, FXMenuCommand, FXMenuSeparator, FXMenuTitle, FXOption, FXOptionMenu, FXPacker, FXPopup, FXProgressBar, FXRadioButton, FXRootWindow, FXScrollArea, FXScrollbar, FXHorizontalSeparator, FXVerticalSeparator, FXSlider, FXSpinner, FXSplitter, FXStatusbar, FXStatusline, FXSwitcher, FXTabBar, FXTabBook, FXTable, FXText, FXTextField, FXToggleButton, FXToolbar, FXToolbarGrip, FXToolbarShell, FXToolbarTab, FXTooltip, FXTopWindow, FXTreeList, FXTreeListBox, and FXVerticalFrame.

getDefaultWidth()

Return the default width of this window.

Reimplemented in AFXMainWindow, AFXToolbarGroup, AFXBaseTable, AFXOptionTreeItem, AFXOptionTreeList, AFXPrimFloatSpinner, AFXProgressBar, AFXSlider, AFXTable, AFXTextField, AFXTreeTable, AFXVerticalAligner, FX4Splitter, FXArrowButton, FXCheckButton, FXColorBar, FXColorWell, FXColorWheel, FXComboBox, FXComposite, FXDial, FXDockSite, FXDockTitle, FXDragCorner, FXFrame, FXGroupBox, FXHeader, FXHorizontalFrame, FXLabel, FXList, FXListBox, FXMatrix, FXMDIDeleteButton, FXMDIRestoreButton, FXMDIMaximizeButton, FXMDIMinimizeButton, FXMDIWindowButton, FXMDIChild, FXMenuButton, FXMenuCaption, FXMenuCommand, FXMenuSeparator, FXMenuTitle, FXOption, FXOptionMenu, FXPacker, FXPopup, FXProgressBar, FXRadioButton, FXRootWindow, FXScrollArea, FXScrollbar, FXHorizontalSeparator, FXVerticalSeparator, FXSlider, FXSpinner, FXSplitter, FXStatusbar, FXStatusline, FXSwitcher, FXTabBar, FXTabBook, FXTable, FXText, FXTextField, FXToggleButton, FXToolbar, FXToolbarGrip, FXToolbarShell, FXToolbarTab, FXTooltip, FXTopWindow, FXTreeList, FXTreeListBox, and FXVerticalFrame.

getFirst()

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

Reimplemented in AFXOptionTreeItem.

getHeightForWidth(givenwidth)

Return height for given width.

Reimplemented in FXDockSite.

Argument	Type	Default	Description
givenwidth	Int

getKey()

Return window key.

getLast()

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

Reimplemented in AFXOptionTreeItem.

getLayoutHints()

Get layout hints for this window.

getNext()

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

Reimplemented in AFXOptionTreeItem.

getOwner()

Return a pointer to the owner window.

Reimplemented in AFXToolbarGroup.

getParent()

Return a pointer to the parent window.

Reimplemented in AFXOptionTreeItem.

getPrev()

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

Reimplemented in AFXOptionTreeItem.

getRoot()

Return a pointer to the root window.

getSelector()

Get the message identifier for this window.

getShell()

Return a pointer to the shell window.

getTarget()

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

getWidthForHeight(givenheight)

Return width for given height.

Reimplemented in FXDockSite.

Argument	Type	Default	Description
givenheight	Int

getX()

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

getY()

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

grab(confineTo=None)

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

Argument	Type	Default	Description
confineTo	FXWindow	None

grabbed()

Return True if the window has been grabbed.

hasFocus()

Return True if this window has the focus.

hide()

Hide this window.

Reimplemented in AFXManagerMenuDB, AFXMenuTitle, AFXToolbarGroup, AFXToolbarGroupRender, AFXDialog, AFXFlyoutItem, AFXMessageDialog, AFXOptionTreeItem, AFXProgressBar, and FXTopWindow.

indexOfChild(window)

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

Argument	Type	Default	Description
window	FXWindow

isActive()

Return True if the window is active.

Reimplemented in AFXToolbarGroup.

isChildOf(window)

Return True if specified window is this window's parent.

Argument	Type	Default	Description
window	FXWindow

isDefault()

Return True if this is the default window.

isEnabled()

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

isInitial()

Return True if this is the initial default window.

linkAfter(sibling)

Relink this window after sibling in the window list.

Argument	Type	Default	Description
sibling	FXWindow

linkBefore(sibling)

Relink this window before sibling in the window list.

Argument	Type	Default	Description
sibling	FXWindow

move(x, y)

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

Reimplemented in FXMDIChild, FXRootWindow, and FXTopWindow.

Argument	Type	Default	Description
x	Int
y	Int

numChildren()

Return the number of child windows for this window.

Reimplemented in AFXOptionTreeItem.

position(x, y, w, h)

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

Reimplemented in FXIconList, FXMDIChild, FXRootWindow, FXText, and FXTopWindow.

Argument	Type	Default	Description
x	Int
y	Int
w	Int
h	Int

recalc()

Mark this window's layout as dirty.

Reimplemented in AFXBaseTable, AFXSlider, AFXTable, FXIconList, FXList, FXMDIClient, FXRootWindow, FXShell, FXTable, FXText, and FXTreeList.

repaint()

If marked but not yet painted, paint the entire window.

repaint(x, y, w, h)

If marked but not yet painted, paint the given area.

Argument	Type	Default	Description
x	Int
y	Int
w	Int
h	Int

resize(w, h)

Resize this window to the specified width and height.

Reimplemented from FXDrawable.

Reimplemented in FXIconList, FXMDIChild, FXRootWindow, FXText, and FXTopWindow.

Argument	Type	Default	Description
w	Int
h	Int

setBackColor(clr)

Set window background color.

Reimplemented in FXComboBox, and FXListBox.

Argument	Type	Default	Description
clr	FXColor

setCursorPosition(x, y)

Warp the cursor to the new position.

Argument	Type	Default	Description
x	Int
y	Int

setFocus()

Move the focus to this window.

Reimplemented in AFXBaseTable, AFXFlyoutItem, AFXTextField, FXButton, FXColorWell, FXIconList, FXList, FXMenuCascade, FXMenuCommand, FXMenuTitle, FXOption, FXPopup, FXRootWindow, FXShell, FXTable, FXText, FXTextField, FXTopWindow, and FXTreeList.

setHeight(h)

Set the window height.

Argument	Type	Default	Description
h	Int

setInitial(enable=True)

Make this window the initial default window.

Argument	Type	Default	Description
enable	Bool	True

setKey(k)

Change window key.

Argument	Type	Default	Description
k	Int

setLayoutHints(lout)

Set layout hints for this window.

Argument	Type	Default	Description
lout	Int

setSelector(sel)

Set the message identifier for this window.

Argument	Type	Default	Description
sel	Int

setTarget(t)

Set the message target object for this window.

Argument	Type	Default	Description
t	FXObject

setWidth(w)

Set the window width.

Argument	Type	Default	Description
w	Int

setX(x)

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

Argument	Type	Default	Description
x	Int

setY(y)

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

Argument	Type	Default	Description
y	Int

show()

Show this window.

Reimplemented in AFXMenuTitle, AFXToolbarGroup, AFXToolbarGroupRender, AFXDialog, AFXFileDialog, AFXMessageDialog, AFXOptionTreeItem, AFXProgressBar, AFXSlider, FXTooltip, and FXTopWindow.

shown()

Return True if the window is shown.

translateCoordinatesTo(tox, toy, towindow, fromx, fromy)

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

Argument	Type	Default	Description
tox	Int
toy	Int
towindow	FXWindow
fromx	Int
fromy	Int

ungrab()

Release the mouse grab.

update()

Mark the entire window client area dirty.

update(x, y, w, h)

Mark the specified rectangle dirty, i.e. to be repainted.

Argument	Type	Default	Description
x	Int
y	Int
w	Int
h	Int

Class flags

FLAG_SHOWN	Is shown.
FLAG_ENABLED	Able to receive input.
FLAG_UPDATE	Is subject to GUI update.
FLAG_DROPTARGET	Drop target.
FLAG_FOCUSED	Has focus.
FLAG_DIRTY	Needs layout.
FLAG_RECALC	Needs recalculation.
FLAG_TIP	Show tip.
FLAG_HELP	Show help.
FLAG_DEFAULT	Default widget.
FLAG_INITIAL	Initial widget.
FLAG_SHELL	Shell window.
FLAG_ACTIVE	Window is active.
FLAG_PRESSED	Button has been pressed.
FLAG_KEY	Keyboard key pressed.
FLAG_CARET	Caret is on.
FLAG_CHANGED	Window data changed.
FLAG_LASSO	Lasso mode.
FLAG_TRYDRAG	Tentative drag mode.
FLAG_DODRAG	Doing drag mode.
FLAG_SCROLLINSIDE	Scroll only when inside.
FLAG_SCROLLING	Right mouse scrolling.

ID_TOGGLEENABLED	CAE: Copied from FOX 1.4.34.
ID_TIPTIMER	CAE: Copied from FOX 1.4.34.
ID_SETICONVALUE	CAE: Copied from FOX 1.4.34.
ID_GETICONVALUE	CAE: Copied from FOX 1.4.34.
ID_SETHELPSTRING	CAE: Copied from FOX 1.4.34.
ID_GETHELPSTRING	CAE: Copied from FOX 1.4.34.
ID_SETTIPSTRING	CAE: Copied from FOX 1.4.34.
ID_GETTIPSTRING	CAE: Copied from FOX 1.4.34.
ID_QUERY_TIP	CAE: Removed from later FOX version.
ID_QUERY_HELP	CAE: Removed from later FOX version.
ID_CLOSE_DOCUMENT	CAE: Removed from later FOX version.
ID_CLOSE_ALL_DOCUMENTS	CAE: Removed from later FOX version.
CAE_GET_VERSION	CAE, used to get an object's version number.
CAE_SET_VERSION	CAE, used to set an object's version number.

Global flags

Layout hints for child widgets

LAYOUT_NORMAL	Default layout mode.
LAYOUT_SIDE_TOP	Pack on top side (default).
LAYOUT_SIDE_BOTTOM	Pack on bottom side.
LAYOUT_SIDE_LEFT	Pack on left side.
LAYOUT_SIDE_RIGHT	Pack on right side.
LAYOUT_FILL_COLUMN	Matrix column is stretchable.
LAYOUT_FILL_ROW	Matrix row is stretchable.
LAYOUT_LEFT	Stick on left (default).
LAYOUT_RIGHT	Stick on right.
LAYOUT_CENTER_X	Center horizontally.
LAYOUT_FIX_X	X fixed.
LAYOUT_TOP	Stick on top (default).
LAYOUT_BOTTOM	Stick on bottom.
LAYOUT_CENTER_Y	Center vertically.
LAYOUT_FIX_Y	Y fixed CAE: Copied from FOX 1.4.34 to support dockable tool bars.
LAYOUT_DOCK_SAME	Dock on same galley if it fits.
LAYOUT_DOCK_NEXT	Dock on next galley LAYOUT_RESERVED_1 = 0x00000040, LAYOUT_RESERVED_2 = 0x00000080,
LAYOUT_RESERVED_1	CAE End.
LAYOUT_FIX_WIDTH	Width fixed.
LAYOUT_FIX_HEIGHT	height fixed
LAYOUT_MIN_WIDTH	Minimum width is the default.
LAYOUT_MIN_HEIGHT	Minimum height is the default.
LAYOUT_FILL_X	Stretch or shrink horizontally.
LAYOUT_FILL_Y	Stretch or shrink vertically.
LAYOUT_EXPLICIT	Explicit placement.

Frame border appearance styles (for subclasses)

FRAME_NONE	Default is no frame.
FRAME_SUNKEN	Sunken border.
FRAME_RAISED	Raised border.
FRAME_THICK	Thick border.
FRAME_GROOVE	A groove or etched-in border.
FRAME_RIDGE	A ridge or embossed border.
FRAME_LINE	Simple line border.
FRAME_NORMAL	Regular raised/thick border.

Packing style (for packers)

PACK_NORMAL	Default is each its own size.
PACK_UNIFORM_HEIGHT	Uniform height.
PACK_UNIFORM_WIDTH	Uniform width.