WPSStringStream Class Reference documentation

Public Member Functions | Private Member Functions | Private Attributes | List of all members
WPSStringStream Class Referencefinal

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

`#include <WPSStringStream.h>`

Inheritance diagram for WPSStringStream:

## Public Member Functions
| WPSStringStream (const unsigned char *data, const unsigned int dataSize)
| constructor
| ~WPSStringStream () 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
| WPSStringStream (const WPSStringStream &)=delete
WPSStringStream & | operator= (const WPSStringStream &)=delete

## Private Attributes
std::unique_ptr< WPSStringStreamPrivate > | 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

## ◆ WPSStringStream() [1/2]

WPSStringStream::WPSStringStream | ( | const unsigned char * | data,
|  | const unsigned int | dataSize )

constructor

## ◆ ~WPSStringStream()

WPSStringStream::~WPSStringStream | ( |  | ) |
| final

destructor

## ◆ WPSStringStream() [2/2]

WPSStringStream::WPSStringStream | ( | const WPSStringStream & |  | ) |
| privatedelete

## Member Function Documentation

## ◆ append()

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

append some data at the end of the string

## ◆ existsSubStream()

bool WPSStringStream::existsSubStream | ( | const char * | name | ) |
| final

returns true if a substream with name exists

See also
  returns always false

## ◆ getSubStreamById()

librevenge::RVNGInputStream * WPSStringStream::getSubStreamById | ( | unsigned |  | ) |
| final

return a new stream for a ole zone

See also
  returns always 0

## ◆ getSubStreamByName()

librevenge::RVNGInputStream * WPSStringStream::getSubStreamByName | ( | const char * | name | ) |
| final

return a new stream for a ole zone

See also
  returns always 0

## ◆ isEnd()

bool WPSStringStream::isEnd | ( |  | ) |
| final

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

## ◆ isStructured()

bool WPSStringStream::isStructured | ( |  | ) |
| final

returns true if the stream is ole

See also
  returns always false

## ◆ operator=()

WPSStringStream & WPSStringStream::operator= | ( | const WPSStringStream & |  | ) |
| privatedelete

## ◆ read()

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

! reads numbytes data.

Returns
  a pointer to the read elements

## ◆ seek()

int WPSStringStream::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 WPSStringStream::subStreamCount | ( |  | ) |
| final

returns the number of sub streams.

See also
  returns always 0

## ◆ subStreamName()

const char * WPSStringStream::subStreamName | ( | unsigned |  | ) |
| final

returns the ith sub streams name

See also
  returns always 0

## ◆ tell()

long WPSStringStream::tell | ( |  | ) |
| final

returns actual offset position

## Member Data Documentation

## ◆ m_data

std::unique_ptr<WPSStringStreamPrivate> WPSStringStream::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:

- WPSStringStream.h
- WPSStringStream.cpp