Module Geyser.UserWindow
Represents a UserWindow Class.
See also: Mudlet Manual
Info:
- Author: guy,Edru
Functions
| Geyser.UserWindow:disableAutoDock () | Disables the automatic docking at the borders |
| Geyser.UserWindow:enableAutoDock () | Enables the automatic docking at the borders if it was previously disabled |
| Geyser.UserWindow:move (x, y) | Moves the UserWindow: is set to floating state if this function is used |
| Geyser.UserWindow:new (cons) | Geyser UserWindow constructor |
| Geyser.UserWindow:new2 (cons) | Overridden constructor to use add2 |
| Geyser.UserWindow:resetTitle () | Resets the title of your UserWindow to default |
| Geyser.UserWindow:resize (width, height) | Resizes the UserWindow: only works if your UserWindow is in floating state |
| Geyser.UserWindow:setDockPosition (pos) | Your UserWindow will be docked at position (pos): works also if autoDock is disabled |
| Geyser.UserWindow:setStyleSheet (css) | Sets the style sheet of the UserWindows (border and title area) |
| Geyser.UserWindow:setTitle (text) | Changes the title text of your UserWindow |
Fields
| Geyser.UserWindow | Represents a UserWindow Class Support of UserWindows in Geyser UserWindows use also all the functions of MiniConsole as they contain one |
Functions
- Geyser.UserWindow:disableAutoDock ()
- Disables the automatic docking at the borders
- Geyser.UserWindow:enableAutoDock ()
- Enables the automatic docking at the borders if it was previously disabled
- Geyser.UserWindow:move (x, y)
-
Moves the UserWindow:
is set to floating state if this function is used
Parameters:
- x x-coordinate
- y y-coordinate
- Geyser.UserWindow:new (cons)
-
Geyser UserWindow constructor
Parameters:
- cons table of Geyser MiniConsole options such as name, width, and height.
UserWindow parameters are:
- restoreLayout restore previously saved Layout or not (is set to false if not set) (default 'false')
- docked start the container in a docked state (if set to true x, y, width and height will be ignored) (default 'nil')
- autoDock dock at the borders if the window is put at them (set to true if not set) (default 'true')
- dockPosition choose the dockPosition at creation. Possible values are: "top", "bottom", "right", "left" and "floating" (is set to "right" if not set) (default 'right')
- titleText choose your UserWindows title (set to default title if not set)
- cons table of Geyser MiniConsole options such as name, width, and height.
UserWindow parameters are:
- Geyser.UserWindow:new2 (cons)
-
Overridden constructor to use add2
Parameters:
- cons
- Geyser.UserWindow:resetTitle ()
- Resets the title of your UserWindow to default
- Geyser.UserWindow:resize (width, height)
-
Resizes the UserWindow:
only works if your UserWindow is in floating state
Parameters:
- width userwindow widh
- height userwindow height
- Geyser.UserWindow:setDockPosition (pos)
-
Your UserWindow will be docked at position (pos):
works also if autoDock is disabled
Parameters:
- pos possible positions are "top", "bottom","left", "right" and "floating"
- Geyser.UserWindow:setStyleSheet (css)
-
Sets the style sheet of the UserWindows (border and title area)
Parameters:
- css The style sheet string
- Geyser.UserWindow:setTitle (text)
-
Changes the title text of your UserWindow
Parameters:
- text title text of your UserWindow