home
 
 index of namespace ui
 
 index of project tkui
 
 index of module MLayer

Class MLayer.ui::Layer


SynopsisThe Layer class is the baseclass for all graphical components.

  Base classes:
  Derived classes:
  Functions:
  Methods:
  Constants:
Function FindFirstNonRootTabCycleMember
Signature
FindFirstNonRootTabCycleMember(Objectn,
  intdir 
  )  
 :ui::Layer
Arguments
Objectn
intdir
Returns

 
 top of page
Function IsTabCycleKey
Signature
IsTabCycleKey(Keyk)
 :int
Arguments
Keyk
Returns
int

 
 top of page
Method addActionConsumer
Signature
addActionConsumer(ui::ActionConsumerconsumer)
Arguments
ui::ActionConsumerconsumer

 
 top of page
Method addChildLayer
Signature
addChildLayer(Objectl)
Arguments
Objectl

 
 top of page
Method addLayer
Signature
addLayer(Objectl,
  intlayoutHints 
  )  
Arguments
Objectl
intlayoutHints

 
 top of page
Method addOverlay
Signature
addOverlay(Objectl)
Arguments
Objectl

 
 top of page
Method addTabCycleMembersToList
Signature
addTabCycleMembersToList(PointerArraylist)
Arguments
PointerArraylist

 
 top of page
Method addXFMChild
Signature
addXFMChild(Objectc)
Arguments
Objectc

 
 top of page
Method addXFMObject
Signature
addXFMObject(ui::XFMObjecto)
Arguments

 
 top of page
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
allowCursorKeysForTabCycling():int
Returns
int

 
 top of page
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
allowSubPixelPosition():int
Returns
int

 
 top of page
Method allowSubPixelSize
Query whether layer allows sub-pixel size.
Signature
allowSubPixelSize():int
Returns
int

 
 top of page
Method appendHierarchyString
Signature
appendHierarchyString(Stringr,
  intcx 
  )  
Arguments
Stringr
intcx

 
 top of page
Method beginXFMTag
Signature
beginXFMTag(ui::AbstractXMLFormform,
  HashTableattributes 
  )  
 :int
Arguments
ui::AbstractXMLFormform
HashTableattributes
Returns
int

 
 top of page
Method blockMouseDrag
Signature
blockMouseDrag():int
Returns
int

 
 top of page
Method buildTabCycleList
Scan child layers and build tab cycle list. Usually implemented by container-like layers (e.g. Panels).
Signature
buildTabCycleList()

 
 top of page
Method calcAbsolutePosition
Signature
calcAbsolutePosition(ui::Point2fv)
Arguments

 
 top of page
Method calcAbsolutePositionFBO
Signature
calcAbsolutePositionFBO(ui::Point2fv)
Arguments

 
 top of page
Method calcMinimumSizeX
Signature
calcMinimumSizeX()

 
 top of page
Method calcMinimumSizeY
Signature
calcMinimumSizeY()

 
 top of page
Method calcParentPosition
Calc position relative to logical parent (root or ViewPane)
Signature
calcParentPosition(ui::Point2fv)
Arguments

 
 top of page
Method calcPreferredSize
Signature
calcPreferredSize()

 
 top of page
Method calcPreferredSizeX
Signature
calcPreferredSizeX()

 
 top of page
Method calcPreferredSizeY
Signature
calcPreferredSizeY()

 
 top of page
Method calcSizeX
Signature
calcSizeX():float
Returns
float

 
 top of page
Method calcSizeY
Signature
calcSizeY():float
Returns
float

 
 top of page
Method cancelToolTipTimer
Signature
cancelToolTipTimer()

 
 top of page
Method compositeAll
Composite all layers. Also see UI.CompositeAll()
Signature
compositeAll()

 
 top of page
Method consumeAction
Signature
consumeAction(ui::Actionac)
 :int
Arguments
ui::Actionac
Returns
int

 
 top of page
Method containsAbsoluteXY
Check whether this layer contains the given absolute coordinate.
Signature
containsAbsoluteXY(floatx,
  floaty 
  )  
 :int
Arguments
floatx
floaty
Returns
int

 
 top of page
Method debugPrintTabCycleList
Signature
debugPrintTabCycleList()

 
 top of page
Method drawChildHierarchy
Signature
drawChildHierarchy(intbForceRedraw,
  intbCheckIntersect 
  )  
Arguments
intbForceRedraw
intbCheckIntersect

 
 top of page
Method drawHierarchy
Signature
drawHierarchy(intbForceRedraw,
  intbCheckIntersect 
  )  
Arguments
intbForceRedraw
intbCheckIntersect

 
 top of page
Method endXFMTag
Signature
endXFMTag(ui::AbstractXMLFormform,
  HashTableattributes 
  )  
Arguments
ui::AbstractXMLFormform
HashTableattributes

 
 top of page
Method findSizeGroupMembers
Signature
findSizeGroupMembers(ui::SizeGroupsg,
  PointerArrayret 
  )  
Arguments

 
 top of page
Method findTabCycleRoot
Find parent layer that is a a tab cycle root.
Signature
findTabCycleRoot():ui::Layer
Returns

 
 top of page
Method focusFirstTabCycleMember
Set keyboard focus to first non-root tab cycle member.
Signature
focusFirstTabCycleMember()

 
 top of page
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
focusNextTabCycleMember(intlocal)
Arguments
intlocal

 
 top of page
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
focusPreviousTabCycleMember(intlocal)
Arguments
intlocal

 
 top of page
Method getAbsolutePositionString
Signature
getAbsolutePositionString():String
Returns
String

 
 top of page
Method getAbsolutePositionX
Signature
getAbsolutePositionX():float
Returns
float

 
 top of page
Method getAbsolutePositionY
Signature
getAbsolutePositionY():float
Returns
float

 
 top of page
Method getAlignment
Signature
getAlignment():int
Returns
int

 
 top of page
Method getAlpha
Signature
getAlpha():int
Returns
int

 
 top of page
Method getDefaultPreferredSizeX
Signature
getDefaultPreferredSizeX():float
Returns
float

 
 top of page
Method getDefaultPreferredSizeY
Signature
getDefaultPreferredSizeY():float
Returns
float

 
 top of page
Method getGeometry4f
Signature
getGeometry4f():ui::Geometry4f
Returns

 
 top of page
Method getGeometryString
Signature
getGeometryString():String
Returns
String

 
 top of page
Method getLayerId
Signature
getLayerId():String
Returns
String

 
 top of page
Method getLayout
Return the layout of this layer.
Signature
getLayout()

 
 top of page
Method getLayoutFirstChild
Signature
getLayoutFirstChild():ui::Layer
Returns

 
 top of page
Method getLayoutHints
Signature
getLayoutHints():int
Returns
int

 
 top of page
Method getLayoutSizeX
Signature
getLayoutSizeX():float
Returns
float

 
 top of page
Method getLayoutSizeY
Signature
getLayoutSizeY():float
Returns
float

 
 top of page
Method getLayoutWeightX
Signature
getLayoutWeightX():float
Returns
float

 
 top of page
Method getLayoutWeightY
Signature
getLayoutWeightY():float
Returns
float

 
 top of page
Method getMinimumSizePadX
Signature
getMinimumSizePadX():float
Returns
float

 
 top of page
Method getMinimumSizePadY
Signature
getMinimumSizePadY():float
Returns
float

 
 top of page
Method getMinimumSizeString
Signature
getMinimumSizeString():String
Returns
String

 
 top of page
Method getMinimumSizeX
Signature
getMinimumSizeX():float
Returns
float

 
 top of page
Method getMinimumSizeY
Signature
getMinimumSizeY():float
Returns
float

 
 top of page
Method getNumChildLayers
Signature
getNumChildLayers():int
Returns
int

 
 top of page
Method getPadBottom
Signature
getPadBottom():float
Returns
float

 
 top of page
Method getPadLeft
Signature
getPadLeft():float
Returns
float

 
 top of page
Method getPadRight
Signature
getPadRight():float
Returns
float

 
 top of page
Method getPadTop
Signature
getPadTop():float
Returns
float

 
 top of page
Method getParent
Signature
getParent():ui::Layer
Returns

 
 top of page
Method getParentLayerType
Signature
getParentLayerType(Objecttype)
 :ui::Layer
Arguments
Objecttype
Returns

 
 top of page
Method getPositionString
Signature
getPositionString():String
Returns
String

 
 top of page
Method getPositionX
Signature
getPositionX():float
Returns
float

 
 top of page
Method getPositionY
Signature
getPositionY():float
Returns
float

 
 top of page
Method getPreferredSizePadX
Signature
getPreferredSizePadX():float
Returns
float

 
 top of page
Method getPreferredSizePadY
Signature
getPreferredSizePadY():float
Returns
float

 
 top of page
Method getPreferredSizeString
Signature
getPreferredSizeString():String
Returns
String

 
 top of page
Method getPreferredSizeX
Signature
getPreferredSizeX():float
Returns
float

 
 top of page
Method getPreferredSizeY
Signature
getPreferredSizeY():float
Returns
float

 
 top of page
Method getRoot
Signature
getRoot():ui::Layer
Returns

 
 top of page
Method getScreenRegion
Return the rectangular screen region occupied by this layer
Signature
getScreenRegion():ui::Rectangle2f
Returns

 
 top of page
Method getSize
Signature
getSize(ui::Size2fretSz)
Arguments
ui::Size2fretSz

 
 top of page
Method getSizeGroup
Signature
getSizeGroup():ui::SizeGroup
Returns

 
 top of page
Method getSizePadX
Signature
getSizePadX():float
Returns
float

 
 top of page
Method getSizePadY
Signature
getSizePadY():float
Returns
float

 
 top of page
Method getSizeString
Signature
getSizeString():String
Returns
String

 
 top of page
Method getSizeX
Signature
getSizeX():float
Returns
float

 
 top of page
Method getSizeY
Signature
getSizeY():float
Returns
float

 
 top of page
Method getTabCycleOrder
Returns sorting order in tabcycleroot list. Should return -1 if this layer is not focusable.
Signature
getTabCycleOrder():int
Returns
int

 
 top of page
Method getToolTipCaption
Signature
getToolTipCaption():String
Returns
String

 
 top of page
Method getToolTipOffsetX
Signature
getToolTipOffsetX():float
Returns
float

 
 top of page
Method getTotalNumChildLayers
Signature
getTotalNumChildLayers():int
Returns
int

 
 top of page
Method getUserData
Signature
getUserData():Object
Returns
Object

 
 top of page
Method grabKeyboardFocus
Helper method to delegate key input to this layer.
Signature
grabKeyboardFocus()
Description
Only one layer at a time may have the keyboard focus.

 
 top of page
Method handleDrawOverlays
Signature
handleDrawOverlays()

 
 top of page
Method handleNewTabCycleFocus
Signature
handleNewTabCycleFocus(Objectn)
Arguments
Objectn

 
 top of page
Method hasChildLayer
Query whether this layer has the given child layer.
Signature
hasChildLayer(ui::Layerl)
 :int
Arguments
ui::Layerl
Returns
int

 
 top of page
Method hasDirectChildLayer
Query whether this layer has the given child layer. Do not search recursively.
Signature
hasDirectChildLayer(Objectl)
 :int
Arguments
Objectl
Returns
int

 
 top of page
Method hasKeyboardFocus
Query whether this layer currently has the keyboard focus
Signature
hasKeyboardFocus():int
Returns
int

 
 top of page
Method hasMouseFocus
Query whether this layer currently has the mouse focus
Signature
hasMouseFocus():int
Returns
int

 
 top of page
Method hasParent
Query whether l is a parent of this layer.
Signature
hasParent(Objectl)
 :int
Arguments
Objectl
Returns
int

 
 top of page
Method hasParentOrIs
Signature
hasParentOrIs(Objectl)
 :int
Arguments
Objectl
Returns
int

 
 top of page
Method hide
Hide layer. Only used for dialogs/windows/popups.
Signature
hide()

 
 top of page
Method hideToolTip
Signature
hideToolTip()

 
 top of page
Method hierarchyHasKeyboardFocus
Signature
hierarchyHasKeyboardFocus():int
Returns
int

 
 top of page
Method invalidateAbsolutePositions
Signature
invalidateAbsolutePositions()

 
 top of page
Method invalidateChildContainerMinSizeCaches
Recursively invalidate minimum size caches of all container-like child layers.
Signature
invalidateChildContainerMinSizeCaches()

 
 top of page
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
invalidateMinimumSizes()

 
 top of page
Method invalidateMinSizeCache
Helper method to invalidate the current minimum size
Signature
invalidateMinSizeCache()

 
 top of page
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
invalidatePreferredSizes()

 
 top of page
Method invalidateSizeCache
Helper method to invalidate the current preferred/minimum size
Signature
invalidateSizeCache()

 
 top of page
Method invalidateSizeCaches
Recursively invalidate preferred and minimum size fields so that they are recalculated the next time they are accessed.
Signature
invalidateSizeCaches()

 
 top of page
Method invalidateSizeGroupMemberSizes
Signature
invalidateSizeGroupMemberSizes()

 
 top of page
Method is3d
Signature
is3d():int
Returns
int

 
 top of page
Method isEditable
Signature
isEditable():int
Returns
int

 
 top of page
Method isLayoutMinSweepPass
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)
Signature
isLayoutMinSweepPass():int
Returns
int

 
 top of page
Method isModal
This is used to implement dialog windows that make all other floating layers
Signature
isModal():int
Returns
int
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!

 
 top of page
Method isMouseFocusLocked
Signature
isMouseFocusLocked():int
Returns
int

 
 top of page
Method isMouseOver
Signature
isMouseOver():int
Returns
int

 
 top of page
Method isPopup
Return true if the floating layer should be closed when the user clicks outside the layer area (handleNonChildMouseOver)
Signature
isPopup():int
Returns
int

 
 top of page
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
isTabCycleMember():int
Returns
int

 
 top of page
Method isTabCycleProxy
Query whether the layer is cycleroot and active cyclemember at the same time, e.g. a TabbedView.
Signature
isTabCycleProxy():int
Returns
int

 
 top of page
Method isTabCycleRoot
Query whether this layer manages a focus cycle list for its child layers.
Signature
isTabCycleRoot():int
Returns
int

 
 top of page
Method isTranslucent
Signature
isTranslucent():int
Returns
int

 
 top of page
Method layerAt2f
Signature
layerAt2f(floatx,
  floaty 
  )  
 :ui::Layer
Arguments
floatx
floaty
Returns

 
 top of page
Method layoutHierarchy
Layout child layers. Assumes that this layer is already layouted.
Signature
layoutHierarchy(intbInvalidateSizeCaches,
  intbLayoutFinal 
  )  
Arguments
intbInvalidateSizeCaches
intbLayoutFinal

 
 top of page
Method loseKeyboardFocus
Lose keyboard focus (if this layer has it), do not generate onKeyboardFocusLost() event!
Signature
loseKeyboardFocus()

 
 top of page
Method loseMouseFocus
Lose mouse focus (if this layer has it), do not generate onMouseLeave() event!
Signature
loseMouseFocus()

 
 top of page
Method moveChildLayerToTop
Signature
moveChildLayerToTop(Objectl)
Arguments
Objectl

 
 top of page
Method moveToPosition2f
Signature
moveToPosition2f(floatx,
  floaty 
  )  
Arguments
floatx
floaty

 
 top of page
Method newToolTip
Instantiate and return new ToolTip object. The ToolTip instance is deleted when the tooltip is hidden.
Signature
newToolTip():ui::ToolTip
Returns

 
 top of page
Method onAcceleratorKey
Called if the given accelerator key has been pressed.
Signature
onAcceleratorKey(ui::AcceleratorKeyk)
Arguments

 
 top of page
Method onBeginTriadKeyMode
Called to inform the keyboard focus layer that the user has entered the 'magic' escape sequence (lctrl-x).
Signature
onBeginTriadKeyMode():int
Returns
int

 
 top of page
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
onChildMouseEnter(ui::MouseEventev)
Arguments

 
 top of page
Method onDraw
The onDraw() method is called when the layer region needs to be repainted.
Signature
onDraw()

 
 top of page
Method onDrawOverlays
Called when FBO compositing is enabled.
Signature
onDrawOverlays()

 
 top of page
Method onDropFiles
Called when one or many files have been dropped on this layer
Signature
onDropFiles(StringArrayfileNames)
 :int
Arguments
StringArrayfileNames
Returns
int

 
 top of page
Method onEndTriadKeyMode
Called to inform the keyboard focus layer that the 'magic' escape sequence (lctrl-x) - ? has finished.
Signature
onEndTriadKeyMode(Keyk)
 :int
Arguments
Keyk
Returns
int

 
 top of page
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
onKey(Keykey)
 :int
Arguments
Keykey
Returns
int

 
 top of page
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
onKeyboardFocus()

 
 top of page
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
onKeyboardFocusLost(intbQuiet)
Arguments
intbQuiet

 
 top of page
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
onLookAndFeelChanged()

 
 top of page
Method onMouse
Signature
onMouse(ui::MouseEventev)
 :int
Arguments
Returns
int

 
 top of page
Method onMouseBeginDrag
Signature
onMouseBeginDrag(ui::MouseEventdragStart,
  ui::MouseEventev 
  )  
 :int
Arguments
ui::MouseEventdragStart
ui::MouseEventev
Returns
int

 
 top of page
Method onMouseCancelDrag
Signature
onMouseCancelDrag(ui::MouseEventev)
Arguments

 
 top of page
Method onMouseClick
Signature
onMouseClick(ui::MouseEventev)
 :int
Arguments
Returns
int

 
 top of page
Method onMouseDoubleClick
Signature
onMouseDoubleClick(ui::MouseEventev)
 :int
Arguments
Returns
int

 
 top of page
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
onMouseDrag(ui::MouseEventlastEv,
  ui::MouseEventcurrentEv 
  )  
 :int
Arguments
ui::MouseEventlastEv
ui::MouseEventcurrentEv
Returns
int

 
 top of page
Method onMouseEndDrag
Signature
onMouseEndDrag(ui::MouseEventev)
Arguments

 
 top of page
Method onMouseEnter
Signature
onMouseEnter(ui::MouseEventev)
 :int
Arguments
Returns
int

 
 top of page
Method onMouseFocus
Signature
onMouseFocus()

 
 top of page
Method onMouseHold
Called when a mouse button is pressed and held down for MOUSE_HOLD_DELAY milliseconds without moving the mouse pointer.
Signature
onMouseHold(ui::MouseEventstartEv)
 :int
Arguments
ui::MouseEventstartEv
Returns
int

 
 top of page
Method onMouseLeave
Signature
onMouseLeave(ui::MouseEventev)
 :int
Arguments
Returns
int

 
 top of page
Method onMouseUnfocus
Signature
onMouseUnfocus()

 
 top of page
Method onOpen
The onOpen() method is called when the layer needs to update
Signature
onOpen()
Description
(re-)initialize its Textures, DisplayLists and vertex/color/index/.. OpenGL arrays.

 
 top of page
Method onResize
Called when the layer has been resized to its final size.
Signature
onResize()

 
 top of page
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
onTabFocus()

 
 top of page
Method onTriadKey
Called after key has been entered after lctrl-x escape sequence.
Signature
onTriadKey(Keyk)
 :int
Arguments
Keyk
Returns
int

 
 top of page
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
onTriadKeyTimeout():int
Returns
int

 
 top of page
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
onUIActivate()

 
 top of page
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
onUIDeactivate()

 
 top of page
Method popParentViewPaneScissors
Signature
popParentViewPaneScissors()

 
 top of page
Method printHierarchy
Signature
printHierarchy()

 
 top of page
Method provideAction
Signature
provideAction(ui::ActionprovidedAction)
Arguments
ui::ActionprovidedAction

 
 top of page
Method pushParentViewPaneScissors
Signature
pushParentViewPaneScissors()

 
 top of page
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
recursiveBuildTabCycleLists()

 
 top of page
Method recursiveFocusTabCycleMember
Signature
recursiveFocusTabCycleMember(Objectactive,
  intdir,
  intlocal 
  )  
 :int
Arguments
Objectactive
intdir
intlocal
Returns
int

 
 top of page
Method recursiveHideToolTips
Signature
recursiveHideToolTips()

 
 top of page
Method recursiveInvalidateSizeGroupMemberSizes
Signature
recursiveInvalidateSizeGroupMemberSizes()

 
 top of page
Method recursiveOnLookAndFeelChanged
Do not call directly. This is called by @UI.SetLookAndFeel().
Signature
recursiveOnLookAndFeelChanged()

 
 top of page
Method recursiveOnOpen
Signature
recursiveOnOpen()

 
 top of page
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
recursiveOnResize()

 
 top of page
Method recursiveSetEditable
Recursively invalidate preferred and minimum size fields so that they are recalculated the next time they are accessed.
Signature
recursiveSetEditable(intbEditable)
Arguments
intbEditable

 
 top of page
Method recursiveSetEnableCursorKeyTabCycling
Signature
recursiveSetEnableCursorKeyTabCycling(intbEnabled)
Arguments
intbEnabled

 
 top of page
Method redraw
Redraw this layer
Signature
redraw()

 
 top of page
Method redrawAll
Redraw all layers. Also see UI.RedrawAll()
Signature
redrawAll()

 
 top of page
Method relayout
Signature
relayout()

 
 top of page
Method removeActionConsumer
Signature
removeActionConsumer(ui::ActionConsumerconsumer)
Arguments
ui::ActionConsumerconsumer

 
 top of page
Method removeAllOverlays
Signature
removeAllOverlays()

 
 top of page
Method removeChildHierarchy
Recursively remove all children
Signature
removeChildHierarchy()

 
 top of page
Method removeChildLayer
Signature
removeChildLayer(Objectl)
Arguments
Objectl

 
 top of page
Method removeChildren
Remove children of this layer (no recursion)
Signature
removeChildren()

 
 top of page
Method removeOverlay
Signature
removeOverlay(Objectl)
Arguments
Objectl

 
 top of page
Method resizeToMinimum
Signature
resizeToMinimum()

 
 top of page
Method restartToolTipTimer
Signature
restartToolTipTimer()

 
 top of page
Method restoreGeometryIfValid
Signature
restoreGeometryIfValid(ui::Geometry4fgeo)
 :int
Arguments
Returns
int

 
 top of page
Method revertCursor
Signature
revertCursor(Stringname)
Arguments
Stringname

 
 top of page
Method scheduleToolTipTimer
Signature
scheduleToolTipTimer()

 
 top of page
Method setAlignment
Signature
setAlignment(intalignment)
Arguments
intalignment

 
 top of page
Method setAlpha
Signature
setAlpha(inta)
Arguments
inta

 
 top of page
Method setDefaultInnerPadding
Signature
setDefaultInnerPadding()

 
 top of page
Method setEditable
Signature
setEditable(intbEditable)
Arguments
intbEditable

 
 top of page
Method setEnableForceMinimumSize
Signature
setEnableForceMinimumSize(intbX,
  intbY 
  )  
Arguments
intbX
intbY

 
 top of page
Method setEnableForceMinimumSizeX
Signature
setEnableForceMinimumSizeX(intbX)
Arguments
intbX

 
 top of page
Method setEnableForceMinimumSizeY
Signature
setEnableForceMinimumSizeY(intbY)
Arguments
intbY

 
 top of page
Method setGeometry
Signature
setGeometry(floatpx,
  floatpy,
  floatsx,
  floatsy 
  )  
Arguments
floatpx
floatpy
floatsx
floatsy

 
 top of page
Method setGeometry4f
Signature
setGeometry4f(ui::Geometry4fgeo)
Arguments

 
 top of page
Method setLayerId
Signature
setLayerId(Stringid)
Arguments
Stringid

 
 top of page
Method setLayout
Set a Layout for this Layer.
Signature
setLayout(ui::Layoutl)
Arguments

 
 top of page
Method setLayoutHints
Signature
setLayoutHints(inthints)
Arguments
inthints

 
 top of page
Method setLayoutWeight2f
Signature
setLayoutWeight2f(floatx,
  floaty 
  )  
Arguments
floatx
floaty

 
 top of page
Method setLayoutWeightX
Signature
setLayoutWeightX(floatwx)
Arguments
floatwx

 
 top of page
Method setLayoutWeightY
Signature
setLayoutWeightY(floatwy)
Arguments
floatwy

 
 top of page
Method setManualPreferredSize2f
Signature
setManualPreferredSize2f(floatw,
  floath 
  )  
Arguments
floatw
floath

 
 top of page
Method setManualPreferredSizeX
Signature
setManualPreferredSizeX(floatw)
Arguments
floatw

 
 top of page
Method setManualPreferredSizeY
Signature
setManualPreferredSizeY(floath)
Arguments
floath

 
 top of page
Method setMinimumSize2f
Signature
setMinimumSize2f(floatw,
  floath 
  )  
Arguments
floatw
floath

 
 top of page
Method setMinimumSizeX
Signature
setMinimumSizeX(floatx)
Arguments
floatx

 
 top of page
Method setMinimumSizeY
Signature
setMinimumSizeY(floaty)
Arguments
floaty

 
 top of page
Method setPadBottom
Signature
setPadBottom(floatbottom)
Arguments
floatbottom

 
 top of page
Method setPadding4f
Signature
setPadding4f(floattop,
  floatleft,
  floatbottom,
  floatright 
  )  
Arguments
floattop
floatleft
floatbottom
floatright

 
 top of page
Method setPadLeft
Signature
setPadLeft(floatleft)
Arguments
floatleft

 
 top of page
Method setPadRight
Signature
setPadRight(floatright)
Arguments
floatright

 
 top of page
Method setPadTop
Signature
setPadTop(floattop)
Arguments
floattop

 
 top of page
Method setPosition2f
Signature
setPosition2f(floatx,
  floaty 
  )  
Arguments
floatx
floaty

 
 top of page
Method setPositionX
Signature
setPositionX(floatx)
Arguments
floatx

 
 top of page
Method setPositionY
Signature
setPositionY(floaty)
Arguments
floaty

 
 top of page
Method setPreferredSize2f
Signature
setPreferredSize2f(floatw,
  floath 
  )  
Arguments
floatw
floath

 
 top of page
Method setPreferredSizeX
Signature
setPreferredSizeX(floatw)
Arguments
floatw

 
 top of page
Method setPreferredSizeY
Signature
setPreferredSizeY(floath)
Arguments
floath

 
 top of page
Method setRequiredSize2f
Force layer size to (_w; _h)
Signature
setRequiredSize2f(floatw,
  floath 
  )  
Arguments
floatw
floath

 
 top of page
Method setRequiredSizeX
Signature
setRequiredSizeX(floatw)
Arguments
floatw

 
 top of page
Method setRequiredSizeY
Signature
setRequiredSizeY(floath)
Arguments
floath

 
 top of page
Method setSize2f
Signature
setSize2f(floatx,
  floaty 
  )  
Arguments
floatx
floaty

 
 top of page
Method setSizeGroup
Signature
setSizeGroup(ui::SizeGroupsg)
Arguments

 
 top of page
Method setSizeX
Signature
setSizeX(floatx)
Arguments
floatx

 
 top of page
Method setSizeY
Signature
setSizeY(floaty)
Arguments
floaty

 
 top of page
Method setTabCycleOrder
Signature
setTabCycleOrder(intorder)
Arguments
intorder

 
 top of page
Method setToolTipCaption
Signature
setToolTipCaption(StringtooltipCaption)
Arguments
StringtooltipCaption

 
 top of page
Method setUserData
Signature
setUserData(Objectdata)
Arguments
Objectdata

 
 top of page
Method showCursor
Signature
showCursor(Stringname)
Arguments
Stringname

 
 top of page
Method showToolTip
Signature
showToolTip()

 
 top of page
Method unlinkChildLayer
Signature
unlinkChildLayer(Objectl)
 :ui::Layer
Arguments
Objectl
Returns

 
 top of page
Method unlinkFirstChild
Signature
unlinkFirstChild():ui::Layer
Returns

 
 top of page
Method unlinkNext
Signature
unlinkNext():ui::Layer
Returns

 
 top of page
Method unlinkUserData
Signature
unlinkUserData():Object
Returns
Object

 
 top of page
Method wantKeyboardFocus
Signature
wantKeyboardFocus():int
Returns
int

 
 top of page
Method wantKeyRepeat
Signature
wantKeyRepeat(Keyk)
 :int
Arguments
Keyk
Returns
int

 
 top of page
Method wantShadeModal
Signature
wantShadeModal():int
Returns
int

 
 top of page
Method wantToolTipNearMouse
Signature
wantToolTipNearMouse():int
Returns
int

 
 top of page
Method wantTriadKeyMode
Return true if layer supports lctrl-x escape sequence.
Signature
wantTriadKeyMode():int
Returns
int

 
 top of page
Method wantTriadKeyRepeat
Check whether the given key shall be repeat (first non-repeat key exits mode)
Signature
wantTriadKeyRepeat(Keyk)
 :int
Arguments
Keyk
Returns
int

 
 top of page
Method ~Layer
Signature
~Layer()

 
 top of page
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)

 

Project Modules:MAbstractXMLForm , MAcceleratorKey , MAcceleratorList , MAction , MActionConsumer , MActionProvider , MBezierEdit , MButton , MCharFilter , MCharFilterFloat , MCharFilterFloatExpr , MCharFilterHex , MCharFilterHexExpr , MCheckBox , MChoiceDialog , MColorBox , MColorButton , MComboBox , MComboBoxTM , MComposite , MControl , MCursorShapes , MDial , MDialog , MDynamicPopupMenuAction , MFBO , MFloatAction , MFloatField , MFloatingLayer , MFloatParam , MFloatParamEditor , MFont , MFontResource , MForm , MFT2Face , MFT2FontCache , MFT2Glyph , MGeometry4f , MHiddenPanel , MHSVColorPicker , MIcon , MIconCache , MInfoDialog , MIntAction , MKeyAction , MLabel , MLayer , MLayerSwitch , MLayout , MLookAndFeel , MLookAndFeel_DarkFawn , MLookAndFeel_Gray , MLookAndFeel_LightFawn , MLookAndFeel_LightGray , MMouseEvent , MOpaquePanel , MPanel , MPNGIcon , MPoint2f , MPopupMenu , MPopupMenuBar , MPopupMenuBarButton , MPopupMenuButton , MPopupMenuCheckButton , MPopupMenuFolderButton , MPopupMenuSeparator , MPopupMenuWindowDock , MRadioButton , MRadioButtonGroup , MRectangle2f , MRepeatButton , MScroller , MScrollPane , MSize2f , MSizeGroup , MSizeGroupX , MSizeGroupXY , MSizeGroupY , MSlider , MSpacer , MSplitPane , MStatusBar , MStringAction , MStringDialog , MSuperBorderLayout , MTabbedView , MTableCellEditor , MTableCellEditorCheckBox , MTableCellEditorComboBox , MTableCellEditorFloatParam , MTableModel , MTableView , MTableViewData , MTableViewHeader , MTabSwitch , MTextEdit , MTextEditDialog , MTextField , MTextFieldIncDec , MTextInputDialog , MTextView , MTimerAction , MTitledPanel , MToolTip , MTransparentPanel , MTreeTableModel , MTreeTableNode , MUI , MUIConstants , MUIPluginLoader , MUIRenderer , MValueAction , MVector2f , MView , MViewPane , MWindow , MWindowDock , MWindowTitleBar , MXFMObject , MXMLForm 
Project Classes:ColorBox , HSVColorPicker , ui::AbstractXMLForm , ui::AcceleratorKey , ui::AcceleratorList , ui::Action , ui::ActionConsumer , ui::ActionProvider , ui::BezierEdit , ui::BezierEditState , ui::BezierHistory , ui::BorderLayout , ui::Button , ui::CharFilter , ui::CharFilterFloat , ui::CharFilterFloatExpr , ui::CharFilterHex , ui::CharFilterHexExpr , ui::CheckBox , ui::ChoiceDialog , ui::ColorButton , ui::ComboBox , ui::ComboBoxPopup , ui::ComboBoxTM , ui::Composite , ui::Control , ui::CursorShapes , ui::Dial , ui::Dialog , ui::DynamicPopupMenuAction , ui::FBO , ui::FloatAction , ui::FloatField , ui::FloatingLayer , ui::FloatParam , ui::FloatParamEditor , ui::Font , ui::FontResource , ui::Form , ui::FT2Face , ui::FT2FontCache , ui::FT2FontResource , ui::FT2Glyph , ui::FT2LocalFileFontResource , ui::FT2PakFileFontResource , ui::Geometry4f , ui::HiddenPanel , ui::Icon , ui::IconCache , ui::InfoDialog , ui::IntAction , ui::KeyAction , ui::KeyRepeatAction , ui::KeyRepeatConsumer , ui::Label , ui::Layer , ui::LayerSwitch , ui::Layout , ui::LookAndFeel , ui::LookAndFeel_DarkFawn , ui::LookAndFeel_Gray , ui::LookAndFeel_LightFawn , ui::LookAndFeel_LightGray , ui::MouseEvent , ui::MouseHoldAction , ui::MouseHoldConsumer , ui::OpaquePanel , ui::Panel , ui::PNGIcon , ui::Point2f , ui::PopupMenu , ui::PopupMenuBar , ui::PopupMenuBarButton , ui::PopupMenuButton , ui::PopupMenuCheckButton , ui::PopupMenuFolderButton , ui::PopupMenuRadioButton , ui::PopupMenuSeparator , ui::PopupMenuWindowDock , ui::RadioButton , ui::RadioButtonGroup , ui::Rectangle2f , ui::RepeatButton , ui::Scroller , ui::ScrollPane , ui::Size2f , ui::SizeGroup , ui::SizeGroupX , ui::SizeGroupXY , ui::SizeGroupY , ui::Slider , ui::Spacer , ui::SplitPane , ui::StatusBar , ui::StatusBarListener , ui::StatusBarMessage , ui::StringAction , ui::StringDialog , ui::StringDialogTextField , ui::SuperBorderLayout , ui::TabbedView , ui::TableCellEditor , ui::TableCellEditorCheckBox , ui::TableCellEditorComboBox , ui::TableCellEditorFloatParam , ui::TableModel , ui::TableView , ui::TableViewData , ui::TableViewHeader , ui::TabSwitch , ui::TabSwitchLabelPanel , ui::TextEdit , ui::TextEditDialog , ui::TextField , ui::TextFieldIncDec , ui::TextInputDialog , ui::TextView , ui::TimerAction , ui::TitledPanel , ui::ToolTip , ui::TransparentPanel , ui::TreeTableModel , ui::TreeTableNode , ui::TriadKeyConsumer , ui::UI , ui::UIConstants , ui::UIRenderer , ui::ValueAction , ui::Vector2f , ui::View , ui::ViewPane , ui::Window , ui::WindowDock , ui::WindowTitleBar , ui::XFMObject , ui::XMLForm 
Project Functions:getTableViewStepSizeDec , getTableViewStepSizeInc , Screen_onApplicationActive , Screen_onClose , Screen_onDraw , Screen_onDropFiles , Screen_onExpose , Screen_onInputFocusActive , Screen_onKeyboard , Screen_onMouse , Screen_onMouseFocusActive , Screen_onOpen , Screen_onResize , Screen_onTimer 
All Namespaces:default , ui 
All Projects:core , debugtext , tkfreetype2 , tkmath , tkmidi , tkopengl , tkportaudio , tksdl , tkui , tkunit 


auto-generated by "DOG", the TkScript document generator. Mon, 28/Dec/2015 14:27:06