Classes |
Public Member Functions |
Public Attributes |
Protected Member Functions |
List of all members
Dragengine.Gui.WindowVirtualKeyboard Class Reference
Window for showing virtual keyboard. More...
Inheritance diagram for Dragengine.Gui.WindowVirtualKeyboard:
Classes | |
| class | HideVirtualKeyboard |
| Hide keyboard listener. \versoin 1.15. More... | |
| class | RenameShiftToggle |
| Rename key upon shift toggle listener. More... | |
| class | VirtualKeyType |
| Virtual key type listener. More... | |
Public Member Functions | |
| Widget | getInputWidget () |
| Input widget or null. More... | |
| Panel | getKeyboardLayoutDefault () |
| Default keyboard layout panel. More... | |
| Panel | getKeyboardLayoutNumeric () |
| Numeric keyboard layout panel. More... | |
| Panel | getKeyboardLayoutPanel () |
| Active keyboard layout panel or null. More... | |
| void | grabFocus () |
| Grab focus if possible. More... | |
| WindowVirtualKeyboard | new () |
| Create window. More... | |
| void | onFrameUpdate (float elapsed) |
| Do frame update. More... | |
| void | popdown () |
| Pop down windowand clears input widget. More... | |
| void | popup (Widget inputWidget) |
| Pop up window operating on input widget. More... | |
| void | sendKeyPressed (int keyCode, int keyChar) |
| Send key pressed event to input widget if present. More... | |
| void | sendKeyReleased (int keyCode, int keyChar) |
| Send key released event to input widget if present. More... | |
 Public Member Functions inherited from Dragengine.Gui.Window | |
| 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 | 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 (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 | 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... | |
Protected Member Functions | |
| Point | calculatePopupPosition (Widget widget) |
| Calculate popup position. More... | |
| Panel | createKeyboardLayoutDefaultPanel () |
| Create default keyboard layout panel. More... | |
| void | createKeyboardLayoutPanels (Container container) |
| Create layout panels adding them to container. More... | |
| Widget | createVirtualKey (int keyCode, int keyChar, Image image, String designerSuffix) |
| Create virtual key widget. More... | |
| Widget | createVirtualKey (int keyCode, int keyChar, String text, int shiftedKeyChar, String shiftedText, String designerSuffix) |
| Create virtual key widget. More... | |
| Widget | createVirtualKeyHide (Image image, String designerSuffix) |
| Create virtual key widget. \versoin 1.15. More... | |
| Panel | selectKeyboardLayout (TextWidget textWidget) |
| Select keyboard layout best matching input widget. More... | |
| Panel | selectKeyboardLayout (Widget inputWidget) |
| Select keyboard layout best matching input widget. More... | |
| void | setKeyboardLayoutPanel (Panel panel) |
| Set active keyboard layout panel or null. More... | |
| Protected Member Functions inherited from Dragengine.Gui.Window | |
| 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
Window for showing virtual keyboard.
- Version
- 1.7
Similar to WindowPopup but does not capture the mouse.
Supports designing using designer selector "WindowVirtualKeyboard".
Window shows one panel out of a selection of possible panels depending on the characteristics of the input widget.
By default Desktop has no virtual keyboard assign. Use Desktop.setWindowVirtualKeyboard() to assign an instance of this class. Widgets supporting keyboard input in a reasonable way will call popup() upon receiving the focus and popdown(null) upon loosing the focus.
Member Function Documentation
◆ calculatePopupPosition()
Calculate popup position.
◆ createKeyboardLayoutDefaultPanel()
|
protected |
Create default keyboard layout panel.
◆ createKeyboardLayoutPanels()
|
protected |
Create layout panels adding them to container.
◆ createVirtualKey() [1/2]
|
protected |
Create virtual key widget.
◆ createVirtualKey() [2/2]
|
protected |
Create virtual key widget.
◆ createVirtualKeyHide()
|
protected |
Create virtual key widget. \versoin 1.15.
◆ getInputWidget()
| Widget Dragengine.Gui.WindowVirtualKeyboard.getInputWidget | ( | ) |
Input widget or null.
◆ getKeyboardLayoutDefault()
| Panel Dragengine.Gui.WindowVirtualKeyboard.getKeyboardLayoutDefault | ( | ) |
Default keyboard layout panel.
◆ getKeyboardLayoutNumeric()
| Panel Dragengine.Gui.WindowVirtualKeyboard.getKeyboardLayoutNumeric | ( | ) |
Numeric keyboard layout panel.
◆ getKeyboardLayoutPanel()
| Panel Dragengine.Gui.WindowVirtualKeyboard.getKeyboardLayoutPanel | ( | ) |
Active keyboard layout panel or null.
◆ grabFocus()
| void Dragengine.Gui.WindowVirtualKeyboard.grabFocus | ( | ) |
Grab focus if possible.
Implementation for popup windows is slightly different than for regular windows. Regular windows focus the first focusable widget if they are not focusable itself. Popup windows can not grab the focus nor do they focus the first focusable widget. This avoids popup windows stealing focus from the underlaying window.
Reimplemented from Dragengine.Gui.Window.
◆ new()
| WindowVirtualKeyboard Dragengine.Gui.WindowVirtualKeyboard.new | ( | ) |
Create window.
Reimplemented from Dragengine.Gui.Window.
◆ onFrameUpdate()
| void Dragengine.Gui.WindowVirtualKeyboard.onFrameUpdate | ( | float | elapsed | ) |
Do frame update.
Reimplemented from Dragengine.Gui.Widget.
◆ popdown()
| void Dragengine.Gui.WindowVirtualKeyboard.popdown | ( | ) |
Pop down windowand clears input widget.
Hides window.
◆ popup()
| void Dragengine.Gui.WindowVirtualKeyboard.popup | ( | Widget | inputWidget | ) |
Pop up window operating on input widget.
Shows the window at suitable position. Chooses keyboard layout best matching input widget. Input is send to the input widget as KeyEvent.
If no suitable keyboard layout exists noting is shown.
◆ selectKeyboardLayout() [1/2]
|
protected |
Select keyboard layout best matching input widget.
◆ selectKeyboardLayout() [2/2]
Select keyboard layout best matching input widget.
◆ sendKeyPressed()
| void Dragengine.Gui.WindowVirtualKeyboard.sendKeyPressed | ( | int | keyCode, |
| int | keyChar | ||
| ) |
Send key pressed event to input widget if present.
◆ sendKeyReleased()
| void Dragengine.Gui.WindowVirtualKeyboard.sendKeyReleased | ( | int | keyCode, |
| int | keyChar | ||
| ) |
Send key released event to input widget if present.
◆ setKeyboardLayoutPanel()
|
protected |
Set active keyboard layout panel or null.
Member Data Documentation
◆ pInputWidget
| Widget Dragengine.Gui.WindowVirtualKeyboard.pInputWidget |
◆ pKeyboardLayoutDefaultPanel
| Panel Dragengine.Gui.WindowVirtualKeyboard.pKeyboardLayoutDefaultPanel |
◆ pKeyboardLayoutNumericPanel
| Panel Dragengine.Gui.WindowVirtualKeyboard.pKeyboardLayoutNumericPanel |
◆ pKeyboardLayoutPanel
| Panel Dragengine.Gui.WindowVirtualKeyboard.pKeyboardLayoutPanel |
◆ pModelShift
| DefaultToggleModel Dragengine.Gui.WindowVirtualKeyboard.pModelShift |
The documentation for this class was generated from the following file:
