SoDialogCheckBox Class Reference
[Dialog]

VSG extension Dialog CheckBox node. More...

#include <DialogViz/dialog/SoDialogCheckBox.h>

Inheritance diagram for SoDialogCheckBox:
SoDialogComponent SoTopComponent SoDialogViz SoDragger SoInteractionKit SoBaseKit SoNode SoGetView SoFieldContainer SoBase SoRefCounter SoTypedObject SoDialogCheckBoxLauncher

List of all members.

Public Member Functions

 SoDialogCheckBox ()
void addAuditor (SoDialogCheckBoxAuditor *auditor)
void removeAuditor (SoDialogCheckBoxAuditor *auditor)

Public Attributes

SoSFBool state
SoSFString onString
SoSFString offString

Detailed Description

VSG extension Dialog CheckBox node.

This node defines a check box component for the dialog.

DialogCheckBox.jpg

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.

state field change TRUE FALSE
DialogCheckBox_state_TRUE.jpg
DialogCheckBox_state_FALSE.jpg

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

SEE ALSO

SoDialogCheckBoxLauncher, SoDialogComboBox, SoDialogRadioButtons, SoDialogCustom, SoDialogEditText, SoColumnDialog, SoRowDialog, SoTabDialog, SoDialogLabel, SoDialogPushButton, SoDialogPushButtonLauncher, SoDialogSeparator, SoDialogIntegerSlider, SoDialogRealSlider

See related examples:

ShowAll, Simple, SetSkin, Simple3DMenu


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:

Open Inventor Toolkit reference manual, generated on 12 Feb 2024
Copyright © Thermo Fisher Scientific All rights reserved.
http://www.openinventor.com/