man SoSFString () - field containing a string

NAME

SoSFString - field containing a string

INHERITS FROM

SoField > SoSField > SoSFString

SYNOPSIS

#include <Inventor/fields/SoSFString.h> Methods from class SoSFString: c } c } setValue(const char *string)

c } c } getClassTypeId()

c } c } getTypeId() const

c } c } getValue() const

c } c } operator =(const SbString & newValue)

c } c } setValue(const SbString & newValue)

c } c } operator ==(const SoSFString &f) const

c } c } operator !=(const SoSFString &f) const Methods from class SoField: c } c } setIgnored(SbBool ignore)

c } c } isIgnored() const

c } c } isDefault() const

c } c } isOfType(SoType type) const

c } c } set(const char *valueString)

c } c } get(SbString &valueString)

c } c } touch()

c } c } connectFrom(SoField *fromField)

c } c } connectFrom(SoEngineOutput *fromEngine)

c } c } disconnect()

c } c } isConnected() const

c } c } isConnectedFromField() const

c } c } getConnectedField(SoField *&writingField) const

c } c } isConnectedFromEngine() const

c } c } getConnectedEngine(SoEngineOutput *&engineOutput) const

c } c } enableConnection(SbBool flag)

c } c } isConnectionEnabled() const

c } c } getForwardConnections(SoFieldList &list) const

c } c } getContainer() const

DESCRIPTION

A field containing an ASCII string (sequence of characters). Inventor does not support non-ASCII strings. SoSFStrings are written to file as a sequence of ASCII characters in double quotes (optional if the string doesn't contain any whitespace). Any characters (including newlines) may appear within the quotes. To include a double quote character within the string, precede it with a backslash. For example:

Testing "One, Two, Three" "He said, \"Immel did it!\""

are all valid strings.

METHODS

c } c } setValue(const char *string)

Convenience method to set the field's value given a character array. c } c } getClassTypeId()

c } c } getTypeId() const

Returns the type for this class or a particular object of this class. c } c } getValue() const

Returns this field's value. c } c } operator =(const SbString & newValue)

c } c } setValue(const SbString & newValue)

Sets this field to newValue. c } c } operator ==(const SoSFString &f) const

c } c } operator !=(const SoSFString &f) const

Returns TRUE if f is of the same type and has the same value as this field.

SEE ALSO

SbString, SoField, SoSField, SoMFString