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

List box enabling user to edit bindings. More...

Inheritance diagram for Dragengine.Gui.EditBindingsListBox:
Dragengine.Gui.ListBox Dragengine.Gui.Container Dragengine.Gui.RangeModelListener Dragengine.Gui.ListModelListener Dragengine.Gui.Widget

Classes

class  CaptureFinished
 Capture binding result listener. More...
 
class  DoubleClickCaptureBinding
 Capture binding if mouse button is double clicked. More...
 
class  ReassignResult
 Reassign result listener. More...
 

Public Member Functions

void captureBinding (EditBindingsListModelEntry entry)
 Capture and add binding for entry. More...
 
EditBindingsListBox new (EditBindingsListModel model)
 Create edit bindings list box. More...
 
EditBindingsListBox new (EditBindingsListModel model, EditBindingsListRenderer renderer)
 Create edit bindings list box. More...
 
void onKeyPress (KeyEvent event)
 Key pressed event. More...
 
void selectedCaptureBinding ()
 Capture and add binding for selected entry if any is selected. More...
 
void selectedRemoveBindings ()
 Remove all key bindings of selected entry if any is selected. More...
 
- Public Member Functions inherited from Dragengine.Gui.ListBox
bool allowsChildGrabFocus ()
 Container allows child widgets to grab the focus. More...
 
void contentChanged (ListModel listModel, int fromIndex, int toIndex)
 Content of the model changed. More...
 
void dispose ()
 Dispose of widget. More...
 
void elementsAdded (ListModel listModel, int fromIndex, int toIndex)
 Elements added. More...
 
void elementsRemoved (ListModel listModel, int fromIndex, int toIndex)
 Elements removed. More...
 
Widget findFocusableWidget ()
 First widget that can grab the focus or null if absent. More...
 
Widget findLastFocusableWidget ()
 Last widget that can grab the focus or null if absent. More...
 
int getElementAt (int x, int y)
 Index of element at position or -1 if not found. More...
 
int getElementAt (Point position)
 Index of the element at position or -1 if not found. More...
 
int getElementHeight ()
 Element height. More...
 
Point getElementPositionAt (int index)
 Position of element at index. More...
 
ListElementRenderer getElementRenderer ()
 List element renderer. More...
 
int getElementWidth ()
 Element width. More...
 
int getFirstElement ()
 Index of the first visible element. More...
 
RangeModel getHorizontalRangeModel ()
 Horizontal range model for viewports to synchronize the horizontal scrollbar. More...
 
int getLastElement ()
 Index of the last visible element. More...
 
Point getMinimumSize ()
 Minimal size of widget. More...
 
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...
 
ListModel getModel ()
 List model. More...
 
int getNumberDisplayLines ()
 Number of lines to display. More...
 
int getpVisibleColumnCount ()
 Count of visible columns. More...
 
int getpVisibleRowCount ()
 Count of visible rows. More...
 
int getSelectedElement ()
 Index of selected item or -1 if none is selected. More...
 
Type getType ()
 List type. More...
 
RangeModel getVerticalRangeModel ()
 Vertical range model for viewports to synchronize the vertical scrollbar. More...
 
bool hasFocusWidget ()
 Focus widget is inside container somewhere. More...
 
void makeElementVisible (int index)
 Make element fully visible by adjusting scroll position if required. More...
 
void makeSelectedElementVisible ()
 Make selected element fully visible by adjusting scroll position if required. More...
 
ListBox new ()
 Create list box. More...
 
ListBox new (ListModel model)
 Create list box using model. More...
 
ListBox new (ListModel model, ListElementRenderer renderer)
 Create list box using model and element renderer. More...
 
Widget nextFocusWidgetAfter (Widget widget)
 Find next widget in the focus cycle that can grab the focus. More...
 
void onButtonPress (MouseEvent event)
 Mouse button pressed. More...
 
void onButtonRelease (MouseEvent event)
 Mouse button released. More...
 
void onGuiThemeChanged ()
 Gui theme changed. More...
 
void onMouseMove (MouseEvent event)
 Mouse moved. More...
 
void onMouseWheel (MouseEvent event)
 Mouse wheel has moved. More...
 
void onResize (WidgetEvent event)
 Size 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 rangeChanged (RangeModel rangeModel)
 Range properties changed. More...
 
void selectionChanged (ListModel listModel)
 Selection in the model changed. More...
 
void setElementRenderer (ListElementRenderer renderer)
 Set list element renderer. More...
 
void setModel (ListModel model)
 Set list model. More...
 
void setNumberDisplayLines (int lines)
 Set number of lines to display. More...
 
void setSelectedElement (int index)
 Set index of selected item or -1 if none is selected. More...
 
void setType (Type type)
 Set list type. More...
 
void valueChanged (RangeModel rangeModel)
 Value changed. More...
 
- Public Member Functions inherited from Dragengine.Gui.Container
void addWidget (Widget widget)
 
void addWidget (Widget widget, Object settings)
 
void doLayout ()
 
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 ()
 
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 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 (int x, int y, int width, int height)
 
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)
 
void onPaddingChanged ()
 Padding 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...
 
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 ()
 
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 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 requestGrabFocus (Widget widget)
 
void runWhileBlockingLayoutParent (Block ablock)
 Run block while layouting is blocked. More...
 
void safeDispose ()
 Safely dispose of widget. More...
 
void sendEvent (Event event)
 
void sendEventToListeners (Event event, bool sendToParent)
 Send event to all appropriate listeners for events of its kind. More...
 
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...
 

Protected Member Functions

void askUserReassignBinding (EditBindingsListModelEntry entry, WindowCaptureBinding.CaptureResult captured, Command command)
 Ask user to reassign binding. More...
 
void askUserReassignBinding (WindowCaptureBinding.CaptureResult captured, Command command)
 Ask user to reassign binding. More...
 
- Protected Member Functions inherited from Dragengine.Gui.ListBox
void checkModel ()
 Check if model is dirty and update parameters if required. More...
 
void recalcVisibleElements ()
 Recalculate number of visible elements. More...
 
void updateElementSize ()
 Update element size. More...
 
void updateRangeModels ()
 Update range model. More...
 
void updateRenderWidgets ()
 Update render widgets if required. 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...
 

Additional Inherited Members

- 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
 

Detailed Description

List box enabling user to edit bindings.

List box shows all commands the user can bind with all bindings they are currently bound to. The user can edit commands to add new bindings by pressing input controls or deleting all bindings for a command.

Model is instance of EditBindingsListModel.

To change the appearance of overwrite the appropriate methods.

Member Function Documentation

◆ askUserReassignBinding() [1/2]

void Dragengine.Gui.EditBindingsListBox.askUserReassignBinding ( EditBindingsListModelEntry  entry,
WindowCaptureBinding.CaptureResult  captured,
Command  command 
)
protected

Ask user to reassign binding.

Version
1.20
Parameters
capturedCaptured binding causing the problem.
commandCommand already assigned to the binding.

◆ askUserReassignBinding() [2/2]

void Dragengine.Gui.EditBindingsListBox.askUserReassignBinding ( WindowCaptureBinding.CaptureResult  captured,
Command  command 
)
protected

Ask user to reassign binding.

Parameters
capturedCaptured binding causing the problem.
commandCommand already assigned to the binding.

◆ captureBinding()

void Dragengine.Gui.EditBindingsListBox.captureBinding ( EditBindingsListModelEntry  entry)

Capture and add binding for entry.

Version
1.20

◆ new() [1/2]

EditBindingsListBox Dragengine.Gui.EditBindingsListBox.new ( EditBindingsListModel  model)

Create edit bindings list box.

Parameters
modelModel to use.

◆ new() [2/2]

EditBindingsListBox Dragengine.Gui.EditBindingsListBox.new ( EditBindingsListModel  model,
EditBindingsListRenderer  renderer 
)

Create edit bindings list box.

Parameters
modelModel to use.
rendererRenderer to use.

◆ onKeyPress()

void Dragengine.Gui.EditBindingsListBox.onKeyPress ( KeyEvent  event)

Key pressed event.

Reimplemented from Dragengine.Gui.ListBox.

◆ selectedCaptureBinding()

void Dragengine.Gui.EditBindingsListBox.selectedCaptureBinding ( )

Capture and add binding for selected entry if any is selected.

◆ selectedRemoveBindings()

void Dragengine.Gui.EditBindingsListBox.selectedRemoveBindings ( )

Remove all key bindings of selected entry if any is selected.


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