Drag[en]gine Script Module DragonScript  1.21
Dragengine.Gui.ComboBox Class Reference

Drop down list displaying the currently selected element. More...

Inheritance diagram for Dragengine.Gui.ComboBox:
Dragengine.Gui.Container Dragengine.Gui.ListModelListener Dragengine.Gui.Widget

Classes

class  ComboPopup
 Popup window. More...
 
class  EditorFocusLost
 
class  EditorValueChanged
 Editor value changed listener. More...
 
class  PopupWidgetListener
 
class  RollUpMouseListener
 Roll up mouse listener. More...
 

Public Member Functions

void contentChanged (ListModel listModel, int fromIndex, int toIndex)
 Content of the model changed. More...
 
void dispose ()
 Dispose of widget. More...
 
void dropDown ()
 Drop down the list box if not already dropped down. More...
 
bool droppedDown ()
 Drop down list visible. More...
 
void elementsAdded (ListModel listModel, int fromIndex, int toIndex)
 Elements have been added. More...
 
void elementsRemoved (ListModel listModel, int fromIndex, int toIndex)
 Elements have been removed. More...
 
Widget getButtonDropDownWidget ()
 Drop down button widget or null if not set. More...
 
Point getDefaultElementSize ()
 Get default element size. More...
 
ComboBoxEditor getEditor ()
 Combo box editor if editable or null if not editable. More...
 
ListElementRenderer getElementRenderer ()
 List element renderer. More...
 
ListModel getModel ()
 List model. More...
 
int getNumberDisplayLines ()
 Number of lines to display in the drop down list box. More...
 
int getSelectedElement ()
 Index of the selected item or -1 if none is selected. More...
 
bool getSelectFromEditorOnDropDown ()
 Set selected from editor value on drop down. More...
 
Widget getWidgetSelectedElement ()
 Selected element widget or null. More...
 
void grabFocus ()
 Grab focus if possible. More...
 
ComboBox new ()
 Create combo box widget. More...
 
ComboBox new (ListModel model)
 Create combo box widget. More...
 
ComboBox new (ListModel model, ComboBoxEditor editor)
 Create combo box widget. More...
 
ComboBox new (ListModel model, ListElementRenderer renderer)
 Create combo box widget. More...
 
ComboBox new (ListModel model, ListElementRenderer renderer, ComboBoxEditor editor)
 Create combo box widget. More...
 
void onArrowDown ()
 Arrow down pressed. More...
 
void onArrowUp ()
 Arrow up pressed. More...
 
void onButtonPress (MouseEvent event)
 Mouse button pressed. More...
 
void onDesignerSelectorChanged ()
 Designer selector changed. More...
 
void onFocusLost (FocusEvent event)
 Widget lost focus. More...
 
void onFocusReceived (FocusEvent event)
 Widget received focus. More...
 
void onGuiThemeChanged ()
 Gui theme changed. More...
 
void onKeyPress (KeyEvent event)
 Key pressed. More...
 
void onMouseWheel (MouseEvent event)
 
void onPageDown ()
 Page down pressed. More...
 
void onPageUp ()
 Page up pressed. More...
 
void onResize (WidgetEvent event)
 Size changed. More...
 
bool requestReleaseMouse (Widget widget)
 Request to release mouse capture. More...
 
void rollUp ()
 Roll up the list box if dropped down. More...
 
void selectionChanged (ListModel listModel)
 Selection in the list box changed. More...
 
void setDropDownButtonWidget (Widget widget)
 Set drop down button widget or null if not set. More...
 
void setEditor (ComboBoxEditor editor)
 Set combo box editor if editable or null if not editable. 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 in the drop down list box. More...
 
void setSelectedElement (int index)
 Set index of the selected item or -1 if none is selected. More...
 
void setSelectedFromEditorValue ()
 Set selection from editor value. More...
 
void setSelectFromEditorOnDropDown (bool selectedFromEditorOnDropDown)
 Set selected from editor value on drop down. More...
 
void startEditing ()
 Start editing if an editor is set. More...
 
void toggleDropDown ()
 Toggle between dropped down and rolled up state. More...
 
void updateDefaultElementSize ()
 Update default element size. More...
 
void updateSelectedVisibility ()
 Update visibility of editor and selected element renderer. More...
 
void updateSelectedWidget ()
 Update selected widget. 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 (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)
 
Widget nextFocusWidgetAfter (Widget widget)
 Find next widget in the focus cycle that can grab the focus. More...
 
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 removeAllWidgets ()
 Remove and dispose all widgets. More...
 
void removeWidget (Widget widget)
 Remove widget without disposing. More...
 
bool requestCaptureMouse (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...
 
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 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 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...
 
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 ()
 
Widget nextFocusWidget ()
 Find next widget in the focus cycle that can grab the focus. More...
 
void notifyBorderParametersChanged ()
 
void onDesignerChanged ()
 Designer changed. More...
 
void onDispose (WidgetEvent event)
 Window is disposing. 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 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 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 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...
 
void stopRepeatEventTimer ()
 

Public Attributes

Point pDefaultElementSize
 
ComboPopup pDropDown
 
bool pDropDownRequiresSelFromEditor
 
ComboBoxEditor pEditor
 
EditorFocusLost pEditorFocusLost
 
EditorValueChanged pEditorValueChanged
 
ListBox pListBox
 
Panel pPanelSelectedElement
 
Widget pSelectedElement
 
String pSelectedElementDesignerSelector
 
bool pSelFromEditorOnDropDown
 
Panel pSpacer
 
Widget pWidgetButtonDropDown
 
Container pWidgetButtonDropDownContainer
 
- 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
 
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 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

bool getDropDownRequiresSelectFromEditor ()
 Select from editor value is required during next drop down. More...
 
void setDropDownRequiresSelectFromEditor (bool requiresSelectFromEditor)
 Set select from editor value is required during next drop down. 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

Drop down list displaying the currently selected element.

Supports designing using designer selector "ComboBox". The drop-down list box supports desining using designer selector "ListBox.ComboBox".

Member Function Documentation

◆ contentChanged()

void Dragengine.Gui.ComboBox.contentChanged ( ListModel  listModel,
int  fromIndex,
int  toIndex 
)

Content of the model changed.

Implements Dragengine.Gui.ListModelListener.

◆ dispose()

void Dragengine.Gui.ComboBox.dispose ( )

Dispose of widget.

Reimplemented from Dragengine.Gui.Widget.

◆ dropDown()

void Dragengine.Gui.ComboBox.dropDown ( )

Drop down the list box if not already dropped down.

◆ droppedDown()

bool Dragengine.Gui.ComboBox.droppedDown ( )

Drop down list visible.

◆ elementsAdded()

void Dragengine.Gui.ComboBox.elementsAdded ( ListModel  listModel,
int  fromIndex,
int  toIndex 
)

Elements have been added.

Implements Dragengine.Gui.ListModelListener.

◆ elementsRemoved()

void Dragengine.Gui.ComboBox.elementsRemoved ( ListModel  listModel,
int  fromIndex,
int  toIndex 
)

Elements have been removed.

Implements Dragengine.Gui.ListModelListener.

◆ getButtonDropDownWidget()

Widget Dragengine.Gui.ComboBox.getButtonDropDownWidget ( )

Drop down button widget or null if not set.

For use by button designers.

◆ getDefaultElementSize()

Point Dragengine.Gui.ComboBox.getDefaultElementSize ( )

Get default element size.

◆ getDropDownRequiresSelectFromEditor()

bool Dragengine.Gui.ComboBox.getDropDownRequiresSelectFromEditor ( )
protected

Select from editor value is required during next drop down.

Version
1.7

◆ getEditor()

ComboBoxEditor Dragengine.Gui.ComboBox.getEditor ( )

Combo box editor if editable or null if not editable.

◆ getElementRenderer()

ListElementRenderer Dragengine.Gui.ComboBox.getElementRenderer ( )

List element renderer.

◆ getModel()

ListModel Dragengine.Gui.ComboBox.getModel ( )

List model.

◆ getNumberDisplayLines()

int Dragengine.Gui.ComboBox.getNumberDisplayLines ( )

Number of lines to display in the drop down list box.

◆ getSelectedElement()

int Dragengine.Gui.ComboBox.getSelectedElement ( )

Index of the selected item or -1 if none is selected.

◆ getSelectFromEditorOnDropDown()

bool Dragengine.Gui.ComboBox.getSelectFromEditorOnDropDown ( )

Set selected from editor value on drop down.

Version
1.7

If true delays sets selected from editor value until drop down. If false sets selected from editor immediately. This can be slow down UI if the list has many elements.

Default value is true.

◆ getWidgetSelectedElement()

Widget Dragengine.Gui.ComboBox.getWidgetSelectedElement ( )

Selected element widget or null.

Version
1.7

◆ grabFocus()

void Dragengine.Gui.ComboBox.grabFocus ( )

Grab focus if possible.

If an editor is set grabs focus of edit widget instead.

Reimplemented from Dragengine.Gui.Widget.

◆ new() [1/5]

ComboBox Dragengine.Gui.ComboBox.new ( )

Create combo box widget.

Reimplemented from Dragengine.Gui.Container.

◆ new() [2/5]

ComboBox Dragengine.Gui.ComboBox.new ( ListModel  model)

Create combo box widget.

◆ new() [3/5]

ComboBox Dragengine.Gui.ComboBox.new ( ListModel  model,
ComboBoxEditor  editor 
)

Create combo box widget.

◆ new() [4/5]

ComboBox Dragengine.Gui.ComboBox.new ( ListModel  model,
ListElementRenderer  renderer 
)

Create combo box widget.

◆ new() [5/5]

ComboBox Dragengine.Gui.ComboBox.new ( ListModel  model,
ListElementRenderer  renderer,
ComboBoxEditor  editor 
)

Create combo box widget.

◆ onArrowDown()

void Dragengine.Gui.ComboBox.onArrowDown ( )

Arrow down pressed.

Version
1.17

◆ onArrowUp()

void Dragengine.Gui.ComboBox.onArrowUp ( )

Arrow up pressed.

Version
1.17

◆ onButtonPress()

void Dragengine.Gui.ComboBox.onButtonPress ( MouseEvent  event)

Mouse button pressed.

◆ onDesignerSelectorChanged()

void Dragengine.Gui.ComboBox.onDesignerSelectorChanged ( )

Designer selector changed.

Reimplemented from Dragengine.Gui.Widget.

◆ onFocusLost()

void Dragengine.Gui.ComboBox.onFocusLost ( FocusEvent  event)

Widget lost focus.

Reimplemented from Dragengine.Gui.Widget.

◆ onFocusReceived()

void Dragengine.Gui.ComboBox.onFocusReceived ( FocusEvent  event)

Widget received focus.

Reimplemented from Dragengine.Gui.Widget.

◆ onGuiThemeChanged()

void Dragengine.Gui.ComboBox.onGuiThemeChanged ( )

Gui theme changed.

Called if setGuiTheme is used or parent changed.

Warning
You have to super-call this method since it is used a bit differently than the other callback methods.

Reimplemented from Dragengine.Gui.Container.

◆ onKeyPress()

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

Key pressed.

◆ onMouseWheel()

void Dragengine.Gui.ComboBox.onMouseWheel ( MouseEvent  event)

Mouse wheeled.

◆ onPageDown()

void Dragengine.Gui.ComboBox.onPageDown ( )

Page down pressed.

Version
1.17

◆ onPageUp()

void Dragengine.Gui.ComboBox.onPageUp ( )

Page up pressed.

Version
1.17

◆ onResize()

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

Size changed.

Reimplemented from Dragengine.Gui.Widget.

◆ requestReleaseMouse()

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

Request to release mouse capture.

Capture mouse to popup window if visible. Required if editor widget captures mouse.

Reimplemented from Dragengine.Gui.Container.

◆ rollUp()

void Dragengine.Gui.ComboBox.rollUp ( )

Roll up the list box if dropped down.

◆ selectionChanged()

void Dragengine.Gui.ComboBox.selectionChanged ( ListModel  listModel)

Selection in the list box changed.

Implements Dragengine.Gui.ListModelListener.

◆ setDropDownButtonWidget()

void Dragengine.Gui.ComboBox.setDropDownButtonWidget ( Widget  widget)

Set drop down button widget or null if not set.

For use by button designers.

◆ setDropDownRequiresSelectFromEditor()

void Dragengine.Gui.ComboBox.setDropDownRequiresSelectFromEditor ( bool  requiresSelectFromEditor)
protected

Set select from editor value is required during next drop down.

Version
1.7

◆ setEditor()

void Dragengine.Gui.ComboBox.setEditor ( ComboBoxEditor  editor)

Set combo box editor if editable or null if not editable.

◆ setElementRenderer()

void Dragengine.Gui.ComboBox.setElementRenderer ( ListElementRenderer  renderer)

Set list element renderer.

◆ setModel()

void Dragengine.Gui.ComboBox.setModel ( ListModel  model)

Set list model.

◆ setNumberDisplayLines()

void Dragengine.Gui.ComboBox.setNumberDisplayLines ( int  lines)

Set number of lines to display in the drop down list box.

◆ setSelectedElement()

void Dragengine.Gui.ComboBox.setSelectedElement ( int  index)

Set index of the selected item or -1 if none is selected.

◆ setSelectedFromEditorValue()

void Dragengine.Gui.ComboBox.setSelectedFromEditorValue ( )

Set selection from editor value.

◆ setSelectFromEditorOnDropDown()

void Dragengine.Gui.ComboBox.setSelectFromEditorOnDropDown ( bool  selectedFromEditorOnDropDown)

Set selected from editor value on drop down.

Version
1.7

If true delays sets selected from editor value until drop down. If false sets selected from editor immediately. This can be slow down UI if the list has many elements.

Default value is true.

◆ startEditing()

void Dragengine.Gui.ComboBox.startEditing ( )

Start editing if an editor is set.

◆ toggleDropDown()

void Dragengine.Gui.ComboBox.toggleDropDown ( )

Toggle between dropped down and rolled up state.

◆ updateDefaultElementSize()

void Dragengine.Gui.ComboBox.updateDefaultElementSize ( )

Update default element size.

◆ updateSelectedVisibility()

void Dragengine.Gui.ComboBox.updateSelectedVisibility ( )

Update visibility of editor and selected element renderer.

◆ updateSelectedWidget()

void Dragengine.Gui.ComboBox.updateSelectedWidget ( )

Update selected widget.

Member Data Documentation

◆ pDefaultElementSize

Point Dragengine.Gui.ComboBox.pDefaultElementSize

◆ pDropDown

ComboPopup Dragengine.Gui.ComboBox.pDropDown

◆ pDropDownRequiresSelFromEditor

bool Dragengine.Gui.ComboBox.pDropDownRequiresSelFromEditor

◆ pEditor

ComboBoxEditor Dragengine.Gui.ComboBox.pEditor

◆ pEditorFocusLost

EditorFocusLost Dragengine.Gui.ComboBox.pEditorFocusLost

◆ pEditorValueChanged

EditorValueChanged Dragengine.Gui.ComboBox.pEditorValueChanged

◆ pListBox

ListBox Dragengine.Gui.ComboBox.pListBox

◆ pPanelSelectedElement

Panel Dragengine.Gui.ComboBox.pPanelSelectedElement

◆ pSelectedElement

Widget Dragengine.Gui.ComboBox.pSelectedElement

◆ pSelectedElementDesignerSelector

String Dragengine.Gui.ComboBox.pSelectedElementDesignerSelector

◆ pSelFromEditorOnDropDown

bool Dragengine.Gui.ComboBox.pSelFromEditorOnDropDown

◆ pSpacer

Panel Dragengine.Gui.ComboBox.pSpacer

◆ pWidgetButtonDropDown

Widget Dragengine.Gui.ComboBox.pWidgetButtonDropDown

◆ pWidgetButtonDropDownContainer

Container Dragengine.Gui.ComboBox.pWidgetButtonDropDownContainer

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