PoDoFo::PdfHexFilter Class Reference

#include <PdfFiltersPrivate.h>

Inheritance diagram for PoDoFo::PdfHexFilter:

PoDoFo::PdfFilter

List of all members.

Public Member Functions

virtual bool CanEncode () const
virtual void EncodeBlockImpl (const char *pBuffer, long lLen)
virtual bool CanDecode () const
virtual void BeginDecodeImpl (const PdfDictionary *)
virtual void DecodeBlockImpl (const char *pBuffer, long lLen)
virtual void EndDecodeImpl ()
virtual EPdfFilter GetType () const


Detailed Description

The ascii hex filter.

Member Function Documentation

void PoDoFo::PdfHexFilter::BeginDecodeImpl ( const PdfDictionary *   )  [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.

bool PoDoFo::PdfHexFilter::CanDecode (  )  const [inline, virtual]

Check wether the decoding is implemented for this filter.

Returns:
true if the filter is able to decode data

Implements PoDoFo::PdfFilter.

bool PoDoFo::PdfHexFilter::CanEncode (  )  const [inline, virtual]

Check wether the encoding is implemented for this filter.

Returns:
true if the filter is able to encode data

Implements PoDoFo::PdfFilter.

void PoDoFo::PdfHexFilter::DecodeBlockImpl ( const char *  pBuffer,
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::PdfHexFilter::EncodeBlockImpl ( const char *  pBuffer,
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:
pBuffer pointer to a buffer with data to encode
lLen length of data to encode.
Call EndEncodeImpl() after all data has been encoded

See also:
BeginEncodeImpl

EndEncodeImpl

Implements PoDoFo::PdfFilter.

void PoDoFo::PdfHexFilter::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.

EPdfFilter PoDoFo::PdfHexFilter::GetType (  )  const [inline, virtual]

GetType of this filter.

Returns:
the GetType of this filter

Implements PoDoFo::PdfFilter.


Generated on Sat May 2 02:50:34 2009 for PoDoFo by  doxygen 1.5.8