Inherits QWidget.

Public Member Functions
def	__init__ (self, parent=None)

def	AddComboControl (self, name, control, value, items, width=-1, height=-1, tooltip="")

def	AddComboControlToGrid (self, name, control, value, items, row, column, tooltip="", expand=True, rowSpan=1, colSpan=1)

def	AddControl (self, name, control, value, width=-1, height=-1, tooltip="")

def	AddControlToGrid (self, name, control, value, row, column, tooltip="", expand=True, rowSpan=-1, colSpan=-1)

def	AddGrid (self)

def	AddGroupBox (self, name, text, collapsible)

def	AddHorizontalSpacerToGrid (self, name, row, column)

def	AddRadioControl (self, name, control, value, text, groupName, width=-1, height=-1, tooltip="")

def	AddRadioControlToGrid (self, name, control, value, text, groupName, row, column, tooltip="", expand=True, rowSpan=1, colSpan=1)

def	AddRangeControl (self, name, control, value, minimum, maximum, decimalPlaces, increment, width=-1, height=-1, tooltip="")

def	AddRangeControlToGrid (self, name, control, value, minimum, maximum, decimalPlaces, increment, row, column, tooltip="", expand=True, rowSpan=1, colSpan=1)

def	AddRow (self)

def	AddSelectionControl (self, name, control, value, theFilter, width=-1, height=-1, tooltip="", browserLocation="")

def	AddSelectionControlToGrid (self, name, control, value, theFilter, row, column, tooltip="", expand=True, rowSpan=1, colSpan=1, browserLocation="")

def	AddSubsetControl (self, name, control, value, items, width=-1, height=-1, tooltip="", windowTitle="", instructions="", separator=",")

def	AddSubsetControlToGrid (self, name, control, value, items, row, column, tooltip="", rowSpan=1, colSpan=1, expand=True, windowTitle="", instructions="", separator=",")

def	AddTabControl (self, name, width, height)

def	AddTabPage (self, text, isScrollable=False)

def	AddTextControl (self, name, control, value, width=-1, height=-1, tooltip="", validator="")

def	AddTextControlToGrid (self, name, control, value, row, column, tooltip="", expand=True, rowSpan=1, colSpan=1, validator="")

def	AllowResizingDialog (self, allow)

def	EndGrid (self)

def	EndGroupBox (self, isCollapsed, netWidth=-1)

def	EndRow (self)

def	EndTabControl (self)

def	EndTabPage (self)

def	GetCollapsed (self, name)

def	GetEnabled (self, name)

def	GetItems (self, name)

def	GetValue (self, name)

def	SetCollapsed (self, name, collapsed)

def	SetEnabled (self, name, enabled)

def	SetItems (self, name, items)

def	SetToolTip (self, name, tooltip)

def	SetValue (self, name, value)

Detailed Description

A panel of script controls.

Constructor & Destructor Documentation

◆ init()

def ScriptControl.ScriptControl.__init__	(	self,
		parent = `None`
	)

Constructor.

Member Function Documentation

◆ AddComboControl()

def ScriptControl.ScriptControl.AddComboControl	(	self,
		name,
		control,
		value,
		items,
		width = `-1`,
		height = `-1`,
		tooltip = `""`
	)

Adds a combo control to the panel.
name (str): A unique name for the control. If the name is not unique, an error will be thrown.
control (str): The control type. The options are BooleanComboControl, ComboControl, EditableComboControl,
         ListControl, and MultiSelectListControl.
value (str): The value for the control.
items (list): The list of items for the control. Should be a list of strings.
width (int): The width of the control, or -1 to use the default.
height (int): The height of the control, or -1 to use the default.
tooltip (str): A tooltip for the control.
returns: Returns the newly created control.

◆ AddComboControlToGrid()

def ScriptControl.ScriptControl.AddComboControlToGrid	(	self,
		name,
		control,
		value,
		items,
		row,
		column,
		tooltip = `""`,
		expand = `True`,
		rowSpan = `1`,
		colSpan = `1`
	)

Adds a combo control to the grid panel.
name (str): A unique name for the control. If the name is not unique, an error will be thrown.
control (str): The control type. The options are BooleanComboControl, ComboControl, EditableComboControl,
         ListControl, and MultiSelectListControl.
value (str): The value for the control.
items (list): The list of items for the control. Should be a list of strings.
row (int): The row index to insert the control at.
column (int): The column index to insert the control at.
tooltip (str): A tooltip for the control.
expand (bool): If set, the control will grow horizontally as much as possible within its grid row. Else, it will remain large enough for its contents.
rowSpan (int): The number of rows the control will span, defaults to 1.
colSpan (int): The number of columns the control will span, defaults to 1.
returns: Returns the newly created control.

◆ AddControl()

def ScriptControl.ScriptControl.AddControl	(	self,
		name,
		control,
		value,
		width = `-1`,
		height = `-1`,
		tooltip = `""`
	)

Adds a control to the panel.
name (str): A unique name for the control. If the name is not unique, an error will be thrown.
control (str): The control type. The options are ButtonControl, ColorControl, LabelControl, MultiLineTextControl,
         PasswordControl, ReadOnlyTextControl, SeparatorControl, and TextControl.
value (str or QColor): The value for the control.
width (int): The width of the control, or -1 to use the default.
height (int): The height of the control, or -1 to use the default.
tooltip (str): A tooltip for the control.
returns: Returns the newly created control.

◆ AddControlToGrid()

def ScriptControl.ScriptControl.AddControlToGrid	(	self,
		name,
		control,
		value,
		row,
		column,
		tooltip = `""`,
		expand = `True`,
		rowSpan = `-1`,
		colSpan = `-1`
	)

Adds a control to the panel.
name (str): A unique name for the control. If the name is not unique, an error will be thrown.
control (str): The control type. The options are ButtonControl, ColorControl, LabelControl, MultiLineTextControl,
         PasswordControl, ReadOnlyTextControl, SeparatorControl, and TextControl.
value (str or QColor): The value for the control.
row (int): The row index to insert the control at.
column (int): The column index to insert the control at.
tooltip (str): A tooltip for the control.
expand (bool): If set, the control will grow horizontally as much as possible within its grid row. Else, it will remain large enough for its contents.
rowSpan (int): The number of rows the control will span, defaults to 1.
colSpan (int): The number of columns the control will span, defaults to 1.
returns: Returns the newly created control.

◆ AddGrid()

def ScriptControl.ScriptControl.AddGrid ( self )

Adds a new grid to the panel. Controls added to the panel will be added to this grid until EndGrid() is called.
If a grid is already in the process of being added, an error is thrown.
returns (QGridLayout): The newly created grid layout.

◆ AddGroupBox()

def ScriptControl.ScriptControl.AddGroupBox	(	self,
		name,
		text,
		collapsible
	)

Adds a new group box to the panel. If a group box is already in the process of being added, an error is thrown.
name (str): The name of the group box.
text (str): The text for the group box label.
collapsible (bool): If the group box is collapsible or not.
returns (QGroupBox): The newly created group box.

◆ AddHorizontalSpacerToGrid()

def ScriptControl.ScriptControl.AddHorizontalSpacerToGrid	(	self,
		name,
		row,
		column
	)

Adds a horizontal spacer to the current grid panel.
name (str): A unique name for the control. If the name is not unique, an error will be thrown.
row (int): The row index to insert the spacer at.
column (int): The column index to insert the spacer at.
returns: Returns the newly created control.

◆ AddRadioControl()

def ScriptControl.ScriptControl.AddRadioControl	(	self,
		name,
		control,
		value,
		text,
		groupName,
		width = `-1`,
		height = `-1`,
		tooltip = `""`
	)

Adds a combo control to the panel.
name (str): A unique name for the control. If the name is not unique, an error will be thrown.
control (str): The control type. The only option is RadioControl.
value (bool): The value for the control.
text (str): The label for the RadioControl.
groupName (str): The radio group that this control belongs too.
width (int): The width of the control, or -1 to use the default.
height (int): The height of the control, or -1 to use the default.
tooltip (str): A tooltip for the control.
returns: Returns the newly created control.

◆ AddRadioControlToGrid()

def ScriptControl.ScriptControl.AddRadioControlToGrid	(	self,
		name,
		control,
		value,
		text,
		groupName,
		row,
		column,
		tooltip = `""`,
		expand = `True`,
		rowSpan = `1`,
		colSpan = `1`
	)

Adds a combo control to the grid panel.
name (str): A unique name for the control. If the name is not unique, an error will be thrown.
control (str): The control type. The only option is RadioControl.
value (bool): The value for the control.
text (str): The label for the RadioControl.
groupName (str): The radio group that this control belongs too.
row (int): The row index to insert the control at.
column (int): The column index to insert the control at.
tooltip (str): A tooltip for the control.
expand (bool): If set, the control will grow horizontally as much as possible within its grid row. Else, it will remain large enough for its contents.
rowSpan (int): The number of rows the control will span, defaults to 1.
colSpan (int): The number of columns the control will span, defaults to 1.
returns: Returns the newly created control.

◆ AddRangeControl()

def ScriptControl.ScriptControl.AddRangeControl	(	self,
		name,
		control,
		value,
		minimum,
		maximum,
		decimalPlaces,
		increment,
		width = `-1`,
		height = `-1`,
		tooltip = `""`
	)

Adds a range control to the panel.
name (str): A unique name for the control. If the name is not unique, an error will be thrown.
control (str): The control type. The options are ProgressBarControl, RangeControl, and SliderControl.
value (float or int): The value for the control.
minimum (float or int): The minimum value.
maximum (float or int): The maximum value.
decimalPlaces (int): The number of decimal places to show.
increment (int): The increment step.
width (int): The width of the control, or -1 to use the default.
height (int): The height of the control, or -1 to use the default.
tooltip (str): A tooltip for the control.
returns: Returns the newly created control.

◆ AddRangeControlToGrid()

def ScriptControl.ScriptControl.AddRangeControlToGrid	(	self,
		name,
		control,
		value,
		minimum,
		maximum,
		decimalPlaces,
		increment,
		row,
		column,
		tooltip = `""`,
		expand = `True`,
		rowSpan = `1`,
		colSpan = `1`
	)

Adds a range control to the grid panel.
name (str): A unique name for the control. If the name is not unique, an error will be thrown.
control (str): The control type. The options are ProgressBarControl, RangeControl, and SliderControl.
value (float or int): The value for the control.
minimum (float or int): The minimum value.
maximum (float or int): The maximum value.
decimalPlaces (int): The number of decimal places to show.
increment (int): The increment step.
row (int): The row index to insert the control at.
column (int): The column index to insert the control at.
tooltip (str): A tooltip for the control.
expand (bool): If set, the control will grow horizontally as much as possible within its grid row. Else, it will remain large enough for its contents.
rowSpan (int): The number of rows the control will span, defaults to 1.
colSpan (int): The number of columns the control will span, defaults to 1.
returns: Returns the newly created control.

◆ AddRow()

def ScriptControl.ScriptControl.AddRow ( self )

Adds a new row to the panel. Controls added to the panel will be added to this row until EndRow() is called.
If a row is already in the process of being added, an error is thrown.
returns (QHBoxLayout): The newly created row layout.

◆ AddSelectionControl()

def ScriptControl.ScriptControl.AddSelectionControl	(	self,
		name,
		control,
		value,
		theFilter,
		width = `-1`,
		height = `-1`,
		tooltip = `""`,
		browserLocation = `""`
	)

Adds a selection control to the panel.
name (str): A unique name for the control. If the name is not unique, an error will be thrown.
control (str): The control type. The options are CheckBoxControl, FileBrowserControl, FileSaverControl,
         FolderBrowserControl, MultiFileBrowserControl, MultiLineMultiFileBrowserControl, and
         MultiLineMultiFolderBrowserControl.
value (float or str): The value for the control.
theFilter (str): This is the label for CheckBoxControl, and the filter for the file browser controls. An example file browser filter would look like "Text Files (*.txt);;All Files (*.*)".
width (int): The width of the control, or -1 to use the default.
height (int): The height of the control, or -1 to use the default.
tooltip (str): A tooltip for the control.
returns: Returns the newly created control.

◆ AddSelectionControlToGrid()

def ScriptControl.ScriptControl.AddSelectionControlToGrid	(	self,
		name,
		control,
		value,
		theFilter,
		row,
		column,
		tooltip = `""`,
		expand = `True`,
		rowSpan = `1`,
		colSpan = `1`,
		browserLocation = `""`
	)

Adds a selection control to the grid panel.
name (str): A unique name for the control. If the name is not unique, an error will be thrown.
control (str): The control type. The options are CheckBoxControl, FileBrowserControl, FileSaverControl,
         FolderBrowserControl, MultiFileBrowserControl, MultiLineMultiFileBrowserControl, and
         MultiLineMultiFolderBrowserControl.
value (float or str): The value for the control.
theFilter (str): This is the label for CheckBoxControl, and the filter for the file browser controls. An example file browser filter would look like "Text Files (*.txt);;All Files (*.*)".
row (int): The row index to insert the control at.
column (int): The column index to insert the control at.
tooltip (str): A tooltip for the control.
expand (bool): If set, the control will grow horizontally as much as possible within its grid row. Else, it will remain large enough for its contents.
rowSpan (int): The number of rows the control will span, defaults to 1.
colSpan (int): The number of columns the control will span, defaults to 1.
returns: Returns the newly created control.

◆ AddSubsetControl()

def ScriptControl.ScriptControl.AddSubsetControl	(	self,
		name,
		control,
		value,
		items,
		width = `-1`,
		height = `-1`,
		tooltip = `""`,
		windowTitle = `""`,
		instructions = `""`,
		separator = `","`
	)

Adds a text control to the panel.
name (str): A unique name for the control. If the name is not unique, an error will be thrown.
control (str): The control type. The only option is TextControl.
value (str): The value for the control.
items (list): The list of items (should be a list of strings).
width (int): The width of the control, or -1 to use the default.
height (int): The height of the control, or -1 to use the default.
tooltip (str): A tooltip for the control.
windowTitle (str): The title for the popup window.
instructions (str): The instructions to describe how to select and unselect items.
separator (str): The string used to separate items in the textbox
returns: Returns the newly created control.

◆ AddSubsetControlToGrid()

def ScriptControl.ScriptControl.AddSubsetControlToGrid	(	self,
		name,
		control,
		value,
		items,
		row,
		column,
		tooltip = `""`,
		rowSpan = `1`,
		colSpan = `1`,
		expand = `True`,
		windowTitle = `""`,
		instructions = `""`,
		separator = `","`
	)

Adds a text control to the grid panel.
name (str): A unique name for the control. If the name is not unique, an error will be thrown.
control (str): The control type. The only option is TextControl.
value (str): The value for the control.
items (list): The list of items (should be a list of strings).
row (int): The row index to insert the control at.
column (int): The column index to insert the control at.
tooltip (str): A tooltip for the control.
rowSpan (int): The number of rows the control will span, defaults to 1.
colSpan (int): The number of columns the control will span, defaults to 1.
expand (bool): If set, the control will grow horizontally as much as possible within its grid row. Else, it will remain large enough for its contents.
windowTitle (str): The title for the popup window.
instructions (str): The instructions to describe how to select and unselect items.
separator (str): The string used to separate items in the textbox
returns: Returns the newly created control.

◆ AddTabControl()

def ScriptControl.ScriptControl.AddTabControl	(	self,
		name,
		width,
		height
	)

Adds a new tab control to the panel. If a tab control is already in the process of being added, an error is thrown.
returns (QTabWidget): The newly created tab control.

◆ AddTabPage()

def ScriptControl.ScriptControl.AddTabPage	(	self,
		text,
		isScrollable = `False`
	)

Adds a new tab page to the current tab control. If there is no tab control being added, or a tab page is already in the
process of being added, an error is thrown.
returns (QWidget): The newly created tab page.

◆ AddTextControl()

def ScriptControl.ScriptControl.AddTextControl	(	self,
		name,
		control,
		value,
		width = `-1`,
		height = `-1`,
		tooltip = `""`,
		validator = `""`
	)

Adds a text control to the panel.
name (str): A unique name for the control. If the name is not unique, an error will be thrown.
control (str): The control type. The only option is TextControl.
value (str): The value for the control.
width (int): The width of the control, or -1 to use the default.
height (int): The height of the control, or -1 to use the default.
tooltip (str): A tooltip for the control.
validator (str): A regular expression used to validate text in the TextControl.
returns: Returns the newly created control.

◆ AddTextControlToGrid()

def ScriptControl.ScriptControl.AddTextControlToGrid	(	self,
		name,
		control,
		value,
		row,
		column,
		tooltip = `""`,
		expand = `True`,
		rowSpan = `1`,
		colSpan = `1`,
		validator = `""`
	)

Adds a text control to the grid panel.
name (str): A unique name for the control. If the name is not unique, an error will be thrown.
control (str): The control type. The only option is TextControl.
value (str): The value for the control.
row (int): The row index to insert the control at.
column (int): The column index to insert the control at.
tooltip (str): A tooltip for the control.
expand (bool): If set, the control will grow horizontally as much as possible within its grid row. Else, it will remain large enough for its contents.
rowSpan (int): The number of rows the control will span, defaults to 1.
colSpan (int): The number of columns the control will span, defaults to 1.
validator (str): A regular expression used to validate text in the TextControl.
returns: Returns the newly created control.

◆ AllowResizingDialog()

def ScriptControl.ScriptControl.AllowResizingDialog	(	self,
		allow
	)

Sets whether or not the dialog will be resizable by the user. Default behaviour if this is not called is True.
allow (bool): Allow the dialog to be resized by the user or not.

◆ EndGrid()

def ScriptControl.ScriptControl.EndGrid ( self )

Ends the current grid in the panel. If a grid is not in the process of being added, an error is thrown.

◆ EndGroupBox()

def ScriptControl.ScriptControl.EndGroupBox	(	self,
		isCollapsed,
		netWidth = `-1`
	)

Ends the current group box control. If a group box is not in the process of being added, an error is thrown.
isCollapsed (bool): If the group box should start in the collapsed state or not.
netWidth (int): Currently unused, here for legacy purposes.

◆ EndRow()

def ScriptControl.ScriptControl.EndRow ( self )

Ends the current row in the panel. If a row is not in the process of being added, an error is thrown.

◆ EndTabControl()

def ScriptControl.ScriptControl.EndTabControl ( self )

Ends the current tab control in the panel. If a tab control is not in the process of being added, an error is thrown.

◆ EndTabPage()

def ScriptControl.ScriptControl.EndTabPage ( self )

Ends the current tab page in the tab control. If a tab page is not in the process of being added, an error is thrown.

◆ GetCollapsed()

def ScriptControl.ScriptControl.GetCollapsed	(	self,
		name
	)

Gets the collapsed state of the group box with the given name.
name (str): The name of the group box. If the group box doesn't exist, an error is thrown.
returns (bool): If the group box is collapsed or not.

◆ GetEnabled()

def ScriptControl.ScriptControl.GetEnabled	(	self,
		name
	)

Gets if the control with the given name is enabled.
name (str): The name of the control. If the control doesn't exist, an error is thrown.
returns (bool): If the control is enabled or not.

◆ GetItems()

def ScriptControl.ScriptControl.GetItems	(	self,
		name
	)

Gets the items of the control with the given name. This is used for combo or list controls.
name (str): The name of the control. If the control doesn't exist, an error is thrown.
returns (list): The list of items (a list of strings).

◆ GetValue()

def ScriptControl.ScriptControl.GetValue	(	self,
		name
	)

Gets the value of the control with the given name.
name (str): The name of the control. If the control doesn't exist, an error is thrown.
returns: The value (type is based on control type).

◆ SetCollapsed()

def ScriptControl.ScriptControl.SetCollapsed	(	self,
		name,
		collapsed
	)

Sets the collapsed state of the group box with the given name.
name (str): The name of the group box. If the group box doesn't exist, an error is thrown.
collapsed (bool): If the group box should be collapsed or not.

◆ SetEnabled()

def ScriptControl.ScriptControl.SetEnabled	(	self,
		name,
		enabled
	)

Sets if the control with the given name is enabled.
name (str): The name of the control. If the control doesn't exist, an error is thrown.
enabled (bool): If the control is enabled or not.

◆ SetItems()

def ScriptControl.ScriptControl.SetItems	(	self,
		name,
		items
	)

Sets the items of the control with the given name. This is used for combo or list controls.
name (str): The name of the control. If the control doesn't exist, an error is thrown.
items (list): The list of items (should be a list of strings).

◆ SetToolTip()

def ScriptControl.ScriptControl.SetToolTip	(	self,
		name,
		tooltip
	)

Sets the tooltip of the control with the given name.
name (str): The name of the control. If the control doesn't exist, an error is thrown.
tooltip (str): The tool tip text.

◆ SetValue()

def ScriptControl.ScriptControl.SetValue	(	self,
		name,
		value
	)

Sets the value of the control with the given name.
name (str): The name of the control. If the control doesn't exist, an error is thrown.
value: The value (type is based on control type).

Public Member Functions