UIDropdown Class
Dropdown "window" used for selection of one item from a list.
Declared on: line 21 of Lua/dialogs/resizables/dropdown.lua.
Inheritance: UIDropdown » UIResizable » Window
Inheritance: UIDropdown » UIResizable » Window
Method Index
- addBevelPanel(x, y, w, h, colour, highlight_colour, shadow_colour, disabled_colour) (inherited from Window)
- addColourPanel(x, y, w, h, r, g, b) (inherited from Window)
- addKeyHandler(key, handler, ...) (inherited from Window)
- addPanel(sprite_index, x, y, w, h) (inherited from Window)
- addWindow(window) (inherited from Window)
- afterLoad(old, new) (inherited from UIResizable)
- beginDrag(x, y) (overrides Window:beginDrag)
- beginResize(x, y, mode) (inherited from UIResizable)
- bringToTop() (inherited from Window)
- close() (inherited from Window)
- draw(canvas, x, y) (inherited from UIResizable)
- getSavedWindowPositionName() (inherited from Window)
- getTooltipAt(x, y) (inherited from Window)
- getTooltipForElement(elem, x, y) (inherited from Window)
- getWindow(window_class) (inherited from Window)
- getWindows(window_class) (inherited from Window)
- hitTest(x, y) (inherited from UIResizable)
- hitTestCorners(x, y) (inherited from UIResizable)
- hitTestPanel(x, y, panel) (inherited from Window)
- makeButtonOnPanel(panel, x, y, w, h, sprite, on_click, on_click_self, on_rightclick) (inherited from Window)
- makeDynamicTooltip(callback, x, y, r, b, tooltip_x, tooltip_y) (inherited from Window)
- makeScrollbarOnPanel(panel, slider_colour, callback, min_value, max_value, page_size, value) (inherited from Window)
- makeTextboxOnPanel(panel, confirm_callback, abort_callback) (inherited from Window)
- makeTooltip(text, x, y, r, b, tooltip_x, tooltip_y) (inherited from Window)
- onChangeLanguage() (inherited from Window)
- onChangeResolution() (inherited from Window)
- onCursorWorldPositionChange(x, y) (inherited from Window)
- onMouseDown(button, x, y) (inherited from UIResizable)
- onMouseMove(x, y, dx, dy) (inherited from Window)
- onMouseUp(button, x, y) (inherited from Window)
- onTick() (inherited from Window)
- onWorldTick() (inherited from Window)
- removeAllPanels() (inherited from Window)
- removeWindow(window) (inherited from Window)
- selectItem(number)
- sendToBottom(window) (inherited from Window)
- sendToTop(window) (inherited from Window)
- setColour(colour) (inherited from UIResizable)
- setDefaultPosition(x, y) (inherited from Window)
- setPosition(x, y) (inherited from Window)
- setSize(width, height) (inherited from UIResizable)
- startButtonBlinking(button_index) (inherited from Window)
- stopButtonBlinking() (inherited from Window)
Member Index
- active_button (*)
- active_scrollbar (*)
- background_panel (*)
- blink_counter (*)
- blinking_button (*)
- border_pos (*)
- border_sprites (*)
- btn_repeat_delay (*)
- buttons (*)
- buttons_down (*)
- callback
- closed (*)
- colour (*)
- default_button_sound
- draggable (*)
- dragging (*)
- esc_closes
- height (*)
- items
- key_handlers (*)
- min_height (*)
- min_width (*)
- modal_class
- panel_sprites (*)
- panels (*)
- parent (*)
- parent_button
- parent_window
- resizable
- scrollbars (*)
- textboxes (*)
- tooltip_regions (*)
- ui (*)
- visible (*)
- width (*)
- windows (*)
- x (*)
- x_original (*)
- y (*)
- y_original (*)
function UIDropdown:UIDropdown(ui, parent_window, parent_button, items, callback, colour)
Constructor for the dropdown "window"
Parameters:
| Name | Type | Description |
|---|---|---|
| ui | UI | The ui the window is created in |
| parent_window | Window | The window that this dropdown will be attached to |
| parent_button | Button | The button in the parent_window that this dropdown will be positioned under |
| items | table | A list of items for the list to display, where each item is a table with at least the field text, and optionally fields font and/or tooltip |
| callback | function | A function to be called when an item is selected. It is called with two parameters: The parent window and the index of the selected item |
| colour | table | A colour in the form of {red = ..., green = ..., blue = ...}. Optional if parent_window is a UIResizable |
Declared on: line 24 of Lua/dialogs/resizables/dropdown.lua.
function UIDropdown:beginDrag(x, y)
Parameters:
| Name | Type | Description |
|---|---|---|
| x | ? | ? |
| y | ? | ? |
Overrides: Window:beginDrag.
Declared on: line 77 of Lua/dialogs/resizables/dropdown.lua.
function UIDropdown:selectItem(number)
Parameters:
| Name | Type | Description |
|---|---|---|
| number | ? | ? |
Declared on: line 69 of Lua/dialogs/resizables/dropdown.lua.