STOFFStringStream Class Referencefinal

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

#include <STOFFStringStream.hxx>

Inheritance diagram for STOFFStringStream:

Public Member Functions

 STOFFStringStream (const unsigned char *data, const unsigned int dataSize)
 constructor
 
 ~STOFFStringStream () final
 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) final
 ! reads numbytes data.
 
long tell () final
 returns actual offset position
 
int seek (long offset, librevenge::RVNG_SEEK_TYPE seekType) final
 seeks to a offset position, from actual, beginning or ending position
 
bool isEnd () final
 returns true if we are at the end of the section/file
 
bool isStructured () final
 returns true if the stream is ole
 
unsigned subStreamCount () final
 returns the number of sub streams.
 
const char * subStreamName (unsigned) final
 returns the ith sub streams name
 
bool existsSubStream (const char *name) final
 returns true if a substream with name exists
 
librevenge::RVNGInputStream * getSubStreamByName (const char *name) final
 return a new stream for a ole zone
 
librevenge::RVNGInputStream * getSubStreamById (unsigned) final
 return a new stream for a ole zone
 

Private Member Functions

 STOFFStringStream (const STOFFStringStream &)
 
STOFFStringStreamoperator= (const STOFFStringStream &)
 

Private Attributes

std::unique_ptr< STOFFStringStreamPrivatem_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() [1/2]

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

constructor

◆ ~STOFFStringStream()

STOFFStringStream::~STOFFStringStream ( )
final

destructor

◆ STOFFStringStream() [2/2]

STOFFStringStream::STOFFStringStream ( const STOFFStringStream & )
private

Member Function Documentation

◆ append()

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

append some data at the end of the string

◆ existsSubStream()

bool STOFFStringStream::existsSubStream ( const char * name)
final

returns true if a substream with name exists

See also
returns always false

◆ getSubStreamById()

librevenge::RVNGInputStream * STOFFStringStream::getSubStreamById ( unsigned )
final

return a new stream for a ole zone

See also
returns always 0

◆ getSubStreamByName()

librevenge::RVNGInputStream * STOFFStringStream::getSubStreamByName ( const char * name)
final

return a new stream for a ole zone

See also
returns always 0

◆ isEnd()

bool STOFFStringStream::isEnd ( )
final

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

◆ isStructured()

bool STOFFStringStream::isStructured ( )
final

returns true if the stream is ole

See also
returns always false

◆ operator=()

STOFFStringStream & STOFFStringStream::operator= ( const STOFFStringStream & )
private

◆ read()

const unsigned char * STOFFStringStream::read ( unsigned long numBytes,
unsigned long & numBytesRead )
final

! reads numbytes data.

Returns
a pointer to the read elements

◆ seek()

int STOFFStringStream::seek ( long offset,
librevenge::RVNG_SEEK_TYPE seekType )
final

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

Returns
0 if ok

◆ subStreamCount()

unsigned STOFFStringStream::subStreamCount ( )
final

returns the number of sub streams.

See also
returns always 0

◆ subStreamName()

const char * STOFFStringStream::subStreamName ( unsigned )
final

returns the ith sub streams name

See also
returns always 0

◆ tell()

long STOFFStringStream::tell ( )
final

returns actual offset position

Member Data Documentation

◆ m_data

std::unique_ptr<STOFFStringStreamPrivate> STOFFStringStream::m_data
private

the string stream data

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


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

Generated on Mon Apr 22 2024 12:48:55 for libstaroffice by doxygen 1.10.0