Public Member Functions | Private Member Functions | Private Attributes
STOFFStringStream Class Reference

internal class used to create a RVNGInputStream from a unsigned char's pointer More...

#include <STOFFStringStream.hxx>

List of all members.

Public Member Functions

 STOFFStringStream (const unsigned char *data, const unsigned int dataSize)
 constructor
 ~STOFFStringStream ()
 destructor
void append (const unsigned char *data, const unsigned int dataSize)
 append some data at the end of the string
const unsigned char * read (unsigned long numBytes, unsigned long &numBytesRead)
 ! reads numbytes data.
long tell ()
 returns actual offset position
int seek (long offset, librevenge::RVNG_SEEK_TYPE seekType)
 seeks to a offset position, from actual, beginning or ending position
bool isEnd ()
 returns true if we are at the end of the section/file
bool isStructured ()
 returns true if the stream is ole
unsigned subStreamCount ()
 returns the number of sub streams.
const char * subStreamName (unsigned)
 returns the ith sub streams name
bool existsSubStream (const char *name)
 returns true if a substream with name exists
librevenge::RVNGInputStream * getSubStreamByName (const char *name)
 return a new stream for a ole zone
librevenge::RVNGInputStream * getSubStreamById (unsigned)
 return a new stream for a ole zone

Private Member Functions

 STOFFStringStream (const STOFFStringStream &)
STOFFStringStream & operator= (const STOFFStringStream &)

Private Attributes

STOFFStringStreamPrivate * m_data
 the string stream data

Detailed Description

internal class used to create a RVNGInputStream from a unsigned char's pointer

Note:
this class (highly inspired from librevenge) does not implement the isStructured's protocol, ie. it only returns false.

Constructor & Destructor Documentation

STOFFStringStream::STOFFStringStream ( const unsigned char *  data,
const unsigned int  dataSize 
)

constructor

STOFFStringStream::~STOFFStringStream ( )

destructor

STOFFStringStream::STOFFStringStream ( const STOFFStringStream &  ) [private]

Member Function Documentation

void STOFFStringStream::append ( const unsigned char *  data,
const unsigned int  dataSize 
)

append some data at the end of the string

bool STOFFStringStream::existsSubStream ( const char *  name)

returns true if a substream with name exists

See also:
returns always false
librevenge::RVNGInputStream * STOFFStringStream::getSubStreamById ( unsigned  )

return a new stream for a ole zone

See also:
returns always 0
librevenge::RVNGInputStream * STOFFStringStream::getSubStreamByName ( const char *  name)

return a new stream for a ole zone

See also:
returns always 0
bool STOFFStringStream::isEnd ( )

returns true if we are at the end of the section/file

bool STOFFStringStream::isStructured ( )

returns true if the stream is ole

See also:
returns always false
STOFFStringStream& STOFFStringStream::operator= ( const STOFFStringStream &  ) [private]
const unsigned char * STOFFStringStream::read ( unsigned long  numBytes,
unsigned long &  numBytesRead 
)

! reads numbytes data.

Returns:
a pointer to the read elements
int STOFFStringStream::seek ( long  offset,
librevenge::RVNG_SEEK_TYPE  seekType 
)

seeks to a offset position, from actual, beginning or ending position

Returns:
0 if ok
unsigned STOFFStringStream::subStreamCount ( )

returns the number of sub streams.

See also:
returns always 0
const char * STOFFStringStream::subStreamName ( unsigned  )

returns the ith sub streams name

See also:
returns always 0
long STOFFStringStream::tell ( )

returns actual offset position

Member Data Documentation

STOFFStringStreamPrivate* STOFFStringStream::m_data [private]

the string stream data

Referenced by append(), isEnd(), read(), seek(), tell(), and ~STOFFStringStream().

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