CorsixTH Lua Documentation

UIResizable Class

Class for resizable windows.

Declared on: line 21 of Lua/dialogs/resizable.lua.
Inheritance: UIResizable ยป Window
Subclasses: UICallsDispatcher, UICheats, UICustomise, UIDirectoryBrowser, UIDropdown, UIFileBrowser, UIFolder, UILuaConsole, UIMainMenu, UIMenuList, UINewGame, UIOptions, UIResolution, UITipOfTheDay, UIUpdate
Full description:
If resizable is set to true, the user can resize by clicking and dragging any of the corners.

Method Index

Member Index

(*) only used in superclass methods
function UIResizable:UIResizable(ui, width, height, colour, no_borders, background_bevel)

Parameters:

NameTypeDescription
ui ? ?
width ? ?
height ? ?
colour ? ?
no_borders ? ?
background_bevel ? ?

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

function UIResizable:afterLoad(old, new)

Parameters:

NameTypeDescription
old ? ?
new ? ?

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

function UIResizable:beginResize(x, y, mode)

Initiate resizing of the resizable window.

Parameters:

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

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

function UIResizable:draw(canvas, x, y)

Parameters:

NameTypeDescription
canvas ? ?
x ? ?
y ? ?

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

function UIResizable:hitTest(x, y)

Parameters:

NameTypeDescription
x ? ?
y ? ?

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

function UIResizable:hitTestCorners(x, y)

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

Parameters:

NameTypeDescription
x ? the x coordinate to test
y ? the y coordinate to test

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

function UIResizable:onMouseDown(button, x, y)

Parameters:

NameTypeDescription
button ? ?
x ? ?
y ? ?

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

function UIResizable:setColour(colour)

Parameters:

NameTypeDescription
colour ? ?

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

function UIResizable:setSize(width, height)

Parameters:

NameTypeDescription
width ? ?
height ? ?

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

Page generated on Sat Feb 07, 2015 at 18:38:28 by LDocGen.