PoDoFo::PdfFilterFactory Class Reference
#include <PdfFilter.h>
List of all members.
Detailed Description
A factory to create a filter object for a filter GetType from the EPdfFilter enum.
All filters should be created using this factory.
Member Function Documentation
std::auto_ptr< PdfFilter > PoDoFo::PdfFilterFactory::Create |
( |
const EPdfFilter |
eFilter |
) |
[static] |
Create a filter from an enum.
Ownership is transferred to the caller, who should let the auto_ptr the filter is returned in take care of freeing it when they're done with it.
- Parameters:
-
| eFilter | the GetType of filter that should be created. |
- Returns:
- a new PdfFilter allocated using new or NULL if no filter is available for this type.
PdfOutputStream * PoDoFo::PdfFilterFactory::CreateDecodeStream |
( |
const TVecFilters & |
filters, |
|
|
PdfOutputStream * |
pStream, |
|
|
const PdfDictionary * |
pDictionary = NULL | |
|
) |
| | [static] |
Create a PdfOutputStream that applies a list of filters on all data written to it.
- Parameters:
-
| filters | a list of filters |
| pStream | write all data to this PdfOutputStream after it has been decoded. |
| pDictionary | pointer to a dictionary that might contain additional parameters for decoding the stream. CreateDecodeStream will look for a key named DecodeParms in this dictionary and pass the information found in this dictionary to the filters. |
- Returns:
- a new PdfOutputStream that has to be deleted by the caller.
- See also:
- PdfFilterFactory::CreateFilterList
TVecFilters PoDoFo::PdfFilterFactory::CreateFilterList |
( |
const PdfObject * |
pObject |
) |
[static] |
The passed PdfObject has to be a dictionary with a Filters key, an array of filter names or a filter name.
- Parameters:
-
| pObject | must define a list of filters. |
- Returns:
- a list of filters
EPdfFilter PoDoFo::PdfFilterFactory::FilterNameToType |
( |
const PdfName & |
name |
) |
[static] |
Converts a filter name to the corresponding enum
- Parameters:
-
| name | of the filter without leading |
- Returns:
- the filter as enum
const char * PoDoFo::PdfFilterFactory::FilterTypeToName |
( |
EPdfFilter |
eFilter |
) |
[static] |
Converts a filter type enum to the corresponding PdfName
- Parameters:
-
- Returns:
- the filter as name