PoDoFo  0.9.4
Public Member Functions | List of all members
PoDoFo::PdfLZWFilter Class Reference

#include <PdfFiltersPrivate.h>

Inheritance diagram for PoDoFo::PdfLZWFilter:
PoDoFo::PdfFilter

Public Member Functions

virtual bool CanEncode () const
 
virtual void BeginEncodeImpl ()
 
virtual void EncodeBlockImpl (const char *pBuffer, pdf_long lLen)
 
virtual void EndEncodeImpl ()
 
virtual bool CanDecode () const
 
virtual void BeginDecodeImpl (const PdfDictionary *)
 
virtual void DecodeBlockImpl (const char *pBuffer, pdf_long lLen)
 
virtual void EndDecodeImpl ()
 
virtual EPdfFilter GetType () const
 
- Public Member Functions inherited from PoDoFo::PdfFilter
 PdfFilter ()
 
virtual ~PdfFilter ()
 
void Encode (const char *pInBuffer, pdf_long lInLen, char **ppOutBuffer, pdf_long *plOutLen) const
 
void BeginEncode (PdfOutputStream *pOutput)
 
void EncodeBlock (const char *pBuffer, pdf_long lLen)
 
void EndEncode ()
 
void Decode (const char *pInBuffer, pdf_long lInLen, char **ppOutBuffer, pdf_long *plOutLen, const PdfDictionary *pDecodeParms=NULL) const
 
void BeginDecode (PdfOutputStream *pOutput, const PdfDictionary *pDecodeParms=NULL)
 
void DecodeBlock (const char *pBuffer, pdf_long lLen)
 
void EndDecode ()
 

Additional Inherited Members

- Protected Member Functions inherited from PoDoFo::PdfFilter
PODOFO_NOTHROW void FailEncodeDecode ()
 

Detailed Description

The LZW filter.

Member Function Documentation

void PoDoFo::PdfLZWFilter::BeginDecodeImpl ( const PdfDictionary pDecodeParms)
virtual

Real implementation of `BeginDecode()'. NEVER call this method directly.

By default this function does nothing. If your filter needs to do setup for decoding, you should override this method.

PdfFilter ensures that a valid stream is available when this method is called, and that EndDecode() was called since the last BeginDecode()/DecodeBlock().

See also
BeginDecode

Reimplemented from PoDoFo::PdfFilter.

void PoDoFo::PdfLZWFilter::BeginEncodeImpl ( )
virtual

Begin encoding data using this filter. Called by PdfFilter::BeginEncode.

See also
EncodeBlockImpl
EndEncodeImpl
PdfFilter::BeginEncode

Reimplemented from PoDoFo::PdfFilter.

bool PoDoFo::PdfLZWFilter::CanDecode ( ) const
inlinevirtual

Check wether the decoding is implemented for this filter.

Returns
true if the filter is able to decode data

Implements PoDoFo::PdfFilter.

bool PoDoFo::PdfLZWFilter::CanEncode ( ) const
inlinevirtual

Check wether the encoding is implemented for this filter.

Returns
true if the filter is able to encode data

Implements PoDoFo::PdfFilter.

void PoDoFo::PdfLZWFilter::DecodeBlockImpl ( const char *  pBuffer,
pdf_long  lLen 
)
virtual

Real implementation of `DecodeBlock()'. NEVER call this method directly.

You must override this method to decode the buffer passed by the caller.

You are not obliged to immediately process any or all of the data in the passed buffer, but you must ensure that you have processed it and written it out by the end of EndDecodeImpl(). You must copy the buffer if you're going to store it, as ownership is not transferred to the filter and the caller may free the buffer at any time.

PdfFilter ensures that a valid stream is available when this method is called, ensures that BeginDecode() has been called, and ensures that EndDecode() has not been called since the last BeginDecode().

See also
DecodeBlock

Implements PoDoFo::PdfFilter.

void PoDoFo::PdfLZWFilter::EncodeBlockImpl ( const char *  pBuffer,
pdf_long  lLen 
)
virtual

Encode a block of data and write it to the PdfOutputStream specified by BeginEncodeImpl.

BeginEncodeImpl() has to be called before this function.

Parameters
pBufferpointer to a buffer with data to encode
lLenlength of data to encode.

Call EndEncodeImpl() after all data has been encoded

See also
BeginEncodeImpl
EndEncodeImpl

Implements PoDoFo::PdfFilter.

void PoDoFo::PdfLZWFilter::EndDecodeImpl ( )
virtual

Real implementation of `EndDecode()'. NEVER call this method directly.

By the time this method returns, all filtered data must be written to the stream and the filter must be in a state where BeginDecode() can be safely called.

PdfFilter ensures that a valid stream is available when this method is called, and ensures that BeginDecodeImpl() has been called.

See also
EndDecode

Reimplemented from PoDoFo::PdfFilter.

void PoDoFo::PdfLZWFilter::EndEncodeImpl ( )
virtual

Finish encoding of data.

See also
BeginEncodeImpl
EncodeBlockImpl

Reimplemented from PoDoFo::PdfFilter.

EPdfFilter PoDoFo::PdfLZWFilter::GetType ( ) const
inlinevirtual

GetType of this filter.

Returns
the GetType of this filter

Implements PoDoFo::PdfFilter.