ui
tkui
MLayer
MLayer.ui::Layer
MColorBox.ColorBox
MComposite.ui::Composite
MLabel.ui::Label
MPopupMenuSeparator.ui::PopupMenuSeparator
MSpacer.ui::Spacer
MSplitPane.ui::SplitPane
MTableViewData.ui::TableViewData
MTableViewHeader.ui::TableViewHeader
FindFirstNonRootTabCycleMember(Object n, int dir) : ui::Layer
-
IsTabCycleKey(Key k) : int
- addActionConsumer(ui::ActionConsumer consumer)
-
addChildLayer(Object l)
-
addLayer(Object l, int layoutHints)
-
addOverlay(Object l)
-
addTabCycleMembersToList(PointerArray list)
-
addXFMChild(Object c)
-
addXFMObject(ui::XFMObject o)
-
allowCursorKeysForTabCycling() : int
- Query whether the layer wants to use the cursor keys to cycle between widgets. Please overwrite this method and return false in order to let the keyboard event propagate to the parent layer.
allowSubPixelPosition() : int
- Query whether layer allows sub-pixel placement. Allowing this can cause text rendering artefacts for example so the default is not to allow it.
allowSubPixelSize() : int
- Query whether layer allows sub-pixel size.
appendHierarchyString(String r, int cx)
-
beginXFMTag(ui::AbstractXMLForm form, HashTable attributes) : int
-
blockMouseDrag() : int
-
buildTabCycleList()
- Scan child layers and build tab cycle list. Usually implemented by container-like layers (e.g. Panels).
calcAbsolutePosition(ui::Point2f v)
-
calcAbsolutePositionFBO(ui::Point2f v)
-
calcMinimumSizeX()
-
calcMinimumSizeY()
-
calcParentPosition(ui::Point2f v)
- Calc position relative to logical parent (root or ViewPane)
calcPreferredSize()
-
calcPreferredSizeX()
-
calcPreferredSizeY()
-
calcSizeX() : float
-
calcSizeY() : float
-
cancelToolTipTimer()
-
compositeAll()
- Composite all layers. Also see UI.CompositeAll()
consumeAction(ui::Action ac) : int
-
containsAbsoluteXY(float x, y) : int
- Check whether this layer contains the given absolute coordinate.
debugPrintTabCycleList()
-
drawChildHierarchy(int bForceRedraw, bCheckIntersect)
-
drawHierarchy(int bForceRedraw, bCheckIntersect)
-
endXFMTag(ui::AbstractXMLForm form, HashTable attributes)
-
findSizeGroupMembers(ui::SizeGroup sg, PointerArray ret)
-
findTabCycleRoot() : ui::Layer
- Find parent layer that is a a tab cycle root.
focusFirstTabCycleMember()
- Set keyboard focus to first non-root tab cycle member.
focusNextTabCycleMember(int local)
- Determine next tab cycle member and set the keyboard focus. This method does not generate a onKeyboardFocusLost() event for the current tab focus layer; yet it will generate an onTabFocusLost() event for the current layer and an onTabFocus() event for the new tab focus layer. If the local argument is true, this will only cycle within the list of the tab cycle root that references this layer in its cycle list.
focusPreviousTabCycleMember(int local)
- Determine previous tab cycle member and set the keyboard focus. This method does not generate a onKeyboardFocusLost() event for the current tab focus layer; yet it will generate an onTabFocusLost() event for the current layer and an onTabFocus() event for the new tab focus layer. If the local argument is true, this will only cycle within the list of the tab cycle root that references this layer in its cycle list.
getAbsolutePositionString() : String
-
getAbsolutePositionX() : float
-
getAbsolutePositionY() : float
-
getAlignment() : int
-
getAlpha() : int
-
getDefaultPreferredSizeX() : float
-
getDefaultPreferredSizeY() : float
-
getGeometry4f() : ui::Geometry4f
-
getGeometryString() : String
-
getLayerId() : String
-
getLayout()
- Return the layout of this layer.
getLayoutFirstChild() : ui::Layer
-
getLayoutHints() : int
-
getLayoutSizeX() : float
-
getLayoutSizeY() : float
-
getLayoutWeightX() : float
-
getLayoutWeightY() : float
-
getMinimumSizePadX() : float
-
getMinimumSizePadY() : float
-
getMinimumSizeString() : String
-
getMinimumSizeX() : float
-
getMinimumSizeY() : float
-
getNumChildLayers() : int
-
getPadBottom() : float
-
getPadLeft() : float
-
getPadRight() : float
-
getPadTop() : float
-
getParent() : ui::Layer
-
getParentLayerType(Object type) : ui::Layer
-
getPositionString() : String
-
getPositionX() : float
-
getPositionY() : float
-
getPreferredSizePadX() : float
-
getPreferredSizePadY() : float
-
getPreferredSizeString() : String
-
getPreferredSizeX() : float
-
getPreferredSizeY() : float
-
getRoot() : ui::Layer
-
getScreenRegion() : ui::Rectangle2f
- Return the rectangular screen region occupied by this layer
getSize(ui::Size2f retSz)
-
getSizeGroup() : ui::SizeGroup
-
getSizePadX() : float
-
getSizePadY() : float
-
getSizeString() : String
-
getSizeX() : float
-
getSizeY() : float
-
getTabCycleOrder() : int
- Returns sorting order in tabcycleroot list. Should return -1 if this layer is not focusable.
getToolTipCaption() : String
-
getToolTipOffsetX() : float
-
getTotalNumChildLayers() : int
-
getUserData() : Object
-
grabKeyboardFocus()
- Helper method to delegate key input to this layer.
handleDrawOverlays()
-
handleNewTabCycleFocus(Object n)
-
hasChildLayer(ui::Layer l) : int
- Query whether this layer has the given child layer.
hasDirectChildLayer(Object l) : int
- Query whether this layer has the given child layer. Do not search recursively.
hasKeyboardFocus() : int
- Query whether this layer currently has the keyboard focus
hasMouseFocus() : int
- Query whether this layer currently has the mouse focus
hasParent(Object l) : int
- Query whether l is a parent of this layer.
hasParentOrIs(Object l) : int
-
hide()
- Hide layer. Only used for dialogs/windows/popups.
hideToolTip()
-
hierarchyHasKeyboardFocus() : int
-
invalidateAbsolutePositions()
-
invalidateChildContainerMinSizeCaches()
- Recursively invalidate minimum size caches of all container-like child layers.
invalidateMinimumSizes()
- Recursively invalidate minimum_size_x and minimum_size_y so that they are recalculated the next time they are accessed. This method should be used with care since it overrides the preferences set in e.g. an .xfm document.
invalidateMinSizeCache()
- Helper method to invalidate the current minimum size
invalidatePreferredSizes()
- Recursively invalidate preferred_size_x and preferred_size_y so that they are recalculated the next time they are accessed. This method should be used with care since it overrides the preferences set in e.g. an .xfm document.
invalidateSizeCache()
- Helper method to invalidate the current preferred/minimum size
invalidateSizeCaches()
- Recursively invalidate preferred and minimum size fields so that they are recalculated the next time they are accessed.
invalidateSizeGroupMemberSizes()
-
is3d() : int
-
isEditable() : int
-
isLayoutMinSweepPass() : int
- Can be used by widgets implemented outside the ui namespace to test whether the current layout pass tries to determine the minimum size (of a Window
). If this returns true, certain widgets (like SplitPane
) do not clip certain states (like the split position in case of the SplitPane)
isModal() : int
- This is used to implement dialog windows that make all other floating layers
isMouseFocusLocked() : int
-
isMouseOver() : int
-
isPopup() : int
- Return true if the floating layer should be closed when the user clicks outside the layer area (handleNonChildMouseOver)
isTabCycleMember() : int
- Query whether this layer supports tab-cycling. A special case are tabcycleroots which cannot be focused themselves but still are cycle memberes and thus should have a tab cycle order assigned.
isTabCycleProxy() : int
- Query whether the layer is cycleroot and active cyclemember at the same time, e.g. a TabbedView.
isTabCycleRoot() : int
- Query whether this layer manages a focus cycle list for its child layers.
isTranslucent() : int
-
layerAt2f(float x, y) : ui::Layer
-
layoutHierarchy(int bInvalidateSizeCaches, bLayoutFinal)
- Layout child layers. Assumes that this layer is already layouted.
loseKeyboardFocus()
- Lose keyboard focus (if this layer has it), do not generate onKeyboardFocusLost() event!
loseMouseFocus()
- Lose mouse focus (if this layer has it), do not generate onMouseLeave() event!
moveChildLayerToTop(Object l)
-
moveToPosition2f(float x, y)
-
newToolTip() : ui::ToolTip
- Instantiate and return new ToolTip object. The ToolTip instance is deleted when the tooltip is hidden.
onAcceleratorKey(ui::AcceleratorKey k)
- Called if the given accelerator key has been pressed.
onBeginTriadKeyMode() : int
- Called to inform the keyboard focus layer that the user has entered the 'magic' escape sequence (lctrl-x).
onChildMouseEnter(ui::MouseEvent ev)
- Called if a child gains the mouse focus. Used for submenus to disable the auto-hide timeout if a submenu child is re-focused.
onDraw()
- The onDraw() method is called when the layer region needs to be repainted.
onDrawOverlays()
- Called when FBO compositing is enabled.
onDropFiles(StringArray fileNames) : int
- Called when one or many files have been dropped on this layer
onEndTriadKeyMode(Key k) : int
- Called to inform the keyboard focus layer that the 'magic' escape sequence (lctrl-x) - ? has finished.
onKey(Key key) : int
- The onKey() method is called when a keyboard input event has been received from the HAL(SDL) subsystem. Returns true/false depending on whether the event was handled or not.
onKeyboardFocus()
- The onKeyboardFocus() method is called when this layer has gained the keyboard focus. This method is usually called if a new keyboard focus has been set by @UI.SetKeyboardFocus.
onKeyboardFocusLost(int bQuiet)
- The onKeyboardFocusLost() method is called when this layer has lost the keyboard focus; probably because another layer grabbed it.If bQuiet is true, simply stop editing and do NOT provide actions or refocus
onLookAndFeelChanged()
- Called by @UI.SetLookAndFeel() if the look and feel class has changed. Layers that store color information in member variables have to re-read these fields for example (e.g. @Label or @TransparentPanel).
onMouse(ui::MouseEvent ev) : int
-
onMouseBeginDrag(ui::MouseEvent dragStart, ev) : int
-
onMouseCancelDrag(ui::MouseEvent ev)
-
onMouseClick(ui::MouseEvent ev) : int
-
onMouseDoubleClick(ui::MouseEvent ev) : int
-
onMouseDrag(ui::MouseEvent lastEv, currentEv) : int
- Called when onMouseBeginDrag() returned true, the left mouse button is held down and the mouse has moved at least MOUSE_DRAG_THRESHOLD
pixels.
onMouseEndDrag(ui::MouseEvent ev)
-
onMouseEnter(ui::MouseEvent ev) : int
-
onMouseFocus()
-
onMouseHold(ui::MouseEvent startEv) : int
- Called when a mouse button is pressed and held down for MOUSE_HOLD_DELAY
milliseconds without moving the mouse pointer.
onMouseLeave(ui::MouseEvent ev) : int
-
onMouseUnfocus()
-
onOpen()
- The onOpen() method is called when the layer needs to update
onResize()
- Called when the layer has been resized to its final size.
onTabFocus()
- Called if the keyboard focus was gained by cycling through the layers using tab/cursor keys. Also used by some dialog classes to set the default button. This event is very similar to onKeyboardFocus() although the layer can implement a slightly different behaviour (e.g. a textfield might want to select all text)
onTriadKey(Key k) : int
- Called after key has been entered after lctrl-x escape sequence.
onTriadKeyTimeout() : int
- Called when third key in lctrl-x ? sequence has not been pressed in time (e.g. show help dialog in that case)
onUIActivate()
- Called when this layer has the keyboard focus and the application window re-gains the focus. This is mainly used to close the popupmenu when alt-tabbing through windows (alt opens the popupmenu and this is probably not the desired behaviour when alt-tab is used!). See PopupMenuBarButton.
onUIDeactivate()
- Called when this layer has the keyboard focus and the application window looses the focus. This is mainly used to close the popupmenu when alt-tabbing through windows (alt opens the popupmenu and this is probably not the desired behaviour when alt-tab is used!). See PopupMenuBarButton.
popParentViewPaneScissors()
-
printHierarchy()
-
provideAction(ui::Action providedAction)
-
pushParentViewPaneScissors()
-
recursiveBuildTabCycleLists()
- Utility method that is used to recursively build tabcycle lists for all children. Usually this is automatically done when using XMLForms but if the layer hierarchy is built programmatically this method might be handy.
recursiveFocusTabCycleMember(Object active, int dir, local) : int
-
recursiveHideToolTips()
-
recursiveInvalidateSizeGroupMemberSizes()
-
recursiveOnLookAndFeelChanged()
- Do not call directly. This is called by @UI.SetLookAndFeel().
recursiveOnOpen()
-
recursiveOnResize()
- Recursively inform all child layers that their final sizes have been set. Do not call directly! Called by UI.RootLayerResize() and Window.onMouse().
recursiveSetEditable(int bEditable)
- Recursively invalidate preferred and minimum size fields so that they are recalculated the next time they are accessed.
recursiveSetEnableCursorKeyTabCycling(int bEnabled)
-
redraw()
- Redraw this layer
redrawAll()
- Redraw all layers. Also see UI.RedrawAll()
relayout()
-
removeActionConsumer(ui::ActionConsumer consumer)
-
removeAllOverlays()
-
removeChildHierarchy()
- Recursively remove all children
removeChildLayer(Object l)
-
removeChildren()
- Remove children of this layer (no recursion)
removeOverlay(Object l)
-
resizeToMinimum()
-
restartToolTipTimer()
-
restoreGeometryIfValid(ui::Geometry4f geo) : int
-
revertCursor(String name)
-
scheduleToolTipTimer()
-
setAlignment(int alignment)
-
setAlpha(int a)
-
setDefaultInnerPadding()
-
setEditable(int bEditable)
-
setEnableForceMinimumSize(int bX, bY)
-
setEnableForceMinimumSizeX(int bX)
-
setEnableForceMinimumSizeY(int bY)
-
setGeometry(float px, py, sx, sy)
-
setGeometry4f(ui::Geometry4f geo)
-
setLayerId(String id)
-
setLayout(ui::Layout l)
- Set a Layout for this Layer.
setLayoutHints(int hints)
-
setLayoutWeight2f(float x, y)
-
setLayoutWeightX(float wx)
-
setLayoutWeightY(float wy)
-
setManualPreferredSize2f(float w, h)
-
setManualPreferredSizeX(float w)
-
setManualPreferredSizeY(float h)
-
setMinimumSize2f(float w, h)
-
setMinimumSizeX(float x)
-
setMinimumSizeY(float y)
-
setPadBottom(float bottom)
-
setPadding4f(float top, left, bottom, right)
-
setPadLeft(float left)
-
setPadRight(float right)
-
setPadTop(float top)
-
setPosition2f(float x, y)
-
setPositionX(float x)
-
setPositionY(float y)
-
setPreferredSize2f(float w, h)
-
setPreferredSizeX(float w)
-
setPreferredSizeY(float h)
-
setRequiredSize2f(float w, h)
- Force layer size to (_w; _h)
setRequiredSizeX(float w)
-
setRequiredSizeY(float h)
-
setSize2f(float x, y)
-
setSizeGroup(ui::SizeGroup sg)
-
setSizeX(float x)
-
setSizeY(float y)
-
setTabCycleOrder(int order)
-
setToolTipCaption(String tooltipCaption)
-
setUserData(Object data)
-
showCursor(String name)
-
showToolTip()
-
unlinkChildLayer(Object l) : ui::Layer
-
unlinkFirstChild() : ui::Layer
-
unlinkNext() : ui::Layer
-
unlinkUserData() : Object
-
wantKeyboardFocus() : int
-
wantKeyRepeat(Key k) : int
-
wantShadeModal() : int
-
wantToolTipNearMouse() : int
-
wantTriadKeyMode() : int
- Return true if layer supports lctrl-x escape sequence.
wantTriadKeyRepeat(Key k) : int
- Check whether the given key shall be repeat (first non-repeat key exits mode)
~Layer()
- float
ABS_INVALID
-
int
DEFAULT_MINIMUM_SIZE_X
-
int
DEFAULT_MINIMUM_SIZE_Y
-
int
DEFAULT_PREFERRED_SIZE_X
-
int
DEFAULT_PREFERRED_SIZE_Y
-
Function FindFirstNonRootTabCycleMember | ||||||||
Signature | ||||||||
Arguments | ||||||||
| ||||||||
Returns | ||||||||
Method addActionConsumer | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method addTabCycleMembersToList | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method addXFMObject | |||||
Signature | |||||
| |||||
Arguments | |||||
Method allowCursorKeysForTabCycling | |||||
Query whether the layer wants to use the cursor keys to cycle between widgets. Please overwrite this method and return false in order to let the keyboard event propagate to the parent layer. | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method allowSubPixelPosition | |||||
Query whether layer allows sub-pixel placement. Allowing this can cause text rendering artefacts for example so the default is not to allow it. | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method allowSubPixelSize | |||||
Query whether layer allows sub-pixel size. | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method appendHierarchyString | |||||||||||||||
Signature | |||||||||||||||
| |||||||||||||||
Arguments | |||||||||||||||
|
Method beginXFMTag | ||||||||||||||||||||
Signature | ||||||||||||||||||||
| ||||||||||||||||||||
Arguments | ||||||||||||||||||||
| ||||||||||||||||||||
Returns | ||||||||||||||||||||
|
Method blockMouseDrag | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method buildTabCycleList | |||
Scan child layers and build tab cycle list. Usually implemented by container-like layers (e.g. Panels). | |||
Signature | |||
|
Method calcAbsolutePosition | |||||
Signature | |||||
| |||||
Arguments | |||||
Method calcAbsolutePositionFBO | |||||
Signature | |||||
| |||||
Arguments | |||||
Method calcMinimumSizeX | |||
Signature | |||
|
Method calcMinimumSizeY | |||
Signature | |||
|
Method calcParentPosition | |||||
Calc position relative to logical parent (root or ViewPane) | |||||
Signature | |||||
| |||||
Arguments | |||||
Method calcPreferredSize | |||
Signature | |||
|
Method calcPreferredSizeX | |||
Signature | |||
|
Method calcPreferredSizeY | |||
Signature | |||
|
Method calcSizeX | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method calcSizeY | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method cancelToolTipTimer | |||
Signature | |||
|
Method compositeAll | |||
Composite all layers. Also see UI.CompositeAll() | |||
Signature | |||
|
Method consumeAction | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
|
Method containsAbsoluteXY | ||||||||||||||||||||
Check whether this layer contains the given absolute coordinate. | ||||||||||||||||||||
Signature | ||||||||||||||||||||
| ||||||||||||||||||||
Arguments | ||||||||||||||||||||
| ||||||||||||||||||||
Returns | ||||||||||||||||||||
|
Method debugPrintTabCycleList | |||
Signature | |||
|
Method drawChildHierarchy | |||||||||||||||
Signature | |||||||||||||||
| |||||||||||||||
Arguments | |||||||||||||||
|
Method drawHierarchy | |||||||||||||||
Signature | |||||||||||||||
| |||||||||||||||
Arguments | |||||||||||||||
|
Method endXFMTag | |||||||||||||||
Signature | |||||||||||||||
| |||||||||||||||
Arguments | |||||||||||||||
|
Method findSizeGroupMembers | |||||||||||||||
Signature | |||||||||||||||
| |||||||||||||||
Arguments | |||||||||||||||
|
Method findTabCycleRoot | |||||
Find parent layer that is a a tab cycle root. | |||||
Signature | |||||
| |||||
Returns | |||||
Method focusFirstTabCycleMember | |||
Set keyboard focus to first non-root tab cycle member. | |||
Signature | |||
|
Method focusNextTabCycleMember | |||||
Determine next tab cycle member and set the keyboard focus. This method does not generate a onKeyboardFocusLost() event for the current tab focus layer; yet it will generate an onTabFocusLost() event for the current layer and an onTabFocus() event for the new tab focus layer. If the local argument is true, this will only cycle within the list of the tab cycle root that references this layer in its cycle list. | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method focusPreviousTabCycleMember | |||||
Determine previous tab cycle member and set the keyboard focus. This method does not generate a onKeyboardFocusLost() event for the current tab focus layer; yet it will generate an onTabFocusLost() event for the current layer and an onTabFocus() event for the new tab focus layer. If the local argument is true, this will only cycle within the list of the tab cycle root that references this layer in its cycle list. | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method getAbsolutePositionX | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getAbsolutePositionY | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getAlignment | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getAlpha | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getDefaultPreferredSizeX | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getDefaultPreferredSizeY | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getGeometry4f | |||||
Signature | |||||
| |||||
Returns | |||||
Method getLayout | |||
Return the layout of this layer. | |||
Signature | |||
|
Method getLayoutHints | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getLayoutSizeX | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getLayoutSizeY | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getLayoutWeightX | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getLayoutWeightY | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getMinimumSizePadX | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getMinimumSizePadY | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getMinimumSizeX | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getMinimumSizeY | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getNumChildLayers | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getPadBottom | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getPadLeft | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getPadRight | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getPadTop | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getParentLayerType | ||||
Signature | ||||
Arguments | ||||
| ||||
Returns | ||||
Method getPositionX | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getPositionY | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getPreferredSizePadX | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getPreferredSizePadY | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getPreferredSizeX | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getPreferredSizeY | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getScreenRegion | |||||
Return the rectangular screen region occupied by this layer | |||||
Signature | |||||
| |||||
Returns | |||||
Method getSize | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method getSizeGroup | |||||
Signature | |||||
| |||||
Returns | |||||
Method getSizePadX | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getSizePadY | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getSizeX | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getSizeY | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getTabCycleOrder | |||||
Returns sorting order in tabcycleroot list. Should return -1 if this layer is not focusable. | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getToolTipOffsetX | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getTotalNumChildLayers | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method grabKeyboardFocus | |||
Helper method to delegate key input to this layer. | |||
Signature | |||
| |||
Description | |||
Only one layer at a time may have the keyboard focus. |
Method handleDrawOverlays | |||
Signature | |||
|
Method hasChildLayer | ||||||||||
Query whether this layer has the given child layer. | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
Returns | ||||||||||
|
Method hasDirectChildLayer | ||||||||||
Query whether this layer has the given child layer. Do not search recursively. | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
|
Method hasKeyboardFocus | |||||
Query whether this layer currently has the keyboard focus | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method hasMouseFocus | |||||
Query whether this layer currently has the mouse focus | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method hasParent | ||||||||||
Query whether l is a parent of this layer. | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
|
Method hide | |||
Hide layer. Only used for dialogs/windows/popups. | |||
Signature | |||
|
Method hideToolTip | |||
Signature | |||
|
Method hierarchyHasKeyboardFocus | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method invalidateAbsolutePositions | |||
Signature | |||
|
Method invalidateChildContainerMinSizeCaches | |||
Recursively invalidate minimum size caches of all container-like child layers. | |||
Signature | |||
|
Method invalidateMinimumSizes | |||
Recursively invalidate minimum_size_x and minimum_size_y so that they are recalculated the next time they are accessed. This method should be used with care since it overrides the preferences set in e.g. an .xfm document. | |||
Signature | |||
|
Method invalidateMinSizeCache | |||
Helper method to invalidate the current minimum size | |||
Signature | |||
|
Method invalidatePreferredSizes | |||
Recursively invalidate preferred_size_x and preferred_size_y so that they are recalculated the next time they are accessed. This method should be used with care since it overrides the preferences set in e.g. an .xfm document. | |||
Signature | |||
|
Method invalidateSizeCache | |||
Helper method to invalidate the current preferred/minimum size | |||
Signature | |||
|
Method invalidateSizeCaches | |||
Recursively invalidate preferred and minimum size fields so that they are recalculated the next time they are accessed. | |||
Signature | |||
|
Method invalidateSizeGroupMemberSizes | |||
Signature | |||
|
Method is3d | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method isEditable | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method isLayoutMinSweepPass | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method isModal | |||||
This is used to implement dialog windows that make all other floating layers | |||||
Signature | |||||
| |||||
Returns | |||||
| |||||
Description | |||||
become unresponsive until a specific action has been taken in the (frontmost) dialog window. Note: Only top-level windows (floating layers) may be modal! |
Method isMouseFocusLocked | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method isMouseOver | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method isPopup | |||||
Return true if the floating layer should be closed when the user clicks outside the layer area (handleNonChildMouseOver) | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method isTabCycleMember | |||||
Query whether this layer supports tab-cycling. A special case are tabcycleroots which cannot be focused themselves but still are cycle memberes and thus should have a tab cycle order assigned. | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method isTabCycleProxy | |||||
Query whether the layer is cycleroot and active cyclemember at the same time, e.g. a TabbedView. | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method isTabCycleRoot | |||||
Query whether this layer manages a focus cycle list for its child layers. | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method isTranslucent | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method layerAt2f | ||||||||||||||||||||
Signature | ||||||||||||||||||||
| ||||||||||||||||||||
Arguments | ||||||||||||||||||||
| ||||||||||||||||||||
Returns | ||||||||||||||||||||
Method layoutHierarchy | |||||||||||||||
Layout child layers. Assumes that this layer is already layouted. | |||||||||||||||
Signature | |||||||||||||||
| |||||||||||||||
Arguments | |||||||||||||||
|
Method loseKeyboardFocus | |||
Lose keyboard focus (if this layer has it), do not generate onKeyboardFocusLost() event! | |||
Signature | |||
|
Method loseMouseFocus | |||
Lose mouse focus (if this layer has it), do not generate onMouseLeave() event! | |||
Signature | |||
|
Method moveToPosition2f | |||||||||||||||
Signature | |||||||||||||||
| |||||||||||||||
Arguments | |||||||||||||||
|
Method newToolTip | |||||
Instantiate and return new ToolTip object. The ToolTip instance is deleted when the tooltip is hidden. | |||||
Signature | |||||
| |||||
Returns | |||||
Method onAcceleratorKey | |||||
Called if the given accelerator key has been pressed. | |||||
Signature | |||||
| |||||
Arguments | |||||
Method onBeginTriadKeyMode | |||||
Called to inform the keyboard focus layer that the user has entered the 'magic' escape sequence (lctrl-x). | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method onChildMouseEnter | |||||
Called if a child gains the mouse focus. Used for submenus to disable the auto-hide timeout if a submenu child is re-focused. | |||||
Signature | |||||
| |||||
Arguments | |||||
Method onDraw | |||
The onDraw() method is called when the layer region needs to be repainted. | |||
Signature | |||
|
Method onDrawOverlays | |||
Called when FBO compositing is enabled. | |||
Signature | |||
|
Method onDropFiles | ||||||||||
Called when one or many files have been dropped on this layer | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
|
Method onEndTriadKeyMode | ||||||||||
Called to inform the keyboard focus layer that the 'magic' escape sequence (lctrl-x) - ? has finished. | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
|
Method onKey | ||||||||||
The onKey() method is called when a keyboard input event has been received from the HAL(SDL) subsystem. Returns true/false depending on whether the event was handled or not. | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
|
Method onKeyboardFocus | |||
The onKeyboardFocus() method is called when this layer has gained the keyboard focus. This method is usually called if a new keyboard focus has been set by @UI.SetKeyboardFocus. | |||
Signature | |||
|
Method onKeyboardFocusLost | |||||
The onKeyboardFocusLost() method is called when this layer has lost the keyboard focus; probably because another layer grabbed it.If bQuiet is true, simply stop editing and do NOT provide actions or refocus | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method onLookAndFeelChanged | |||
Called by @UI.SetLookAndFeel() if the look and feel class has changed. Layers that store color information in member variables have to re-read these fields for example (e.g. @Label or @TransparentPanel). | |||
Signature | |||
|
Method onMouse | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
Returns | ||||||||||
|
Method onMouseBeginDrag | ||||||||||||||||||||
Signature | ||||||||||||||||||||
| ||||||||||||||||||||
Arguments | ||||||||||||||||||||
| ||||||||||||||||||||
Returns | ||||||||||||||||||||
|
Method onMouseCancelDrag | |||||
Signature | |||||
| |||||
Arguments | |||||
Method onMouseClick | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
Returns | ||||||||||
|
Method onMouseDoubleClick | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
Returns | ||||||||||
|
Method onMouseDrag | ||||||||||||||||||||
Called when onMouseBeginDrag() returned true, the left mouse button is held down and the mouse has moved at least MOUSE_DRAG_THRESHOLD pixels. | ||||||||||||||||||||
Signature | ||||||||||||||||||||
| ||||||||||||||||||||
Arguments | ||||||||||||||||||||
| ||||||||||||||||||||
Returns | ||||||||||||||||||||
|
Method onMouseEndDrag | |||||
Signature | |||||
| |||||
Arguments | |||||
Method onMouseEnter | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
Returns | ||||||||||
|
Method onMouseFocus | |||
Signature | |||
|
Method onMouseHold | ||||||||||
Called when a mouse button is pressed and held down for MOUSE_HOLD_DELAY milliseconds without moving the mouse pointer. | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
|
Method onMouseLeave | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
Returns | ||||||||||
|
Method onMouseUnfocus | |||
Signature | |||
|
Method onOpen | |||
The onOpen() method is called when the layer needs to update | |||
Signature | |||
| |||
Description | |||
(re-)initialize its Textures, DisplayLists and vertex/color/index/.. OpenGL arrays. |
Method onResize | |||
Called when the layer has been resized to its final size. | |||
Signature | |||
|
Method onTabFocus | |||
Called if the keyboard focus was gained by cycling through the layers using tab/cursor keys. Also used by some dialog classes to set the default button. This event is very similar to onKeyboardFocus() although the layer can implement a slightly different behaviour (e.g. a textfield might want to select all text) | |||
Signature | |||
|
Method onTriadKey | ||||||||||
Called after key has been entered after lctrl-x escape sequence. | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
|
Method onTriadKeyTimeout | |||||
Called when third key in lctrl-x ? sequence has not been pressed in time (e.g. show help dialog in that case) | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method onUIActivate | |||
Called when this layer has the keyboard focus and the application window re-gains the focus. This is mainly used to close the popupmenu when alt-tabbing through windows (alt opens the popupmenu and this is probably not the desired behaviour when alt-tab is used!). See PopupMenuBarButton. | |||
Signature | |||
|
Method onUIDeactivate | |||
Called when this layer has the keyboard focus and the application window looses the focus. This is mainly used to close the popupmenu when alt-tabbing through windows (alt opens the popupmenu and this is probably not the desired behaviour when alt-tab is used!). See PopupMenuBarButton. | |||
Signature | |||
|
Method popParentViewPaneScissors | |||
Signature | |||
|
Method printHierarchy | |||
Signature | |||
|
Method provideAction | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method pushParentViewPaneScissors | |||
Signature | |||
|
Method recursiveBuildTabCycleLists | |||
Utility method that is used to recursively build tabcycle lists for all children. Usually this is automatically done when using XMLForms but if the layer hierarchy is built programmatically this method might be handy. | |||
Signature | |||
|
Method recursiveFocusTabCycleMember | |||||||||||||||||||||||||
Signature | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
Arguments | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
Returns | |||||||||||||||||||||||||
|
Method recursiveHideToolTips | |||
Signature | |||
|
Method recursiveInvalidateSizeGroupMemberSizes | |||
Signature | |||
|
Method recursiveOnLookAndFeelChanged | |||
Do not call directly. This is called by @UI.SetLookAndFeel(). | |||
Signature | |||
|
Method recursiveOnOpen | |||
Signature | |||
|
Method recursiveOnResize | |||
Recursively inform all child layers that their final sizes have been set. Do not call directly! Called by UI.RootLayerResize() and Window.onMouse(). | |||
Signature | |||
|
Method recursiveSetEditable | |||||
Recursively invalidate preferred and minimum size fields so that they are recalculated the next time they are accessed. | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method recursiveSetEnableCursorKeyTabCycling | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method redraw | |||
Redraw this layer | |||
Signature | |||
|
Method redrawAll | |||
Redraw all layers. Also see UI.RedrawAll() | |||
Signature | |||
|
Method relayout | |||
Signature | |||
|
Method removeActionConsumer | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method removeAllOverlays | |||
Signature | |||
|
Method removeChildHierarchy | |||
Recursively remove all children | |||
Signature | |||
|
Method removeChildren | |||
Remove children of this layer (no recursion) | |||
Signature | |||
|
Method resizeToMinimum | |||
Signature | |||
|
Method restartToolTipTimer | |||
Signature | |||
|
Method restoreGeometryIfValid | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
|
Method scheduleToolTipTimer | |||
Signature | |||
|
Method setAlignment | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setAlpha | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setDefaultInnerPadding | |||
Signature | |||
|
Method setEditable | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setEnableForceMinimumSize | |||||||||||||||
Signature | |||||||||||||||
| |||||||||||||||
Arguments | |||||||||||||||
|
Method setEnableForceMinimumSizeX | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setEnableForceMinimumSizeY | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setGeometry | |||||||||||||||||||||||||
Signature | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
Arguments | |||||||||||||||||||||||||
|
Method setGeometry4f | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setLayout | |||||
Set a Layout for this Layer. | |||||
Signature | |||||
| |||||
Arguments | |||||
Method setLayoutHints | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setLayoutWeight2f | |||||||||||||||
Signature | |||||||||||||||
| |||||||||||||||
Arguments | |||||||||||||||
|
Method setLayoutWeightX | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setLayoutWeightY | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setManualPreferredSize2f | |||||||||||||||
Signature | |||||||||||||||
| |||||||||||||||
Arguments | |||||||||||||||
|
Method setManualPreferredSizeX | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setManualPreferredSizeY | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setMinimumSize2f | |||||||||||||||
Signature | |||||||||||||||
| |||||||||||||||
Arguments | |||||||||||||||
|
Method setMinimumSizeX | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setMinimumSizeY | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setPadBottom | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setPadding4f | |||||||||||||||||||||||||
Signature | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
Arguments | |||||||||||||||||||||||||
|
Method setPadLeft | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setPadRight | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setPadTop | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setPosition2f | |||||||||||||||
Signature | |||||||||||||||
| |||||||||||||||
Arguments | |||||||||||||||
|
Method setPositionX | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setPositionY | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setPreferredSize2f | |||||||||||||||
Signature | |||||||||||||||
| |||||||||||||||
Arguments | |||||||||||||||
|
Method setPreferredSizeX | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setPreferredSizeY | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setRequiredSize2f | |||||||||||||||
Force layer size to (_w; _h) | |||||||||||||||
Signature | |||||||||||||||
| |||||||||||||||
Arguments | |||||||||||||||
|
Method setRequiredSizeX | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setRequiredSizeY | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setSize2f | |||||||||||||||
Signature | |||||||||||||||
| |||||||||||||||
Arguments | |||||||||||||||
|
Method setSizeGroup | |||||
Signature | |||||
| |||||
Arguments | |||||
Method setSizeX | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setSizeY | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setTabCycleOrder | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setToolTipCaption | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method showToolTip | |||
Signature | |||
|
Method unlinkChildLayer | ||||
Signature | ||||
Arguments | ||||
| ||||
Returns | ||||
Method wantKeyboardFocus | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method wantShadeModal | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method wantToolTipNearMouse | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method wantTriadKeyMode | |||||
Return true if layer supports lctrl-x escape sequence. | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method wantTriadKeyRepeat | ||||||||||
Check whether the given key shall be repeat (first non-repeat key exits mode) | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
|
Method ~Layer | |||
Signature | |||
|
Constant ABS_INVALID (float) | |
Constant DEFAULT_MINIMUM_SIZE_X (int) | |
Constant DEFAULT_MINIMUM_SIZE_Y (int) | |
Constant DEFAULT_PREFERRED_SIZE_X (int) | |
Constant DEFAULT_PREFERRED_SIZE_Y (int) | |
auto-generated by "DOG", the TkScript document generator. Mon, 28/Dec/2015 14:27:06