Class Box

A container that holds and maintains a dynamically arranged collection of Frames.

Methods

Box:Box (_name[, initialMode=BoxMode.Horizontal], initialBackground, initialFrames) Box constructor.

Properties

self.Name.get () Returns the name of the Box.
self.Background.get () Returns the background Frame of the Box.
self.Frames.get () Returns the Frames the Box contains.
self.Container.get () Returns the parent Frame of the Box.
self.Container.set (value) Sets the parent Frame of the Box.
self.Mode.get () Returns the BoxMode of the Box.
self.Mode.set (value) Sets the BoxMode of the Box.


Methods

Box:Box (_name[, initialMode=BoxMode.Horizontal], initialBackground, initialFrames)
Box constructor.

Parameters:

  • _name string The name of the Box and the automatically generated container Frame.
  • initialMode BoxMode Alignment of Frames. (default BoxMode.Horizontal)
  • initialBackground Frame The background Frame for this Box.
  • initialFrames table A numerically indexed table holding the Frames this Box contains.

Returns:

    Box

Properties

self.Name.get ()
Returns the name of the Box.

Returns:

    string
self.Background.get ()
Returns the background Frame of the Box.

Returns:

    Frame
self.Frames.get ()
Returns the Frames the Box contains.

Returns:

    table
self.Container.get ()
Returns the parent Frame of the Box.

Returns:

    Frame
self.Container.set (value)
Sets the parent Frame of the Box.

Parameters:

self.Mode.get ()
Returns the BoxMode of the Box.

Returns:

    BoxMode
self.Mode.set (value)
Sets the BoxMode of the Box.

Parameters:

generated by LDoc 1.4.6 Last updated 2017-11-15 22:27:55