UIFileBrowser Class
A file browser with a scrollbar. Used by load_game and save_game.
Declared on: line 145 of Lua/dialogs/resizables/file_browser.lua.
Inheritance: UIFileBrowser » UIResizable » Window
Subclasses: UIChooseFont, UIChooseSoundfont, UILoadGame, UILoadMap, UISaveGame, UISaveMap
Inheritance: UIFileBrowser » UIResizable » Window
Subclasses: UIChooseFont, UIChooseSoundfont, UILoadGame, UILoadMap, UISaveGame, UISaveMap
Method Index
- addBevelPanel(x, y, w, h, colour, highlight_colour, shadow_colour, disabled_colour, lowered_colour, apply_ui_scale) (inherited from Window)
- addColourPanel(x, y, w, h, r, g, b, apply_ui_scale) (inherited from Window)
- addKeyHandler(key, handler, ...) (inherited from Window)
- addPanel(sprite_index, x, y, w, h, apply_ui_scale, draw_flags) (inherited from Window)
- addWindow(window) (inherited from Window)
- afterLoad(old, new) (inherited from UIResizable)
- beginDrag(x, y) (inherited from Window)
- beginResize(x, y, mode) (inherited from UIResizable)
- bringToTop() (inherited from Window)
- buttonBack()
- checkChoice(node)
- choiceMade(name)
- close() (inherited from Window)
- draw(canvas, x, y) (inherited from UIResizable)
- getRealXY() (inherited from Window)
- 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)
- hoverTest(active_hover, mouse_x, mouse_y, min_x, max_x, min_y, max_y) (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)
- makeHotkeyBoxOnPanel(panel, confirm_callback, abort_callback) (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, apply_ui_scale) (inherited from Window)
- mustPause() (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)
- onMouseWheel(x, y) (inherited from Window)
- onTick() (inherited from Window)
- onWorldTick() (inherited from Window)
- overrideMinSize(min_width, min_height) (inherited from UIResizable)
- removeAllPanels() (inherited from Window)
- removeKeyHandler(keys) (inherited from Window)
- removeWindow(window) (inherited from Window)
- sendToBottom(window) (inherited from Window)
- sendToTop(window) (inherited from Window)
- setColour(colour) (inherited from UIResizable)
- setDefaultPosition(x, y) (inherited from Window)
- setInputValue(label)
- 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 (*)
- apply_ui_scale (*)
- background_panel (*)
- blink_counter (*)
- blinking_button (*)
- border_pos (*)
- border_sprites (*)
- btn_repeat_delay (*)
- buttons (*)
- buttons_down (*)
- closed (*)
- col_bg
- col_scrollbar
- colour (*)
- confirmName
- control
- cursor_x (*)
- cursor_y (*)
- default_button_sound
- draggable (*)
- dragging (*)
- esc_closes
- height (*)
- hotkeyboxes (*)
- key_handlers (*)
- min_height (*)
- min_width (*)
- modal_class
- mode
- on_top
- panel_sprites (*)
- panels (*)
- parent (*)
- resizable
- scrollbars (*)
- textboxes (*)
- tooltip_regions (*)
- ui (*)
- visible (*)
- width (*)
- windows (*)
- x (*)
- x_original (*)
- y (*)
- y_original (*)
function UIFileBrowser:UIFileBrowser(ui, mode, title, vertical_size, root, show_dates, submit_text)
Constructs the dialog.
Parameters:
| Name | Type | Description |
|---|---|---|
| ui | UI | The active ui. |
| mode | string | Either "menu" or "game" depending on which mode the game is in right now. |
| title | string | The desired title of the dialog. |
| vertical_size | number | |
| root | ? | |
| show_dates | boolean | Whether to show date last modified |
| submit_text | string | Optional alternative labelling of the OK button |
Declared on: line 157 of Lua/dialogs/resizables/file_browser.lua.
function UIFileBrowser:buttonBack()
Declared on: line 238 of Lua/dialogs/resizables/file_browser.lua.
function UIFileBrowser:checkChoice(node)
Check selection is a valid file, and not a directory
Parameters:
| Name | Type | Description |
|---|---|---|
| node | table | user selected element |
Declared on: line 232 of Lua/dialogs/resizables/file_browser.lua.
function UIFileBrowser:choiceMade(name)
Function stub for dialogs to override. This function is called each time a file is chosen.
Parameters:
| Name | Type | Description |
|---|---|---|
| name | string | Name of the file chosen. |
Declared on: line 221 of Lua/dialogs/resizables/file_browser.lua.
function UIFileBrowser:setInputValue(label)
Function stub for dialogs with user input option. This will be called for
updating inputs, override it for a proper implementation in the derived class.
Parameters:
| Name | Type | Description |
|---|---|---|
| label | string | Name of the file chosen |
Declared on: line 226 of Lua/dialogs/resizables/file_browser.lua.