FormGroupBox

A group box is a type of frame that contains other items. Group boxes are often used to make logical groupings of items and are therefore mainly design components. Functionally, group boxes make it easier to hide or disable several items simultaneously by simply modifying the properties of the group box container.

Example

form = cf.Form.New("Convert format")
inputFile = cf.FormFileBrowser.New("Input filename")
group = cf.FormGroupBox.New("Output options")
outputFile = cf.FormLineEdit.New("Output filename")
checkbox1 = cf.FormCheckBox.New("Export angles in degrees")

    -- Add items into the 'FormGroupBox' layout
    
group:Add(outputFile)
group:Add(checkbox1)

    -- Add the 'FormGroupBox' and other items into the top level 'Form' layout
    
form:Add(inputFile)
form:Add(group)

form:Run()

Inheritance

The FormGroupBox object is derived from the FormItem object.

Usage locations

The FormGroupBox object can be accessed from the following locations:

Property List

Enabled
Controls the item enabled state. Setting the enabled state of an item to false will also disable items or their contents. (Read/Write boolean)
FixedHeight
The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the height of the item. Setting the fixed height to zero or a negative value will restore the default/auto setting and the height will be dynamically determined. The fixed height takes precedence over the minimum height and thus the minimum height is ignored when a fixed height is set. (Read/Write number)
FixedWidth
The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the width of the item. Setting the fixed width to zero or a negative value will restore the default/auto setting and the width will be dynamically determined. The fixed width takes precedence over the minimum width and thus the minimum width is ignored when a fixed width is set. (Read/Write number)
ItemHeight
The height of the item in pixels. (Read only number)
ItemWidth
The width of the item in pixels. (Read only number)
MinimumHeight
The minimum height of the item in pixels. When the height is dynamically determined, it will not be less than the minimum height setting. The minimum height value will only be used when the FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero or a negative value will restore the default/auto setting where no minimum height is enforced. (Read/Write number)
MinimumWidth
The minimum width of the item in pixels. When the width is dynamically determined, it will not be less than the minimum width setting. The minimum width value will only be used when the FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or a negative value will restore the default/auto setting where no minimum width is enforced. (Read/Write number)
Type
The object type string. (Read only string)
Visible
Controls the item visibility. Setting the visibility of an item to false will also hide items or their contents. (Read/Write boolean)

Collection List

FormItems
The collection of item widgets contained in the group box. (FormGroupBoxItemCollection of FormItem.)

Method List

Add (item FormItem)
Adds the given item to the group box. Items can be any of the defined form item types.
Add (item FormItem, row number, column number)
Adds the given item to the group box at the specified position. Positions are defined as a row and column, starting at (1,1).
Remove (item FormItem)
Removes the given item from the group box. The item can be any of the items that resides in the collection of the form items contained in the group box.

Constructor Function List

New (label string, layout FormLayoutEnum)
Create a new group box item with a specified label and layout. (Returns a FormGroupBox object.)
New (label string)
Create a new group box item with a specified label and vertical layout. (Returns a FormGroupBox object.)
New ()
Create a new group box item with a vertical layout. (Returns a FormGroupBox object.)

Property Details

Enabled
Controls the item enabled state. Setting the enabled state of an item to false will also disable items or their contents.
Type
boolean
Access
Read/Write
FixedHeight
The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the height of the item. Setting the fixed height to zero or a negative value will restore the default/auto setting and the height will be dynamically determined. The fixed height takes precedence over the minimum height and thus the minimum height is ignored when a fixed height is set.
Type
number
Access
Read/Write
FixedWidth
The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the width of the item. Setting the fixed width to zero or a negative value will restore the default/auto setting and the width will be dynamically determined. The fixed width takes precedence over the minimum width and thus the minimum width is ignored when a fixed width is set.
Type
number
Access
Read/Write
ItemHeight
The height of the item in pixels.
Type
number
Access
Read only
ItemWidth
The width of the item in pixels.
Type
number
Access
Read only
MinimumHeight
The minimum height of the item in pixels. When the height is dynamically determined, it will not be less than the minimum height setting. The minimum height value will only be used when the FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero or a negative value will restore the default/auto setting where no minimum height is enforced.
Type
number
Access
Read/Write
MinimumWidth
The minimum width of the item in pixels. When the width is dynamically determined, it will not be less than the minimum width setting. The minimum width value will only be used when the FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or a negative value will restore the default/auto setting where no minimum width is enforced.
Type
number
Access
Read/Write
Type
The object type string.
Type
string
Access
Read only
Visible
Controls the item visibility. Setting the visibility of an item to false will also hide items or their contents.
Type
boolean
Access
Read/Write

Collection Details

FormItems
The collection of item widgets contained in the group box.
Type
FormGroupBoxItemCollection

Method Details

Add (item FormItem)
Adds the given item to the group box. Items can be any of the defined form item types.
Input Parameters
item(FormItem)
The item widget to add to the group.
Add (item FormItem, row number, column number)
Adds the given item to the group box at the specified position. Positions are defined as a row and column, starting at (1,1).
Input Parameters
item(FormItem)
The form item to add to the group.
row(number)
The layout row position.
column(number)
The layout column position.
Remove (item FormItem)
Removes the given item from the group box. The item can be any of the items that resides in the collection of the form items contained in the group box.
Input Parameters
item(FormItem)
The form item to remove from the group.

Static Function Details

New (label string, layout FormLayoutEnum)
Create a new group box item with a specified label and layout.
Input Parameters
label(string)
The item label.
layout(FormLayoutEnum)
A value indicating how new items will be arranged.
Return
FormGroupBox
The newly created group box item.
New (label string)
Create a new group box item with a specified label and vertical layout.
Input Parameters
label(string)
The item label.
Return
FormGroupBox
The newly created group box item.
New ()
Create a new group box item with a vertical layout.
Return
FormGroupBox
The newly created group box item.