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

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <Inventor/lists/SbStringList\&.h>\fP
.PP
Inherits \fBSbPList\fP\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBSbStringList\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBSbStringList\fP (\fBconst\fP int \fBsizehint\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBappend\fP (\fBSbString\fP *string)"
.br
.ti -1c
.RI "int \fBfind\fP (\fBSbString\fP *string) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBinsert\fP (\fBSbString\fP *string, int \fBinsertbefore\fP)"
.br
.ti -1c
.RI "\fBSbString\fP *& \fBoperator[]\fP (\fBconst\fP int idx) \fBconst\fP"
.br
.ti -1c
.RI "\fBconst\fP \fBSbString\fP ** \fBgetArrayPtr\fP (\fBvoid\fP) \fBconst\fP"
.br
.in -1c

Public Member Functions inherited from \fBSbPList\fP
.in +1c
.ti -1c
.RI "\fBSbPList\fP (\fBconst\fP int \fBsizehint\fP=DEFAULTSIZE)"
.br
.ti -1c
.RI "\fBSbPList\fP (\fBconst\fP \fBSbPList\fP &\fBl\fP)"
.br
.ti -1c
.RI "\fB~SbPList\fP ()"
.br
.ti -1c
.RI "\fBvoid\fP \fBcopy\fP (\fBconst\fP \fBSbPList\fP &\fBl\fP)"
.br
.ti -1c
.RI "\fBSbPList\fP & \fBoperator=\fP (\fBconst\fP \fBSbPList\fP &\fBl\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBfit\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBappend\fP (\fBvoid\fP *\fBitem\fP)"
.br
.ti -1c
.RI "int \fBfind\fP (\fBconst\fP \fBvoid\fP *\fBitem\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBinsert\fP (\fBvoid\fP *\fBitem\fP, \fBconst\fP int \fBinsertbefore\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBremoveItem\fP (\fBvoid\fP *\fBitem\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBremove\fP (\fBconst\fP int index)"
.br
.ti -1c
.RI "\fBvoid\fP \fBremoveFast\fP (\fBconst\fP int index)"
.br
.ti -1c
.RI "int \fBgetLength\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBtruncate\fP (\fBconst\fP int length, \fBconst\fP int \fBfit\fP=0)"
.br
.ti -1c
.RI "\fBvoid\fP ** \fBgetArrayPtr\fP (\fBconst\fP int start=0) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP *& \fBoperator[]\fP (\fBconst\fP int index) \fBconst\fP"
.br
.ti -1c
.RI "int \fBoperator==\fP (\fBconst\fP \fBSbPList\fP &\fBl\fP) \fBconst\fP"
.br
.ti -1c
.RI "int \fBoperator!=\fP (\fBconst\fP \fBSbPList\fP &\fBl\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP * \fBget\fP (\fBconst\fP int index) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBset\fP (\fBconst\fP int index, \fBvoid\fP *\fBitem\fP)"
.br
.in -1c
.SS "Additional Inherited Members"


Protected Member Functions inherited from \fBSbPList\fP
.in +1c
.ti -1c
.RI "\fBvoid\fP \fBexpand\fP (\fBconst\fP int size)"
.br
.ti -1c
.RI "int \fBgetArraySize\fP (\fBvoid\fP) \fBconst\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
The \fBSbStringList\fP class is a container for pointers to \fBSbString\fP objects\&. 

Note that upon using the equality and inequality operators, the strings themselves are not compared, only the pointer values\&. 
.br
.PP
This class does not allocate or deallocate strings\&. It's the callers responsibility to allocate/deallocate the \fBSbString\fP instances\&.
.PP
\fBSee also\fP
.RS 4
\fBSbPList\fP 
.RE
.PP

.SH "Constructor & Destructor Documentation"
.PP 
.SS "SbStringList::SbStringList (\fBvoid\fP)\fC [inline]\fP"
Default constructor\&. 
.SS "SbStringList::SbStringList (\fBconst\fP int sizehint)\fC [inline]\fP"
This constructor initializes the internal allocated size for the list to \fIsizehint\fP\&. Note that the list will still initially contain zero items\&.
.PP
\fBSee also\fP
.RS 4
\fBSPbList::SbList(const int sizehint)\fP 
.RE
.PP

.SH "Member Function Documentation"
.PP 
.SS "\fBvoid\fP SbStringList::append (\fBSbString\fP * string)\fC [inline]\fP"
Append \fIitem\fP to the end of the list\&.
.PP
Automatically allocates more items internally if needed\&.  
.PP
Overloaded from parent to accept an \fBSbString\fP pointer argument\&.
.PP
\fBSee also\fP
.RS 4
\fBSbPList::append()\fP 
.RE
.PP

.SS "int SbStringList::find (\fBSbString\fP * string) const\fC [inline]\fP"
Return index of first occurrence of \fIitem\fP in the list, or -1 if \fIitem\fP is not present\&.  
.PP
Overloaded from parent to accept an \fBSbString\fP pointer argument\&.
.PP
\fBSee also\fP
.RS 4
\fBSbPList::find()\fP 
.RE
.PP

.SS "\fBvoid\fP SbStringList::insert (\fBSbString\fP * string, int insertbefore)\fC [inline]\fP"
Insert \fIitem\fP at index \fIinsertbefore\fP\&.
.PP
\fIinsertbefore\fP should not be larger than the current number of items in the list\&.  
.PP
Overloaded from parent to accept an \fBSbString\fP pointer argument\&.
.PP
\fBSee also\fP
.RS 4
\fBSbPList::insert()\fP 
.RE
.PP

.SS "\fBSbString\fP *& SbStringList::operator[] (\fBconst\fP int idx) const\fC [inline]\fP"
Returns element at \fIindex\fP\&.
.PP
Will automatically expand the size of the internal array if \fIindex\fP is outside the current bounds of the list\&. The values of any additional pointers are then set to \fCNULL\fP\&.  
.PP
Overloaded from parent to return an \fBSbString\fP pointer\&.
.PP
\fBSee also\fP
.RS 4
\fBSbPList::operator[]()\fP 
.RE
.PP

.SS "\fBconst\fP \fBSbString\fP ** SbStringList::getArrayPtr (\fBvoid\fP) const\fC [inline]\fP"
Returns pointer to a non-modifiable array of the lists elements\&. \fIstart\fP specifies an index into the array\&.
.PP
The caller is \fInot\fP responsible for freeing up the array, as it is just a pointer into the internal array used by the list\&.  
.PP
Overloaded from parent to return an \fBSbString\fP pointer array\&.
.PP
\fBSee also\fP
.RS 4
\fBSbPList::getArrayPtr()\fP 
.RE
.PP


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