ui
ui
MLayerMLayer.ui::LayerMXFMObject.ui::XFMObject
MActionConsumer.ui::ActionConsumer
MUserDataContainer.ui::UserDataContainerMComposite.ui::Composite
MControl.ui::Control
MKeyboardMonitor.ui::KeyboardMonitor
MLabel.ui::Label
MPopupMenuSeparator.ui::PopupMenuSeparator
MSpacer.ui::Spacer
MSplitPane.ui::SplitPane
MTableViewData.ui::TableViewData
MTableViewHeader.ui::TableViewHeaderAllowXFMAttribDPI(String atval) : int -
FindFirstNonRootTabCycleMember(Object n, int dir) : ui::Layer -
FindNextTabCycleOverrideMember(PointerArray layers, Object c) -
FindPreviousTabCycleOverrideMember(PointerArray layers, Object c) -
IsTabCycleKey(Key k) : int -
ParseAlignmentFlagsFromArray(StringArray atsplit) : int - addActionConsumer(ui::ActionConsumer consumer) -
addChildLayer(Object l) -
addGridLayer(Object l, int gridX, gridY, gridW, gridH) -
addLayer(Object l, int layoutHints) -
addOverlay(Object l) -
addTabCycleMembersToList(PointerArray list) -
addTabCycleOverrides(PointerArray retLayers) -
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(ui::MouseEvent ev) : int -
buildTabCycleList() - Scan child layers and build tab cycle list. Usually implemented by container-like layers (e.g. Panels).
calcAbsolutePosition(Point2f vOrNull) -
calcAbsolutePositionFBO(Point2f v) -
calcDirFlagsRelativeTo(Object o, Point2f pThis, pO) : int -
calcDropFilesPosition(Point2f p) -
calcEffectiveBg32() : int -
calcMinimumSizeX() -
calcMinimumSizeY() -
calcParentPosition(Point2f v) - Calc position relative to logical parent (root or ViewPane)
calcPositionWithin(Object root, Point2f p) -
calcPreferredSize() -
calcPreferredSizeX() -
calcPreferredSizeY() -
calcSizeX() : float -
calcSizeY() : float -
cancelToolTipTimer() -
canDropObject(Object o, ui::MouseEvent ev) : int -
cloneLookAndFeelColors() : IntArray -
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.
debugPrintChildLayers() -
debugPrintChildLayersRecursive(int off, bRecursive) -
debugPrintTabCycleList() -
drawChildHierarchy(int bForceRedraw, bCheckIntersect, viewShiftX, viewShiftY, viewSizeX, viewSizeY) -
drawHierarchy(int bForceRedraw, bCheckIntersect, viewShiftX, viewShiftY, viewSizeX, viewSizeY) -
drawHierarchySimple() -
endXFMTag(ui::AbstractXMLForm form, HashTable attributes) -
exportPNG(String pathName) -
findChildLayerByClass(Class c) : ui::Layer -
findChildLayerById(String id) : ui::Layer -
findChildLayerByName(String name) : ui::Layer -
findFirstNonPanelChildLayer() : ui::Layer -
findNextLayerByIdx(int idx) : ui::Layer -
findParentBackgroundColor() : int -
findSizeGroupMembers(Object sg, PointerArray ret) -
findTabCycleHeader() : ui::Layer -
findTabCycleOverrides() : PointerArray -
findTabCycleRoot() : ui::Layer - Find parent layer that is a a tab cycle root.
flattenHierarchy(int bIgnoreLayerGroups) -
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.
freeLayer() -
getAbsolutePositionString() : String -
getAbsolutePositionX() : float -
getAbsolutePositionY() : float -
getAlignment() : int -
getAlpha() : int -
getBackgroundColor() : int -
getBackgroundTint() : int -
getBaselineY() : float -
getDebug() : int -
getDebugString() : String -
getDefaultKeyboardFocusLayer() : ui::Layer -
getDefaultPreferredSizeX() : float -
getDefaultPreferredSizeY() : float -
getDisplayedText() : String -
getEnableBackgroundKeepAlpha() : int -
getEnableFillBackground() : int - Query whether to fill background before painting the caption.
getEnableFlatHighContrast() : int -
getEnableLayerGroup() : int -
getFirstLabelDebugString() : String -
getForegroundColor() : int -
getForegroundTint() : int -
getGeometry4f() : ui::Geometry4f -
getGeometryString() : String -
getGraphData() : Object -
getLastChild() : ui::Layer -
getLayerId() : String -
getLayerName() : String -
getLayout() - Return the layout of this layer.
getLayoutFirstChild() : ui::Layer -
getLayoutHints() : int -
getLayoutSizeX() : float -
getLayoutSizeY() : float -
getLayoutWeightX() : float -
getLayoutWeightY() : float -
getLinkedRedraw() : ui::Layer -
getMinimumSizePadX() : float -
getMinimumSizePadY() : float -
getMinimumSizeString() : String -
getMinimumSizeX() : float -
getMinimumSizeY() : float -
getNumChildLayers() : int -
getNumParents() : int -
getPadBottom() : float -
getPaddingString() : String -
getPadLeft() : float -
getPadRight() : float -
getPadTop() : float -
getPadX() : float -
getPadY() : float -
getParent() : ui::Layer -
getParentLayerType(Object type) : ui::Layer -
getParentPositionX() : float -
getParentPositionY() : float -
getPositionString() : String -
getPositionX() : float -
getPositionXScaled() : float -
getPositionY() : float -
getPositionYScaled() : float -
getPreferredSizePadX() : float -
getPreferredSizePadY() : float -
getPreferredSizeString() : String -
getPreferredSizeX() : float -
getPreferredSizeY() : float -
getRequiredSizeString() : String -
getRequiredSizeX() : float -
getRequiredSizeY() : float -
getRoot() : ui::Layer -
getScreenRegion() : ui::Rectangle2f - Return the rectangular screen region occupied by this layer
getSize(Size2f retSz) -
getSizeGroup() : ui::SizeGroup -
getSizePadString() : String -
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.
getTabCycleOverrides() : PointerArray - Get override list of tab cycle members. Should only be implemented by one layer.
getTabCycleOverridesDef() : PointerArray -
getToolTipCaption() : String -
getToolTipHideDelay() : int -
getToolTipOffsetX() : float -
getToolTipStage2Delay() : int -
getTotalNumChildLayers() : int -
grabKeyboardFocus() - Helper method to delegate key input to this layer.
handleDrawOverlays() -
handleMouseEventByDefault() : int -
handleNewTabCycleFocus(ui::Layer n) -
handleResize() -
hasChildLayer(ui::Layer l) : int - Query whether this layer has the given child layer.
hasCustomBackgroundColor() : int -
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 -
initLayer() -
invalidateAbsolutePositions() -
invalidateChildContainerMinSizeCaches() - Recursively invalidate minimum size caches of all container-like child layers.
invalidateContentLayout() -
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 -
isDecorative() : int -
isEditable() : int -
isEditing() : 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)
isLookAndFeelLight() : int -
isModal() : int - This is used to implement dialog windows that make all other floating layers
isMouseDragLayer() : int -
isMouseFocusLocked() : int -
isMouseFocusWithin() : int -
isMouseOver() : int -
isMouseOverWithin() : int -
isPanel() : 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.
isToolTipVisible() : int -
isTranslucent() : int -
layerAt2f(float x, y) : ui::Layer -
layoutApplyCommonBaselineAdjustments(float maxBaselineY, sizeAvail) -
layoutApplyCompositeBaselineAdjustments() -
layoutApplyCompositeBaselineAdjustments_BorderLayout() -
layoutApplyCompositeBaselineAdjustments_GridLayout() -
layoutContent() -
layoutFindChildEffectiveBaselineY() : float -
layoutFindEffectiveBaselineY() : float -
layoutHierarchy(int bInvalidateSizeCaches, bLayoutFinal) - Layout child layers. Assumes that this layer is already layouted.
lnfGetColorAlpha(int lnfIdx, alpha) : int -
lnfGetTintedColor(int lnfIdx, tint32) : int -
lnfGetTintedColorAlpha(int lnfIdx, tint32, alpha) : int -
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!
makeBackgroundColorSolid() -
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.
newToolTipStage2() : ui::ToolTip -
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.
onCycleAppLookAndFeel() -
onDrainEventQueue() -
onDraw() - The onDraw() method is called when the layer region needs to be repainted.
onDrawChildPost(Object childLayer) - Called after rendering the given child layer
onDrawOverlays() - Called when FBO compositing is enabled.
onDrawPost() - Called after child hierarchy has been rendered
onDropFiles(StringArray fileNames) : int - Called when one or many files have been dropped on this layer
onDropObject(Object o, ui::MouseEvent ev) : int -
onEndTriadKeyMode(Key k) : int - Called to inform the keyboard focus layer that the 'magic' escape sequence (lctrl-x) - ? has finished.
onKey(Key k) : 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 ev) : int - Called when a mouse button is pressed and held down for MOUSE_HOLD_DELAY milliseconds without moving the mouse pointer.
onMouseHoldEnd(ui::MouseEvent ev) : int - Called when mouse button is released after hold
onMouseKey(Key k) : int -
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.
onRootLayerActivated() -
onRootLayerMoved(int x, y) -
onScreenShot() -
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.
parseColorString(String s) : int -
parseLayerStyle(String s) : int -
parseLayout(HashTable attributes) -
popParentViewPaneScissors() -
printHierarchy() -
provideAction(ui::Action providedAction) : int -
pushParentViewPaneScissors() -
queueRelayout() -
recursiveAddTabCycleOverrides(PointerArray retLayers) -
recursiveBeginResize() -
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.
recursiveFlattenHierarchy(ui::Layer parent, float tx, ty, PointerArray retLayers, int bIgnoreLayerGroups) -
recursiveFocusTabCycleMember(Object active, int dir, local) : int -
recursiveFreeLayer() -
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) -
recursiveSetLookAndFeel(String name) -
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) -
removeParentLayerRefs() -
resizeToMinimum() -
resizeToMinimumX() -
resizeToMinimumY() -
restartToolTipTimer() -
restoreGeometryIfValid(ui::Geometry4f geo) : int -
restorePositionIfValid(Point2f pos) : int -
revertCursor(String name) -
scheduleToolTipTimer() -
scheduleToolTipTimer2(int forcedDelay) -
setAlignment(int alignment) -
setAlpha(int a) -
setBackgroundColor(int c32bg) - Set color of label background
setBackgroundColorFromString(String s) -
setBackgroundTint(int tint32) -
setBackgroundTintAndRedraw(int tint32) -
setBaselineContentShiftY(float y) -
setDebug(int bDebug) -
setDefaultInnerPadding() -
setEditable(int bEditable) -
setEnableBackgroundKeepAlpha(int bEnable) -
setEnableBaselineContentShift(int bEnable) -
setEnableCollapse(int bEnable) -
setEnableCursorKeyTabCycling(int bEnabled) -
setEnableDecorative(int bEnable) -
setEnableFillBackground(int bEnabled) - Fill background before painting the caption when bEnabled==true.
setEnableFlatHighContrast(int bEnable) -
setEnableForceMinimumSize(int bX, bY) -
setEnableForceMinimumSizeX(int bX) -
setEnableForceMinimumSizeY(int bY) -
setEnableInvokeParentOnDrawChildPost(int bEnable) -
setEnableKbdFocusOnMouse(int bEnable) -
setEnableLayerGroup(int bEnable) -
setEnableLockSize(int bLock) -
setEnableLockSizeX(int bLock) -
setEnableLockSizeY(int bLock) -
setForegroundColor(int c32fg) - Set color of label caption
setForegroundColorFromString(String s) -
setForegroundTint(int tint32) -
setGeometry(float px, py, sx, sy) -
setGeometry4f(ui::Geometry4f geo) -
setGraphData(Object data) -
setLayerId(String id) -
setLayerName(String name) -
setLayerStyle(int style) -
setLayout(ui::Layout l) - Set a Layout for this Layer.
setLayoutHints(int hints) -
setLayoutWeight2f(float x, y) -
setLayoutWeightX(float wx) -
setLayoutWeightY(float wy) -
setLinkedRedraw(Object l) -
setLookAndFeel(String name) -
setLookAndFeelDark() -
setLookAndFeelLight() -
setLookAndFeelMono() -
setLookAndFeelRef(ui::LookAndFeel lnf, int bForce) -
setManualPreferredSize2f(float w, h) -
setManualPreferredSizeX(float w) -
setManualPreferredSizeY(float h) -
setMinimumSize2f(float w, h) -
setMinimumSize2fScaled(float w, h) -
setMinimumSizeX(float x) -
setMinimumSizeXScaled(float x) -
setMinimumSizeY(float y) -
setMinimumSizeYScaled(float y) -
setPadBottom(float bottom) -
setPadBottomUnscaled(float bottom) -
setPadding4f(float top, left, bottom, right) -
setPadding4fUnscaled(float top, left, bottom, right) -
setPadLeft(float left) -
setPadLeftUnscaled(float left) -
setPadRight(float right) -
setPadRightUnscaled(float right) -
setPadTop(float top) -
setPadTopUnscaled(float top) -
setPosition2f(float x, y) -
setPosition2fScaled(float x, y) -
setPositionX(float x) -
setPositionXScaled(float x) -
setPositionY(float y) -
setPositionYScaled(float y) -
setPreferredSize2f(float w, h) -
setPreferredSizePadX(float wPad) -
setPreferredSizePadY(float hPad) -
setPreferredSizeX(float w) -
setPreferredSizeY(float h) -
setRequiredPosition2f(float x, y) -
setRequiredPosition2fScaled(float x, y) -
setRequiredSize2f(float w, h) - Force layer size to (_w; _h)
setRequiredSize2fScaled(float w, h) -
setRequiredSizePadX(float wPad) -
setRequiredSizePadY(float hPad) -
setRequiredSizeX(float w) -
setRequiredSizeXScaled(float w) -
setRequiredSizeY(float h) -
setRequiredSizeYScaled(float h) -
setSize2f(float w, h) -
setSize2fScaled(float w, h) -
setSizeGroup(Object sg) -
setSizePadX(float wPad) -
setSizePadY(float hPad) -
setSizeX(float w) -
setSizeXScaled(float w) -
setSizeY(float h) -
setSizeYScaled(float h) -
setTabCycleOrder(int order) -
setToolTipCaption(String tooltipCaption) -
setToolTipFontOverride(ui::Font font) -
showCursor(String name) -
showToolTip(int bStage2) -
showToolTip2(int bStage2) -
unlinkChildLayer(Object l) : ui::Layer -
unlinkFirstChild() : ui::Layer -
unlinkNext() : ui::Layer -
updateToolTipIfVisible() -
wantKeyboardFocus() : int -
wantKeyRepeat(Key k) : int -
wantMouseDragButtonOnlyEvents() : int -
wantOnMouseClickAfterOnMouseWasHandled() : 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)
warpTo(float relX, relY) -
warpToX(float relX) -
warpToY(float relY) - float ABS_INVALID -
int DEFAULT_MINIMUM_SIZE_X -
int DEFAULT_MINIMUM_SIZE_Y -
int DEFAULT_PREFERRED_SIZE_X -
int DEFAULT_PREFERRED_SIZE_Y -
Function AllowXFMAttribDPI | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
| ||||||||||
Function FindFirstNonRootTabCycleMember | ||||||||
Signature | ||||||||
Arguments | ||||||||
| ||||||||
Returns | ||||||||
Function FindNextTabCycleOverrideMember | |||||||||||||||
Signature | |||||||||||||||
| |||||||||||||||
Arguments | |||||||||||||||
|
Function FindPreviousTabCycleOverrideMember | |||||||||||||||
Signature | |||||||||||||||
| |||||||||||||||
Arguments | |||||||||||||||
|
Function ParseAlignmentFlagsFromArray | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
| ||||||||||
Method addActionConsumer | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method addGridLayer | ||||||||||||||||||||||||||||||
Signature | ||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||
Arguments | ||||||||||||||||||||||||||||||
|
Method addTabCycleMembersToList | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method addTabCycleOverrides | |||||
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 | ||||||||||
| ||||||||||
Arguments | ||||||||||
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 calcDirFlagsRelativeTo | |||||||||||||||||||||||||
Signature | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
Arguments | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
Returns | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
Method calcDropFilesPosition | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method calcEffectiveBg32 | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method calcMinimumSizeX | |||
Signature | |||
|
Method calcMinimumSizeY | |||
Signature | |||
|
Method calcParentPosition | |||||
Calc position relative to logical parent (root or ViewPane) | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method calcPositionWithin | |||||||||||||||
Signature | |||||||||||||||
| |||||||||||||||
Arguments | |||||||||||||||
|
Method calcPreferredSize | |||
Signature | |||
|
Method calcPreferredSizeX | |||
Signature | |||
|
Method calcPreferredSizeY | |||
Signature | |||
|
Method calcSizeX | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method calcSizeY | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method cancelToolTipTimer | |||
Signature | |||
|
Method canDropObject | ||||||||||||||||||||
Signature | ||||||||||||||||||||
| ||||||||||||||||||||
Arguments | ||||||||||||||||||||
| ||||||||||||||||||||
Returns | ||||||||||||||||||||
| ||||||||||||||||||||
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 debugPrintChildLayers | |||
Signature | |||
|
Method debugPrintChildLayersRecursive | |||||||||||||||
Signature | |||||||||||||||
| |||||||||||||||
Arguments | |||||||||||||||
|
Method debugPrintTabCycleList | |||
Signature | |||
|
Method drawChildHierarchy | |||||||||||||||||||||||||||||||||||
Signature | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
Arguments | |||||||||||||||||||||||||||||||||||
|
Method drawHierarchy | |||||||||||||||||||||||||||||||||||
Signature | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
Arguments | |||||||||||||||||||||||||||||||||||
|
Method drawHierarchySimple | |||
Signature | |||
|
Method endXFMTag | |||||||||||||||
Signature | |||||||||||||||
| |||||||||||||||
Arguments | |||||||||||||||
|
Method findChildLayerByClass | ||||
Signature | ||||
Arguments | ||||
| ||||
Returns | ||||
Method findChildLayerById | ||||
Signature | ||||
Arguments | ||||
| ||||
Returns | ||||
Method findChildLayerByName | ||||
Signature | ||||
Arguments | ||||
| ||||
Returns | ||||
Method findFirstNonPanelChildLayer | |||||
Signature | |||||
| |||||
Returns | |||||
Method findNextLayerByIdx | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
Method findParentBackgroundColor | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method findSizeGroupMembers | |||||||||||||||
Signature | |||||||||||||||
| |||||||||||||||
Arguments | |||||||||||||||
|
Method findTabCycleOverrides | |||||
Signature | |||||
| |||||
Returns | |||||
Method findTabCycleRoot | |||||
Find parent layer that is a a tab cycle root. | |||||
Signature | |||||
| |||||
Returns | |||||
Method flattenHierarchy | |||||
Signature | |||||
| |||||
Arguments | |||||
|
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 freeLayer | |||
Signature | |||
|
Method getAbsolutePositionX | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getAbsolutePositionY | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getAlignment | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getAlpha | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getBackgroundColor | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getBackgroundTint | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getBaselineY | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getDebug | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getDefaultKeyboardFocusLayer | |||||
Signature | |||||
| |||||
Returns | |||||
Method getDefaultPreferredSizeX | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getDefaultPreferredSizeY | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getEnableBackgroundKeepAlpha | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getEnableFillBackground | |||||
Query whether to fill background before painting the caption. | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getEnableFlatHighContrast | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getEnableLayerGroup | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getForegroundColor | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getForegroundTint | |||||
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 getNumParents | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getPadBottom | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getPadLeft | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getPadRight | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getPadTop | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getPadX | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getPadY | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getParentLayerType | ||||
Signature | ||||
Arguments | ||||
| ||||
Returns | ||||
Method getParentPositionX | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getParentPositionY | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getPositionX | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getPositionXScaled | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getPositionY | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getPositionYScaled | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getPreferredSizePadX | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getPreferredSizePadY | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getPreferredSizeX | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getPreferredSizeY | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getRequiredSizeX | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getRequiredSizeY | |||||
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 getTabCycleOverrides | |||||
Get override list of tab cycle members. Should only be implemented by one layer. | |||||
Signature | |||||
| |||||
Returns | |||||
Method getTabCycleOverridesDef | |||||
Signature | |||||
| |||||
Returns | |||||
Method getToolTipHideDelay | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getToolTipOffsetX | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getToolTipStage2Delay | |||||
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 handleMouseEventByDefault | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method handleResize | |||
Signature | |||
|
Method hasChildLayer | ||||||||||
Query whether this layer has the given child layer. | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
Returns | ||||||||||
| ||||||||||
Method hasCustomBackgroundColor | |||||
Signature | |||||
| |||||
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 initLayer | |||
Signature | |||
|
Method invalidateAbsolutePositions | |||
Signature | |||
|
Method invalidateChildContainerMinSizeCaches | |||
Recursively invalidate minimum size caches of all container-like child layers. | |||
Signature | |||
|
Method invalidateContentLayout | |||
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 isDecorative | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method isEditable | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method isEditing | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method isLayoutMinSweepPass | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method isLookAndFeelLight | |||||
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 isMouseDragLayer | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method isMouseFocusLocked | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method isMouseFocusWithin | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method isMouseOver | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method isMouseOverWithin | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method isPanel | |||||
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 isToolTipVisible | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method isTranslucent | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method layerAt2f | ||||||||||||||||||||
Signature | ||||||||||||||||||||
| ||||||||||||||||||||
Arguments | ||||||||||||||||||||
| ||||||||||||||||||||
Returns | ||||||||||||||||||||
Method layoutApplyCommonBaselineAdjustments | |||||||||||||||
Signature | |||||||||||||||
| |||||||||||||||
Arguments | |||||||||||||||
|
Method layoutApplyCompositeBaselineAdjustments | |||
Signature | |||
|
Method layoutApplyCompositeBaselineAdjustments_BorderLayout | |||
Signature | |||
|
Method layoutApplyCompositeBaselineAdjustments_GridLayout | |||
Signature | |||
|
Method layoutContent | |||
Signature | |||
|
Method layoutFindChildEffectiveBaselineY | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method layoutFindEffectiveBaselineY | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method layoutHierarchy | |||||||||||||||
Layout child layers. Assumes that this layer is already layouted. | |||||||||||||||
Signature | |||||||||||||||
| |||||||||||||||
Arguments | |||||||||||||||
|
Method lnfGetColorAlpha | ||||||||||||||||||||
Signature | ||||||||||||||||||||
| ||||||||||||||||||||
Arguments | ||||||||||||||||||||
| ||||||||||||||||||||
Returns | ||||||||||||||||||||
| ||||||||||||||||||||
Method lnfGetTintedColor | ||||||||||||||||||||
Signature | ||||||||||||||||||||
| ||||||||||||||||||||
Arguments | ||||||||||||||||||||
| ||||||||||||||||||||
Returns | ||||||||||||||||||||
| ||||||||||||||||||||
Method lnfGetTintedColorAlpha | |||||||||||||||||||||||||
Signature | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
Arguments | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
Returns | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
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 makeBackgroundColorSolid | |||
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 newToolTipStage2 | |||||
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 onCycleAppLookAndFeel | |||
Signature | |||
|
Method onDrainEventQueue | |||
Signature | |||
|
Method onDraw | |||
The onDraw() method is called when the layer region needs to be repainted. | |||
Signature | |||
|
Method onDrawChildPost | |||||
Called after rendering the given child layer | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method onDrawOverlays | |||
Called when FBO compositing is enabled. | |||
Signature | |||
|
Method onDrawPost | |||
Called after child hierarchy has been rendered | |||
Signature | |||
|
Method onDropFiles | ||||||||||
Called when one or many files have been dropped on this layer | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
| ||||||||||
Method onDropObject | ||||||||||||||||||||
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 onMouseHoldEnd | ||||||||||
Called when mouse button is released after hold | ||||||||||
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 onRootLayerActivated | |||
Signature | |||
|
Method onRootLayerMoved | |||||||||||||||
Signature | |||||||||||||||
| |||||||||||||||
Arguments | |||||||||||||||
|
Method onScreenShot | |||
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 | ||||||||||
| ||||||||||
Returns | ||||||||||
| ||||||||||
Method pushParentViewPaneScissors | |||
Signature | |||
|
Method queueRelayout | |||
Signature | |||
|
Method recursiveAddTabCycleOverrides | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method recursiveBeginResize | |||
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 recursiveFlattenHierarchy | ||||||||||||||||||||||||||||||
Signature | ||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||
Arguments | ||||||||||||||||||||||||||||||
|
Method recursiveFocusTabCycleMember | |||||||||||||||||||||||||
Signature | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
Arguments | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
Returns | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
Method recursiveFreeLayer | |||
Signature | |||
|
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 removeParentLayerRefs | |||
Signature | |||
|
Method resizeToMinimum | |||
Signature | |||
|
Method resizeToMinimumX | |||
Signature | |||
|
Method resizeToMinimumY | |||
Signature | |||
|
Method restartToolTipTimer | |||
Signature | |||
|
Method restoreGeometryIfValid | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
| ||||||||||
Method restorePositionIfValid | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
| ||||||||||
Method scheduleToolTipTimer | |||
Signature | |||
|
Method scheduleToolTipTimer2 | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setAlignment | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setAlpha | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setBackgroundColor | |||||
Set color of label background | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setBackgroundColorFromString | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setBackgroundTint | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setBackgroundTintAndRedraw | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setBaselineContentShiftY | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setDebug | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setDefaultInnerPadding | |||
Signature | |||
|
Method setEditable | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setEnableBackgroundKeepAlpha | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setEnableBaselineContentShift | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setEnableCollapse | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setEnableCursorKeyTabCycling | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setEnableDecorative | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setEnableFillBackground | |||||
Fill background before painting the caption when bEnabled==true. | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setEnableFlatHighContrast | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setEnableForceMinimumSize | |||||||||||||||
Signature | |||||||||||||||
| |||||||||||||||
Arguments | |||||||||||||||
|
Method setEnableForceMinimumSizeX | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setEnableForceMinimumSizeY | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setEnableInvokeParentOnDrawChildPost | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setEnableKbdFocusOnMouse | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setEnableLayerGroup | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setEnableLockSize | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setEnableLockSizeX | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setEnableLockSizeY | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setForegroundColor | |||||
Set color of label caption | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setForegroundColorFromString | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setForegroundTint | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setGeometry | |||||||||||||||||||||||||
Signature | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
Arguments | |||||||||||||||||||||||||
|
Method setGeometry4f | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setLayerStyle | |||||
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 setLookAndFeelDark | |||
Signature | |||
|
Method setLookAndFeelLight | |||
Signature | |||
|
Method setLookAndFeelMono | |||
Signature | |||
|
Method setLookAndFeelRef | |||||||||||||||
Signature | |||||||||||||||
| |||||||||||||||
Arguments | |||||||||||||||
|
Method setManualPreferredSize2f | |||||||||||||||
Signature | |||||||||||||||
| |||||||||||||||
Arguments | |||||||||||||||
|
Method setManualPreferredSizeX | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setManualPreferredSizeY | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setMinimumSize2f | |||||||||||||||
Signature | |||||||||||||||
| |||||||||||||||
Arguments | |||||||||||||||
|
Method setMinimumSize2fScaled | |||||||||||||||
Signature | |||||||||||||||
| |||||||||||||||
Arguments | |||||||||||||||
|
Method setMinimumSizeX | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setMinimumSizeXScaled | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setMinimumSizeY | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setMinimumSizeYScaled | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setPadBottom | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setPadBottomUnscaled | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setPadding4f | |||||||||||||||||||||||||
Signature | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
Arguments | |||||||||||||||||||||||||
|
Method setPadding4fUnscaled | |||||||||||||||||||||||||
Signature | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
Arguments | |||||||||||||||||||||||||
|
Method setPadLeft | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setPadLeftUnscaled | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setPadRight | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setPadRightUnscaled | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setPadTop | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setPadTopUnscaled | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setPosition2f | |||||||||||||||
Signature | |||||||||||||||
| |||||||||||||||
Arguments | |||||||||||||||
|
Method setPosition2fScaled | |||||||||||||||
Signature | |||||||||||||||
| |||||||||||||||
Arguments | |||||||||||||||
|
Method setPositionX | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setPositionXScaled | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setPositionY | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setPositionYScaled | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setPreferredSize2f | |||||||||||||||
Signature | |||||||||||||||
| |||||||||||||||
Arguments | |||||||||||||||
|
Method setPreferredSizePadX | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setPreferredSizePadY | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setPreferredSizeX | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setPreferredSizeY | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setRequiredPosition2f | |||||||||||||||
Signature | |||||||||||||||
| |||||||||||||||
Arguments | |||||||||||||||
|
Method setRequiredPosition2fScaled | |||||||||||||||
Signature | |||||||||||||||
| |||||||||||||||
Arguments | |||||||||||||||
|
Method setRequiredSize2f | |||||||||||||||
Force layer size to (_w; _h) | |||||||||||||||
Signature | |||||||||||||||
| |||||||||||||||
Arguments | |||||||||||||||
|
Method setRequiredSize2fScaled | |||||||||||||||
Signature | |||||||||||||||
| |||||||||||||||
Arguments | |||||||||||||||
|
Method setRequiredSizePadX | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setRequiredSizePadY | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setRequiredSizeX | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setRequiredSizeXScaled | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setRequiredSizeY | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setRequiredSizeYScaled | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setSize2f | |||||||||||||||
Signature | |||||||||||||||
| |||||||||||||||
Arguments | |||||||||||||||
|
Method setSize2fScaled | |||||||||||||||
Signature | |||||||||||||||
| |||||||||||||||
Arguments | |||||||||||||||
|
Method setSizePadX | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setSizePadY | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setSizeX | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setSizeXScaled | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setSizeY | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setSizeYScaled | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setTabCycleOrder | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setToolTipCaption | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method setToolTipFontOverride | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method showToolTip | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method showToolTip2 | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method unlinkChildLayer | ||||
Signature | ||||
Arguments | ||||
| ||||
Returns | ||||
Method updateToolTipIfVisible | |||
Signature | |||
|
Method wantKeyboardFocus | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method wantMouseDragButtonOnlyEvents | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method wantOnMouseClickAfterOnMouseWasHandled | |||||
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 warpTo | |||||||||||||||
Signature | |||||||||||||||
| |||||||||||||||
Arguments | |||||||||||||||
|
Method warpToX | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method warpToY | |||||
Signature | |||||
| |||||
Arguments | |||||
|
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. Thu, 11/Dec/2025 13:42:00