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

Top level window. More...

Inheritance diagram for Dragengine.Gui.Window:
Dragengine.Gui.Container Dragengine.Gui.Widget Dragengine.Gui.MainMenus.Interactive.InteractiveMainMenu Dragengine.Gui.WindowConsole Dragengine.Gui.WindowGameWorld Dragengine.Gui.WindowLoading Dragengine.Gui.WindowLogo Dragengine.Gui.WindowModal Dragengine.Gui.WindowOverColor Dragengine.Gui.WindowPlayerChoice Dragengine.Gui.WindowPopup Dragengine.Gui.WindowSubTitle Dragengine.Gui.WindowToolTip Dragengine.Gui.WindowVirtualKeyboard

Classes

enum  WindowState
 Window.WindowState.. More...
 

Public Member Functions

void activeWidgetGrabFocus ()
 
void addWindowListener (WindowListener listener)
 Add window listener. More...
 
void becomeBackgroundWindow ()
 Set window to act as a non-interactive background window. More...
 
void centerWindow ()
 Move window to the center of the parent desktop. More...
 
void close ()
 Close window. More...
 
void dispose ()
 Dispose of widget. More...
 
void fitToContent ()
 Fit window size to content size. More...
 
bool getActivated ()
 Window is activated. More...
 
Widget getActiveWidget ()
 Active widget or null if there is none. More...
 
bool getAlwaysOnTop ()
 Window is always on top of all others. More...
 
WindowModal getBlockingWindow ()
 Modal window blocking this window or null. More...
 
bool getCanActivate ()
 Window can be activated. More...
 
bool getCanClose ()
 Window can be closed. More...
 
bool getCanMaximize ()
 Window can be maximized. More...
 
bool getCanMinimize ()
 Window can be minimized. More...
 
bool getCanMove ()
 Window can be moved. More...
 
bool getCanReorder ()
 Window can be reordered. More...
 
bool getCanResize ()
 Window can be resized. More...
 
Decoration getDecoration ()
 Decoration of window. More...
 
BorderSize getDecorationSize ()
 Get decoration size. More...
 
Color getModalDarkenColor ()
 Darkening color while modal window is in use. More...
 
bool getProtectDecoration ()
 Protect custom set decoration. More...
 
bool getProtectModalDarkenColor ()
 Protect custom set modal window darkening color. More...
 
Window getTopBlockingWindow ()
 Get top most blocking window or null. More...
 
Window getWindow ()
 Window or null if this widget is not part of a window. More...
 
Point getWindowPosition ()
 Widget position in window coordinates. More...
 
WindowState getWindowState ()
 Window state. More...
 
void grabFocus ()
 Grab the focus if possible. More...
 
void moveAbove (Window window)
 Move window right above the given window. More...
 
void moveBelow (Window window)
 Move window right below the given window. More...
 
void moveToBottom ()
 Move window to the bottom. More...
 
void moveToTop ()
 Move window to the top. More...
 
Window new ()
 Create window. More...
 
Window new (int x, int y, int width, int height)
 Create window with the given geometry. More...
 
Window new (Point position, Point size)
 Create window with the given geometry. More...
 
Widget nextFocusWidgetAfter (Widget widget)
 Find next widget in the focus cycle that can grab the focus. More...
 
void onDesignerChanged ()
 Designer changed. More...
 
void onDesignerSelectorChanged ()
 Designer selector changed. More...
 
void onDesktopResized ()
 Desktop size changed. More...
 
void onGuiThemeChanged ()
 Gui theme changed. More...
 
void onMaximized (WindowEvent event)
 Window has been maximized. More...
 
void onMinimized (WindowEvent event)
 Window has been minimized. More...
 
void onTranslationChanged ()
 Translation manager or active language pack changed. More...
 
Widget prevFocusWidgetAfter (Widget widget)
 Find previous widget in the focus cycle that can grab the focus. More...
 
void removeWindowListener (WindowListener listener)
 Remove window listener. More...
 
void requestClose ()
 Request closing window. More...
 
void requestGrabFocus (Widget widget)
 Request to focus the specified widget. More...
 
void sendEventToListeners (Event event, bool sendToParent)
 Send event to all appropriate listeners for events of its kind. More...
 
void setActivated (bool activated)
 Set if window is activated. More...
 
void setActiveWidget (Widget widget)
 Set active widget. More...
 
void setAlwaysOnTop (bool alwaysOnTop)
 Set if window is always on top of all others. More...
 
void setBlockingWindow (WindowModal window)
 Set modal window blocking this window or null. More...
 
void setCanActivate (bool canActivate)
 Set if window can be activated. More...
 
void setCanClose (bool canClose)
 Set if window can be closed. More...
 
void setCanMaximize (bool canMaximize)
 Set if window can be maximized. More...
 
void setCanMinimize (bool canMinimize)
 Set if window can be minimized. More...
 
void setCanMove (bool canMove)
 Set if window can be moved. More...
 
void setCanReorder (bool canReorder)
 Set if window can be reordered. More...
 
void setCanResize (bool canResize)
 Set window can be resized. More...
 
void setDecoration (Decoration decoration)
 Set decoration of window. More...
 
void setModalDarkenColor (Color color)
 Set darkening color while modal window is in use. More...
 
void setProtectDecoration (bool protect)
 Set protect custom set decoration. More...
 
void setProtectModalDarkenColor (bool protect)
 Set protect custom set modal window darkening color. More...
 
void setTitle (String title)
 Set window title. More...
 
void setWindowState (WindowState state)
 Set window state. More...
 
- Public Member Functions inherited from Dragengine.Gui.Container
void addWidget (Widget widget)
 
void addWidget (Widget widget, Object settings)
 
bool allowsChildGrabFocus ()
 
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 ()
 
void giveUpFocus ()
 
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 layoutParent ()
 
void moveWidget (Widget widget, int newPosition)
 
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...
 
void onPaddingChanged ()
 Padding changed. More...
 
void onStateChanged (StateChangeEvent event)
 State changed. More...
 
void removeAllWidgets ()
 Remove and dispose all widgets. More...
 
void removeWidget (Widget widget)
 Remove widget without disposing. More...
 
bool requestCaptureMouse (Widget widget)
 
bool requestReleaseMouse (Widget widget)
 
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...
 
Desktop getDesktop ()
 
Point getDesktopPosition ()
 Widget position in desktop coordinates. 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...
 
Widget getHoverWidget ()
 Widget the mouse hovers above or null. 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...
 
int getX ()
 X position of widget. More...
 
int getY ()
 Y position of widget. More...
 
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 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 onResize (WidgetEvent event)
 Size changed. More...
 
void onSetFont ()
 
void onSetTextColor ()
 Text color changed. More...
 
void onShown (WidgetEvent event)
 Widget has been shown. 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 processEvent (Event event)
 
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 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

bool pActivated
 
Widget pActiveWidget
 
bool pAlwaysOnTop
 
WindowModal pBlockingWindow
 
bool pCanActivate
 
bool pCanClose
 
bool pCanMaximize
 
bool pCanMinimize
 
bool pCanMove
 
bool pCanReorder
 
bool pCanResize
 
Decoration pDecoration
 
Color pModalDarkenColor
 
bool pProtectDecoration
 
bool pProtectModalDarkenColor
 
Array pWindowListeners
 
WindowState pWindowState
 
- 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 setDecorationFromDesigner ()
 Set decoration from designer if not protected. More...
 
void updateCanvasGeometry ()
 Update canvas position and size. More...
 
- Protected Member Functions inherited from Dragengine.Gui.Widget
WidgetDesigner getDesignerFromTheme ()
 Get designer from gui theme. More...
 
void updateCanvasBackground ()
 Update background canvas content. More...
 

Detailed Description

Top level window.

Supports designing using designer selector "Window".

Member Function Documentation

◆ activeWidgetGrabFocus()

void Dragengine.Gui.Window.activeWidgetGrabFocus ( )

Tries to aquire the focus for the active widget.

◆ addWindowListener()

void Dragengine.Gui.Window.addWindowListener ( WindowListener  listener)

Add window listener.

◆ becomeBackgroundWindow()

void Dragengine.Gui.Window.becomeBackgroundWindow ( )

Set window to act as a non-interactive background window.

Convenience method to set canFocus and canActivate to false. In this mode the window is not activated nor brought to the front if clicked. Furthermore the window never grabs the focus. This is suitable configuration for windows acting as a background with other interactive windows placed ontop of it.

◆ centerWindow()

void Dragengine.Gui.Window.centerWindow ( )

Move window to the center of the parent desktop.

◆ close()

void Dragengine.Gui.Window.close ( )

Close window.

Removes window from parent and disposes of the window.

Reimplemented in Dragengine.Gui.WindowModal, and Dragengine.Gui.WindowDialog.

◆ dispose()

◆ fitToContent()

void Dragengine.Gui.Window.fitToContent ( )

Fit window size to content size.

Depending on the layout used and widgets contained in the window the current window size affects the result. For example if the window contains wrapping labels the current window size is used as reference width affecting the size of the wrapping label. It is thus preferable to set a reasonable window size before calling fitToContent() to obtain a window size near the set window size.

Note
Calling this function only adjusts the window size. The user can still resize the window afterwards. If you want the window to stick to the fitting size use setCanResize() to lock the size. This can be done before or after the call since fitToContent() ignore the set can-resize value.

Reimplemented in Dragengine.Gui.MenuPopup.

◆ getActivated()

bool Dragengine.Gui.Window.getActivated ( )

Window is activated.

◆ getActiveWidget()

Widget Dragengine.Gui.Window.getActiveWidget ( )

Active widget or null if there is none.

◆ getAlwaysOnTop()

bool Dragengine.Gui.Window.getAlwaysOnTop ( )

Window is always on top of all others.

Version
1.15

◆ getBlockingWindow()

WindowModal Dragengine.Gui.Window.getBlockingWindow ( )

Modal window blocking this window or null.

◆ getCanActivate()

bool Dragengine.Gui.Window.getCanActivate ( )

Window can be activated.

◆ getCanClose()

bool Dragengine.Gui.Window.getCanClose ( )

Window can be closed.

◆ getCanMaximize()

bool Dragengine.Gui.Window.getCanMaximize ( )

Window can be maximized.

◆ getCanMinimize()

bool Dragengine.Gui.Window.getCanMinimize ( )

Window can be minimized.

◆ getCanMove()

bool Dragengine.Gui.Window.getCanMove ( )

Window can be moved.

◆ getCanReorder()

bool Dragengine.Gui.Window.getCanReorder ( )

Window can be reordered.

◆ getCanResize()

bool Dragengine.Gui.Window.getCanResize ( )

Window can be resized.

◆ getDecoration()

Decoration Dragengine.Gui.Window.getDecoration ( )

Decoration of window.

◆ getDecorationSize()

BorderSize Dragengine.Gui.Window.getDecorationSize ( )

Get decoration size.

If no decoration is set an empty border size is returned.

◆ getModalDarkenColor()

Color Dragengine.Gui.Window.getModalDarkenColor ( )

Darkening color while modal window is in use.

◆ getProtectDecoration()

bool Dragengine.Gui.Window.getProtectDecoration ( )

Protect custom set decoration.

◆ getProtectModalDarkenColor()

bool Dragengine.Gui.Window.getProtectModalDarkenColor ( )

Protect custom set modal window darkening color.

◆ getTopBlockingWindow()

Window Dragengine.Gui.Window.getTopBlockingWindow ( )

Get top most blocking window or null.

◆ getWindow()

Window Dragengine.Gui.Window.getWindow ( )

Window or null if this widget is not part of a window.

The default implementation forwards the request to the parent with the Window or a subclass thereof intercepting.

Reimplemented from Dragengine.Gui.Widget.

◆ getWindowPosition()

Point Dragengine.Gui.Window.getWindowPosition ( )

Widget position in window coordinates.

Reimplemented from Dragengine.Gui.Widget.

◆ getWindowState()

WindowState Dragengine.Gui.Window.getWindowState ( )

Window state.

◆ grabFocus()

void Dragengine.Gui.Window.grabFocus ( )

Grab the focus if possible.

If the window is disabled or not visible the focus is not grabbed. Otherwise the focus is grabbed by the first widget able to do so:

  • Active widget
  • First focusable widget otherwise
  • Window itself

Reimplemented from Dragengine.Gui.Widget.

Reimplemented in Dragengine.Gui.WindowVirtualKeyboard, Dragengine.Gui.WindowToolTip, and Dragengine.Gui.WindowPopup.

◆ moveAbove()

void Dragengine.Gui.Window.moveAbove ( Window  window)

Move window right above the given window.

Reimplemented in Dragengine.Gui.WindowModal.

◆ moveBelow()

void Dragengine.Gui.Window.moveBelow ( Window  window)

Move window right below the given window.

Reimplemented in Dragengine.Gui.WindowModal.

◆ moveToBottom()

void Dragengine.Gui.Window.moveToBottom ( )

Move window to the bottom.

Reimplemented in Dragengine.Gui.WindowModal.

◆ moveToTop()

void Dragengine.Gui.Window.moveToTop ( )

Move window to the top.

Reimplemented in Dragengine.Gui.WindowModal.

◆ new() [1/3]

◆ new() [2/3]

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

Create window with the given geometry.

Reimplemented from Dragengine.Gui.Container.

Reimplemented in Dragengine.Gui.WindowModal, Dragengine.Gui.WindowDialog, Dragengine.Gui.WindowConsole, and Dragengine.Gui.WindowSettings.

◆ new() [3/3]

Window Dragengine.Gui.Window.new ( Point  position,
Point  size 
)

Create window with the given geometry.

Reimplemented from Dragengine.Gui.Container.

◆ nextFocusWidgetAfter()

Widget Dragengine.Gui.Window.nextFocusWidgetAfter ( Widget  widget)

Find next widget in the focus cycle that can grab the focus.

Similar to Container.nextFocusWidgetAfter but wraps around if no suitable Widget is found until the last widget in the window.

Reimplemented from Dragengine.Gui.Container.

◆ onDesignerChanged()

void Dragengine.Gui.Window.onDesignerChanged ( )

Designer changed.

Reimplemented from Dragengine.Gui.Widget.

◆ onDesignerSelectorChanged()

void Dragengine.Gui.Window.onDesignerSelectorChanged ( )

Designer selector changed.

Reimplemented from Dragengine.Gui.Widget.

Reimplemented in Dragengine.Gui.WindowGameWorld.

◆ onDesktopResized()

void Dragengine.Gui.Window.onDesktopResized ( )

◆ onGuiThemeChanged()

void Dragengine.Gui.Window.onGuiThemeChanged ( )

Gui theme changed.

Reimplemented from Dragengine.Gui.Container.

Reimplemented in Dragengine.Gui.WindowConsole.

◆ onMaximized()

void Dragengine.Gui.Window.onMaximized ( WindowEvent  event)

Window has been maximized.

Sends event to listeners.

◆ onMinimized()

void Dragengine.Gui.Window.onMinimized ( WindowEvent  event)

Window has been minimized.

Sends event to listeners.

◆ onTranslationChanged()

void Dragengine.Gui.Window.onTranslationChanged ( )

Translation manager or active language pack changed.

Version
1.20

Reimplemented from Dragengine.Gui.Widget.

◆ prevFocusWidgetAfter()

Widget Dragengine.Gui.Window.prevFocusWidgetAfter ( Widget  widget)

Find previous widget in the focus cycle that can grab the focus.

Similar to Container.prevFocusWidgetAfter but wraps around if no suitable Widget is found until the first widget in the window.

Reimplemented from Dragengine.Gui.Container.

◆ removeWindowListener()

void Dragengine.Gui.Window.removeWindowListener ( WindowListener  listener)

Remove window listener.

◆ requestClose()

void Dragengine.Gui.Window.requestClose ( )

Request closing window.

Version
1.23

Called by Desktop if user clicks on close window decoration button. Optionally can be called by other scripts to request closing window if there is the possibility to reject this request. Implementation has to call close() if the request is honored otherwise do nothing. The default implementation calls close().

Reimplemented in Dragengine.Gui.ModManagement.MMWindowModManagement.

◆ requestGrabFocus()

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

Request to focus the specified widget.

Reimplemented from Dragengine.Gui.Widget.

◆ sendEventToListeners()

void Dragengine.Gui.Window.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.

◆ setActivated()

void Dragengine.Gui.Window.setActivated ( bool  activated)

Set if window is activated.

◆ setActiveWidget()

void Dragengine.Gui.Window.setActiveWidget ( Widget  widget)

Set active widget.

Used to set the initial active widget for a window.

◆ setAlwaysOnTop()

void Dragengine.Gui.Window.setAlwaysOnTop ( bool  alwaysOnTop)

Set if window is always on top of all others.

Version
1.15

◆ setBlockingWindow()

void Dragengine.Gui.Window.setBlockingWindow ( WindowModal  window)

Set modal window blocking this window or null.

This call is for WindowModal only. Do not call directly.

◆ setCanActivate()

void Dragengine.Gui.Window.setCanActivate ( bool  canActivate)

Set if window can be activated.

◆ setCanClose()

void Dragengine.Gui.Window.setCanClose ( bool  canClose)

Set if window can be closed.

◆ setCanMaximize()

void Dragengine.Gui.Window.setCanMaximize ( bool  canMaximize)

Set if window can be maximized.

◆ setCanMinimize()

void Dragengine.Gui.Window.setCanMinimize ( bool  canMinimize)

Set if window can be minimized.

◆ setCanMove()

void Dragengine.Gui.Window.setCanMove ( bool  canMove)

Set if window can be moved.

◆ setCanReorder()

void Dragengine.Gui.Window.setCanReorder ( bool  canReorder)

Set if window can be reordered.

◆ setCanResize()

void Dragengine.Gui.Window.setCanResize ( bool  canResize)

Set window can be resized.

◆ setDecoration()

void Dragengine.Gui.Window.setDecoration ( Decoration  decoration)

Set decoration of window.

If null create from gui theme.

◆ setDecorationFromDesigner()

void Dragengine.Gui.Window.setDecorationFromDesigner ( )
protected

Set decoration from designer if not protected.

◆ setModalDarkenColor()

void Dragengine.Gui.Window.setModalDarkenColor ( Color  color)

Set darkening color while modal window is in use.

◆ setProtectDecoration()

void Dragengine.Gui.Window.setProtectDecoration ( bool  protect)

Set protect custom set decoration.

◆ setProtectModalDarkenColor()

void Dragengine.Gui.Window.setProtectModalDarkenColor ( bool  protect)

Set protect custom set modal window darkening color.

◆ setTitle()

void Dragengine.Gui.Window.setTitle ( String  title)

Set window title.

Reimplemented from Dragengine.Gui.Widget.

◆ setWindowState()

void Dragengine.Gui.Window.setWindowState ( WindowState  state)

Set window state.

◆ updateCanvasGeometry()

void Dragengine.Gui.Window.updateCanvasGeometry ( )
protected

Update canvas position and size.

The position and size of the background and content canvas are adjusted to match the position and size of the widget in the parent container. Border canvas if existing is adjusted to always fit properly around the canvas background and content.

Warning
This method is also called from the constructor. Subclasses overwriting this method have to be able to run while the subclass constructor has not yet been processed.

Reimplemented from Dragengine.Gui.Widget.

Member Data Documentation

◆ pActivated

bool Dragengine.Gui.Window.pActivated

◆ pActiveWidget

Widget Dragengine.Gui.Window.pActiveWidget

◆ pAlwaysOnTop

bool Dragengine.Gui.Window.pAlwaysOnTop

◆ pBlockingWindow

WindowModal Dragengine.Gui.Window.pBlockingWindow

◆ pCanActivate

bool Dragengine.Gui.Window.pCanActivate

◆ pCanClose

bool Dragengine.Gui.Window.pCanClose

◆ pCanMaximize

bool Dragengine.Gui.Window.pCanMaximize

◆ pCanMinimize

bool Dragengine.Gui.Window.pCanMinimize

◆ pCanMove

bool Dragengine.Gui.Window.pCanMove

◆ pCanReorder

bool Dragengine.Gui.Window.pCanReorder

◆ pCanResize

bool Dragengine.Gui.Window.pCanResize

◆ pDecoration

Decoration Dragengine.Gui.Window.pDecoration

◆ pModalDarkenColor

Color Dragengine.Gui.Window.pModalDarkenColor

◆ pProtectDecoration

bool Dragengine.Gui.Window.pProtectDecoration

◆ pProtectModalDarkenColor

bool Dragengine.Gui.Window.pProtectModalDarkenColor

◆ pWindowListeners

Array Dragengine.Gui.Window.pWindowListeners

◆ pWindowState

WindowState Dragengine.Gui.Window.pWindowState

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