.TH "SoMFString" 3 "Fri Sep 6 2024 15:32:06" "Version 4.0.3" "Coin" \" -*- nroff -*-
.ad l
.nh
.SH NAME
SoMFString \- The \fBSoMFString\fP class is a container for \fBSbString\fP values\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fR#include <Inventor/fields/SoMFString\&.h>\fP
.PP
Inherits \fBSoMField\fP\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "virtual \fBSoType\fP \fBgetTypeId\fP (void) const"
.br
.ti -1c
.RI "virtual void \fBcopyFrom\fP (const \fBSoField\fP &field)"
.br
.ti -1c
.RI "const \fBSoMFString\fP & \fBoperator=\fP (const \fBSoMFString\fP &field)"
.br
.ti -1c
.RI "virtual SbBool \fBisSame\fP (const \fBSoField\fP &field) const"
.br
.ti -1c
.RI "const \fBSbString\fP & \fBoperator[]\fP (const int idx) const"
.br
.ti -1c
.RI "const \fBSbString\fP * \fBgetValues\fP (const int start) const"
.br
.ti -1c
.RI "int \fBfind\fP (const \fBSbString\fP &value, SbBool addifnotfound=FALSE)"
.br
.ti -1c
.RI "void \fBsetValues\fP (const int start, const int \fBnum\fP, const \fBSbString\fP *newvals)"
.br
.ti -1c
.RI "void \fBset1Value\fP (const int idx, const \fBSbString\fP &value)"
.br
.ti -1c
.RI "void \fBsetValue\fP (const \fBSbString\fP &value)"
.br
.ti -1c
.RI "const \fBSbString\fP & \fBoperator=\fP (const \fBSbString\fP &val)"
.br
.ti -1c
.RI "SbBool \fBoperator==\fP (const \fBSoMFString\fP &field) const"
.br
.ti -1c
.RI "SbBool \fBoperator!=\fP (const \fBSoMFString\fP &field) const"
.br
.ti -1c
.RI "\fBSbString\fP * \fBstartEditing\fP (void)"
.br
.ti -1c
.RI "void \fBfinishEditing\fP (void)"
.br
.ti -1c
.RI "void \fBsetValues\fP (const int start, const int \fBnum\fP, const char *strings[])"
.br
.ti -1c
.RI "void \fBsetValue\fP (const char *string)"
.br
.ti -1c
.RI "void \fBdeleteText\fP (const int fromline, const int fromchar, const int toline, const int tochar)"
.br
.in -1c

Public Member Functions inherited from \fBSoMField\fP
.in +1c
.ti -1c
.RI "virtual \fB~SoMField\fP ()"
.br
.ti -1c
.RI "int \fBgetNum\fP (void) const"
.br
.ti -1c
.RI "void \fBsetNum\fP (const int \fBnum\fP)"
.br
.ti -1c
.RI "virtual void \fBdeleteValues\fP (int start, int \fBnum\fP=\-1)"
.br
.ti -1c
.RI "virtual void \fBinsertSpace\fP (int start, int \fBnum\fP)"
.br
.ti -1c
.RI "SbBool \fBset1\fP (const int index, const char *const valuestring)"
.br
.ti -1c
.RI "void \fBget1\fP (const int index, \fBSbString\fP &valuestring)"
.br
.ti -1c
.RI "virtual void \fBenableDeleteValues\fP (void)"
.br
.ti -1c
.RI "virtual SbBool \fBisDeleteValuesEnabled\fP (void) const"
.br
.in -1c

Public Member Functions inherited from \fBSoField\fP
.in +1c
.ti -1c
.RI "virtual \fB~SoField\fP ()"
.br
.ti -1c
.RI "void \fBsetIgnored\fP (SbBool ignore)"
.br
.ti -1c
.RI "SbBool \fBisIgnored\fP (void) const"
.br
.ti -1c
.RI "void \fBsetDefault\fP (SbBool defaultVal)"
.br
.ti -1c
.RI "SbBool \fBisDefault\fP (void) const"
.br
.ti -1c
.RI "SbBool \fBisOfType\fP (const \fBSoType\fP type) const"
.br
.ti -1c
.RI "void \fBenableConnection\fP (SbBool flag)"
.br
.ti -1c
.RI "SbBool \fBisConnectionEnabled\fP (void) const"
.br
.ti -1c
.RI "SbBool \fBconnectFrom\fP (\fBSoEngineOutput\fP *master, SbBool notnotify=FALSE, SbBool append=FALSE)"
.br
.ti -1c
.RI "SbBool \fBappendConnection\fP (\fBSoEngineOutput\fP *master, SbBool notnotify=FALSE)"
.br
.ti -1c
.RI "void \fBdisconnect\fP (\fBSoEngineOutput\fP *engineoutput)"
.br
.ti -1c
.RI "SbBool \fBisConnectedFromEngine\fP (void) const"
.br
.ti -1c
.RI "SbBool \fBgetConnectedEngine\fP (\fBSoEngineOutput\fP *&master) const"
.br
.ti -1c
.RI "SbBool \fBconnectFrom\fP (\fBSoField\fP *master, SbBool notnotify=FALSE, SbBool append=FALSE)"
.br
.ti -1c
.RI "SbBool \fBappendConnection\fP (\fBSoField\fP *master, SbBool notnotify=FALSE)"
.br
.ti -1c
.RI "void \fBdisconnect\fP (\fBSoField\fP *field)"
.br
.ti -1c
.RI "SbBool \fBisConnectedFromField\fP (void) const"
.br
.ti -1c
.RI "SbBool \fBgetConnectedField\fP (\fBSoField\fP *&master) const"
.br
.ti -1c
.RI "int \fBgetNumConnections\fP (void) const"
.br
.ti -1c
.RI "int \fBgetForwardConnections\fP (\fBSoFieldList\fP &slavelist) const"
.br
.ti -1c
.RI "int \fBgetConnections\fP (\fBSoFieldList\fP &masterlist) const"
.br
.ti -1c
.RI "void \fBdisconnect\fP (void)"
.br
.ti -1c
.RI "SbBool \fBisConnected\fP (void) const"
.br
.ti -1c
.RI "void \fBsetContainer\fP (\fBSoFieldContainer\fP *cont)"
.br
.ti -1c
.RI "\fBSoFieldContainer\fP * \fBgetContainer\fP (void) const"
.br
.ti -1c
.RI "SbBool \fBset\fP (const char *valuestring)"
.br
.ti -1c
.RI "void \fBget\fP (\fBSbString\fP &valuestring)"
.br
.ti -1c
.RI "SbBool \fBshouldWrite\fP (void) const"
.br
.ti -1c
.RI "virtual void \fBtouch\fP (void)"
.br
.ti -1c
.RI "virtual void \fBstartNotify\fP (void)"
.br
.ti -1c
.RI "virtual void \fBnotify\fP (\fBSoNotList\fP *nlist)"
.br
.ti -1c
.RI "SbBool \fBenableNotify\fP (SbBool on)"
.br
.ti -1c
.RI "SbBool \fBisNotifyEnabled\fP (void) const"
.br
.ti -1c
.RI "void \fBaddAuditor\fP (void *f, \fBSoNotRec::Type\fP type)"
.br
.ti -1c
.RI "void \fBremoveAuditor\fP (void *f, \fBSoNotRec::Type\fP type)"
.br
.ti -1c
.RI "int \fBoperator==\fP (const \fBSoField\fP &f) const"
.br
.ti -1c
.RI "int \fBoperator!=\fP (const \fBSoField\fP &f) const"
.br
.ti -1c
.RI "virtual void \fBconnectionStatusChanged\fP (int numconnections)"
.br
.ti -1c
.RI "SbBool \fBisReadOnly\fP (void) const"
.br
.ti -1c
.RI "virtual void \fBfixCopy\fP (SbBool copyconnections)"
.br
.ti -1c
.RI "virtual SbBool \fBreferencesCopy\fP (void) const"
.br
.ti -1c
.RI "void \fBcopyConnection\fP (const \fBSoField\fP *fromfield)"
.br
.ti -1c
.RI "virtual SbBool \fBread\fP (\fBSoInput\fP *input, const \fBSbName\fP &name)"
.br
.ti -1c
.RI "virtual void \fBwrite\fP (\fBSoOutput\fP *out, const \fBSbName\fP &name) const"
.br
.ti -1c
.RI "virtual void \fBcountWriteRefs\fP (\fBSoOutput\fP *out) const"
.br
.ti -1c
.RI "void \fBsetFieldType\fP (int type)"
.br
.ti -1c
.RI "int \fBgetFieldType\fP (void) const"
.br
.ti -1c
.RI "SbBool \fBgetDirty\fP (void) const"
.br
.ti -1c
.RI "void \fBsetDirty\fP (SbBool dirty)"
.br
.ti -1c
.RI "void \fBevaluate\fP (void) const"
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "static void * \fBcreateInstance\fP (void)"
.br
.ti -1c
.RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)"
.br
.ti -1c
.RI "static void \fBinitClass\fP (void)"
.br
.in -1c

Static Public Member Functions inherited from \fBSoMField\fP
.in +1c
.ti -1c
.RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)"
.br
.ti -1c
.RI "static void \fBatexit_cleanup\fP (void)"
.br
.ti -1c
.RI "static void \fBinitClass\fP (void)"
.br
.in -1c

Static Public Member Functions inherited from \fBSoField\fP
.in +1c
.ti -1c
.RI "static void \fBinitClass\fP (void)"
.br
.ti -1c
.RI "static void \fBinitClasses\fP (void)"
.br
.ti -1c
.RI "static void \fBcleanupClass\fP (void)"
.br
.ti -1c
.RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "virtual void \fBdeleteAllValues\fP (void)"
.br
.ti -1c
.RI "virtual void \fBcopyValue\fP (int to, int from)"
.br
.ti -1c
.RI "virtual int \fBfieldSizeof\fP (void) const"
.br
.ti -1c
.RI "virtual void * \fBvaluesPtr\fP (void)"
.br
.ti -1c
.RI "virtual void \fBsetValuesPtr\fP (void *ptr)"
.br
.ti -1c
.RI "virtual void \fBallocValues\fP (int \fBnum\fP)"
.br
.in -1c

Protected Member Functions inherited from \fBSoMField\fP
.in +1c
.ti -1c
.RI "\fBSoMField\fP (void)"
.br
.ti -1c
.RI "virtual void \fBmakeRoom\fP (int newnum)"
.br
.ti -1c
.RI "virtual \fBSoNotRec\fP \fBcreateNotRec\fP (\fBSoBase\fP *container)"
.br
.ti -1c
.RI "void \fBsetChangedIndex\fP (const int chgidx)"
.br
.ti -1c
.RI "void \fBsetChangedIndices\fP (const int chgidx=\-1, const int numchgind=0)"
.br
.in -1c

Protected Member Functions inherited from \fBSoField\fP
.in +1c
.ti -1c
.RI "\fBSoField\fP (void)"
.br
.ti -1c
.RI "void \fBvalueChanged\fP (SbBool resetdefault=TRUE)"
.br
.ti -1c
.RI "virtual void \fBevaluateConnection\fP (void) const"
.br
.ti -1c
.RI "virtual SbBool \fBreadConnection\fP (\fBSoInput\fP *in)"
.br
.ti -1c
.RI "virtual void \fBwriteConnection\fP (\fBSoOutput\fP *out) const"
.br
.ti -1c
.RI "SbBool \fBisDestructing\fP (void) const"
.br
.in -1c
.SS "Protected Attributes"

.in +1c
.ti -1c
.RI "\fBSbString\fP * \fBvalues\fP"
.br
.in -1c

Protected Attributes inherited from \fBSoMField\fP
.in +1c
.ti -1c
.RI "int \fBnum\fP"
.br
.ti -1c
.RI "int \fBmaxNum\fP"
.br
.ti -1c
.RI "SbBool \fBuserDataIsUsed\fP"
.br
.in -1c
.SS "Additional Inherited Members"


Public Types inherited from \fBSoField\fP
.in +1c
.ti -1c
.RI "enum \fBFieldType\fP { \fBNORMAL_FIELD\fP = 0, \fBEVENTIN_FIELD\fP, \fBEVENTOUT_FIELD\fP, \fBEXPOSED_FIELD\fP }"
.br
.in -1c

Public Attributes inherited from \fBSoField\fP
.SH "Detailed Description"
.PP 
The \fBSoMFString\fP class is a container for \fBSbString\fP values\&. 

This field is used where nodes, engines or other field containers needs to store arrays of strings\&.

.PP
\fBSee also\fP
.RS 4
\fBSoSFString\fP 
.RE
.PP

.SH "Member Function Documentation"
.PP 
.SS "void * SoMFString::createInstance (void )\fR [static]\fP"
\fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP
.br

.br
 Creates a new instance of the class type corresponding to the \fBSoType\fP object\&. 
.br
 
.SS "\fBSoType\fP SoMFString::getClassTypeId (void )\fR [static]\fP"
This static method returns the \fBSoType\fP object associated with objects of this class\&. 
.br
 
.SS "\fBSoType\fP SoMFString::getTypeId (void ) const\fR [virtual]\fP"
Returns the type identification of an object derived from a class inheriting \fBSoField\fP\&. This is used for runtime type checking and 'downward' casting\&. 
.br
 
.PP
Implements \fBSoField\fP\&.
.SS "void SoMFString::copyFrom (const \fBSoField\fP & f)\fR [virtual]\fP"
Copy value(s) from \fIf\fP into this field\&. \fIf\fP must be of the same type as this field\&. 
.PP
Implements \fBSoField\fP\&.
.SS "SbBool SoMFString::isSame (const \fBSoField\fP & f) const\fR [virtual]\fP"
Check for equal type and value(s)\&. 
.PP
Implements \fBSoField\fP\&.
.SS "void SoMFString::deleteAllValues (void )\fR [protected]\fP, \fR [virtual]\fP"
\fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP
.br

.br
 
.PP
Implements \fBSoMField\fP\&.
.SS "void SoMFString::copyValue (int to, int from)\fR [protected]\fP, \fR [virtual]\fP"
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 constructors where necessary\&. 
.PP
Implements \fBSoMField\fP\&.
.SS "const \fBSbString\fP * SoMFString::getValues (const int start) const\fR [inline]\fP"
Returns a pointer to the values array\&. 
.br
 
.SS "void SoMFString::initClass (void )\fR [static]\fP"
Internal method called upon initialization of the library (from \fBSoDB::init()\fP) to set up the type system\&.    
.SS "void SoMFString::setValues (const int start, const int numarg, const char * strings[])"
Set field to contain \fInum\fP \fIstrings\fP from index \fIstart\fP, replacing any strings already present at the given indices\&. 
.SS "void SoMFString::setValue (const char * str)"
Set field to contain a single string, from \fIstr\fP\&. 
.SS "void SoMFString::deleteText (const int fromline, const int fromchar, const int toline, const int tochar)"
Remove all text from \fIfromchar\fP on \fIfromline\fP and to \fItochar\fP on \fItoline\fP, including all lines between \fIfromline\fP and \fItoline\fP\&. Merge \fIfromline\fP and \fItoline\fP after deletion\&. 

.SH "Author"
.PP 
Generated automatically by Doxygen for Coin from the source code\&.