index

Class MLayer.Layer

all modules:MAcceleratorKey , MAcceleratorList , Main , MBorderLayout , MButton , MCheckBox , MChoiceDialog , MColorBox , MControl , MCursorShapes , MDialog , MFloatingLayer , MForm , MFT2Face , MFT2FontCache , MFT2Glyph , MIconCache , MInfoDialog , MLabel , MLayer , MLookAndFeel , MLookAndFeel_DarkFawn , MLookAndFeel_Gray , MLookAndFeel_LightFawn , MLookAndFeel_LightGray , MMouseEvent , MPanel , MPNGIcon , MPoint2f , MPopupMenu , MPopupMenuBar , MPopupMenuBarButton , MPopupMenuButton , MPopupMenuCheckButton , MPopupMenuFolderButton , MPopupMenuSeparator , MRadioButton , MRadioButtonGroup , MRectangle2f , MRepeatButton , MScroller , MScrollPane , MSize2f , MSlider , MSplitPane , MTabbedView , MTest3dLayer , MTestSuperBorderLayoutForm , MTestUIRendererForm , MTextEdit , MTextField , MTextInputDialog , MTextView , MTimerAction , MTitledPanel , MToolTip , MTransparentPanel , MUI , MUIPrimitives , MUIRenderer , MVector2f , MView , MViewPane , MWindow , MWindowTitleBar , MXFMObject , MXMLForm , ui_abstract 
all classes:AbstractAction , AbstractActionAdapter , AbstractActionConsumer , AbstractActionPerformer , AbstractActionProvider , AbstractBinaryStringValidator , AbstractButton , AbstractCharsetStringValidator , AbstractCheckBox , AbstractCheckBoxGroup , AbstractComboBox , AbstractDecimalStringValidator , AbstractDesktop , AbstractDialog , AbstractDisplayObject , AbstractFloatStringValidator , AbstractFontCache , AbstractForm , AbstractHexadecimalStringValidator , AbstractHorizontalScroller , AbstractHorizontalSlider , AbstractKnob , AbstractLabel , AbstractLayer , AbstractMenu , AbstractMenuBar , AbstractMenuItem , AbstractOptionGroup , AbstractPage , AbstractPanel , AbstractPasswordStringValidator , AbstractPerspective , AbstractRadioButtonGroup , AbstractScriptIdentifierStringValidator , AbstractScroller , AbstractScrollPane , AbstractSlider , AbstractStringLengthValidator , AbstractStringValidator , AbstractTabbedPane , AbstractTextArea , AbstractTextField , AbstractTreeView , AbstractVerticalScroller , AbstractVerticalSlider , AbstractView , AbstractViewPane , AbstractViewSite , AbstractWindow , AbstractXMLForm , AcceleratorKey , AcceleratorList , Action , BorderLayout , Button , CardLayout , CDialogTest_ChoiceYesNo , CDialogTest_ChoiceYesNoCancel , CDialogTest_Error , CDialogTest_Idea , CDialogTest_Info , CDialogTest_InfoCustom , CDialogTest_Success , CDialogTest_TextInput , CheckBox , ChoiceDialog , ColorBox , Control , CPopupMenuTest , CStatic , CursorShapes , Dialog , FloatAction , FloatingLayer , FlowLayout , Font , FontResource , Form , FT2Face , FT2FontCache , FT2FontResource , FT2Glyph , FT2LocalFileFontResource , FT2PakFileFontResource , Icon , IconCache , InfoDialog , IntAction , KeyRepeatAction , KeyRepeatConsumer , Label , Layer , Layout , LookAndFeel , LookAndFeel_DarkFawn , LookAndFeel_Gray , LookAndFeel_LightFawn , LookAndFeel_LightGray , MouseEvent , MouseHoldAction , MouseHoldConsumer , MyForm , MyPanel , Panel , PNGIcon , Point2f , PopupMenu , PopupMenuBar , PopupMenuBarButton , PopupMenuButton , PopupMenuCheckButton , PopupMenuFolderButton , PopupMenuSeparator , RadioButton , RadioButtonGroup , Rectangle2f , RedDotPanel , RepeatButton , Scroller , ScrollPane , Size2f , Slider , SplitPane , StringAction , SuperBorderLayout , TabbedView , Test3dLayer , TestLayer , TestSuperBorderLayoutForm , TestUIRendererControl , TestUIRendererForm , TextEdit , TextField , TextInputDialog , TextView , TimerAction , TitledPanel , ToolTip , TransparentPanel , UI , UIConstants , UIPrimitives , UIPrimitivesTestLayer , UIRenderer , Vector2f , View , ViewPane , Window , WindowTitleBar , XFMObject , XMLForm 

Synopsis

  Base classes:
  Derived classes:
  Functions:
  Methods:
  Constants:
Description:
 

Function FindFirstNonRootTabCycleMember

Synopsis:  

Arguments: Returns:  Layer
 
 top of page

Function IsTabCycleKey

Synopsis:  

Arguments: Returns:  int
 
 top of page

Method addActionConsumer

Synopsis:  

Arguments:
 
 top of page

Method addChildLayer

Synopsis:  

Arguments:
 
 top of page

Method addLayer

Synopsis:  

Arguments:
 
 top of page

Method addTabCycleMembersToList

Synopsis:  

Arguments:
 
 top of page

Method addXFMChild

Synopsis:  

Arguments:
 
 top of page

Method addXFMObject

Synopsis:  

Arguments:
 
 top of page

Method allowSubPixelPosition

Synopsis:  Query whether layer allows sub-pixel placement. Allowing this can cause text rendering artefacts for example so the default is not to allow it.
Returns:  int
 
 top of page

Method allowSubPixelSize

Synopsis:  Query whether layer allows sub-pixel size.
Returns:  int
 
 top of page

Method appendHierarchyString

Synopsis:  

Arguments: Returns:  String
 
 top of page

Method beginXFMTag

Synopsis:  

Arguments: Returns:  int
 
 top of page

Method buildTabCycleList

Synopsis:  Scan child layers and build tab cycle list. Usually implemented by container-like layers (e.g. Panels).

 
 top of page

Method calcAbsolutePosition

Synopsis:  

Arguments:
 
 top of page

Method calcPreferredSize

Synopsis:  
Returns:  int
 
 top of page

Method calcPreferredSizeX

Synopsis:  
Returns:  int
 
 top of page

Method calcPreferredSizeY

Synopsis:  
Returns:  int
 
 top of page

Method callReopen

Synopsis:  

 
 top of page

Method consumeAction

Synopsis:  

Arguments: Returns:  int
 
 top of page

Method containsAbsoluteXY

Synopsis:  Check whether this layer contains the given absolute coordinate.

Arguments: Returns:  int
 
 top of page

Method drawChildHierarchy

Synopsis:  

Arguments:
 
 top of page

Method drawHierarchy

Synopsis:  

Arguments:
 
 top of page

Method endXFMTag

Synopsis:  

Arguments:
 
 top of page

Method findTabCycleRoot

Synopsis:  Find parent layer that is a a tab cycle root.
Returns:  Layer
 
 top of page

Method focusNextTabCycleMember

Synopsis:  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.

Arguments:
 
 top of page

Method focusPreviousTabCycleMember

Synopsis:  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.

Arguments:
 
 top of page

Method getAbsolutePositionString

Synopsis:  
Returns:  String
 
 top of page

Method getAbsolutePositionX

Synopsis:  
Returns:  float
 
 top of page

Method getAbsolutePositionY

Synopsis:  
Returns:  float
 
 top of page

Method getAlignment

Synopsis:  
Returns:  int
 
 top of page

Method getAlpha

Synopsis:  
Returns:  int
 
 top of page

Method getGeometryString

Synopsis:  
Returns:  String
 
 top of page

Method getLayerId

Synopsis:  
Returns:  String
 
 top of page

Method getLayout

Synopsis:  Return the layout of this layer.

 
 top of page

Method getLayoutFirstChild

Synopsis:  
Returns:  Layer
 
 top of page

Method getLayoutHints

Synopsis:  
Returns:  int
 
 top of page

Method getLayoutSizeX

Synopsis:  
Returns:  float
 
 top of page

Method getLayoutSizeY

Synopsis:  
Returns:  float
 
 top of page

Method getLayoutWeightX

Synopsis:  
Returns:  float
 
 top of page

Method getLayoutWeightY

Synopsis:  
Returns:  float
 
 top of page

Method getMinimumSizePadX

Synopsis:  
Returns:  float
 
 top of page

Method getMinimumSizePadY

Synopsis:  
Returns:  float
 
 top of page

Method getMinimumSizeX

Synopsis:  
Returns:  float
 
 top of page

Method getMinimumSizeY

Synopsis:  
Returns:  float
 
 top of page

Method getPadBottom

Synopsis:  
Returns:  float
 
 top of page

Method getPadLeft

Synopsis:  
Returns:  float
 
 top of page

Method getPadRight

Synopsis:  
Returns:  float
 
 top of page

Method getPadTop

Synopsis:  
Returns:  float
 
 top of page

Method getParent

Synopsis:  
Returns:  Layer
 
 top of page

Method getPositionString

Synopsis:  
Returns:  String
 
 top of page

Method getPositionX

Synopsis:  
Returns:  float
 
 top of page

Method getPositionY

Synopsis:  
Returns:  float
 
 top of page

Method getPreferredSizePadX

Synopsis:  
Returns:  float
 
 top of page

Method getPreferredSizePadY

Synopsis:  
Returns:  float
 
 top of page

Method getPreferredSizeX

Synopsis:  
Returns:  float
 
 top of page

Method getPreferredSizeY

Synopsis:  
Returns:  float
 
 top of page

Method getRoot

Synopsis:  
Returns:  Layer
 
 top of page

Method getScalingX

Synopsis:  
Returns:  float
 
 top of page

Method getScalingY

Synopsis:  
Returns:  float
 
 top of page

Method getScreenRegion

Synopsis:  Return the rectangular screen region occupied by this layer
Returns:  Rectangle2f
 
 top of page

Method getSizeX

Synopsis:  
Returns:  float
 
 top of page

Method getSizeY

Synopsis:  
Returns:  float
 
 top of page

Method getTabCycleOrder

Synopsis:  Returns sorting order in tabcycleroot list. Should return -1 if this layer is not focusable.
Returns:  int
 
 top of page

Method grabKeyboardFocus

Synopsis:  Helper method to delegate key input to this layer. 
Description:
 
Only one layer at a time may have the keyboard focus.
 
 top of page

Method handleNewTabCycleFocus

Synopsis:  

Arguments:
 
 top of page

Method hasChildLayer

Synopsis:  Query whether this layer has the given child layer.

Arguments: Returns:  int
 
 top of page

Method hasKeyboardFocus

Synopsis:  Query whether this layer currently has the keyboard focus
Returns:  int
 
 top of page

Method hasMouseFocus

Synopsis:  Query whether this layer currently has the mouse focus
Returns:  int
 
 top of page

Method hasParent

Synopsis:  Query whether l is a parent of this layer.

Arguments: Returns:  int
 
 top of page

Method hide

Synopsis:  Hide layer. Only used for dialogs/windows/popups.

 
 top of page

Method hideToolTip

Synopsis:  

 
 top of page

Method invalidateAbsolutePositions

Synopsis:  

 
 top of page

Method isEmptyTabCycleProxy

Synopsis:  
Returns:  int
 
 top of page

Method isModal

Synopsis:  This is used to implement dialog windows that make all other floating layers 
Returns:  intDescription:
 
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

Synopsis:  
Returns:  int
 
 top of page

Method isMouseOver

Synopsis:  
Returns:  int
 
 top of page

Method isPopup

Synopsis:  Return true if the floating layer should be closed when the user clicks outside the layer area
Returns:  int
 
 top of page

Method isTabCycleMember

Synopsis:  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.
Returns:  int
 
 top of page

Method isTabCycleProxy

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

Method isTabCycleRoot

Synopsis:  Query whether this layer manages a focus cycle list for its child layers.
Returns:  int
 
 top of page

Method isTranslucent

Synopsis:  
Returns:  int
 
 top of page

Method Layer

Synopsis:  

 
 top of page

Method layerAt2f

Synopsis:  

Arguments: Returns:  Layer
 
 top of page

Method layoutHierarchy

Synopsis:  Layout child layers. Assumes that this layer is already layouted.

 
 top of page

Method loseKeyboardFocus

Synopsis:  Lose keyboard focus (if this layer has it), do not generate onKeyboardFocusLost() event!

 
 top of page

Method loseMouseFocus

Synopsis:  Lose mouse focus (if this layer has it), do not generate onMouseLeave() event!

 
 top of page

Method moveToPosition2f

Synopsis:  

Arguments:
 
 top of page

Method newToolTip

Synopsis:  Instantiate and return new ToolTip object. The ToolTip instance is deleted when the tooltip is hidden.
Returns:  ToolTip
 
 top of page

Method onAcceleratorKey

Synopsis:  Called if the given accelerator key has been pressed.

Arguments:
 
 top of page

Method onChildMouseEnter

Synopsis:  Called if a child gains the mouse focus. Used for submenus to disable the auto-hide timeout if a submenu child is re-focused.

Arguments:
 
 top of page

Method onDraw

Synopsis:  The onDraw() method is called when the layer region needs to be repainted.

 
 top of page

Method onKey

Synopsis:  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.

Arguments: Returns:  int
 
 top of page

Method onKeyboardFocus

Synopsis:  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.

 
 top of page

Method onKeyboardFocusLost

Synopsis:  The onKeyboardFocusLost() method is called when this layer has lost the keyboard focus; probably because another layer grabbed it.

 
 top of page

Method onLookAndFeelChanged

Synopsis:  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).

 
 top of page

Method onMouse

Synopsis:  

Arguments: Returns:  int
 
 top of page

Method onMouseBeginDrag

Synopsis:  

Arguments: Returns:  int
 
 top of page

Method onMouseClick

Synopsis:  

Arguments: Returns:  int
 
 top of page

Method onMouseDoubleClick

Synopsis:  

Arguments: Returns:  int
 
 top of page

Method onMouseDrag

Synopsis:  Called when onMouseBeginDrag() returned true, the left mouse button is held down and the mouse has moved at least 助IConstants.MOUSE_DRAG_THRESHOLD pixels.

Arguments: Returns:  int
 
 top of page

Method onMouseEndDrag

Synopsis:  

Arguments:
 
 top of page

Method onMouseEnter

Synopsis:  

Arguments: Returns:  int
 
 top of page

Method onMouseFocus

Synopsis:  

 
 top of page

Method onMouseHold

Synopsis:  Called when a mouse button is pressed and held down for 助IConstants.MOUSE_HOLD_DELAY milliseconds without moving the mouse pointer.

Arguments: Returns:  int
 
 top of page

Method onMouseLeave

Synopsis:  

Arguments: Returns:  int
 
 top of page

Method onMouseUnfocus

Synopsis:  

 
 top of page

Method onReopen

Synopsis:  

 
 top of page

Method onTabFocus

Synopsis:  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)

 
 top of page

Method provideAction

Synopsis:  

Arguments:
 
 top of page

Method recursiveBuildTabCycleLists

Synopsis:  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.

 
 top of page

Method recursiveFocusTabCycleMember

Synopsis:  

Arguments: Returns:  int
 
 top of page

Method recursiveOnLookAndFeelChanged

Synopsis:  Do not call directly. This is called by @UI.SetLookAndFeel().

 
 top of page

Method redraw

Synopsis:  Redraw this layer

 
 top of page

Method redrawAll

Synopsis:  Redraw all layers. Also see 助I.RedrawAll

 
 top of page

Method removeActionConsumer

Synopsis:  

Arguments:
 
 top of page

Method removeChildHierarchy

Synopsis:  

 
 top of page

Method removeChildLayer

Synopsis:  

Arguments:
 
 top of page

Method removeChildren

Synopsis:  

 
 top of page

Method revertCursor

Synopsis:  

Arguments:
 
 top of page

Method scheduleToolTipTimer

Synopsis:  

 
 top of page

Method setAlignment

Synopsis:  

Arguments:
 
 top of page

Method setAlpha

Synopsis:  

Arguments:
 
 top of page

Method setGeometry

Synopsis:  

Arguments:
 
 top of page

Method setLayerId

Synopsis:  

Arguments:
 
 top of page

Method setLayout

Synopsis:  Set a Layout for this Layer.

Arguments:
 
 top of page

Method setLayoutHints

Synopsis:  

Arguments:
 
 top of page

Method setLayoutWeight2f

Synopsis:  

Arguments:
 
 top of page

Method setLayoutWeightX

Synopsis:  

Arguments:
 
 top of page

Method setLayoutWeightY

Synopsis:  

Arguments:
 
 top of page

Method setMinimumSize2f

Synopsis:  

Arguments:
 
 top of page

Method setMinimumSizeX

Synopsis:  

Arguments:
 
 top of page

Method setMinimumSizeY

Synopsis:  

Arguments:
 
 top of page

Method setPadBottom

Synopsis:  

Arguments:
 
 top of page

Method setPadding4f

Synopsis:  

Arguments:
 
 top of page

Method setPadLeft

Synopsis:  

Arguments:
 
 top of page

Method setPadRight

Synopsis:  

Arguments:
 
 top of page

Method setPadTop

Synopsis:  

Arguments:
 
 top of page

Method setPosition2f

Synopsis:  

Arguments:
 
 top of page

Method setPositionX

Synopsis:  

Arguments:
 
 top of page

Method setPositionY

Synopsis:  

Arguments:
 
 top of page

Method setPreferredSize2f

Synopsis:  

Arguments:
 
 top of page

Method setPreferredSizeX

Synopsis:  

Arguments:
 
 top of page

Method setPreferredSizeY

Synopsis:  

Arguments:
 
 top of page

Method setRequiredSize2f

Synopsis:  Force layer size to be (_w; _h)

Arguments:
 
 top of page

Method setRequiredSizeX

Synopsis:  

Arguments:
 
 top of page

Method setRequiredSizeY

Synopsis:  

Arguments:
 
 top of page

Method setScaling2f

Synopsis:  

Arguments:
 
 top of page

Method setScalingX

Synopsis:  

Arguments:
 
 top of page

Method setScalingY

Synopsis:  

Arguments:
 
 top of page

Method setSize2f

Synopsis:  

Arguments:
 
 top of page

Method setSizeX

Synopsis:  

Arguments:
 
 top of page

Method setSizeY

Synopsis:  

Arguments:
 
 top of page

Method setTabCycleOrder

Synopsis:  

Arguments:
 
 top of page

Method setToolTipCaption

Synopsis:  

Arguments:
 
 top of page

Method showCursor

Synopsis:  

Arguments:
 
 top of page

Method showToolTip

Synopsis:  

 
 top of page

Method wantKeyRepeat

Synopsis:  

Arguments: Returns:  int
 
 top of page

Method ~Layer

Synopsis:  

 
 top of page

Constant ABS_INVALID (float)

Synopsis:  

Constant DEFAULT_PREFERRED_SIZE_X (int)

Synopsis:  

Constant DEFAULT_PREFERRED_SIZE_Y (int)

Synopsis:  


auto-generated by "DOG", the TkScript document generator. Mon, 21/May/2007 00:21:48