Module GeyserContainer

-- The Geyser Layout Manager by guy -- --

Functions

Geyser.Container:reposition () Responsible for placing/moving/resizing this window to the correct place/size.
Geyser.Container:hide (auto) Hides this window and all its contained windows.
Geyser.Container:show (auto) Shows this window and all windows it contains.
Geyser.Container:raise () Raises the window to the top of the z-order stack, displaying in front of all other windows
Geyser.Container:lower () Lowers the window to the bottom of the z-order stack, displaying behind all other windows
Geyser.Container:move (x, y) Moves this window according to the new x and y contraints set.
Geyser.Container:resize (width, height) Resizes this window according to the new width and height constraints set.
Geyser.Container:setFontSize (fontSize) Sets the default font size for this window.
Geyser.Container:set_constraints (cons) Sets all contraints (x, y, width, height) for this window.
Geyser.Container:flash (time) Flashes a white box over the dimensions of this container.
Geyser.Container:new (cons) Constructor for containers.

Tables

Geyser.Container Represents a generic container with positional information.


Functions

Geyser.Container:reposition ()
Responsible for placing/moving/resizing this window to the correct place/size. Called on window resize events.
Geyser.Container:hide (auto)
Hides this window and all its contained windows.

Parameters:

  • auto
Geyser.Container:show (auto)
Shows this window and all windows it contains.

Parameters:

  • auto
Geyser.Container:raise ()
Raises the window to the top of the z-order stack, displaying in front of all other windows
Geyser.Container:lower ()
Lowers the window to the bottom of the z-order stack, displaying behind all other windows
Geyser.Container:move (x, y)
Moves this window according to the new x and y contraints set.

Parameters:

  • x New x constraint to use. If nil, uses current value.
  • y New y constraint to use. If nil, uses current value.
Geyser.Container:resize (width, height)
Resizes this window according to the new width and height constraints set.

Parameters:

  • width New width constraint to use. If nil, uses current value.
  • height New height constraint to use. If nil, uses current value.
Geyser.Container:setFontSize (fontSize)
Sets the default font size for this window. Will resizes this window if necessary to meet constraints.

Parameters:

  • fontSize The new font size to use.
Geyser.Container:set_constraints (cons)
Sets all contraints (x, y, width, height) for this window.

Parameters:

  • cons Any Lua table that contains appropriate constraint entries.
Geyser.Container:flash (time)
Flashes a white box over the dimensions of this container. This is very useful to see where a container actually is if you've forgotten its details.

Parameters:

  • time Time in seconds to flash for, default is 1.0s.
Geyser.Container:new (cons)
Constructor for containers. This function creates a new container/window Include any parameter such as name or fontSize in cons that are to be used for the new window.

Parameters:

  • cons Any Lua table that contains appropriate constraint entries.

Tables

Geyser.Container
Represents a generic container with positional information. Has no notion of contents and is used to contain other windows and impose some sense of order. other windows

Fields:

  • parent The parent class of this window
  • type The type of this window, usually lowercase of the classname and can be used in checks for certain types. For a Container instance, type is “container.”
  • name The name of this window. This is the same name that Mudlet will use internally for primitive types like labels and miniconsoles. If not specified in the constraints table during creation, an anonymous name unique to this session will be made up.
  • x The x-coordinate relative to this window's container, not absolute from the Mudlet main window. This is not a number, but a constraint specification. To find out the numeric x-coordinate in terms of pixels from the Mudlet main window's origin, use the get_x() method. Default is "10px".
  • y The y-coordinate relative to this window's container, not absolute from the Mudlet main window. This is not a number, but a constraint specification. To find out the numeric y-coordinate in terms of pixels from the Mudlet main window's origin, use the get_y() method. Default is "10px".
  • width The width of this window, possibly relative to the window's container. This is not a number, but a constraint specification. To find out the numeric width in terms of pixels, use the get_width() method. Default is "300px".
  • height The height of this window, possibly relative to the window's container. This is not a number, but a constraint specification. To find out the numeric width in terms of pixels, use the get_width() method. Default is "200px".
  • windowList This is a list of all windows held by this container. It used to handle proper resizing of held windows as well as during show()s and hide()s to recursive show and hide all children windows.
  • windows This is an ordered list of the names of the window held by this container.
  • fontSize The default size font used when calculating dimensions based on the character constraint. Default is 8.
  • h_policy This sets if this widget should be stretched/shrinked horizontally or not
  • v_policy This sets if this widget should be stretched/shrinked vertically or not
  • v_stretch_factor This sets by how much more then window will be stretched vertically in comparison to
  • v_stretch_factor This sets by how much more then window will be stretched vertically in comparison to
generated by LDoc 1.4.6 Last updated 2019-10-04 21:24:12