1SoSFString(3IV)()                                            SoSFString(3IV)()
2
3
4

NAME

6       SoSFString — field containing a string
7

INHERITS FROM

9       SoField > SoSField > SoSFString
10

SYNOPSIS

12       #include <Inventor/fields/SoSFString.h>
13
14          Methods from class SoSFString:
15
16                         setValue(const char *string)
17     static SoType       getClassTypeId()
18     virtual void        getTypeId() const
19     const SbString &    getValue() const
20     const SbString &    operator =(const SbString & newValue)
21     void                setValue(const SbString & newValue)
22     int                 operator ==(const SoSFString &f) const
23     int                 operator !=(const SoSFString &f) const
24
25          Methods from class SoField:
26
27     void                setIgnored(SbBool ignore)
28     SbBool              isIgnored() const
29     SbBool              isDefault() const
30     virtual SbBool      isOfType(SoType type) const
31     SbBool              set(const char *valueString)
32     void                get(SbString &valueString)
33     void                touch()
34     SbBool              connectFrom(SoField *fromField)
35     SbBool              connectFrom(SoEngineOutput *fromEngine)
36     void                disconnect()
37     SbBool              isConnected() const
38     SbBool              isConnectedFromField() const
39     SbBool              getConnectedField(SoField *&writingField) const
40     SbBool              isConnectedFromEngine() const
41     SbBool              getConnectedEngine(SoEngineOutput     *&engineOutput)
42                              const
43     void                enableConnection(SbBool flag)
44     SbBool              isConnectionEnabled() const
45     int                 getForwardConnections(SoFieldList &list) const
46     SoFieldContainer *  getContainer() const
47
48

DESCRIPTION

50       A field containing an ASCII string (sequence of  characters).  Inventor
51       does not support non-ASCII strings.
52
53       SoSFStrings  are  written  to file as a sequence of ASCII characters in
54       double quotes (optional if the string doesn't contain any  whitespace).
55       Any  characters  (including  newlines) may appear within the quotes. To
56       include a double quote character within the string, precede it  with  a
57       backslash. For example:
58
59          Testing
60          "One, Two, Three"
61          "He said, \"Immel did it!\""
62
63     are all valid strings.
64

METHODS

66                         setValue(const char *string)
67          Convenience method to set the field's value given a character array.
68
69     static SoType       getClassTypeId()
70     virtual void        getTypeId() const
71          Returns  the  type  for  this  class  or a particular object of this
72          class.
73
74     const SbString &    getValue() const
75          Returns this field's value.
76
77     const SbString &    operator =(const SbString & newValue)
78     void                setValue(const SbString & newValue)
79          Sets this field to newValue.
80
81     int                 operator ==(const SoSFString &f) const
82     int                 operator !=(const SoSFString &f) const
83          Returns TRUE if f is of the same type and has the same value as this
84          field.
85
86

SEE ALSO

88       SbString, SoField, SoSField, SoMFString
89
90
91
92
93                                                             SoSFString(3IV)()