Drag[en]gine Script Module DragonScript  1.23
Dragengine.Gui.Desktop Class Reference

Desktop containing set of windows. More...

Inheritance diagram for Dragengine.Gui.Desktop:
Dragengine.Gui.Container Dragengine.Gui.Widget

Public Member Functions

void addMousePointerListener (MousePointerListener listener)
 Add mouse pointer listener. More...
 
void addWidget (Widget widget)
 Add window to desktop. More...
 
void addWidget (Widget widget, Object settings)
 Add window to desktop. More...
 
void addWindow (Window window)
 Add window to desktop. More...
 
void addWindow (Window window, Object settings)
 Add window to desktop. More...
 
bool allowsChildGrabFocus ()
 Container allows child widgets to grab the focus. More...
 
void clearFocusWidget ()
 
void dispose ()
 Disposes of widget. More...
 
void focusActiveWidgetOfFirstUsableWindow ()
 Focus the active widget of the top window supporting it if possible. More...
 
MousePointerFactory getActiveMousePointer ()
 Active mouse pointer factory or null. More...
 
Window getActiveWindow ()
 Active window or null. More...
 
Desktop getDesktop ()
 
Point getDesktopPosition ()
 Widget position in desktop coordinates. More...
 
Widget getFocusWidget ()
 Focused widget or null. More...
 
GamepadController getGamepadController ()
 Gamepad controller or null. More...
 
Widget getHoverWidget ()
 Widget the mouse hovers above or null. More...
 
bool getIsMouseHidden ()
 Mouse pointer is hidden. More...
 
RectArea getMouseArea ()
 Movement area of mouse pointer or null if not set. More...
 
Widget getMouseCaptureWidget ()
 
Point getMouseLocation ()
 Location of mouse pointer. More...
 
MousePointer getMousePointerInstance ()
 Mouse pointer instance or null. More...
 
Point getNoBorderPosition ()
 Top left position excluding no window border. More...
 
Point getNoBorderSize ()
 Maximum size excluding no window border. More...
 
BorderSize getNoWindowBorder ()
 Area along the borders no window can occupy. More...
 
ToolTipManager getToolTipManager ()
 Tool tip manager or null. More...
 
WindowVirtualKeyboard getWindowVirtualKeyboard ()
 Virtual keyboard window or null. More...
 
void giveUpFocus ()
 
void layoutParent ()
 
Desktop new (int width, int height)
 Create desktop widget. More...
 
Desktop new (int x, int y, int width, int height)
 Create desktop widget. More...
 
Desktop new (Point size)
 Create desktop widget. More...
 
void onMouseMove (MouseEvent event)
 
void onMousePointerChanged (MousePointerEvent event)
 Mouse pointer changed. More...
 
void onMousePointerHidden (MousePointerEvent event)
 Mouse pointer has been hidden. More...
 
void onMousePointerShown (MousePointerEvent event)
 Mouse pointer has been shown. More...
 
void onResize (WidgetEvent event)
 Size changed. More...
 
void processEvent (Event event)
 
void raiseWindowsAlwaysOnTop ()
 Raise windows with getAlwaysOnTop() set. More...
 
void removeAllWidgets ()
 Remove all windows from desktop. More...
 
void removeMousePointerListener (MousePointerListener listener)
 Remove mouse pointer listener. More...
 
void removeWidget (Widget widget)
 Remove window from desktop. More...
 
bool requestCaptureMouse (Widget widget)
 Request to capture the mouse for the specified widget. More...
 
void requestGrabFocus (Widget widget)
 
bool requestReleaseMouse (Widget widget)
 Request to release mouse capture. More...
 
void sendEventToListeners (Event event, bool sendToParent)
 Send event to all appropriate listeners for events of its kind. More...
 
void setActiveMousePointer (MousePointerFactory mousePointer)
 Set active mouse pointer or null. More...
 
void setGamepadController (GamepadController controller)
 Set gamepad controller or null. More...
 
void setIsMouseHidden (bool hidden)
 Set if mouse pointer is hidden. More...
 
void setMouseArea (RectArea area)
 Set movement area of the mouse pointer or null to clear. More...
 
void setMouseLocation (Point location)
 Set location of mouse pointer. More...
 
void setNoWindowBorder (BorderSize size)
 Set area along the borders no window can occupy. More...
 
void setToolTipManager (ToolTipManager tooltipManager)
 Set tool tip manager or null. More...
 
void setWindowVirtualKeyboard (WindowVirtualKeyboard window)
 Set virtual keyboard window or null. More...
 
void warpCenterMouse ()
 Warp mouse pointer centered in desktop. More...
 
void warpCenterMouseIn (Widget widget)
 Warp mouse pointer centered inside widget. More...
 
void warpMouseIn (Widget widget, Point location)
 Warp mouse pointer relative to widget. More...
 
void warpMousePointer (Point location)
 Warp mouse pointer. More...
 
Widget widgetAcceptingInputAt (Point position)
 Widget accepting input at position. More...
 
- Public Member Functions inherited from Dragengine.Gui.Container
void doLayout ()
 
Widget findFocusableWidget ()
 
Widget findLastFocusableWidget ()
 
Widget findWidget (Block ablock)
 Find widget using block or null if not found. More...
 
int getContainerHeight ()
 
Point getContainerSize ()
 
int getContainerWidth ()
 
bool getHasBlockedDoLayout ()
 doLayout calls happened during runWhileBlockingLayout. More...
 
Layout getLayout ()
 
Point getMinimumSize ()
 
Point getMinimumSizeForHeight (int height)
 Minimum size of widget using reference widget height and variable width. More...
 
Point getMinimumSizeForWidth (int width)
 Minimum size of widget using reference widget width and variable height. More...
 
bool getStateChangeNotifyChildren ()
 Notify children if state changed. More...
 
Widget getWidget (int index)
 
Widget getWidgetAt (Point position)
 Widget at coordinates or null if not found. More...
 
int getWidgetCount ()
 
bool hasFocusWidget ()
 Focus widget is inside container somewhere. More...
 
bool hasWidget (Widget widget)
 
int indexOfWidget (Widget widget)
 
Object injectWidget (Object injectValue, Block ablock)
 Process value visiting widgets using block. More...
 
bool isChildVisible (Widget child)
 
bool isMouseInside ()
 Mouse is hovering over this widget. More...
 
void moveWidget (Widget widget, int newPosition)
 
Container new ()
 
Container new (Layout layout)
 Create container with layout. More...
 
Container new (Layout layout, Block blockAddContent)
 Create container with layout calling block to add content. More...
 
Container new (Point position, Point size)
 
Widget nextFocusWidgetAfter (Widget widget)
 Find next widget in the focus cycle that can grab the focus. More...
 
void onGuiThemeChanged ()
 
void onPaddingChanged ()
 Padding changed. More...
 
void onStateChanged (StateChangeEvent event)
 State changed. More...
 
Widget prevFocusWidgetAfter (Widget widget)
 Find previous widget in the focus cycle that can grab the focus. More...
 
void runWhileBlockingLayout (Block ablock)
 Run block while layouting is blocked. More...
 
void setEnabled (bool enabled)
 
void setHasBlockedDoLayout (bool hasBlockedDoLayout)
 Set if doLayout calls happened during runWhileBlockingLayout. More...
 
void setLayout (Layout layout)
 
void setMousePointer (MousePointerFactory mousePointer)
 Set mouse pointer to use. More...
 
void setStateChangeNotifyChildren (bool notify)
 Set to notify children if state changed. More...
 
- Public Member Functions inherited from Dragengine.Gui.Widget
void addDragListener (DragListener listener)
 
void addFocusListener (FocusListener listener)
 Add focus listener. More...
 
void addGamepadListener (GamepadListener listener)
 Add gamepad listener. More...
 
void addKeyListener (KeyListener listener)
 
void addMouseListener (MouseListener listener)
 
void addStateChangeListener (StateChangeListener listener)
 Add state change listener. More...
 
void addWidgetListener (WidgetListener listener)
 Add widget listener. More...
 
bool canGrabFullFocus ()
 
void captureMouse ()
 
void design ()
 Design widget using WidgetDesigner. More...
 
CanvasCreator getBackgroundCanvasCreator ()
 Background canvas creator or null to use background color. More...
 
bool getBlockLayoutParent ()
 Block layoutParent calls. More...
 
Border getBorder ()
 
BorderSize getBorderSize ()
 
RectArea getBoundary ()
 Rectangulare boundary of the widget. More...
 
RectArea getBoundaryWithBorder ()
 Rectangulare boundary of the widget including border. More...
 
bool getCanFocus ()
 
CanvasView getCanvasBackground ()
 
CanvasView getCanvasContent ()
 
CanvasView getCanvasWidget ()
 
Clipboard getClipboard ()
 Clipboard or null to use parent clipboard. More...
 
ColorMatrix getColorTransformation ()
 Color transformation. More...
 
WidgetDesigner getDesigner ()
 Designer. More...
 
String getDesignerSelector ()
 Designer selector. More...
 
bool getEnabled ()
 
MousePointerFactory getFirstMousePointer ()
 First assigned mouse pointer. More...
 
Font getFont ()
 
bool getHasBlockedLayoutParent ()
 layoutParent calls happened during runWhileBlockingLayoutParent. More...
 
bool getHasFocus ()
 
int getHeight ()
 Height of widget. More...
 
RangeModel getHorizontalRangeModel ()
 Horizontal range model for viewports to synchronize the horizontal scrollbar. More...
 
Point getLocalMouseLocation ()
 Parent desktop mouse location in widget coordinates. More...
 
Point getMinimumSizeWithBorder ()
 
Point getMinimumSizeWithBorderForHeight (int height)
 Minimum size of widget with border using reference height. More...
 
Point getMinimumSizeWithBorderForWidth (int width)
 Minimum size of widget with border for reference width. More...
 
MousePointerFactory getMousePointer ()
 Mouse pointer to use. More...
 
BorderSize getPadding ()
 Padding. More...
 
Container getParent ()
 
Point getPosition ()
 Position of the widget. More...
 
bool getProtectBackgroundCanvasCreator ()
 Protect custom set background canvas creator. More...
 
bool getProtectBorder ()
 Protect custom set border. More...
 
bool getProtectFont ()
 Protect custom set font. More...
 
bool getProtectMinimumSize ()
 Protect custom set minimumsize. More...
 
bool getProtectMousePointer ()
 Protect custom set mouse pointer. More...
 
bool getProtectPadding ()
 Protect custom set padding. More...
 
bool getProtectTextColor ()
 Protect custom set text color. More...
 
Point getRelativePosition (Container parent)
 Widget position in parent widget coordinates. More...
 
Point getScreenPosition ()
 Widget position in screen coordinates. More...
 
RectArea getScreenRectArea ()
 
Point getSetMinimumSize ()
 
Point getSize ()
 Size of the widget. More...
 
Color getTextColor ()
 Text color. More...
 
String getTitle ()
 Widget title. More...
 
Object getToolTip ()
 Tooltip or null. More...
 
float getTotalTransparency ()
 
TexMatrix2 getTransformation ()
 
float getTransparency ()
 
RangeModel getVerticalRangeModel ()
 Vertical range model for viewports to synchronize the vertical scrollbar. More...
 
bool getVisible ()
 
int getWidth ()
 Width of widget. More...
 
Window getWindow ()
 
Point getWindowPosition ()
 Widget position in window coordinates. More...
 
int getX ()
 X position of widget. More...
 
int getY ()
 Y position of widget. More...
 
void grabFocus ()
 
bool hasParent (Container container)
 
bool isDesignerSet ()
 Custom designer is set. More...
 
bool isFullEnabled ()
 Widget and all parent widgets are enabled. More...
 
bool isMinimumSizeSet ()
 
bool isPointInside (Point position)
 
bool isTransformationSet ()
 
void layoutParentIfBlocked ()
 Calls layoutParent if getHasBlockedLayoutParent() is true. More...
 
Widget nextFocusWidget ()
 Find next widget in the focus cycle that can grab the focus. More...
 
void notifyBorderParametersChanged ()
 
void onDesignerChanged ()
 Designer changed. More...
 
void onDesignerSelectorChanged ()
 Designer selector changed. More...
 
void onDispose (WidgetEvent event)
 Window is disposing. More...
 
void onFocusLost (FocusEvent event)
 Widget lost focus. More...
 
void onFocusReceived (FocusEvent event)
 Widget received focus. More...
 
void onFrameUpdate (float elapsed)
 Do frame update. More...
 
void onGamepadButtonPressed (GamepadEvent event)
 Gamepad button has been pressed. More...
 
void onGamepadButtonReleased (GamepadEvent event)
 Gamepad button has been released. More...
 
void onHidden (WidgetEvent event)
 Widget has been hidden. More...
 
void onParentStateChanged ()
 Parent state changed. More...
 
void onParentStateChanged (bool force)
 Parent state changed. More...
 
void onReposition (WidgetEvent event)
 Position changed. More...
 
void onSetFont ()
 
void onSetTextColor ()
 Text color changed. More...
 
void onShown (WidgetEvent event)
 Widget has been shown. More...
 
void onTranslationChanged ()
 Translation manager or active language pack changed. More...
 
void popdownVirtualKeyboard ()
 Popdown virtual keyboard if Desktop has one assigned. More...
 
void popupVirtualKeyboard ()
 Popup virtual keyboard if Desktop has one assigned. More...
 
Widget prevFocusWidget ()
 Find previous widget in the focus cycle that can grab the focus. More...
 
void releaseMouse ()
 
void removeDragListener (DragListener listener)
 
void removeFocusListener (FocusListener listener)
 Remove focus listener. More...
 
void removeGamepadListener (GamepadListener listener)
 Remove gamepad listener. More...
 
void removeKeyListener (KeyListener listener)
 
void removeMouseListener (MouseListener listener)
 
void removeStateChangeListener (StateChangeListener listener)
 Remove state change listener. More...
 
void removeWidgetListener (WidgetListener listener)
 Remove widget listener. More...
 
void runWhileBlockingLayoutParent (Block ablock)
 Run block while layouting is blocked. More...
 
void safeDispose ()
 Safely dispose of widget. More...
 
void sendEvent (Event event)
 
void setBackgroundCanvasCreator (CanvasCreator creator)
 Set background canvas creator or null to use background color. More...
 
void setBlockLayoutParent (bool blockLayoutParent)
 Set block layoutParent calls. More...
 
void setBorder (Border border)
 
void setCanFocus (bool canFocus)
 
void setClipboard (Clipboard clipboard)
 Set clipboard or null to use parent clipboard. More...
 
void setColorTransformation (ColorMatrix transformation)
 Set color transformation. More...
 
void setDesigner (WidgetDesigner designer)
 Set designer. More...
 
void setDesignerSelector (String selector)
 Set designer selector. More...
 
void setFont (Font font)
 
void setHasBlockedLayoutParent (bool hasBlockedLayoutParent)
 Set if layoutParent calls happened during runWhileBlockingLayoutParent. More...
 
void setHasFocus (bool hasFocus)
 
void setHeight (int height)
 Set height of widget. More...
 
void setMinimumSize (Point size)
 
void setPadding (BorderSize padding)
 Set padding. More...
 
void setParent (Container parent)
 
void setPosition (Point position)
 Set position of widget. More...
 
void setProtectBackgroundCanvasCreator (bool protect)
 Set protect custom set background canvas creator. More...
 
void setProtectBorder (bool protect)
 Set protect custom set border. More...
 
void setProtectFont (bool protect)
 Set protect custom set font. More...
 
void setProtectMinimumSize (bool protect)
 Set protect custom set minimumsize. More...
 
void setProtectMousePointer (bool protect)
 Set protect custom set mouse pointer. More...
 
void setProtectPadding (bool protect)
 Set protect custom set padding. More...
 
void setProtectTextColor (bool protect)
 Set protect custom set text color. More...
 
void setSize (Point size)
 Set size of widget. More...
 
void setTextColor (Color color)
 Set text color. More...
 
void setTitle (String title)
 Set widget title. More...
 
void setToolTip (Object toolTip)
 Set tooltip or null. More...
 
void setTransformation (TexMatrix2 transformation)
 
void setTransparency (float transparency)
 
void setVisible (bool visible)
 
void setWidth (int width)
 Set width of widget. More...
 
void setX (int x)
 Set X position of widget. More...
 
void setY (int y)
 Set Y Position of widget. More...
 
void startFrameUpdater ()
 Start frame updater if not running. More...
 
void stopFrameUpdater ()
 Stop frame updater if running. More...
 

Public Attributes

MousePointerFactory pActiveMousePointer
 
bool pBlockSetHoverWidget
 
Widget pCaptureWidget
 
Decoration.Area pDragArea
 
Point pDragOffset
 
Window pDragWindow
 
Widget pFocusInProgress
 
Widget pFocusWidget
 
GamepadController pGamepadController
 
Widget pHoverWidget
 
RectArea pMouseArea
 
bool pMouseHidden
 
Point pMouseLocation
 
MousePointer pMousePointerInstance
 
Array pMousePointerListeners
 
BorderSize pNoWindowBorder
 
ToolTipManager pToolTipManager
 
Window pTrackDecoration
 
Decoration.Area pTrackDecorationAreaHover
 
WindowVirtualKeyboard pWindowVirtualKeyboard
 
- Public Attributes inherited from Dragengine.Gui.Container
bool pBlockLayout
 
Point pCachedMinSize
 
int pCachedMinSizeForHeightHeight
 
Point pCachedMinSizeForHeightSize
 
Point pCachedMinSizeForWidthSize
 
int pCachedMinSizeForWidthWidth
 
Array pChildren
 
bool pHasBlockedDoLayout
 
Layout pLayout
 
bool pStateChangeNotifyChildren
 
- Public Attributes inherited from Dragengine.Gui.Widget
CanvasCreator pBackgroundCanvasCreator
 
bool pBlockLayoutParent
 
Border pBorder
 
bool pCanFocus
 
CanvasView pCanvasBackground
 
CanvasView pCanvasContent
 
CanvasView pCanvasWidget
 
Clipboard pClipboard
 
WidgetDesigner pDesigner
 
String pDesignerSelector
 
Array pDragListeners
 
bool pEnabled
 
Array pFocusListeners
 
Font pFont
 
FrameUpdater pFrameUpdater
 
Array pGamepadListeners
 
bool pHasBlockedLayoutParent
 
bool pHasFocus
 
bool pIsDesignerSet
 
Array pKeyListeners
 
Point pMinSize
 
Array pMouseListeners
 
MousePointerFactory pMousePointer
 
BorderSize pPadding
 
Container pParent
 
Point pPosition
 
bool pProtectBackgroundCanvasCreator
 
bool pProtectBorder
 
bool pProtectFont
 
bool pProtectMinimumSize
 
bool pProtectMousePointer
 
bool pProtectPadding
 
bool pProtectTextColor
 
RepeatKeyEventTimer pRepeatEventTimer
 
Point pSize
 
Array pStateChangeListeners
 
Color pTextColor
 
GuiTheme pTheme
 
String pThemeSelector
 
String pTitle
 
Object pToolTip
 
TexMatrix2 pTransformation
 
TranslationManager pTranslationManager
 
float pTransparency
 
bool pVisible
 
Array pWidgetListeners
 

Protected Member Functions

void clearHoverWidget ()
 Clear hover widget. More...
 
Window getTrackDecoration ()
 Decoration whose state is tracked or null. More...
 
Decoration.Area getTrackDecorationAreaHover ()
 Tracked decoration area the mouse hovers above. More...
 
void setHoverWidget (Widget widget, MouseEvent event)
 Set widget the mouse hovers above. More...
 
void setTrackDecoration (Window window)
 Set decoration whose state is tracked or null. More...
 
void setTrackDecorationAreaHover (Decoration.Area areaHover)
 Set tracked decoration area the mouse hovers above. More...
 
- Protected Member Functions inherited from Dragengine.Gui.Widget
WidgetDesigner getDesignerFromTheme ()
 Get designer from gui theme. More...
 
void updateCanvasBackground ()
 Update background canvas content. More...
 
void updateCanvasGeometry ()
 Update canvas position and size. More...
 

Detailed Description

Desktop containing set of windows.

Provides typical desktop support like handling window interaction, focus and hover widget as well as mouse pointer handling.

Todo:
Add support to set mouse pointers for different situations:
  • normal mouse pointer
  • resizing mouse pointes: 8 pointers for each direction these also have to go into a new DefaultDesktopDesigner class. change the mouse pointer depending on the situation. mouse pointers should have only the responsibility to provide and update a canvas. complex logic like showing additional widgets like the InfoMousePointer does have to be moved into MouseListener which update widgets matching the mouse pointer position. this separates extended logic from basic design which can be done using XML. It also allows to attach logic to a MousePointer without the need to alter the instance itself.

Member Function Documentation

◆ addMousePointerListener()

void Dragengine.Gui.Desktop.addMousePointerListener ( MousePointerListener  listener)

Add mouse pointer listener.

Version
1.7

◆ addWidget() [1/2]

void Dragengine.Gui.Desktop.addWidget ( Widget  widget)

Add window to desktop.

Reimplemented from Dragengine.Gui.Container.

◆ addWidget() [2/2]

void Dragengine.Gui.Desktop.addWidget ( Widget  widget,
Object  settings 
)

Add window to desktop.

Reimplemented from Dragengine.Gui.Container.

◆ addWindow() [1/2]

void Dragengine.Gui.Desktop.addWindow ( Window  window)

Add window to desktop.

To add windows use this function rather than addWidget.

◆ addWindow() [2/2]

void Dragengine.Gui.Desktop.addWindow ( Window  window,
Object  settings 
)

Add window to desktop.

To add windows use this function rather than addWidget.

◆ allowsChildGrabFocus()

bool Dragengine.Gui.Desktop.allowsChildGrabFocus ( )

Container allows child widgets to grab the focus.

Reimplemented from Dragengine.Gui.Container.

◆ clearFocusWidget()

void Dragengine.Gui.Desktop.clearFocusWidget ( )

Clears the focus widget.

◆ clearHoverWidget()

void Dragengine.Gui.Desktop.clearHoverWidget ( )
protected

Clear hover widget.

◆ dispose()

void Dragengine.Gui.Desktop.dispose ( )

Disposes of widget.

Reimplemented from Dragengine.Gui.Widget.

◆ focusActiveWidgetOfFirstUsableWindow()

void Dragengine.Gui.Desktop.focusActiveWidgetOfFirstUsableWindow ( )

Focus the active widget of the top window supporting it if possible.

◆ getActiveMousePointer()

MousePointerFactory Dragengine.Gui.Desktop.getActiveMousePointer ( )

Active mouse pointer factory or null.

◆ getActiveWindow()

Window Dragengine.Gui.Desktop.getActiveWindow ( )

Active window or null.

◆ getDesktop()

Desktop Dragengine.Gui.Desktop.getDesktop ( )

Retrieves the desktop or null if this widget is not part of a desktop. The default implementation forwards the request to the parent with the Desktop or a subclass thereof intercepting.

Reimplemented from Dragengine.Gui.Widget.

◆ getDesktopPosition()

Point Dragengine.Gui.Desktop.getDesktopPosition ( )

Widget position in desktop coordinates.

Reimplemented from Dragengine.Gui.Widget.

◆ getFocusWidget()

Widget Dragengine.Gui.Desktop.getFocusWidget ( )

Focused widget or null.

◆ getGamepadController()

GamepadController Dragengine.Gui.Desktop.getGamepadController ( )

Gamepad controller or null.

Version
1.20

◆ getHoverWidget()

Widget Dragengine.Gui.Desktop.getHoverWidget ( )

Widget the mouse hovers above or null.

Reimplemented from Dragengine.Gui.Widget.

◆ getIsMouseHidden()

bool Dragengine.Gui.Desktop.getIsMouseHidden ( )

Mouse pointer is hidden.

◆ getMouseArea()

RectArea Dragengine.Gui.Desktop.getMouseArea ( )

Movement area of mouse pointer or null if not set.

◆ getMouseCaptureWidget()

Widget Dragengine.Gui.Desktop.getMouseCaptureWidget ( )

Retrieves the widget having captured the mouse.

◆ getMouseLocation()

Point Dragengine.Gui.Desktop.getMouseLocation ( )

Location of mouse pointer.

◆ getMousePointerInstance()

MousePointer Dragengine.Gui.Desktop.getMousePointerInstance ( )

Mouse pointer instance or null.

◆ getNoBorderPosition()

Point Dragengine.Gui.Desktop.getNoBorderPosition ( )

Top left position excluding no window border.

◆ getNoBorderSize()

Point Dragengine.Gui.Desktop.getNoBorderSize ( )

Maximum size excluding no window border.

◆ getNoWindowBorder()

BorderSize Dragengine.Gui.Desktop.getNoWindowBorder ( )

Area along the borders no window can occupy.

◆ getToolTipManager()

ToolTipManager Dragengine.Gui.Desktop.getToolTipManager ( )

Tool tip manager or null.

Version
1.7

◆ getTrackDecoration()

Window Dragengine.Gui.Desktop.getTrackDecoration ( )
protected

Decoration whose state is tracked or null.

◆ getTrackDecorationAreaHover()

Decoration.Area Dragengine.Gui.Desktop.getTrackDecorationAreaHover ( )
protected

Tracked decoration area the mouse hovers above.

◆ getWindowVirtualKeyboard()

WindowVirtualKeyboard Dragengine.Gui.Desktop.getWindowVirtualKeyboard ( )

Virtual keyboard window or null.

Version
1.7

◆ giveUpFocus()

void Dragengine.Gui.Desktop.giveUpFocus ( )

Notifies that the current focus widget can no longer hold the focus.

Reimplemented from Dragengine.Gui.Container.

◆ layoutParent()

void Dragengine.Gui.Desktop.layoutParent ( )

Layout parent if existing. Modified version to not layout of Desktop. Desktop widgets have a fixed size and do not change size if their windows change in any way. Prevents triggering parent layout calls wasting time. On the other hand check for condition changes altering stored widgets

Reimplemented from Dragengine.Gui.Container.

◆ new() [1/3]

Desktop Dragengine.Gui.Desktop.new ( int  width,
int  height 
)

Create desktop widget.

◆ new() [2/3]

Desktop Dragengine.Gui.Desktop.new ( int  x,
int  y,
int  width,
int  height 
)

Create desktop widget.

Reimplemented from Dragengine.Gui.Container.

◆ new() [3/3]

Desktop Dragengine.Gui.Desktop.new ( Point  size)

Create desktop widget.

◆ onMouseMove()

void Dragengine.Gui.Desktop.onMouseMove ( MouseEvent  event)

Notification that the mouse has moved.

◆ onMousePointerChanged()

void Dragengine.Gui.Desktop.onMousePointerChanged ( MousePointerEvent  event)

Mouse pointer changed.

Version
1.7

◆ onMousePointerHidden()

void Dragengine.Gui.Desktop.onMousePointerHidden ( MousePointerEvent  event)

Mouse pointer has been hidden.

Version
1.7

◆ onMousePointerShown()

void Dragengine.Gui.Desktop.onMousePointerShown ( MousePointerEvent  event)

Mouse pointer has been shown.

Version
1.7

◆ onResize()

void Dragengine.Gui.Desktop.onResize ( WidgetEvent  event)

Size changed.

Sends event to listeners.

Reimplemented from Dragengine.Gui.Widget.

◆ processEvent()

void Dragengine.Gui.Desktop.processEvent ( Event  event)

Sends an Event to the focus widget or drop it.

Reimplemented from Dragengine.Gui.Widget.

◆ raiseWindowsAlwaysOnTop()

void Dragengine.Gui.Desktop.raiseWindowsAlwaysOnTop ( )

Raise windows with getAlwaysOnTop() set.

Version
1.15

◆ removeAllWidgets()

void Dragengine.Gui.Desktop.removeAllWidgets ( )

Remove all windows from desktop.

Reimplemented from Dragengine.Gui.Container.

◆ removeMousePointerListener()

void Dragengine.Gui.Desktop.removeMousePointerListener ( MousePointerListener  listener)

Remove mouse pointer listener.

Version
1.7

◆ removeWidget()

void Dragengine.Gui.Desktop.removeWidget ( Widget  widget)

Remove window from desktop.

Reimplemented from Dragengine.Gui.Container.

◆ requestCaptureMouse()

bool Dragengine.Gui.Desktop.requestCaptureMouse ( Widget  widget)

Request to capture the mouse for the specified widget.

Reimplemented from Dragengine.Gui.Container.

◆ requestGrabFocus()

void Dragengine.Gui.Desktop.requestGrabFocus ( Widget  widget)

Request to focus the specified widget.

Reimplemented from Dragengine.Gui.Widget.

◆ requestReleaseMouse()

bool Dragengine.Gui.Desktop.requestReleaseMouse ( Widget  widget)

Request to release mouse capture.

Returns
true if the widget is the capture widget otherwise false.

Reimplemented from Dragengine.Gui.Container.

◆ sendEventToListeners()

void Dragengine.Gui.Desktop.sendEventToListeners ( Event  event,
bool  sendToParent 
)

Send event to all appropriate listeners for events of its kind.

If there are no listeners the event is send to the parent if sendToParent is true.

Reimplemented from Dragengine.Gui.Widget.

◆ setActiveMousePointer()

void Dragengine.Gui.Desktop.setActiveMousePointer ( MousePointerFactory  mousePointer)

Set active mouse pointer or null.

If factory changes a new mouse pointer instance is created if not null.

◆ setGamepadController()

void Dragengine.Gui.Desktop.setGamepadController ( GamepadController  controller)

Set gamepad controller or null.

Version
1.20

◆ setHoverWidget()

void Dragengine.Gui.Desktop.setHoverWidget ( Widget  widget,
MouseEvent  event 
)
protected

Set widget the mouse hovers above.

If widget is different than the old one enter and leave messages are send.

◆ setIsMouseHidden()

void Dragengine.Gui.Desktop.setIsMouseHidden ( bool  hidden)

Set if mouse pointer is hidden.

◆ setMouseArea()

void Dragengine.Gui.Desktop.setMouseArea ( RectArea  area)

Set movement area of the mouse pointer or null to clear.

◆ setMouseLocation()

void Dragengine.Gui.Desktop.setMouseLocation ( Point  location)

Set location of mouse pointer.

Location is clamped to the mouse movement area.

◆ setNoWindowBorder()

void Dragengine.Gui.Desktop.setNoWindowBorder ( BorderSize  size)

Set area along the borders no window can occupy.

◆ setToolTipManager()

void Dragengine.Gui.Desktop.setToolTipManager ( ToolTipManager  tooltipManager)

Set tool tip manager or null.

Version
1.7

◆ setTrackDecoration()

void Dragengine.Gui.Desktop.setTrackDecoration ( Window  window)
protected

Set decoration whose state is tracked or null.

◆ setTrackDecorationAreaHover()

void Dragengine.Gui.Desktop.setTrackDecorationAreaHover ( Decoration.Area  areaHover)
protected

Set tracked decoration area the mouse hovers above.

◆ setWindowVirtualKeyboard()

void Dragengine.Gui.Desktop.setWindowVirtualKeyboard ( WindowVirtualKeyboard  window)

Set virtual keyboard window or null.

Version
1.7

◆ warpCenterMouse()

void Dragengine.Gui.Desktop.warpCenterMouse ( )

Warp mouse pointer centered in desktop.

Use this method if you move the moue pointer directly as otherwise the appropriate messages are not send.

◆ warpCenterMouseIn()

void Dragengine.Gui.Desktop.warpCenterMouseIn ( Widget  widget)

Warp mouse pointer centered inside widget.

Use this method if you move the moue pointer directly as otherwise the appropriate messages are not send.

◆ warpMouseIn()

void Dragengine.Gui.Desktop.warpMouseIn ( Widget  widget,
Point  location 
)

Warp mouse pointer relative to widget.

Use this method if you move the moue pointer directly as otherwise the appropriate messages are not send.

◆ warpMousePointer()

void Dragengine.Gui.Desktop.warpMousePointer ( Point  location)

Warp mouse pointer.

Use this method if you move the moue pointer directly as otherwise the appropriate messages are not send.

◆ widgetAcceptingInputAt()

Widget Dragengine.Gui.Desktop.widgetAcceptingInputAt ( Point  position)

Widget accepting input at position.

Version
1.17

Member Data Documentation

◆ pActiveMousePointer

MousePointerFactory Dragengine.Gui.Desktop.pActiveMousePointer

◆ pBlockSetHoverWidget

bool Dragengine.Gui.Desktop.pBlockSetHoverWidget

◆ pCaptureWidget

Widget Dragengine.Gui.Desktop.pCaptureWidget

◆ pDragArea

Decoration.Area Dragengine.Gui.Desktop.pDragArea

◆ pDragOffset

Point Dragengine.Gui.Desktop.pDragOffset

◆ pDragWindow

Window Dragengine.Gui.Desktop.pDragWindow

◆ pFocusInProgress

Widget Dragengine.Gui.Desktop.pFocusInProgress

◆ pFocusWidget

Widget Dragengine.Gui.Desktop.pFocusWidget

◆ pGamepadController

GamepadController Dragengine.Gui.Desktop.pGamepadController

◆ pHoverWidget

Widget Dragengine.Gui.Desktop.pHoverWidget

◆ pMouseArea

RectArea Dragengine.Gui.Desktop.pMouseArea

◆ pMouseHidden

bool Dragengine.Gui.Desktop.pMouseHidden

◆ pMouseLocation

Point Dragengine.Gui.Desktop.pMouseLocation

◆ pMousePointerInstance

MousePointer Dragengine.Gui.Desktop.pMousePointerInstance

◆ pMousePointerListeners

Array Dragengine.Gui.Desktop.pMousePointerListeners

◆ pNoWindowBorder

BorderSize Dragengine.Gui.Desktop.pNoWindowBorder

◆ pToolTipManager

ToolTipManager Dragengine.Gui.Desktop.pToolTipManager

◆ pTrackDecoration

Window Dragengine.Gui.Desktop.pTrackDecoration

◆ pTrackDecorationAreaHover

Decoration.Area Dragengine.Gui.Desktop.pTrackDecorationAreaHover

◆ pWindowVirtualKeyboard

WindowVirtualKeyboard Dragengine.Gui.Desktop.pWindowVirtualKeyboard

The documentation for this class was generated from the following file: