CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

scfStringArray Class Reference

This class is a thin wrapper around csStringArray with SCF capability. More...

#include <scfstringarray.h>

Inheritance diagram for scfStringArray:

iStringArray iBase List of all members.

Public Methods

 scfStringArray (int iLimit=16, int iDelta=16)
 Create a iStringArray from scratch. More...

virtual ~scfStringArray ()
 Destructor - nothing to do. More...

virtual int Length () const
 Query array length. More...

virtual void Push (char const *value)
 Push a string onto the stack. More...

virtual char * Pop ()
 Pop a string from the top of stack. More...

virtual char const * Get (int n) const
 Get Nth string in vector. More...

virtual int Find (const char *value) const
 Find index of given string, case sensitive. More...

virtual int FindCaseInsensitive (const char *value) const
 Find index of given string, case insensitive. More...

virtual int FindSortedKey (const char *value) const
 Find index of a string in a pre-sorted string array. More...

virtual void Sort ()
 Sort the string array. More...

virtual bool DeleteIndex (int n)
 Delete Nth string in the array. More...

virtual bool Insert (int n, char const *value)
 Insert a string before Nth string in the array. More...

virtual void DeleteAll ()
 Delete all strings in array. More...


Detailed Description

This class is a thin wrapper around csStringArray with SCF capability.

Definition at line 27 of file scfstringarray.h.


Constructor & Destructor Documentation

scfStringArray::scfStringArray int    iLimit = 16,
int    iDelta = 16
[inline]
 

Create a iStringArray from scratch.

Definition at line 35 of file scfstringarray.h.

References SCF_CONSTRUCT_IBASE.

virtual scfStringArray::~scfStringArray   [inline, virtual]
 

Destructor - nothing to do.

Definition at line 39 of file scfstringarray.h.


Member Function Documentation

virtual void scfStringArray::DeleteAll   [inline, virtual]
 

Delete all strings in array.

Implements iStringArray.

Definition at line 103 of file scfstringarray.h.

References csArray< const char *, csStringArrayElementHandler >::DeleteAll.

virtual bool scfStringArray::DeleteIndex int    n [inline, virtual]
 

Delete Nth string in the array.

Implements iStringArray.

Definition at line 91 of file scfstringarray.h.

References csArray< const char *, csStringArrayElementHandler >::DeleteIndex.

virtual int scfStringArray::Find const char *    value const [inline, virtual]
 

Find index of given string, case sensitive.

Implements iStringArray.

Definition at line 67 of file scfstringarray.h.

References csStringArray::Find.

virtual int scfStringArray::FindCaseInsensitive const char *    value const [inline, virtual]
 

Find index of given string, case insensitive.

Implements iStringArray.

Definition at line 73 of file scfstringarray.h.

References csStringArray::FindCaseInsensitive.

virtual int scfStringArray::FindSortedKey const char *    value const [inline, virtual]
 

Find index of a string in a pre-sorted string array.

Implements iStringArray.

Definition at line 79 of file scfstringarray.h.

References csStringArray::FindSortedKey.

virtual char const* scfStringArray::Get int    n const [inline, virtual]
 

Get Nth string in vector.

Implements iStringArray.

Definition at line 61 of file scfstringarray.h.

References csArray< const char *, csStringArrayElementHandler >::Get.

virtual bool scfStringArray::Insert int    n,
char const *    value
[inline, virtual]
 

Insert a string before Nth string in the array.

Implements iStringArray.

Definition at line 97 of file scfstringarray.h.

References csArray< const char *, csStringArrayElementHandler >::Insert.

virtual int scfStringArray::Length   const [inline, virtual]
 

Query array length.

Implements iStringArray.

Definition at line 43 of file scfstringarray.h.

References csArray< const char *, csStringArrayElementHandler >::Length.

virtual char* scfStringArray::Pop   [inline, virtual]
 

Pop a string from the top of stack.

Implements iStringArray.

Definition at line 55 of file scfstringarray.h.

References csStringArray::Pop.

virtual void scfStringArray::Push char const *    value [inline, virtual]
 

Push a string onto the stack.

Definition at line 49 of file scfstringarray.h.

References csArray< const char *, csStringArrayElementHandler >::Push.

virtual void scfStringArray::Sort   [inline, virtual]
 

Sort the string array.

Implements iStringArray.

Definition at line 85 of file scfstringarray.h.

References csStringArray::Sort.


The documentation for this class was generated from the following file:
Generated for Crystal Space by doxygen 1.2.14