Add Widget
Previous Topic  Next Topic 

This action will add a new widget to an install pane.  Widgets are any type of control that is drawn on a pane, which includes: buttons, checkbuttons, labels, radiobuttons and more.


Note

Setting the Text on any widget type other than a label will cause a label to be drawn in combination with the specified widget.  This is the easiest way to add a label with a widget rather than having to add a separate label widget.



Supported Platforms

All



Standard Properties 

See Standard Action Properties.



Advanced Properties


Action

This property specifies an action that should be executed if the user clicks a button or modifies the value of a checkbutton or radiobutton.  The action also applies to entry, browse entry and password entry widgets when the Validate Entry On property is set.


Background

The background color of the new widget.  The most common are system, which is the main system color for the background of windows, and white.


Browse Type

If the widget is a browse entry, this property specifies what you are browsing for.  A directory will use a choose directory dialog.  An open file will use a file dialog that is expecting a file that already exists.  A save file will use a file dialog that will tell the user the file will be overwritten if it already exists.


Checked

When adding a radiobutton or checkbutton, this property tells InstallJammer that the button should be checked on by default when displayed.  If this property is left blank, the status of the button will depend on the virtual text property attached to it.  In the case of a checkbutton, if the virtual text property is true, the checkbutton will be checked.  In the case of a radiobutton, the radiobutton whose value matches the current value of the virtual text will be checked.


Editable

If the widget type is a combobox, this property specifies whether the value in the entry of the combobox should be editable or not.  If the value is not editable, the user may only choose from the given list of values.  If the combobox is editable, the user can either choose from the given values or type in their own value.


File Types

If the widget type is a browse entry for choosing files, this property tells the file chooser popup what file types to allow.  The File Types property must contain a list of pairs containing a description of the file type and a list of extensions to include with the file type.  Example:  "Source Files" ".c .cpp .h .hpp" "Text Files" ".txt" "All Files "*"


Foreground

The foreground color of the new widget.  The most common are system, which is the main system color for the foreground text of windows, and black.


Height

The height of the widget.  Usually, this option should be left blank, and InstallJammer will make the widget as tall as it needs to be.


Label Side

On any widget that is not a label, setting the Text property will cause a label to be drawn with the corresponding widget.  This property tells InstallJammer where you want the label to appear in relation to the widget.  The choices are on top or to the left.


Label Width

This property specifies the width of the text label when it is present next to another widget.  Using this property with your label on the left side, you can make all of your labels line up evenly by giving them all the same width.


Off Value

This is the value the virtual text will be set to when a checkbutton is off.  This is only valid for checkbuttons.


On Value

This is the value the virtual text will be set to when a checkbutton is on.  This is only valid for checkbuttons.


Text

If the widget type is a label, the text property specifies what should be displayed in the label.  If the widget is not a label, setting the text property to any string will cause a label to be drawn with the given widget.


Type

The type of widget to add.  The list currently includes: browse entry, button, checkbutton, combobox, entry, label, label frame, password entry, radiobutton or text.


Validate Entry On

This property tells InstallJammer when to validate the contents of an entry widget when the type of widget added is an entry, and the action property is not empty.  The following values are acceptable as either a single value or as a list of values separated by ;.  Create, Focus, FocusIn, FocusOut and Key.  Create means that the value will be validated when the widget is created.  Focus, FocusIn and FocusOut mean the entry is validated when the focus of the entry changes.  Key means the entry will be validated anytime a key is pressed inside the entry.


Value

For a radiobutton, this is the value stored in the virtual text when this radiobutton is selected.  Please read the section titled Boolean Values in Virtual Text in What is Virtual Text? for information on using boolean-type values as a value for a radiobutton.


Note

Setting the value on an entry or browse entry will set the default value of the virtual text to the given value, which will make the value appear in the entry box.


Values

If the widget type is a combobox, this property specifies a list of values to display in the dropdown menu of the combobox.  This must be a valid list with each item quoted.  Example:  "Item a" "Item b" "Item c" "Item d"


Virtual Text

The virtual text variable to store the result in.  Radiobuttons are grouped together by all sharing the same virtual text variable.  The selected radiobutton will set the value of the virtual text.


Width

The width of the widget.  If this option is left blank, InstallJammer will make the widget as wide as it needs to be.


X

The x coordinate on the pane to place this widget.


Y

The y coordinate on the pane to place this widget.