NAME

       SoSFString — field containing a string

INHERITS FROM

       SoField > SoSField > SoSFString

SYNOPSIS

       #include <Inventor/fields/SoSFString.h>

          Methods from class SoSFString:

                         setValue(const char *string)
     static SoType       getClassTypeId()
     virtual void        getTypeId() const
     const SbString &    getValue() const
     const SbString &    operator =(const SbString & newValue)
     void                setValue(const SbString & newValue)
     int                 operator ==(const SoSFString &f) const
     int                 operator !=(const SoSFString &f) const

          Methods from class SoField:

     void                setIgnored(SbBool ignore)
     SbBool              isIgnored() const
     SbBool              isDefault() const
     virtual SbBool      isOfType(SoType type) const
     SbBool              set(const char *valueString)
     void                get(SbString &valueString)
     void                touch()
     SbBool              connectFrom(SoField *fromField)
     SbBool              connectFrom(SoEngineOutput *fromEngine)
     void                disconnect()
     SbBool              isConnected() const
     SbBool              isConnectedFromField() const
     SbBool              getConnectedField(SoField *&writingField) const
     SbBool              isConnectedFromEngine() const
     SbBool              getConnectedEngine(SoEngineOutput *&engineOutput) const
     void                enableConnection(SbBool flag)
     SbBool              isConnectionEnabled() const
     int                 getForwardConnections(SoFieldList &list) const
     SoFieldContainer *  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

                         setValue(const char *string)
          Convenience method to set the field's value given a character array.

     static SoType       getClassTypeId()
     virtual void        getTypeId() const
          Returns the type for this class or a particular object of this class.

     const SbString &    getValue() const
          Returns this field's value.

     const SbString &    operator =(const SbString & newValue)
     void                setValue(const SbString & newValue)
          Sets this field to newValue.

     int                 operator ==(const SoSFString &f) const
     int                 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

                                                                                SoSFString(3IV)()