.TH "SoMFString" 3 "Thu May 29 2014" "Version 4.0.0a" "Coin" \" -*- nroff -*-
.ad l
.nh
.SH NAME
SoMFString \- 
.PP
The \fBSoMFString\fP class is a container for \fBSbString\fP values\&.
.PP
This field is used where nodes, engines or other field containers needs to store arrays of strings\&.  

.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 "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
.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
.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
.SS "Protected Attributes"

.in +1c
.ti -1c
.RI "\fBSbString\fP * \fBvalues\fP"
.br
.in -1c
.SS "Additional Inherited Members"
.SH "Detailed Description"
.PP 
The \fBSoMFString\fP class is a container for \fBSbString\fP values\&.
.PP
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 "\fBSoType\fP SoMFString::getTypeId (void) const\fC [virtual]\fP"
Returns the type identification instance which uniquely identifies the Coin field class the object belongs to\&.
.PP
\fBSee also:\fP
.RS 4
getClassTypeId(), \fBSoType\fP 
.RE
.PP

.PP
Implements \fBSoField\fP\&.
.SS "void SoMFString::copyFrom (const \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 (const \fBSoField\fP &f) const\fC [virtual]\fP"
Check for equal type and value(s)\&. 
.PP
Implements \fBSoField\fP\&.
.SS "void SoMFString::deleteAllValues (void)\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 
.PP
Implements \fBSoMField\fP\&.
.SS "void SoMFString::copyValue (intto, intfrom)\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 contructors where necessary\&. 
.PP
Implements \fBSoMField\fP\&.
.SS "const \fBSbString\fP* SoMFString::getValues (const intstart) const\fC [inline]\fP"
\\ Returns a pointer to the values array\&. \\ 
.SS "void SoMFString::setValues (const intstart, const intnumarg, 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 intfromline, const intfromchar, const inttoline, const inttochar)"
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\&.