PoDoFo 0.7.0
Public Member Functions
PoDoFo::PdfContentsTokenizer Class Reference

#include <PdfContentsTokenizer.h>

Inheritance diagram for PoDoFo::PdfContentsTokenizer:
PoDoFo::PdfTokenizer

List of all members.

Public Member Functions

 PdfContentsTokenizer (const char *pBuffer, long lLen)
 PdfContentsTokenizer (PdfCanvas *pCanvas)
bool ReadNext (EPdfContentsType &reType, const char *&rpszKeyword, PoDoFo::PdfVariant &rVariant)

Detailed Description

This class is a parser for content streams in PDF documents.

The parsed content stream can be used and modified in various ways.

This class is currently work in progress and subject to change!


Constructor & Destructor Documentation

PoDoFo::PdfContentsTokenizer::PdfContentsTokenizer ( const char *  pBuffer,
long  lLen 
) [inline]

Construct a PdfContentsTokenizer from an existing buffer. Usually a stream from a PdfPage.

Parameters:
pBufferpointer to a buffer
lLenlength of the buffer
PoDoFo::PdfContentsTokenizer::PdfContentsTokenizer ( PdfCanvas pCanvas)

Construct a PdfContentsTokenizer from a PdfCanvas (i.e. PdfPage or a PdfXObject).

This is more convinient as you do not have to care about buffers yourself.

Parameters:
pCanvasan object that hold a PDF contents stream

Member Function Documentation

bool PoDoFo::PdfContentsTokenizer::ReadNext ( EPdfContentsType reType,
const char *&  rpszKeyword,
PoDoFo::PdfVariant rVariant 
)

Read the next keyword or variant, returning true and setting reType if something was read. Either rpszKeyword or rVariant, but never both, have defined and usable values on true return, with which being controlled by the value of eType.

If EOF is encountered, returns false and leaves eType, pszKeyword and rVariant undefined.

As a special case, reType may be set to ePdfContentsType_ImageData. In this case rpszzKeyword is undefined, and rVariant contains a PdfData variant containing the byte sequence between the ID and BI keywords sans the one byte of leading- and trailing- white space. No filter decoding is performed.

Parameters:
[out]reTypewill be set to either keyword or variant if true is returned. Undefined if false is returned.
[out]rpszKeywordif pType is set to ePdfContentsType_Keyword this will point to the keyword, otherwise the value is undefined. If set, the value points to memory owned by the PdfContentsTokenizer and must not be freed. The value is invalidated when ReadNext is next called or when the PdfContentsTokenizer is destroyed.
[out]rVariantif pType is set to ePdfContentsType_Variant or ePdfContentsType_ImageData this will be set to the read variant, otherwise the value is undefined.