KStringListTemplate Class Template Reference

#include <kstringlist.h>

List of all members.

Detailed Description

template<class Type>
class KStringListTemplate< Type >

Definition at line 81 of file kstringlist.h.


Public Member Functions
Operation With The Array
int  AddItem (Type *pItem)
  Append a item at the end of the array.
int  InsertItemAt (int pIndex, Type *pItem)
  Insert a item in the array.
Type *  GetItemAt (int pIndex) const
  Access item at given index.
int  FindItem (Type *pItem) const
  Find first matching item.
Constructor and Destructor
  KStringListTemplate ()
  Default constructor.
virtual  ~KStringListTemplate ()
  Destructor.
void  RemoveLast ()
  Remove the item at the end of the array and delete the associated object.
int  GetCount () const
  Get number of items in the array.
KString &  operator[] (int pIndex)
  Access the string in the item at given index.
kReference  GetReferenceAt (int pIndex) const
  Access the value of reference in the item at given index.
void  SetReferenceAt (int pIndex, kReference pRef)
  Set the value of reference at given index.
char *  GetStringAt (int pIndex) const
  Access the pointer of string at given index.
virtual bool  SetStringAt (int pIndex, const char *pString)
  Set string at given index.
int  Find (Type &pItem) const
  Find first matching item.
int  FindIndex (kReference pReference) const
  Find first matching item which has the same reference as given parameter.
int  FindIndex (const char *pString) const
  Find first matching item in array whose string address is the same as given pointer.
kReference  FindReference (const char *pString) const
  Access the value of reference of the first matching item in array whose string address is the same as given pointer.
bool  Remove (Type &pItem)
  Remove first matching item.
bool  Remove (const char *pString)
  Remove first matching item in array whose string address is the same as given pointer.
bool  RemoveIt (Type &pItem)
  Remove first matching item.
void  Sort ()
  Sort the array by the string of every item,not case sensitive.
void *  FindEqual (const char *pString) const
  Find first matching item which has the same string as given parameter,not case sensitive.
void *  FindCaseSensitive (const char *pString) const
  Find first matching item which has the same string as given parameter, case sensitive.
int  Add (const char *pString, kReference pItem=0)
  Add a new item at the end of array.
virtual int  InsertAt (int pIndex, const char *pString, kReference pItem=0)
  Default constructor.
virtual void  RemoveAt (int pIndex)
  Remove the item at the given position in the array and delete the associated object.
virtual void  Clear ()
  Delete the array.
virtual void  GetText (KString &pText) const
  Get the string of all the item.
virtual int  SetText (const char *pList)
  Clear the array and set the array's new items with the substring separated by '~' from the given string.

Protected Attributes
KArrayTemplate< Type * >  mList

Constructor & Destructor Documentation

KStringListTemplate (  )  [inline]

Default constructor.

Definition at line 120 of file kstringlist.h.

virtual ~KStringListTemplate (  )  [inline, virtual]

Destructor.

Definition at line 125 of file kstringlist.h.

Member Function Documentation

int AddItem ( Type *  pItem  )  [inline]

Append a item at the end of the array.

Returns:
Index of appended pointer.

Definition at line 94 of file kstringlist.h.

int InsertItemAt ( int  pIndex,
Type *  pItem  
) [inline]

Insert a item in the array.

Parameters:
pIndex  Position where to insert the item.
pItem  Item to insert.
Returns:
Position of the inserted item in the array.
Remarks:
If the given index is out of range, the pointer is appended at the end of the array.

Definition at line 102 of file kstringlist.h.

Type* GetItemAt ( int  pIndex  )  const [inline]

Access item at given index.

Definition at line 105 of file kstringlist.h.

int FindItem ( Type *  pItem  )  const [inline]

Find first matching item.

Returns:
Index of first matching item found or -1 if there is no matching element.

Definition at line 110 of file kstringlist.h.

void RemoveLast (  )  [inline]

Remove the item at the end of the array and delete the associated object.

Definition at line 129 of file kstringlist.h.

int GetCount (  )  const [inline]

Get number of items in the array.

Returns:
The number of items in the array.

Definition at line 134 of file kstringlist.h.

KString& operator[] ( int  pIndex  )  [inline]

Access the string in the item at given index.

Definition at line 137 of file kstringlist.h.

kReference GetReferenceAt ( int  pIndex  )  const [inline]

Access the value of reference in the item at given index.

Definition at line 140 of file kstringlist.h.

void SetReferenceAt ( int  pIndex,
kReference  pRef  
) [inline]

Set the value of reference at given index.

Definition at line 143 of file kstringlist.h.

char* GetStringAt ( int  pIndex  )  const [inline]

Access the pointer of string at given index.

Definition at line 146 of file kstringlist.h.

virtual bool SetStringAt ( int  pIndex,
const char *  pString  
) [inline, virtual]

Set string at given index.

Definition at line 149 of file kstringlist.h.

int Find ( Type &  pItem  )  const [inline]

Find first matching item.

Returns:
Index of first matching item found or -1 if there is no matching element.

Definition at line 162 of file kstringlist.h.

Referenced by KStringListTemplate< KStringListItem >::Remove(), and KStringListTemplate< KStringListItem >::RemoveIt().

int FindIndex ( kReference  pReference  )  const [inline]

Find first matching item which has the same reference as given parameter.

Returns:
Index of first matching item found or -1 if there is no matching element.

Definition at line 176 of file kstringlist.h.

Referenced by KStringListTemplate< KStringListItem >::FindReference(), and KStringListTemplate< KStringListItem >::Remove().

int FindIndex ( const char *  pString  )  const [inline]

Find first matching item in array whose string address is the same as given pointer.

Returns:
Index of first matching item found or -1 if there is no matching element.

Definition at line 190 of file kstringlist.h.

kReference FindReference ( const char *  pString  )  const [inline]

Access the value of reference of the first matching item in array whose string address is the same as given pointer.

Returns:
The value of reference of the first matching item found or NULL if there is no matching element.

Definition at line 205 of file kstringlist.h.

bool Remove ( Type &  pItem  )  [inline]

Remove first matching item.

Definition at line 215 of file kstringlist.h.

bool Remove ( const char *  pString  )  [inline]

Remove first matching item in array whose string address is the same as given pointer.

Definition at line 226 of file kstringlist.h.

bool RemoveIt ( Type &  pItem  )  [inline]

Remove first matching item.

Definition at line 237 of file kstringlist.h.

void Sort (  )  [inline]

Sort the array by the string of every item,not case sensitive.

Definition at line 248 of file kstringlist.h.

void* FindEqual ( const char *  pString  )  const [inline]

Find first matching item which has the same string as given parameter,not case sensitive.

Returns:
the pointer of matching item found or NULL if there is no matching element.

Definition at line 257 of file kstringlist.h.

void* FindCaseSensitive ( const char *  pString  )  const [inline]

Find first matching item which has the same string as given parameter, case sensitive.

Returns:
the pointer of matching item found or NULL if there is no matching element.

Definition at line 275 of file kstringlist.h.

int Add ( const char *  pString,
kReference  pItem = 0  
) [inline]

Add a new item at the end of array.

Definition at line 292 of file kstringlist.h.

Referenced by KStringListTemplate< KStringListItem >::SetText().

virtual int InsertAt ( int  pIndex,
const char *  pString,
kReference  pItem = 0  
) [inline, virtual]

Default constructor.

Definition at line 297 of file kstringlist.h.

Referenced by KStringListTemplate< KStringListItem >::Add().

virtual void RemoveAt ( int  pIndex  )  [inline, virtual]

Remove the item at the given position in the array and delete the associated object.

Parameters:
pIndex  Position of the item to remove.
Remarks:
If the index is not valid, nothing is performed. Otherwise, the item is removed from the array and the items are shifted to fill the empty slot.

Definition at line 308 of file kstringlist.h.

Referenced by KStringListTemplate< KStringListItem >::Remove(), KStringListTemplate< KStringListItem >::RemoveIt(), and KStringListTemplate< KStringListItem >::RemoveLast().

virtual void Clear (  )  [inline, virtual]

Delete the array.

Definition at line 314 of file kstringlist.h.

Referenced by KStringListTemplate< KStringListItem >::SetText(), and KStringListTemplate< KStringListItem >::~KStringListTemplate().

virtual void GetText ( KString &  pText  )  const [inline, virtual]

Get the string of all the item.

Returns:
The text of string, each item's string separated by '~'.

Definition at line 325 of file kstringlist.h.

virtual int SetText ( const char *  pList  )  [inline, virtual]

Clear the array and set the array's new items with the substring separated by '~' from the given string.

Parameters:
pList  The string which used to generate the new items.
Returns:
The last index of the item in the new array.
Remarks:
The number of items in the new array is the same as the number of substrings, and the string of each item is decided by the content of each substring.

Definition at line 346 of file kstringlist.h.

Member Data Documentation

KArrayTemplate<Type *> mList [protected]

Definition at line 83 of file kstringlist.h.

Referenced by KStringListTemplate< KStringListItem >::Add(), KStringListTemplate< KStringListItem >::AddItem(), KStringListTemplate< KStringListItem >::Clear(), KStringListTemplate< KStringListItem >::Find(), KStringListTemplate< KStringListItem >::FindCaseSensitive(), KStringListTemplate< KStringListItem >::FindEqual(), KStringListTemplate< KStringListItem >::FindIndex(), KStringListTemplate< KStringListItem >::FindItem(), KStringListTemplate< KStringListItem >::FindReference(), KStringListTemplate< KStringListItem >::GetCount(), KStringListTemplate< KStringListItem >::GetItemAt(), KStringListTemplate< KStringListItem >::GetReferenceAt(), KStringListTemplate< KStringListItem >::GetStringAt(), KStringListTemplate< KStringListItem >::GetText(), KStringListTemplate< KStringListItem >::InsertAt(), KStringListTemplate< KStringListItem >::InsertItemAt(), KStringListTemplate< KStringListItem >::operator[](), KStringListTemplate< KStringListItem >::RemoveAt(), KStringListTemplate< KStringListItem >::RemoveLast(), KStringListTemplate< KStringListItem >::SetReferenceAt(), KStringListTemplate< KStringListItem >::SetStringAt(), and KStringListTemplate< KStringListItem >::Sort().