.TH "SoMFString" 3 "Tue Dec 26 2023 17:59:22" "Version 4.0.2" "Coin" \" -*- nroff -*-
.ad l
.nh
.SH NAME
SoMFString \- The \fBSoMFString\fP class is a container for \fBSbString\fP values\&.  

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

.in +1c
.ti -1c
.RI "\fBvirtual\fP \fBSoType\fP \fBgetTypeId\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBcopyFrom\fP (\fBconst\fP \fBSoField\fP &\fBfield\fP)"
.br
.ti -1c
.RI "\fBconst\fP \fBSoMFString\fP & \fBoperator=\fP (\fBconst\fP \fBSoMFString\fP &\fBfield\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP SbBool \fBisSame\fP (\fBconst\fP \fBSoField\fP &\fBfield\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBconst\fP \fBSbString\fP & \fBoperator[]\fP (\fBconst\fP int idx) \fBconst\fP"
.br
.ti -1c
.RI "\fBconst\fP \fBSbString\fP * \fBgetValues\fP (\fBconst\fP int start) \fBconst\fP"
.br
.ti -1c
.RI "int \fBfind\fP (\fBconst\fP \fBSbString\fP &value, SbBool \fBaddifnotfound\fP=FALSE)"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetValues\fP (\fBconst\fP int start, \fBconst\fP int \fBnum\fP, \fBconst\fP \fBSbString\fP *\fBnewvals\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBset1Value\fP (\fBconst\fP int idx, \fBconst\fP \fBSbString\fP &value)"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetValue\fP (\fBconst\fP \fBSbString\fP &value)"
.br
.ti -1c
.RI "\fBconst\fP \fBSbString\fP & \fBoperator=\fP (\fBconst\fP \fBSbString\fP &\fBval\fP)"
.br
.ti -1c
.RI "SbBool \fBoperator==\fP (\fBconst\fP \fBSoMFString\fP &\fBfield\fP) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBoperator!=\fP (\fBconst\fP \fBSoMFString\fP &\fBfield\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBSbString\fP * \fBstartEditing\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBfinishEditing\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetValues\fP (\fBconst\fP int start, \fBconst\fP int \fBnum\fP, \fBconst\fP char *\fBstrings\fP[])"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetValue\fP (\fBconst\fP char *string)"
.br
.ti -1c
.RI "\fBvoid\fP \fBdeleteText\fP (\fBconst\fP int \fBfromline\fP, \fBconst\fP int \fBfromchar\fP, \fBconst\fP int \fBtoline\fP, \fBconst\fP int \fBtochar\fP)"
.br
.in -1c

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

Public Member Functions inherited from \fBSoField\fP
.in +1c
.ti -1c
.RI "\fBvirtual\fP \fB~SoField\fP ()"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetIgnored\fP (SbBool \fBignore\fP)"
.br
.ti -1c
.RI "SbBool \fBisIgnored\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetDefault\fP (SbBool \fBdefaultVal\fP)"
.br
.ti -1c
.RI "SbBool \fBisDefault\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBisOfType\fP (\fBconst\fP \fBSoType\fP type) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBenableConnection\fP (SbBool \fBflag\fP)"
.br
.ti -1c
.RI "SbBool \fBisConnectionEnabled\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBconnectFrom\fP (\fBSoEngineOutput\fP *master, SbBool \fBnotnotify\fP=FALSE, SbBool append=FALSE)"
.br
.ti -1c
.RI "SbBool \fBappendConnection\fP (\fBSoEngineOutput\fP *master, SbBool \fBnotnotify\fP=FALSE)"
.br
.ti -1c
.RI "\fBvoid\fP \fBdisconnect\fP (\fBSoEngineOutput\fP *\fBengineoutput\fP)"
.br
.ti -1c
.RI "SbBool \fBisConnectedFromEngine\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBgetConnectedEngine\fP (\fBSoEngineOutput\fP *&master) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBconnectFrom\fP (\fBSoField\fP *master, SbBool \fBnotnotify\fP=FALSE, SbBool append=FALSE)"
.br
.ti -1c
.RI "SbBool \fBappendConnection\fP (\fBSoField\fP *master, SbBool \fBnotnotify\fP=FALSE)"
.br
.ti -1c
.RI "\fBvoid\fP \fBdisconnect\fP (\fBSoField\fP *\fBfield\fP)"
.br
.ti -1c
.RI "SbBool \fBisConnectedFromField\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBgetConnectedField\fP (\fBSoField\fP *&master) \fBconst\fP"
.br
.ti -1c
.RI "int \fBgetNumConnections\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "int \fBgetForwardConnections\fP (\fBSoFieldList\fP &\fBslavelist\fP) \fBconst\fP"
.br
.ti -1c
.RI "int \fBgetConnections\fP (\fBSoFieldList\fP &\fBmasterlist\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBdisconnect\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "SbBool \fBisConnected\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetContainer\fP (\fBSoFieldContainer\fP *\fBcont\fP)"
.br
.ti -1c
.RI "\fBSoFieldContainer\fP * \fBgetContainer\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBset\fP (\fBconst\fP char *\fBvaluestring\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBget\fP (\fBSbString\fP &\fBvaluestring\fP)"
.br
.ti -1c
.RI "SbBool \fBshouldWrite\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBtouch\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBstartNotify\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBnotify\fP (\fBSoNotList\fP *\fBnlist\fP)"
.br
.ti -1c
.RI "SbBool \fBenableNotify\fP (SbBool on)"
.br
.ti -1c
.RI "SbBool \fBisNotifyEnabled\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBaddAuditor\fP (\fBvoid\fP *f, \fBSoNotRec::Type\fP type)"
.br
.ti -1c
.RI "\fBvoid\fP \fBremoveAuditor\fP (\fBvoid\fP *f, \fBSoNotRec::Type\fP type)"
.br
.ti -1c
.RI "int \fBoperator==\fP (\fBconst\fP \fBSoField\fP &f) \fBconst\fP"
.br
.ti -1c
.RI "int \fBoperator!=\fP (\fBconst\fP \fBSoField\fP &f) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBconnectionStatusChanged\fP (int \fBnumconnections\fP)"
.br
.ti -1c
.RI "SbBool \fBisReadOnly\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBfixCopy\fP (SbBool \fBcopyconnections\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP SbBool \fBreferencesCopy\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBcopyConnection\fP (\fBconst\fP \fBSoField\fP *fromfield)"
.br
.ti -1c
.RI "\fBvirtual\fP SbBool \fBread\fP (\fBSoInput\fP *input, \fBconst\fP \fBSbName\fP &name)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBwrite\fP (\fBSoOutput\fP *\fBout\fP, \fBconst\fP \fBSbName\fP &name) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBcountWriteRefs\fP (\fBSoOutput\fP *\fBout\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetFieldType\fP (int type)"
.br
.ti -1c
.RI "int \fBgetFieldType\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBgetDirty\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetDirty\fP (SbBool dirty)"
.br
.ti -1c
.RI "\fBvoid\fP \fBevaluate\fP (\fBvoid\fP) \fBconst\fP"
.br
.in -1c
.SS "Static Public Member Functions"

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

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

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

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

Protected Member Functions inherited from \fBSoMField\fP
.in +1c
.ti -1c
.RI "\fBSoMField\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBmakeRoom\fP (int \fBnewnum\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBSoNotRec\fP \fBcreateNotRec\fP (\fBSoBase\fP *container)"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetChangedIndex\fP (\fBconst\fP int \fBchgidx\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetChangedIndices\fP (\fBconst\fP int \fBchgidx\fP=\-1, \fBconst\fP int \fBnumchgind\fP=0)"
.br
.in -1c

Protected Member Functions inherited from \fBSoField\fP
.in +1c
.ti -1c
.RI "\fBSoField\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBvalueChanged\fP (SbBool \fBresetdefault\fP=TRUE)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBevaluateConnection\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP SbBool \fBreadConnection\fP (\fBSoInput\fP *\fBin\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBwriteConnection\fP (\fBSoOutput\fP *\fBout\fP) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBisDestructing\fP (\fBvoid\fP) \fBconst\fP"
.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
.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 "\fBvoid\fP * SoMFString::createInstance (\fBvoid\fP)\fC [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 (\fBvoid\fP)\fC [static]\fP"
This static method returns the \fBSoType\fP object associated with objects of this class\&. 
.br
 
.SS "\fBSoType\fP SoMFString::getTypeId (\fBvoid\fP) const\fC [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 "\fBvoid\fP SoMFString::copyFrom (\fBconst\fP \fBSoField\fP & f)\fC [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 (\fBconst\fP \fBSoField\fP & f) const\fC [virtual]\fP"
Check for equal type and value(s)\&. 
.PP
Implements \fBSoField\fP\&.
.SS "\fBvoid\fP SoMFString::deleteAllValues (\fBvoid\fP)\fC [protected]\fP, \fC [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 "\fBvoid\fP SoMFString::copyValue (int to, int from)\fC [protected]\fP, \fC [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 "\fBconst\fP \fBSbString\fP * SoMFString::getValues (\fBconst\fP int start) const\fC [inline]\fP"
Returns a pointer to the values array\&. 
.br
 
.SS "\fBvoid\fP SoMFString::initClass (\fBvoid\fP)\fC [static]\fP"
Internal method called upon initialization of the library (from \fBSoDB::init()\fP) to set up the type system\&.   
.SS "\fBvoid\fP SoMFString::setValues (\fBconst\fP int start, \fBconst\fP int numarg, \fBconst\fP char * strings[])"
Set field to contain \fInum\fP \fIstrings\fP from index \fIstart\fP, replacing any strings already present at the given indices\&. 
.SS "\fBvoid\fP SoMFString::setValue (\fBconst\fP char * str)"
Set field to contain a single string, from \fIstr\fP\&. 
.SS "\fBvoid\fP SoMFString::deleteText (\fBconst\fP int fromline, \fBconst\fP int fromchar, \fBconst\fP int toline, \fBconst\fP 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\&.