SoMenuCheckBox Class Reference
[Dialog]

Menu pushbutton node. More...

#include <DialogViz/dialog/SoMenuCheckBox.h>

Inheritance diagram for SoMenuCheckBox:

List of all members.

Public Member Functions
	SoMenuCheckBox ()
void	addAuditor (SoMenuCheckBoxAuditor *auditor)
void	removeAuditor (SoMenuCheckBoxAuditor *auditor)
Public Attributes
SoSFBool	state
SoSFString	onString
SoSFString	accelerator

---

Detailed Description

Menu pushbutton node.

This node defines a push button item for a dialog menu.

You can change the parts in any instance of this menu check box using setPart(). The default part geometries are defined as resources for this SoMenuCheckBox 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/MenuCheckBox.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

MenuCheckBox {

accelerator	""
state	FALSE
onString	""
// fields from SoDialogViz
enable	TRUE
label	""
labelAlignment	LEFT
auditorID	""

}




CATALOG PARTS

SoMenuCheckBox {

Group frame (from SoMenuItem)

Defines the item main frame geometry. Default size is set to (x, 18, z)

Switch chkSwtch {

Defines the geometry of the menu push button.

Group stateOff

Defines the geometry of the check box when its state field is set to FALSE.

Group stateOn

Defines the geometry of the check box when its state field is set to TRUE.

}

Group labelProp (from SoMenuItem)

Specifies the properties to apply to the text node representing the item label string

}

Extra information for parts from above structure

Part Name	Resource	Skin file
frame	MenuItemFrame	MenuItem.iv
stateOff	MenuCheckBoxStateOff	MenuCheckBox.iv
stateOn	MenuCheckBoxStateOn	MenuCheckBox.iv
labelProp	TextProperties	TextProperties.iv

 

SEE ALSO

SoMenuCheckBoxLauncher, SoMenuPopup, SoMenuPushButton, SoMenuPushButtonLauncher, SoMenuFileSelection, SoMenuRadioButtons, SoMenuSeparator

See related examples:

ShowAll, Simple, SetSkin, Simple3DMenu

---

Constructor & Destructor Documentation

SoMenuCheckBox::SoMenuCheckBox

(

)

Constructor.

---

Member Function Documentation

void SoMenuCheckBox::addAuditor

(

SoMenuCheckBoxAuditor *

auditor

)

Add a menuCheckBoxAuditor to current CheckBox component.

void SoMenuCheckBox::removeAuditor

(

SoMenuCheckBoxAuditor *

auditor

)

Remove the defined checkBoxAuditor from the auditor list.

---

Member Data Documentation

SoSFString SoMenuCheckBox::accelerator

Defines the menu item accelerator key.

SoSFString SoMenuCheckBox::onString

This string appears when state is TRUE.

If it is empty, label is used instead. Default is empty string.

SoSFBool SoMenuCheckBox::state

Specify the state of the check button.

When state is FALSE label is showm, otherwise onString is shown instead. Default is FALSE

---

The documentation for this class was generated from the following file:

• DialogViz/dialog/SoMenuCheckBox.h