UIResizable Class

Class for resizable windows.

Declared on: line 21 of Lua/dialogs/resizable.lua.
Inheritance: UIResizable » Window
Subclasses: UIAdviserHistory, UICallsDispatcher, UICheats, UICustomise, UIDirectoryBrowser, UIDropdown, UIFileBrowser, UIFolder, UIHotkeyAssign, UILuaConsole, UIMachineMenu, UIMainMenu, UIMapEditor, UIMenuList, UINewGame, UIOptions, UIScrollSpeed, UIShiftScrollSpeed, UISoundSettings, UITipOfTheDay, UIUpdate, UIWindowSize, UIZoomSpeed
Full description:
If resizable is set to true, the user can resize by clicking and dragging any of the corners.

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) (overrides Window:afterLoad)
beginDrag(x, y) (inherited from Window)
beginResize(x, y, mode)
bringToTop() (inherited from Window)
close() (inherited from Window)
draw(canvas, x, y) (overrides Window:draw)
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) (overrides Window:hitTest)
hitTestCorners(x, y)
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) (overrides Window:onMouseDown)
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)
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)
setDefaultPosition(x, y) (inherited from Window)
setPosition(x, y) (inherited from Window)
setSize(width, height) (overrides Window:setSize)
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 (*)
colour
cursor_x (*)
cursor_y (*)
default_button_sound (*)
draggable (*)
dragging
height
hotkeyboxes (*)
key_handlers (*)
min_height
min_width
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 UIResizable:UIResizable(ui, width, height, colour, no_borders, background_bevel)

Parameters:

Name	Type	Description
ui	?	?
width	?	?
height	?	?
colour	?	?
no_borders	?	?
background_bevel	?	?

Declared on: line 34 of Lua/dialogs/resizable.lua.

function UIResizable:afterLoad(old, new)

Parameters:

Name	Type	Description
old	?	?
new	?	?

Overrides: Window:afterLoad.
Declared on: line 211 of Lua/dialogs/resizable.lua.

function UIResizable:beginResize(x, y, mode)

Initiate resizing of the resizable window.

Parameters:

Name	Type	Description
x	?	The X position of the cursor in window coordinates.
y	?	The Y position of the cursor in window coordinates.
mode	?	Either one of "ul", "ur", "ll" or "lr" to denote in which direction to resize. (upper/lower + left/right)

Declared on: line 170 of Lua/dialogs/resizable.lua.

function UIResizable:draw(canvas, x, y)

Parameters:

Name	Type	Description
canvas	?	?
x	?	?
y	?	?

Overrides: Window:draw.
Declared on: line 97 of Lua/dialogs/resizable.lua.

function UIResizable:hitTest(x, y)

Parameters:

Name	Type	Description
x	?	?
y	?	?

Overrides: Window:hitTest.
Declared on: line 131 of Lua/dialogs/resizable.lua.

function UIResizable:hitTestCorners(x, y)

Tests if any of the four corners of the window border is hit

Parameters:

Name	Type	Description
x	?	the x coordinate to test
y	?	the y coordinate to test

Declared on: line 149 of Lua/dialogs/resizable.lua.

function UIResizable:onMouseDown(button, x, y)

Parameters:

Name	Type	Description
button	?	?
x	?	?
y	?	?

Overrides: Window:onMouseDown.
Declared on: line 122 of Lua/dialogs/resizable.lua.

function UIResizable:overrideMinSize(min_width, min_height)

Must be called before UIResizable:setSize

Parameters:

Name	Type	Description
min_width	int	The new minimum width of the window
min_height	int	The new minimum height of the window

Declared on: line 84 of Lua/dialogs/resizable.lua.

function UIResizable:setColour(colour)

Parameters:

Name	Type	Description
colour	?	?

Declared on: line 92 of Lua/dialogs/resizable.lua.

function UIResizable:setSize(width, height)

Apply the initial width and height of the window

Parameters:

Name	Type	Description
width	int	The initial width
height	int	The initial height

Overrides: Window:setSize.
Declared on: line 65 of Lua/dialogs/resizable.lua.