Dialog EditText node. More...

#include <DialogViz/dialog/SoDialogEditText.h>

Inheritance diagram for SoDialogEditText:

Public Member Functions
	SoDialogEditText ()
	Constructor.

void	addAuditor (SoDialogEditTextAuditor *auditor)
	Adds a dialogEditTextAuditor to the current editText component.

void	removeAuditor (SoDialogEditTextAuditor *auditor)
	Removes the specified editTextAuditor from the auditor list.

Public Member Functions inherited from SoDragger
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.

virtual const SoNodekitCatalog *	getNodekitCatalog () 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 SbMatrix &	getMotionMatrix ()
	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 SoNode *	getPart (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 SoNodeKitPath *	createPathToPart (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 SoNode *	copy (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 SoField *	getField (const SbName &fieldName) const
	Returns a the field of this object whose name is fieldName.

virtual SoField *	getEventIn (const SbName &fieldName) const
	Returns a the eventIn with the given name.

virtual SoField *	getEventOut (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
SoSFString	editText
	String of the edit zone.

SoSFBool	editable
	Allows writing in the edit zone.

SoSFBool	multiLine
	Sets multi-line mode.

SoSFBool	wrapLine
	Sets wraping line mode.

SoSFBool	trigOnEnter
	When trigOnEnter is TRUE, the associated auditor is called only when the <ENTER> key is pressed.

SoSFBool	isNumeric
	Specifies if typed text is numeric only.

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
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...

Public Types inherited from SoInteractionKit
enum	CacheEnabled { OFF , ON , AUTO }
	Possible values for caching. More...

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 SoDialogViz *	loadFromFile (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 SoNodekitCatalog *	getClassNodekitCatalog ()
	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 SoNodekitCatalog *	getClassNodekitCatalog ()
	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 SoNodekitCatalog *	getClassNodekitCatalog ()
	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 SoNode *	getByName (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

Dialog EditText node.

This node defines a multi-line editing zone for the dialog.

The editText field represents the text of the editing zone. This field supports the newline (\n) character and the tabulation character (\t). The editable field specifies if the user can write new text in the edit zone or not. The multiLine field allows to edit a multiLine text. In this case, a vertical scroll bar appears at the left side of the component. On windows system, mouse scroll wheel is supported in the edit area. The trigOnEnter field specifies how the associated auditor is triggered. If its value is TRUE, the event happened only when the <ENTER> key is pressed. Otherwise, the auditor is called each time the edit text changes. It's possible to filter text to be numeric or not by using the isNumeric field.

Note : On UNIX systems, the auditor call is depending on the multiLine field value. If the edit control is multiLine, only the num pad <ENTER> key will process the auditor, else, in case multiLine is FALSE, the two <ENTER> key will do it.

To add or remove an SoDialogEditTextAuditor, use the addAuditor() and removeAuditor() methods.

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

editText	""
editable	TRUE
trigOnEnter	TRUE
isNumeric	FALSE
multiLine	FALSE
wrapLine	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

SoDialogEditText {

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.

Switch downSwitch {

Defines the traversed geometry relatively to the down scroll button state

Group downReleased

Defines the geometry of the down scroll button when it is in its released state. Default size is set by DialogViz to (14, 14, 1).

Group downPressed

Defines the geometry of the down scroll button when it is in its pressed state. Default size is set by DialogViz to (14, 14, 1).

}

Switch upSwitch {

Defines the traversed geometry relatively to the up scroll button state

Group upReleased

Defines the geometry of the up scroll button when it is in its released state. Default size is set by DialogViz to (14, 14, z).

Group upPressed

Defines the geometry of the up scroll button when it is in its pressed state. Default size is set by DialogViz to (14, 14, z).

}

Group scrollFrame

Defines the scroll back frame geometry.

Group cursorFrame

Defines the scroll cursor geometry. Default size is set by DialogViz to (14, y, z).

Switch frameSwitch {

Defines the traversed geometry relatively to user action.

Group frame

Defines the geometry of the edit zone when the text is not being modified.

Group editFrame

Defines the geometry of the edit when the user is being modified.

}

Group textProp

Specifies properties to apply to the text node that represents the editText field value.

}

Extra information for parts from above structure

Part Name

Resource

Skin file

edgeStyleNone

DialogComponentEdgeStyleNone

DialogComponent.iv

edgeStyleShadowIn

DialogComponentEdgeStyleShadowIn

DialogComponent.iv

edgeStyleShadowOut

DialogComponentEdgeStyleShadowOut

DialogComponent.iv

labelProp

DialogTextProperties

TextProperties.iv

downReleased

DialogEditTextDownButtonReleased

DialogEditText.iv

downPressed

DialogEditTextDownButtonPressed

DialogEditText.iv

upReleased

DialogEditTextUpButtonReleased

DialogEditText.iv

upPressed

DialogEditTextUpButtonPressed

DialogEditText.iv

scrollFrame

DialogEditTextScrollFrame

DialogEditText.iv

cursorFrame

DialogEditTextCursorFrame

DialogEditText.iv

frame

DialogEditTextFrame

DialogEditText.iv

editFrame

DialogEditTextEditingFrame

DialogEditText.iv

textProp

DialogTextProperties

TextProperties.iv

Constructor & Destructor Documentation

◆ SoDialogEditText()

SoDialogEditText::SoDialogEditText ( )

Constructor.

Member Function Documentation

◆ addAuditor()

void SoDialogEditText::addAuditor ( SoDialogEditTextAuditor * auditor )

Adds a dialogEditTextAuditor to the current editText component.

◆ removeAuditor()

void SoDialogEditText::removeAuditor ( SoDialogEditTextAuditor * auditor )

Removes the specified editTextAuditor from the auditor list.

Member Data Documentation

◆ editable

SoSFBool SoDialogEditText::editable

Allows writing in the edit zone.

Default is TRUE.

Definition at line 131 of file SoDialogEditText.h.

◆ editText

SoSFString SoDialogEditText::editText

String of the edit zone.

Default value is an empty string.

Definition at line 126 of file SoDialogEditText.h.

◆ isNumeric

SoSFBool SoDialogEditText::isNumeric

Specifies if typed text is numeric only.

Definition at line 153 of file SoDialogEditText.h.

◆ multiLine

SoSFBool SoDialogEditText::multiLine

Sets multi-line mode.

Default is FALSE.

Definition at line 136 of file SoDialogEditText.h.

◆ trigOnEnter

SoSFBool SoDialogEditText::trigOnEnter

When trigOnEnter is TRUE, the associated auditor is called only when the <ENTER> key is pressed.

Otherwise, the auditor is called at any edit text changes. Default is TRUE.

Definition at line 148 of file SoDialogEditText.h.

◆ wrapLine

SoSFBool SoDialogEditText::wrapLine

Sets wraping line mode.