PStringList Class Reference

#include <pstring.h>

List of all members.

Operations
PINDEX	AppendString (const PString &str)
PINDEX	InsertString (const PString &before, const PString &str)
PINDEX	GetStringsIndex (const PString &str) const
PStringList &	operator+= (const PStringList &list)
PStringList &	operator+= (const PString &str)
PStringList	operator+ (const PStringList &array)
PStringList	operator+ (const PString &str)
template<typename stlContainer>
static PStringList	container (const stlContainer &vec)
Public Member Functions
Overrides from class PObject
virtual void	ReadFrom (istream &strm)

---

Detailed Description

This is a list collection class of PString# objects. It has all the usual functions for a collection, with the object types set to PString# pointers.

In addition some addition functions are added that take a const PString# reference instead of a pointer as most standard collection functions do. This is more convenient for when string expressions are used as parameters to function in the collection.

See the PAbstractList# and PList# classes and PDECLARE_LIST# macro for more information.

---

Constructor & Destructor Documentation

PStringList::PStringList	(	PINDEX	count,
		char const *const *	strarr,
		BOOL	caseless = FALSE
	)

Create a PStringList from the array of C strings.

Parameters:

count	Count of strings in array
strarr	Array of C strings
caseless	New strings are to be PCaselessStrings

PStringList::PStringList

(

const PString &

str

)

Create a PStringList of length one from the single string.

Parameters:

str	Single string to convert to a list of one.

PStringList::PStringList

(

const PStringArray &

array

)

Create a PStringList from the array of strings.

Parameters:

array

Array of strings to convert to list

PStringList::PStringList

(

const PSortedStringList &

list

)

Create a PStringList from the sorted list of strings.

Parameters:

list	List of strings to convert to list.

PStringList::PStringList	(	PINDEX	count,
		char const *const *	strarr,
		BOOL	caseless = FALSE
	)

Create a PStringList from the array of C strings.

Parameters:

count	Count of strings in array
strarr	Array of C strings
caseless	New strings are to be PCaselessStrings

PStringList::PStringList

(

const PString &

str

)

Create a PStringList of length one from the single string.

Parameters:

str	Single string to convert to a list of one.

PStringList::PStringList

(

const PStringArray &

array

)

Create a PStringList from the array of strings.

Parameters:

array

Array of strings to convert to list

PStringList::PStringList

(

const PSortedStringList &

list

)

Create a PStringList from the sorted list of strings.

Parameters:

list	List of strings to convert to list.

---

Member Function Documentation

virtual void PStringList::ReadFrom

(

istream &

strm

)

[virtual]

Input the contents of the object from the stream. This is primarily used by the standard operator>># function.

The default behaviour reads '
' separated strings until !strm.good().

PINLINE PINDEX PStringList::AppendString

(

const PString &

str

)

Append a string to the list.

Parameters:

str	String to append.

PINLINE PINDEX PStringList::InsertString	(	const PString &	before,
		const PString &	str
	)

Insert a string into the list.

Parameters:

before	String to insert before.
str	String to insert.

PINLINE PINDEX PStringList::GetStringsIndex

(

const PString &

str

)

const

Get the index of the string with the specified value. A linear search of list is performed to find the string value.

Parameters:

str	String value to search for.

PStringList& PStringList::operator+=

(

const PStringList &

list

)

Concatenate a PString or PStringArray to the list

Returns:

The PStringArray with the new items appended

PINLINE PStringList & PStringList::operator+=

(

const PString &

str

)

PINLINE PStringList PStringList::operator+

(

const PStringList &

array

)

Create a new PStringList, and add PString or PStringList to it a new PStringList

Returns:

A new PStringList with the additional elements(s)

PINLINE PStringList PStringList::operator+

(

const PString &

str

)

template<typename stlContainer>

static PStringList PStringList::container

(

const stlContainer &

vec

)

[inline, static]

Create a PStringArray from an STL container

---

The documentation for this class was generated from the following files:

• pstring.h
• contain.inl

---