table of contents
        
      
      
    - Tumbleweed 3.1.3-7.3
 - Leap-15.6
 
| SoMFString(3) | Library Functions Manual | SoMFString(3) | 
NAME¶
SoMFString - The SoMFString class is a container for SbString values.
SYNOPSIS¶
#include <Inventor/fields/SoMFString.h>
Inherits SoMField.
Public Member Functions¶
virtual SoType getTypeId (void) const
  
  virtual void copyFrom (const SoField &field)
  
  const SoMFString & operator= (const SoMFString
    &field)
  
  virtual SbBool isSame (const SoField &field) const
  
  const SbString & operator[] (const int idx) const
  
  const SbString * getValues (const int start) const
  
  int find (const SbString &value, SbBool addifnotfound=FALSE)
  
  void setValues (const int start, const int num, const
    SbString *newvals)
  
  void set1Value (const int idx, const SbString &value)
  
  void setValue (const SbString &value)
  
  const SbString & operator= (const SbString &val)
  
  SbBool operator== (const SoMFString &field) const
  
  SbBool operator!= (const SoMFString &field) const
  
  SbString * startEditing (void)
  
  void finishEditing (void)
  
  void setValues (const int start, const int num, const char
    *strings[])
  
  void setValue (const char *string)
  
  void deleteText (const int fromline, const int fromchar, const int
    toline, const int tochar)
  
  
Public Member Functions inherited from SoMField
  
  virtual ~SoMField ()
  
  int getNum (void) const
  
  void setNum (const int num)
  
  virtual void deleteValues (int start, int num=-1)
  
  virtual void insertSpace (int start, int num)
  
  SbBool set1 (const int index, const char *const valuestring)
  
  void get1 (const int index, SbString &valuestring)
  
  virtual void enableDeleteValues (void)
  
  virtual SbBool isDeleteValuesEnabled (void) const
  
  
Public Member Functions inherited from SoField
  
  virtual ~SoField ()
  
  void setIgnored (SbBool ignore)
  
  SbBool isIgnored (void) const
  
  void setDefault (SbBool defaultVal)
  
  SbBool isDefault (void) const
  
  SbBool isOfType (const SoType type) const
  
  void enableConnection (SbBool flag)
  
  SbBool isConnectionEnabled (void) const
  
  SbBool connectFrom (SoEngineOutput *master, SbBool
    notnotify=FALSE, SbBool append=FALSE)
  
  SbBool appendConnection (SoEngineOutput *master, SbBool
    notnotify=FALSE)
  
  void disconnect (SoEngineOutput *engineoutput)
  
  SbBool isConnectedFromEngine (void) const
  
  SbBool getConnectedEngine (SoEngineOutput *&master) const
  
  SbBool connectFrom (SoField *master, SbBool notnotify=FALSE,
    SbBool append=FALSE)
  
  SbBool appendConnection (SoField *master, SbBool
    notnotify=FALSE)
  
  void disconnect (SoField *field)
  
  SbBool isConnectedFromField (void) const
  
  SbBool getConnectedField (SoField *&master) const
  
  int getNumConnections (void) const
  
  int getForwardConnections (SoFieldList &slavelist) const
  
  int getConnections (SoFieldList &masterlist) const
  
  void disconnect (void)
  
  SbBool isConnected (void) const
  
  void setContainer (SoFieldContainer *cont)
  
  SoFieldContainer * getContainer (void) const
  
  SbBool set (const char *valuestring)
  
  void get (SbString &valuestring)
  
  SbBool shouldWrite (void) const
  
  virtual void touch (void)
  
  virtual void startNotify (void)
  
  virtual void notify (SoNotList *nlist)
  
  SbBool enableNotify (SbBool on)
  
  SbBool isNotifyEnabled (void) const
  
  void addAuditor (void *f, SoNotRec::Type type)
  
  void removeAuditor (void *f, SoNotRec::Type type)
  
  int operator== (const SoField &f) const
  
  int operator!= (const SoField &f) const
  
  virtual void connectionStatusChanged (int numconnections)
  
  SbBool isReadOnly (void) const
  
  virtual void fixCopy (SbBool copyconnections)
  
  virtual SbBool referencesCopy (void) const
  
  void copyConnection (const SoField *fromfield)
  
  virtual SbBool read (SoInput *input, const SbName
    &name)
  
  virtual void write (SoOutput *out, const SbName
    &name) const
  
  virtual void countWriteRefs (SoOutput *out) const
  
  void setFieldType (int type)
  
  int getFieldType (void) const
  
  SbBool getDirty (void) const
  
  void setDirty (SbBool dirty)
  
  void evaluate (void) const
  
  
Static Public Member Functions¶
static void * createInstance (void)
  
  static SoType getClassTypeId (void)
  
  static void initClass (void)
  
  
Static Public Member Functions inherited from SoMField
  
  static SoType getClassTypeId (void)
  
  static void atexit_cleanup (void)
  
  static void initClass (void)
  
  
Static Public Member Functions inherited from SoField
  
  static void initClass (void)
  
  static void initClasses (void)
  
  static void cleanupClass (void)
  
  static SoType getClassTypeId (void)
  
  
Protected Member Functions¶
virtual void deleteAllValues (void)
  
  virtual void copyValue (int to, int from)
  
  virtual int fieldSizeof (void) const
  
  virtual void * valuesPtr (void)
  
  virtual void setValuesPtr (void *ptr)
  
  virtual void allocValues (int num)
  
  
Protected Member Functions inherited from SoMField
  
  SoMField (void)
  
  virtual void makeRoom (int newnum)
  
  
Protected Member Functions inherited from SoField
  
  SoField (void)
  
  void valueChanged (SbBool resetdefault=TRUE)
  
  virtual void evaluateConnection (void) const
  
  virtual SbBool readConnection (SoInput *in)
  
  virtual void writeConnection (SoOutput *out) const
  
  SbBool isDestructing (void) const
  
  
Protected Attributes¶
SbString * values
  
  
Protected Attributes inherited from SoMField
  
  int num
  
  int maxNum
  
  SbBool userDataIsUsed
  
  
Additional Inherited Members¶
Public Types inherited from SoField
  
  enum FieldType { NORMAL_FIELD = 0, EVENTIN_FIELD,
    EVENTOUT_FIELD, EXPOSED_FIELD }
  
  
Detailed Description¶
The SoMFString class is a container for SbString values.
This field is used where nodes, engines or other field containers needs to store arrays of strings.
See also
Member Function Documentation¶
SoType SoMFString::getTypeId (void ) const [virtual]¶
Returns the type identification instance which uniquely identifies the Coin field class the object belongs to.
See also
Implements SoField.
void SoMFString::copyFrom (const SoField & f) [virtual]¶
Copy value(s) from f into this field. f must be of the same type as this field.
Implements SoField.
SbBool SoMFString::isSame (const SoField & f) const [virtual]¶
Check for equal type and value(s).
Implements SoField.
void SoMFString::deleteAllValues (void ) [protected], [virtual]¶
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.
Implements SoMField.
void SoMFString::copyValue (int to, int from) [protected], [virtual]¶
This method is used for moving values around internally within a multivalue field. It needs to be overridden in each field so it automatically takes care of running copy contructors where necessary.
Implements SoMField.
const SbString * SoMFString::getValues (const int start) const [inline]¶
Returns a pointer to the values array.
void SoMFString::setValues (const int start, const int numarg, const char * strings[])¶
Set field to contain num strings from index start, replacing any strings already present at the given indices.
void SoMFString::setValue (const char * str)¶
Set field to contain a single string, from str.
void SoMFString::deleteText (const int fromline, const int fromchar, const int toline, const int tochar)¶
Remove all text from fromchar on fromline and to tochar on toline, including all lines between fromline and toline. Merge fromline and toline after deletion.
Author¶
Generated automatically by Doxygen for Coin from the source code.
| Version 3.1.3 | Coin |