SoDialogCheckBox Class Reference
[Dialog]
Dialog CheckBox node.
More...
#include <DialogViz/dialog/SoDialogCheckBox.h>
Public Member Functions | |
| SoDialogCheckBox () | |
| void | addAuditor (SoDialogCheckBoxAuditor *auditor) |
| void | removeAuditor (SoDialogCheckBoxAuditor *auditor) |
Public Attributes | |
| SoSFBool | state |
| SoSFString | onString |
| SoSFString | offString |
Detailed Description
Dialog CheckBox node.
This node defines a check box component for the dialog.
The state field is the state of the check box (TRUE/FALSE). The onString field represents the string displayed when the check state is TRUE, the offString field represents the string displayed when the state is FALSE.
|
You can change the parts in any instance of this check button using setPart(). The default part geometries are defined as resources for this SoDialogCheckBox class. They are detailed below in the Catalog Parts section of the online reference page for this class. You can make your program use different default resources for the parts by copying the file $OIVHOME/data/DialogViz/Skins/default/DialogCheckBox.iv into your own directory, editing the file, and then setting the environment variable DIALOGVIZ_SKINS_DIR to be a path to that directory, or by using the setSkinDirectory() method in your application.
FILE FORMAT/DEFAULT
- DialogCheckBox {
| state | FALSE |
| onString | "On" |
| offString | "Off" |
| // fields from SoDialogComponent | |
| width | 0 |
| height | 0 |
| fixedWidth | FALSE |
| fixedHeight | FALSE |
| minWidth | 0 |
| maxWidth | 0 |
| minHeight | 0 |
| maxHeight | 0 |
| edgeStyle | NONE |
| labelVisibility | TRUE |
| // fields from SoDialogViz | |
| enable | TRUE |
| label | "" |
| labelAlignment | RIGHT |
| auditorID | "" |
CATALOG PARTS
-
SoDialogCheckBox {
Switch edgeStyleSwitch (from SoDialogComponent) {
Specify the appearance of the component border. By default, the component has its edgeStyle set to NONE.
Group edgeStyleNone (from SoDialogComponent)
Defines the appearance of the component when edgeStyle field is set to NONE.
Group edgeStyleShadowIn (from SoDialogComponent)
Defines the appearance of the component when edgeStyle field is set to SHADOW_IN.
Group edgeStyleShadowOut (from SoDialogComponent)
Defines the appearance of the component when edgeStyle field is set to SHADOW_OUT.
}
Group labelProp
Specifies properties to apply to the text node that represents the label field value.
Group frame
Defines the geometry of the check box main frame.
Switch stateSwitch {
Define the geometry of the check indicator. Default size is set to (14, 14, z)
Group stateOff
Defines the geometry of the check frame when state field is set to FALSE.
Group stateOn
Defines the geometry of the check frame when state field is set to TRUE
}
Group onOffStringProp
Specifies properties to apply to the text representing the current state string corresponding to the onString and offString fields.
}
}
Extra information for parts from above structure
SEE ALSO
SoDialogCheckBoxLauncher, SoDialogComboBox, SoDialogRadioButtons, SoDialogCustom, SoDialogEditText, SoColumnDialog, SoRowDialog, SoTabDialog, SoDialogLabel, SoDialogPushButton, SoDialogPushButtonLauncher, SoDialogSeparator, SoDialogIntegerSlider, SoDialogRealSlider
- See related examples:
Constructor & Destructor Documentation
| SoDialogCheckBox::SoDialogCheckBox | ( | ) |
Constructor.
Member Function Documentation
| void SoDialogCheckBox::addAuditor | ( | SoDialogCheckBoxAuditor * | auditor | ) |
Adds a dialogCheckBoxAuditor to current CheckBox component.
| void SoDialogCheckBox::removeAuditor | ( | SoDialogCheckBoxAuditor * | auditor | ) |
Removes the specified checkBoxAuditor from the auditor list.
Member Data Documentation
String used for state FALSE.
Default is "Off".
String used for state TRUE.
Default is "On".
State of the check button.
Default is FALSE.
The documentation for this class was generated from the following file:
- DialogViz/dialog/SoDialogCheckBox.h