Open Inventor Release 2024.1.3
 
Loading...
Searching...
No Matches
SoTabDialog Class Reference

VSG extension Class that creates the dialog tab container. More...

#include <DialogViz/dialog/SoTabDialog.h>

+ Inheritance diagram for SoTabDialog:

Public Types

enum  TabsLocation {
  TOP ,
  BOTTOM ,
  LEFT ,
  RIGHT
}
 
- Public Types inherited from SoDialogGroup
enum  ScrollVisibility {
  NEVER ,
  ALWAYS ,
  AUTO
}
 
- Public Types inherited from SoDialogComponent
enum  EdgeStyle {
  NONE ,
  SHADOW_IN ,
  SHADOW_OUT
}
 
- Public Types inherited from SoDialogViz
enum  LabelAlignment {
  LEFT ,
  CENTER ,
  RIGHT
}
 
- Public Types inherited from SoDragger
enum  TrackerDirectMode {
  NONE ,
  MOVE ,
  ROTATE ,
  FREE ,
  DEFAULT
}
 Tracker direct mode. More...
 
typedef void SoDraggerCB(void *userData, SoDragger *dragger)
 Used in defining the callback function lists.
 
- Public Types inherited from SoInteractionKit
enum  CacheEnabled {
  OFF ,
  ON ,
  AUTO
}
 Possible values for caching. More...
 

Public Member Functions

 SoTabDialog ()
 Constructor.
 
void addAuditor (SoTabDialogAuditor *auditor)
 Adds a TabDialogAuditor to current TabDialog component.
 
void removeAuditor (SoTabDialogAuditor *auditor)
 Removes the specified TabDialogAuditor from the auditor list.
 
- Public Member Functions inherited from SoDialogGroup
void addAuditor (SoDialogAuditor *auditor)
 Adds a dialogGroupAuditor to the current column component.
 
void removeAuditor (SoDialogAuditor *auditor)
 Removes the specified DialogGroupAuditor from the auditor list.
 
void applyAuditors ()
 Applies all DialogGroupAuditors in the auditor list.
 
SoDialogVizsearchForAuditorId (SbString id)
 Retrieves the DialogViz object from the specified auditorID field in an SoDialogGroup structure.
 
virtual SoNodegetChild (int index) const
 Returns pointer to child node with the given index.
 
virtual int getNumChildren () const
 Returns number of children.
 
virtual int findChild (const SoDialogComponent *child) const
 Finds index of given child within group.
 
- Public Member Functions inherited from SoDragger
virtual SoType getTypeId () const
 Returns the type identifier for this specific instance.
 
virtual const SoNodekitCataloggetNodekitCatalog () const
 Returns the SoNodekitCatalog for this instance.
 
void addStartCallback (SoDraggerCB *f, void *userData=NULL)
 Adds start callback.
 
void removeStartCallback (SoDraggerCB *f, void *userData=NULL)
 Removes start callback.
 
void addMotionCallback (SoDraggerCB *f, void *userData=NULL)
 Adds motion callback.
 
void removeMotionCallback (SoDraggerCB *f, void *userData=NULL)
 Removes motion callback.
 
void addFinishCallback (SoDraggerCB *f, void *userData=NULL)
 Adds finish callback.
 
void removeFinishCallback (SoDraggerCB *f, void *userData=NULL)
 Removes finish callback.
 
void addValueChangedCallback (SoDraggerCB *f, void *userData=NULL)
 Adds value-changed callback.
 
void removeValueChangedCallback (SoDraggerCB *f, void *userData=NULL)
 Removes value-changed callback.
 
void setMinGesture (int pixels)
 Sets the number of pixels of movement required to initiate a constraint gesture.
 
void setMinGesture (float pixels)
 Float version of setMinGesture.
 
int getMinGesture () const
 Gets the number of pixels of movement required to initiate a constraint gesture.
 
float getMinGestureFloat () const
 Float version of getMinGesture.
 
SbBool enableValueChangedCallbacks (SbBool newVal)
 You can temporarily disable a dragger's valueChangedCallbacks.
 
void setTrackerDirectMode (TrackerDirectMode mode=DEFAULT)
 Sets the tracker direct mode for this dragger (see description above).
 
TrackerDirectMode getTrackerDirectMode () const
 Get the current tracker direct mode for this dragger.
 
void setMotionMatrix (const SbMatrix &newMatrix)
 Set the motion matrix.
 
const SbMatrixgetMotionMatrix ()
 Get the motion matrix.
 
- Public Member Functions inherited from SoInteractionKit
virtual SbBool setPartAsPath (const SbName &partName, SoPath *surrogatePath)
 Sets any public part in the interaction kit as a "surrogate" path instead.
 
virtual SbBool affectsState () const
 Returns TRUE if a node has an effect on the state during traversal.
 
- Public Member Functions inherited from SoBaseKit
 SoBaseKit ()
 Constructor.
 
virtual SoNodegetPart (const SbName &partName, SbBool makeIfNeeded)
 Searches the nodekit catalog (and those of all nested nodekits) for the part named partName.
 
template<typename PartType >
PartType * getPart (const SbName &partName)
 Like getPart(const SbName&,SbBool) but casts the returned part to the specified type and sets the makeIfNeeded parameter to TRUE.
 
template<typename PartType >
PartType * checkPart (const SbName &partName)
 Like getPart(const SbName&,SbBool) but casts the returned part to the specified type and sets the makeIfNeeded parameter to FALSE.
 
SbString getPartString (const SoBase *part)
 Given a node or a path to a node, checks if the part exists in the nodekit, in a nested nodekit, or an element of a list part.
 
virtual SoNodeKitPathcreatePathToPart (const SbName &partName, SbBool makeIfNeeded, const SoPath *pathToExtend=NULL)
 Returns a path that begins at this nodekit and ends at partName.
 
virtual SbBool setPart (const SbName &partName, SoNode *newPart)
 Inserts the given node (not a copy) as the new part specified by partName.
 
SoNONUNICODE SbBool set (char *nameValuePairListString)
 This function allows field values of parts (nodes) to be set in several different parts simultaneously.
 
SbBool set (const SbString &nameValuePairListString)
 This function allows field values of parts (nodes) to be set in several different parts simultaneously.
 
SoNONUNICODE SbBool set (const char *partNameString, const char *parameterString)
 This function allows field values of parts (nodes) to be set.
 
SbBool set (const SbString &partNameString, const SbString &parameterString)
 This function allows field values of parts (nodes) to be set.
 
- Public Member Functions inherited from SoNode
virtual void setOverride (const SbBool state)
 Turns the override flag on or off.
 
virtual SbBool isOverride () const
 Returns the state of the override flag.
 
virtual SoNodecopy (SbBool copyConnections=FALSE) const
 Creates and returns an exact copy of the node.
 
virtual void touch ()
 Marks an instance as modified, simulating a change to it.
 
- Public Member Functions inherited from SoFieldContainer
void setToDefaults ()
 Sets all fields in this object to their default values.
 
SbBool hasDefaultValues () const
 Returns TRUE if all of the object's fields have their default values.
 
SbBool fieldsAreEqual (const SoFieldContainer *fc) const
 Returns TRUE if this object's fields are exactly equal to fc's fields.
 
void copyFieldValues (const SoFieldContainer *fc, SbBool copyConnections=FALSE)
 Copies the contents of fc's fields into this object's fields.
 
SoNONUNICODE SbBool set (const char *fieldDataString)
 Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
 
SbBool set (const SbString &fieldDataString)
 Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
 
void get (SbString &fieldDataString)
 Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.
 
virtual int getFields (SoFieldList &list) const
 Appends references to all of this object's fields to resultList, and returns the number of fields appended.
 
virtual int getAllFields (SoFieldList &list) const
 Returns a list of fields, including the eventIn's and eventOut's.
 
virtual SoFieldgetField (const SbName &fieldName) const
 Returns a the field of this object whose name is fieldName.
 
virtual SoFieldgetEventIn (const SbName &fieldName) const
 Returns a the eventIn with the given name.
 
virtual SoFieldgetEventOut (const SbName &fieldName) const
 Returns the eventOut with the given name.
 
SbBool getFieldName (const SoField *field, SbName &fieldName) const
 Returns the name of the given field in the fieldName argument.
 
SbBool enableNotify (SbBool flag)
 Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).
 
SbBool isNotifyEnabled () const
 Notification is the process of telling interested objects that this object has changed.
 
virtual void setUserData (void *data)
 Sets application data.
 
void * getUserData (void) const
 Gets user application data.
 
- Public Member Functions inherited from SoBase
virtual SbName getName () const
 Returns the name of an instance.
 
virtual void setName (const SbName &name)
 Sets the name of an instance.
 
void setSynchronizable (const bool b)
 Sets this to be a ScaleViz synchronizable object.
 
bool isSynchronizable () const
 Gets the ScaleViz synchronizable state of this object.
 
- Public Member Functions inherited from SoRefCounter
void ref () const
 Adds a reference to an instance.
 
void unref () const
 Removes a reference from an instance.
 
void unrefNoDelete () const
 unrefNoDelete() should be called when it is desired to decrement the reference count, but not delete the instance if this brings the reference count to zero.
 
int getRefCount () const
 Returns current reference count.
 
void lock () const
 lock this instance.
 
void unlock () const
 unlock this instance.
 
- Public Member Functions inherited from SoTypedObject
SbBool isOfType (const SoType &type) const
 Returns TRUE if this object is of the type specified in type or is derived from that type.
 
template<typename TypedObjectClass >
SbBool isOfType () const
 Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.
 
- Public Member Functions inherited from SoGetView
 SoGetView ()
 Default constructor.
 
virtual ~SoGetView ()
 
virtual SbBool getViewportIsEnabled () const
 Returns TRUE if SoGetView functionalities are enabled, FALSE otherwise.
 
virtual const SbVec2f getViewportOrigin () const
 Returns SbViewportRegion origin.
 
virtual const SbVec2f getViewportSize () const
 Returns SbViewportRegion size.
 

Public Attributes

SoSFEnum tabsLocation
 Specifies location of the tabs.
 
SoSFInt32 selectedPage
 Specifies currently selected tab page.
 
- Public Attributes inherited from SoDialogGroup
SoSFEnum vScrollVisibility
 Control how vertical scrollbar appears.
 
SoSFEnum hScrollVisibility
 Control how horizontal scrollbar appears.
 
SoSFBool windowResizedByChildren
 Control the window sizing when a child is added or removed.
 
SoSFInt32 margin
 Specifies the margin width.
 
- Public Attributes inherited from SoDialogComponent
SoSFInt32 width
 Preferred width of the element.
 
SoSFInt32 height
 Preferred height of the element.
 
SoSFBool fixedWidth
 When set to FALSE, this allows the component to be resized in the width direction.
 
SoSFBool fixedHeight
 When set to FALSE, this allows the component to be resized in the height direction.
 
SoSFInt32 minWidth
 Sets minimum component width.
 
SoSFInt32 maxWidth
 Sets maximum component width.
 
SoSFInt32 minHeight
 Sets minimum component height.
 
SoSFInt32 maxHeight
 Sets maximum component height.
 
SoSFEnum edgeStyle
 Controls the appearance of the edges of the component.
 
SoSFBool labelVisibility
 Specifies if the label of the component defined in SoDialogViz is visible or not.
 
- Public Attributes inherited from SoDialogViz
SoSFBool enable
 Enables component.
 
SoSFString label
 Label string of the element.
 
SoSFEnum labelAlignment
 Specifies the label alignment.
 
SoSFString auditorID
 Specifies the auditor ID of the node.
 
- Public Attributes inherited from SoDragger
SoSFBool isActive
 TRUE when mouse is down and dragging, else FALSE.
 
SoSFBool enableCallbacks
 If set to FALSE, motion, start and finish callbacks are disabled.
 
- Public Attributes inherited from SoInteractionKit
SoSFEnum boundingBoxCaching
 Set bounding box caching mode.
 
SoSFEnum renderCulling
 Set render culling mode.
 
SoSFEnum pickCulling
 Set pick caching mode.
 
SoDEPRECATED SoSFEnum renderCaching
 Set render caching mode.
 
- Public Attributes inherited from SoBaseKit
SoSFBool boundingBoxIgnoring
 Whether to ignore this node during bounding box traversal.
 

Additional Inherited Members

- Static Public Member Functions inherited from SoDialogViz
static void init ()
 Initalizes the DialogViz classes.
 
static void finish ()
 Shuts down the DialogViz module, which includes freeing any internal static memory that it allocated.
 
static bool isInitialized ()
 Returns TRUE if module is currently initialized.
 
static const char * getProductName ()
 Returns a character string identifying the name of the extension.
 
static SoDialogVizloadFromFile (SbString filename, SbString auditorID="")
 Loads a DialogViz node from an Inventor file.
 
static void setSkin (SbString skinName)
 Sets the directory for 3D DialogViz component skins.
 
static void setSkinsDirectories (SbString directories)
 Sets a list of directories where to search for skins.
 
static SbString getSkinsDirectories ()
 Returns the skins directory.
 
static void setFont (DG_FONT font)
 Sets the DialogViz font.
 
static SoDEPRECATED const char * getVersion ()
 Returns a character string identifying the version of the extension.
 
- Static Public Member Functions inherited from SoDragger
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
static const SoNodekitCataloggetClassNodekitCatalog ()
 Returns the SoNodekitCatalog for this class.
 
static void setMinScale (float newMinScale)
 Sets the smallest scale that any dragger will write.
 
static float getMinScale ()
 Gets the smallest scale that any dragger will write.
 
static void setInitialTrackerDirectMode (TrackerDirectMode mode=DEFAULT)
 Set the initial tracker direct mode for draggers not yet created.
 
static TrackerDirectMode getInitialTrackerDirectMode ()
 Get the initial tracker direct mode.
 
- Static Public Member Functions inherited from SoInteractionKit
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
static const SoNodekitCataloggetClassNodekitCatalog ()
 Returns the SoNodekitCatalog for this class.
 
- Static Public Member Functions inherited from SoBaseKit
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
static const SoNodekitCataloggetClassNodekitCatalog ()
 Returns the SoNodekitCatalog for the class SoBaseKit.
 
static void setSearchingChildren (SbBool newVal)
 Sets if nodekit children are searched during SoSearchAction traversal.
 
static SbBool isSearchingChildren ()
 Returns TRUE if nodekit children are searched during SoSearchAction traversal.
 
- Static Public Member Functions inherited from SoNode
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
static SoNodegetByName (const SbName &name)
 A node's name can be set using SoBase::setName().
 
static int getByName (const SbName &name, SoNodeList &list)
 A node's name can be set using SoBase::setName().
 
- Static Public Member Functions inherited from SoFieldContainer
static SoType getClassTypeId ()
 Returns the type of this class.
 
- Static Public Member Functions inherited from SoBase
static SoType getClassTypeId ()
 Returns type identifier for this class.
 
- Static Public Member Functions inherited from SoTypedObject
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 

Detailed Description

VSG extension Class that creates the dialog tab container.

An SoTabDialog creates multiple pages for the same area of a window. Each page consists of a set of SoDialogComponents that the application displays when the user selects the corresponding tab. You can add, insert, and remove dialog components (SoDialogComponent) by using the addChild(), insertChild(), and removeChild() methods.

You can change the parts in any instance of this tab dialog component using setPart(). The default part geometries are defined as resources for this SoTabDialog 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/TabDialog.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

    TabDialog {
    tabsLocation TOP
    selectedPage 0
    // fields from SoDialogGroup
    verticalScrollBar TRUE
    horizontalScrollBar TRUE
    scrollPolicy AUTO
    windowResizedByChildren TRUE
    // fields from SoDialogComponent
    width 0
    height 0
    fixedWidth FALSE
    fixedHeight FALSE
    minWidth 0
    maxWidth 0
    minHeight 0
    maxHeight 0
    margin 0
    edgeStyle NONE
    labelVisibility TRUE
    // fields from SoDialogViz
    enable TRUE
    label ""
    labelAlignment RIGHT
    auditorID ""
    }

    CATALOG PARTS

      SoTabDialog {

      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.

      }

      Separator pagesSep {

      Defines all tabs of the SoTabDialog component. Each tabs have the same geometry and structure defined by following parts:

      Switch pageSwitch {

      Defines the traversed geometry relatively to user action.

      Group unselected

      Defines the geometry of the tab page if it is not selected

      Group selected

      Defines the geometry of the tab page if it is selected

      }

      Group textProp

      Specifies properties to apply to the text node that represents the label of the page.

      ...

      Ref pageSwitch

      Ref textProp

      }

      Switch lButtonSwtch {

      Defines the traversed geometry relatively to user action. Defines the geometry of the move left button. Default size is set to (14, 14, z).

      Group lButtonReleased

      Geometry when button is released.

      Group lButtonPressed

      Geometry when button is pressed.

      }

      Switch rButtonSwtch {

      Defines the traversed geometry relatively to user action. Defines the geometry of the move roght button. Default size is set to (14, 14, z).

      Group rButtonReleased

      Geometry when button is released.

      Group rButtonPressed

      Geometry when button is pressed.

      }

      Group frame

      Defines geometry of the main tab dialog frame.

    }

    Extra information for parts from above structure

    Part Name
    Resource
    Skin file
    edgeStyleNone
    DialogComponentEdgeStyleNone
    DialogComponent.iv
    edgeStyleShadowIn
    DialogComponentEdgeStyleShadowIn
    DialogComponent.iv
    edgeStyleShadowOut
    DialogComponentEdgeStyleShadowOut
    DialogComponent.iv
    unselected
    TabDialogUnselectedTabFrame
    TabDialog.iv
    selected
    TabDialogSelectedTabFrame
    TabDialog.iv
    textProp
    DialogTextProperties
    TextProperties.iv
    lButtonReleased
    TabDialogLeftButtonReleased
    TabDialog.iv
    lButtonPressed
    TabDialogLeftButtonPressed
    TabDialog.iv
    rButtonReleased
    TabDialogRightButtonReleased
    TabDialog.iv
    rButtonPressed
    TabDialogRightButtonPressed
    TabDialog.iv
    frame
    TabDialogFrame
    TabDialog.iv

     

SEE ALSO

SoColumnDialog, SoRowDialog, SoDialogGroup

Definition at line 93 of file SoTabDialog.h.

Member Enumeration Documentation

◆ TabsLocation

Enumerator
TOP 

Tabs appear at the top of the control (default).

BOTTOM 

Tabs appear at the bottom of the control.

This value equals TCS_RIGHT. This style is not supported if you are using ComCtl32.dll version 6.

LEFT 

Tabs appear vertically on the left side of controls.

RIGHT 

Tabs appear vertically on the right side of controls.

Definition at line 99 of file SoTabDialog.h.

Constructor & Destructor Documentation

◆ SoTabDialog()

SoTabDialog::SoTabDialog ( )

Constructor.

Member Function Documentation

◆ addAuditor()

void SoTabDialog::addAuditor ( SoTabDialogAuditor auditor)

Adds a TabDialogAuditor to current TabDialog component.

◆ removeAuditor()

void SoTabDialog::removeAuditor ( SoTabDialogAuditor auditor)

Removes the specified TabDialogAuditor from the auditor list.

Member Data Documentation

◆ selectedPage

SoSFInt32 SoTabDialog::selectedPage

Specifies currently selected tab page.

Default is zero, the first page.

Definition at line 120 of file SoTabDialog.h.

◆ tabsLocation

SoSFEnum SoTabDialog::tabsLocation

Specifies location of the tabs.

Default value is TOP.

Definition at line 115 of file SoTabDialog.h.


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