---

skStringBuffer Class Reference

This class provides an expandable buffer for textual characters. More...

#include <skStringBuffer.h>

List of all members.

Public Member Functions
	skStringBuffer (USize capacity, USize growth_increment=16)
	Constructs a blank buffer of the given capacity.
	skStringBuffer (const skString &s, USize growth_increment=16)
	Constructs a buffer from the given string.
	skStringBuffer (const skStringBuffer &s)
	Copy constructor - it takes a copy of the underlying buffer.
virtual	~skStringBuffer ()
	Destroys the underlying character buffer.
skStringBuffer &	operator= (const skStringBuffer &s)
	Assignment operator - it takes a copy of the underlying buffer.
void	append (Char ch)
	Adds a character to the buffer, growing it if necessary.
void	append (const skString &s)
	Adds a string to the buffer, growing it if necessary.
void	append (const Char *s)
	Adds a string to the buffer, growing it if necessary.
skString	toString ()
	Creates a new string that owns the underlying buffer.
skString	toStringCopy () const
	Creates a new string that copies the underlying buffer.
	operator const Char * () const
	Returns the underlying buffer.
void	reset ()
	Resets the length of the buffer to zero.
USize	length () const
	Returns the current length of the text in the buffer.
USize	capacity () const
	Returns the current capacity the buffer.

---

Detailed Description

This class provides an expandable buffer for textual characters.

---

Constructor & Destructor Documentation

skStringBuffer::skStringBuffer (  USize  capacity, USize  growth_increment = 16 )  [inline]

Constructs a blank buffer of the given capacity. The buffer's length will be zero. Parameters: capacity  - the capacity of the buffer to create. This can be zero growth_increment  - the minimum amount to grow the buffer by if it is enlarged

skStringBuffer::skStringBuffer (  const skString &  s, USize  growth_increment = 16 )

Constructs a buffer from the given string. The string's data will be copied. The buffer's initial capacity and length will be the length of the string. Remarks: not available in Symbian version Parameters: s  - the string to copy growth_increment  - the minimum amount to grow the buffer by if it is enlarged

skStringBuffer::skStringBuffer (  const skStringBuffer &  s  )

Copy constructor - it takes a copy of the underlying buffer. Remarks: not available in Symbian version Parameters: s  - the other string buffer. A copy is taken of its underlying buffer

---

Member Function Documentation

void skStringBuffer::append (  const Char *  s  )

Adds a string to the buffer, growing it if necessary. Parameters: s  - the string to append to the end of the current buffer Exceptions: Symbian  - a leaving function

void skStringBuffer::append (  const skString &  s  )

Adds a string to the buffer, growing it if necessary. Parameters: s  - the string to append to the end of the current buffer Exceptions: Symbian  - a leaving function

void skStringBuffer::append (  Char  ch  )

Adds a character to the buffer, growing it if necessary. Parameters: ch  - the character to add Exceptions: Symbian  - a leaving function

USize skStringBuffer::capacity (   )  const [inline]

Returns the current capacity the buffer. Returns: the capacity of the buffer

USize skStringBuffer::length (   )  const [inline]

Returns the current length of the text in the buffer. Returns: the length of the text in the buffer

skStringBuffer::operator const Char * (   )  const

Returns the underlying buffer. Remarks: not available in Symbian version Returns: a pointer to the underlying buffer

skStringBuffer & skStringBuffer::operator= (  const skStringBuffer &  s  )

Assignment operator - it takes a copy of the underlying buffer. Parameters: s  - the other string buffer. A copy is taken of its underlying buffer Exceptions: Symbian  - a leaving function

skString skStringBuffer::toString (   )

Creates a new string that owns the underlying buffer. The current buffer is set to null. Returns: a string which owns the current buffer Exceptions: Symbian  - a leaving function

skString skStringBuffer::toStringCopy (   )  const

Creates a new string that copies the underlying buffer. The current buffer remains the same Returns: a string which copies the current buffer Exceptions: Symbian  - a leaving function

---

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

• skStringBuffer.h
• skStringBuffer.cpp

---