PoDoFo 0.9.20
Public Member Functions | List of all members
PoDoFo::PdfHexFilter Class Referencefinal

#include <PdfFiltersPrivate.h>

Inheritance diagram for PoDoFo::PdfHexFilter:
PoDoFo::PdfFilter

Public Member Functions

bool CanEncode () const override
 
void EncodeBlockImpl (const char *buffer, size_t len) override
 
bool CanDecode () const override
 
void BeginDecodeImpl (const PdfDictionary *) override
 
void DecodeBlockImpl (const char *buffer, size_t len) override
 
void EndDecodeImpl () override
 
PdfFilterType GetType () const override
 
- Public Member Functions inherited from PoDoFo::PdfFilter
 PdfFilter ()
 
virtual ~PdfFilter ()
 
void EncodeTo (charbuff &outBuffer, const bufferview &inBuffer) const
 
void BeginEncode (OutputStream &output)
 
void EncodeBlock (const bufferview &view)
 
void EndEncode ()
 
void DecodeTo (charbuff &outBuffer, const bufferview &inBuffer, const PdfDictionary *decodeParms=nullptr) const
 
void BeginDecode (OutputStream &output, const PdfDictionary *decodeParms=nullptr)
 
void DecodeBlock (const bufferview &view)
 
void EndDecode ()
 

Additional Inherited Members

- Protected Member Functions inherited from PoDoFo::PdfFilter
void FailEncodeDecode ()
 
virtual void BeginEncodeImpl ()
 
virtual void EndEncodeImpl ()
 

Detailed Description

The ascii hex filter.

Member Function Documentation

◆ BeginDecodeImpl()

void PdfHexFilter::BeginDecodeImpl ( const PdfDictionary )
overridevirtual

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.

◆ CanDecode()

bool PoDoFo::PdfHexFilter::CanDecode ( ) const
inlineoverridevirtual

Check whether the decoding is implemented for this filter.

Returns
true if the filter is able to decode data

Implements PoDoFo::PdfFilter.

◆ CanEncode()

bool PoDoFo::PdfHexFilter::CanEncode ( ) const
inlineoverridevirtual

Check whether encoding is implemented for this filter.

Returns
true if the filter is able to encode data

Implements PoDoFo::PdfFilter.

◆ DecodeBlockImpl()

void PdfHexFilter::DecodeBlockImpl ( const char *  buffer,
size_t  len 
)
overridevirtual

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

You must method-override it 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.

◆ EncodeBlockImpl()

void PdfHexFilter::EncodeBlockImpl ( const char *  buffer,
size_t  len 
)
overridevirtual

Real implementation of EncodeBlock(). NEVER call this method directly.

You must method-override it to encode 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 EndEncodeImpl(). 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 BeginEncode() has been called, and ensures that EndEncode() has not been called since the last BeginEncode().

See also
EncodeBlock

Implements PoDoFo::PdfFilter.

◆ EndDecodeImpl()

void PdfHexFilter::EndDecodeImpl ( )
overridevirtual

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.

◆ GetType()

PdfFilterType PoDoFo::PdfHexFilter::GetType ( ) const
inlineoverridevirtual

Type of this filter.

Returns
the type of this filter

Implements PoDoFo::PdfFilter.