UIFileBrowser Class

A file browser with a scrollbar. Used by load_game and save_game.

Declared on: line 146 of Lua/dialogs/resizables/file_browser.lua.
Inheritance: UIFileBrowser » UIResizable » Window
Subclasses: UIChooseFont, UILoadGame, UISaveGame

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) (inherited from Window)
beginResize(x, y, mode) (inherited from UIResizable)
bringToTop() (inherited from Window)
buttonBack()
choiceMade(name)
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)
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 (*)
closed (*)
col_bg
col_scrollbar
colour (*)
control
default_button_sound
draggable (*)
dragging (*)
esc_closes
height (*)
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 (*)

(*) only used in superclass methods

function UIFileBrowser:UIFileBrowser(ui, mode, title, vertical_size, root, show_dates)

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	?	?
root	?	?
show_dates	?	?

Declared on: line 161 of Lua/dialogs/resizables/file_browser.lua.

function UIFileBrowser:buttonBack()

Declared on: line 217 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 212 of Lua/dialogs/resizables/file_browser.lua.