Class Frame
The primary container for Vyzor Components.
Methods
| Frame:Frame (_name, _x, _y, _width, _height) | Frame constructor. |
Class Frame
| self.Name.get () | Returns the Frame's name. |
| self.IsBounding.get () | Returns whether or not the Frame is bounding. |
| self.IsBounding.set (value) | Sets whether or not the Frame is bounding. |
| self.BoundingMode.get () | Returns the BoundingMode for the Frame. |
| self.BoundingMode.set (value) | Sets the BoundingMode for this Frame. |
| self.Container.get () | Returns the parent Frame. |
| self.Container.set (value) | Sets the parent Frame. |
| self.Components.get () | Returns the Components in the Frame. |
| self.MiniConsoles.get () | Returns the MiniConsoles in the Frame. |
| self.Compounds.get () | Returns the Compounds in the Frame. |
| self.Frames.get () | Returns the Frames in the Frame. |
| self.Position.get () | Returns the Position supercomponent. |
| self.Size.get () | Returns the Size supercomponent. |
| self.Stylesheet.get () | Updates and returns the stylesheet for the Frame. |
| self.Callback.get () | Returns the callback for the Frame. |
| self.Callback.set (value) | Sets the callback for the Frame to be used when clicked. |
| self.CallbackArguments.get () | Returns the callback arguments passed to the callback. |
| self.CallbackArguments.set (value) | Sets the callback arguments to be passed to the callback. |
| self.IsDrawn.get () | Returns a flag signalling whether or not the Frame has been drawn. |
| self.IsPlaceholder.get () | Returns a flag signaling whether or not a label will be drawn for this Frame. |
| self.IsPlaceholder.set (value) | Toggles whether or not to draw a label for this Frame. |
| self:Add (object) | Adds a new object. |
| self:Remove (object) | Removes an object. |
| self:Draw () | Draws this Frame. |
| self:Resize (width, height) | Resizes the Frame and its children. |
| self:Move (x, y) | Repositions the Frame and its children. |
| self:Hide ([skipChildren=false]) | Hides the Frame and, optionally, its children. |
| self:Show ([skipChildren=false]) | Reveals the Frame and, optionally, its children. |
| self:Echo (text) | Displays text on the Frame. |
| self:CEcho (text) | Displays text on the Frame. |
| self:Clear ([clearChildren=false]) | Clears all text from the Frame and, optionally, its children. |
Methods
- Frame:Frame (_name, _x, _y, _width, _height)
-
Frame constructor.
Parameters:
- _name string The name of the Frame, used for addressing.
- _x number Initial X position of the Frame. Defaults to 0.
- _y number Initial Y position of the Frame. Defaults to 0.
- _width number Initial width of the Frame. Defaults to 1.
- _height number Initial height of the Frame. Defaults to 1.
Returns:
Class Frame
- self.Name.get ()
-
Returns the Frame's name.
Returns:
- self.IsBounding.get ()
-
Returns whether or not the Frame is bounding.
Returns:
-
bool
- self.IsBounding.set (value)
-
Sets whether or not the Frame is bounding.
Parameters:
- value bool
- self.BoundingMode.get ()
-
Returns the BoundingMode for the Frame.
Returns:
- self.BoundingMode.set (value)
-
Sets the BoundingMode for this Frame.
Parameters:
- value BoundingMode
- self.Container.get ()
-
Returns the parent Frame.
Returns:
- self.Container.set (value)
-
Sets the parent Frame.
Raises the sysWindowResizeEvent upon completion.
Parameters:
- value Frame
- self.Components.get ()
-
Returns the Components in the Frame.
Returns:
- self.MiniConsoles.get ()
-
Returns the MiniConsoles in the Frame.
Returns:
- self.Compounds.get ()
-
Returns the Compounds in the Frame.
Returns:
- self.Frames.get ()
-
Returns the Frames in the Frame.
Returns:
- self.Position.get ()
-
Returns the Position supercomponent.
Returns:
- self.Size.get ()
-
Returns the Size supercomponent.
Returns:
- self.Stylesheet.get ()
-
Updates and returns the stylesheet for the Frame.
Returns:
- self.Callback.get ()
-
Returns the callback for the Frame.
Returns:
- self.Callback.set (value)
-
Sets the callback for the Frame to be used when clicked.
Parameters:
- value string The function identifier, globally indexed.
- self.CallbackArguments.get ()
-
Returns the callback arguments passed to the callback.
Returns:
- self.CallbackArguments.set (value)
-
Sets the callback arguments to be passed to the callback.
Parameters:
- self.IsDrawn.get ()
-
Returns a flag signalling whether or not the Frame has been drawn.
Returns:
-
bool
- self.IsPlaceholder.get ()
-
Returns a flag signaling whether or not a label will be drawn for this Frame.
Returns:
-
bool
- self.IsPlaceholder.set (value)
-
Toggles whether or not to draw a label for this Frame.
Parameters:
- value bool
- self:Add (object)
-
Adds a new object.
Parameters:
- self:Remove (object)
-
Removes an object.
Parameters:
- self:Draw ()
- Draws this Frame. Is only called Vyzor:Draw(). Should not be used directly on a Frame.
- self:Resize (width, height)
-
Resizes the Frame and its children.
Parameters:
- width number The Frame's new width.
- height number The Frame's new height.
- self:Move (x, y)
-
Repositions the Frame and its children.
Parameters:
- x number The Frame's new X position.
- y number The Frame's new Y position.
- self:Hide ([skipChildren=false])
-
Hides the Frame and, optionally, its children.
Parameters:
- skipChildren bool If true, this will not hide any of the Frame's children. (default false)
- self:Show ([skipChildren=false])
-
Reveals the Frame and, optionally, its children.
Parameters:
- skipChildren bool If true, this will not show any of the Frame's children. (default false)
- self:Echo (text)
-
Displays text on the Frame.
Parameters:
- text string The text to be displayed.
- self:CEcho (text)
-
Displays text on the Frame.
Parameters:
- text string The text to be displayed.
- self:Clear ([clearChildren=false])
-
Clears all text from the Frame and, optionally, its children.
Parameters:
- clearChildren bool Will call clear on child Frames if true. (default false)