Podofo

PoDoFo
0.9.0 Generated by Doxygen 1.7.1

Mon Mar 14 2011 21:42:01
Contents
1 2 3 Main Page (Codingstyle) Namespace Index 3.1 4 Namespace List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 3 9 9 11 11 15 15 19 19 21 21 26 27 27 27 27 27 27 28 28 28
Class Index 4.1 Class Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Class Index 5.1 Class List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
File Index 6.1 File List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Namespace Documentation 7.1 PoDoFo Namespace Reference . . . . . . . . . . . . . . . . . . . . . 7.1.1 7.1.2 Detailed Description . . . . . . . . . . . . . . . . . . . . . . Typedef Documentation . . . . . . . . . . . . . . . . . . . . 7.1.2.1 7.1.3 PdfArrayBaseClass . . . . . . . . . . . . . . . . .
Enumeration Type Documentation . . . . . . . . . . . . . . . 7.1.3.1 7.1.3.2 7.1.3.3 7.1.3.4 7.1.3.5 7.1.3.6 ELogSeverity . . . . . . . . . . . . . . . . . . . . EPdfAction . . . . . . . . . . . . . . . . . . . . . EPdfAlignment . . . . . . . . . . . . . . . . . . . EPdfAnnotation . . . . . . . . . . . . . . . . . . . EPdfAnnotationFlags . . . . . . . . . . . . . . . . EPdfColorSpace . . . . . . . . . . . . . . . . . . .
ii 7.1.3.7 7.1.3.8 7.1.3.9
CONTENTS EPdfContentsType . . . . . . . . . . . . . . . . . . EPdfDataType . . . . . . . . . . . . . . . . . . . . EPdfDestinationType . . . . . . . . . . . . . . . . 28 28 29 29 31 31 32 32 32 33 33 33 33 33 34 34 34 35 35 35 35 35 35 36 36 36 36 36 36 37 37 37 37
7.1.3.10 EPdfError . . . . . . . . . . . . . . . . . . . . . . 7.1.3.11 EPdfField . . . . . . . . . . . . . . . . . . . . . . 7.1.3.12 EPdfFilter . . . . . . . . . . . . . . . . . . . . . . 7.1.3.13 EPdfFontType . . . . . . . . . . . . . . . . . . . . 7.1.3.14 EPdfFunctionType . . . . . . . . . . . . . . . . . . 7.1.3.15 EPdfHighlightingMode . . . . . . . . . . . . . . . 7.1.3.16 EPdfLineCapStyle . . . . . . . . . . . . . . . . . . 7.1.3.17 EPdfLineJoinStyle . . . . . . . . . . . . . . . . . . 7.1.3.18 EPdfOutlineFormat . . . . . . . . . . . . . . . . . 7.1.3.19 EPdfPageLayout . . . . . . . . . . . . . . . . . . . 7.1.3.20 EPdfPageMode . . . . . . . . . . . . . . . . . . . 7.1.3.21 EPdfPageSize . . . . . . . . . . . . . . . . . . . . 7.1.3.22 EPdfStrokeStyle . . . . . . . . . . . . . . . . . . . 7.1.3.23 EPdfVersion . . . . . . . . . . . . . . . . . . . . . 7.1.3.24 EPdfVerticalAlignment . . . . . . . . . . . . . . . 7.1.3.25 EPdfWriteMode . . . . . . . . . . . . . . . . . . . 7.1.4 Function Documentation . . . . . . . . . . . . . . . . . . . . 7.1.4.1 7.1.4.2 7.1.4.3 7.1.4.4 7.1.4.5 7.1.4.6 7.1.4.7 7.1.5 PDF_MAX . . . . . . . . . . . . . . . . . . . . . PDF_MIN . . . . . . . . . . . . . . . . . . . . . . PdfLocaleImbue . . . . . . . . . . . . . . . . . . . podofo_free . . . . . . . . . . . . . . . . . . . . . podofo_is_little_endian . . . . . . . . . . . . . . . podofo_malloc . . . . . . . . . . . . . . . . . . . . podofo_realloc . . . . . . . . . . . . . . . . . . . .
Variable Documentation . . . . . . . . . . . . . . . . . . . . 7.1.5.1 ePdfVersion_Default . . . . . . . . . . . . . . . . .
Class Documentation 8.1 PoDoFo::MD5Context Struct Reference . . . . . . . . . . . . . . . . 8.1.1 8.2 Detailed Description . . . . . . . . . . . . . . . . . . . . . .
PoDoFo::NamedColorComparatorPredicate Class Reference . . . . .
Generated on Mon Mar 14 2011 21:42:01 for PoDoFo by Doxygen
CONTENTS 8.2.1 8.3 Detailed Description . . . . . . . . . . . . . . . . . . . . . .
iii 37 37 38 38 38 38 38 38 39 39 39 39 39 40 40 40 40 40 40 41 42 42 42 42 42 42 43 43 43 44 44 44 44 44
PoDoFo::PdfVecObjects::Observer Class Reference . . . . . . . . . . 8.3.1 8.3.2 Detailed Description . . . . . . . . . . . . . . . . . . . . . . Member Function Documentation . . . . . . . . . . . . . . . 8.3.2.1 8.3.2.2 8.3.2.3 BeginAppendStream . . . . . . . . . . . . . . . . . EndAppendStream . . . . . . . . . . . . . . . . . . ParentDestructed . . . . . . . . . . . . . . . . . . .
8.4
PoDoFo::PdfAction Class Reference . . . . . . . . . . . . . . . . . . 8.4.1 8.4.2 Detailed Description . . . . . . . . . . . . . . . . . . . . . . Constructor & Destructor Documentation . . . . . . . . . . . 8.4.2.1 8.4.2.2 8.4.2.3 8.4.3 PdfAction . . . . . . . . . . . . . . . . . . . . . . PdfAction . . . . . . . . . . . . . . . . . . . . . . PdfAction . . . . . . . . . . . . . . . . . . . . . .
Member Function Documentation . . . . . . . . . . . . . . . 8.4.3.1 8.4.3.2 8.4.3.3 8.4.3.4 8.4.3.5 AddToDictionary . . . . . . . . . . . . . . . . . . GetType . . . . . . . . . . . . . . . . . . . . . . . GetURI . . . . . . . . . . . . . . . . . . . . . . . HasURI . . . . . . . . . . . . . . . . . . . . . . . SetURI . . . . . . . . . . . . . . . . . . . . . . . .
8.5
PoDoFo::PdfAnnotation Class Reference . . . . . . . . . . . . . . . 8.5.1 8.5.2 Detailed Description . . . . . . . . . . . . . . . . . . . . . . Constructor & Destructor Documentation . . . . . . . . . . . 8.5.2.1 8.5.2.2 8.5.3 PdfAnnotation . . . . . . . . . . . . . . . . . . . . PdfAnnotation . . . . . . . . . . . . . . . . . . . .
Member Function Documentation . . . . . . . . . . . . . . . 8.5.3.1 8.5.3.2 8.5.3.3 8.5.3.4 8.5.3.5 8.5.3.6 8.5.3.7 8.5.3.8 8.5.3.9 GetAction . . . . . . . . . . . . . . . . . . . . . . GetColor . . . . . . . . . . . . . . . . . . . . . . . GetContents . . . . . . . . . . . . . . . . . . . . . GetDestination . . . . . . . . . . . . . . . . . . . . GetFileAttachement . . . . . . . . . . . . . . . . . GetFlags . . . . . . . . . . . . . . . . . . . . . . . GetOpen . . . . . . . . . . . . . . . . . . . . . . . GetPage . . . . . . . . . . . . . . . . . . . . . . . GetQuadPoints . . . . . . . . . . . . . . . . . . . .
iv
CONTENTS 8.5.3.10 GetRect . . . . . . . . . . . . . . . . . . . . . . . 8.5.3.11 GetTitle . . . . . . . . . . . . . . . . . . . . . . . 8.5.3.12 GetType . . . . . . . . . . . . . . . . . . . . . . . 8.5.3.13 HasAction . . . . . . . . . . . . . . . . . . . . . . 8.5.3.14 HasAppearanceStream . . . . . . . . . . . . . . . 8.5.3.15 HasDestination . . . . . . . . . . . . . . . . . . . 8.5.3.16 HasFileAttachement . . . . . . . . . . . . . . . . . 8.5.3.17 SetAction . . . . . . . . . . . . . . . . . . . . . . 8.5.3.18 SetAppearanceStream . . . . . . . . . . . . . . . . 8.5.3.19 SetBorderStyle . . . . . . . . . . . . . . . . . . . . 8.5.3.20 SetBorderStyle . . . . . . . . . . . . . . . . . . . . 8.5.3.21 SetColor . . . . . . . . . . . . . . . . . . . . . . . 8.5.3.22 SetColor . . . . . . . . . . . . . . . . . . . . . . . 8.5.3.23 SetColor . . . . . . . . . . . . . . . . . . . . . . . 8.5.3.24 SetColor . . . . . . . . . . . . . . . . . . . . . . . 8.5.3.25 SetContents . . . . . . . . . . . . . . . . . . . . . 8.5.3.26 SetDestination . . . . . . . . . . . . . . . . . . . . 8.5.3.27 SetFileAttachement . . . . . . . . . . . . . . . . . 8.5.3.28 SetFlags . . . . . . . . . . . . . . . . . . . . . . . 8.5.3.29 SetOpen . . . . . . . . . . . . . . . . . . . . . . . 8.5.3.30 SetQuadPoints . . . . . . . . . . . . . . . . . . . . 8.5.3.31 SetTitle . . . . . . . . . . . . . . . . . . . . . . . . 8.6 PoDoFo::PdfAscii85Filter Class Reference . . . . . . . . . . . . . . 8.6.1 8.6.2 Detailed Description . . . . . . . . . . . . . . . . . . . . . . Member Function Documentation . . . . . . . . . . . . . . . 8.6.2.1 8.6.2.2 8.6.2.3 8.6.2.4 8.6.2.5 8.6.2.6 8.6.2.7 8.6.2.8 8.6.2.9 BeginDecodeImpl . . . . . . . . . . . . . . . . . . BeginEncodeImpl . . . . . . . . . . . . . . . . . . CanDecode . . . . . . . . . . . . . . . . . . . . . CanEncode . . . . . . . . . . . . . . . . . . . . . . DecodeBlockImpl . . . . . . . . . . . . . . . . . . EncodeBlockImpl . . . . . . . . . . . . . . . . . . EndDecodeImpl . . . . . . . . . . . . . . . . . . . EndEncodeImpl . . . . . . . . . . . . . . . . . . . GetType . . . . . . . . . . . . . . . . . . . . . . . 45 45 45 45 45 45 46 46 46 46 46 47 47 47 47 48 48 48 48 49 49 49 49 50 50 50 50 51 51 51 51 52 52 52
CONTENTS 8.7 PoDoFo::PdfAxialShadingPattern Class Reference . . . . . . . . . . 8.7.1 8.7.2 Detailed Description . . . . . . . . . . . . . . . . . . . . . . Constructor & Destructor Documentation . . . . . . . . . . . 8.7.2.1 8.7.2.2 8.8 PdfAxialShadingPattern . . . . . . . . . . . . . . . PdfAxialShadingPattern . . . . . . . . . . . . . . .
v 53 53 53 53 54 54 54 55 55 55 55 55 55 56 56 56 56 57 57 57 57 57 58 58 58 58 59 59 59 59 59 59 59 59
PoDoFo::PdfBufferOutputStream Class Reference . . . . . . . . . . . 8.8.1 8.8.2 Detailed Description . . . . . . . . . . . . . . . . . . . . . . Constructor & Destructor Documentation . . . . . . . . . . . 8.8.2.1 8.8.3 PdfBufferOutputStream . . . . . . . . . . . . . . .
Member Function Documentation . . . . . . . . . . . . . . . 8.8.3.1 8.8.3.2 8.8.3.3 Close . . . . . . . . . . . . . . . . . . . . . . . . . GetLength . . . . . . . . . . . . . . . . . . . . . . Write . . . . . . . . . . . . . . . . . . . . . . . . .
8.9
PoDoFo::PdfCanvas Class Reference . . . . . . . . . . . . . . . . . . 8.9.1 8.9.2 Detailed Description . . . . . . . . . . . . . . . . . . . . . . Constructor & Destructor Documentation . . . . . . . . . . . 8.9.2.1 8.9.3 PdfCanvas . . . . . . . . . . . . . . . . . . . . .
Member Function Documentation . . . . . . . . . . . . . . . 8.9.3.1 8.9.3.2 8.9.3.3 8.9.3.4 8.9.3.5 8.9.3.6 8.9.3.7 AddColorResource . . . . . . . . . . . . . . . . . AddResource . . . . . . . . . . . . . . . . . . . . GetContents . . . . . . . . . . . . . . . . . . . . . GetContentsForAppending . . . . . . . . . . . . . GetPageSize . . . . . . . . . . . . . . . . . . . . . GetProcSet . . . . . . . . . . . . . . . . . . . . . . GetResources . . . . . . . . . . . . . . . . . . . .
8.10 PoDoFo::PdfCheckBox Class Reference . . . . . . . . . . . . . . . . 8.10.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.10.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.10.2.1 PdfCheckBox . . . . . . . . . . . . . . . . . . . . 8.10.2.2 PdfCheckBox . . . . . . . . . . . . . . . . . . . . 8.10.2.3 PdfCheckBox . . . . . . . . . . . . . . . . . . . . 8.10.2.4 PdfCheckBox . . . . . . . . . . . . . . . . . . . . 8.10.2.5 PdfCheckBox . . . . . . . . . . . . . . . . . . . . 8.10.3 Member Function Documentation . . . . . . . . . . . . . . .
vi
CONTENTS 8.10.3.1 IsChecked . . . . . . . . . . . . . . . . . . . . . . 8.10.3.2 SetAppearanceChecked . . . . . . . . . . . . . . . 8.10.3.3 SetAppearanceUnchecked . . . . . . . . . . . . . . 8.10.3.4 SetChecked . . . . . . . . . . . . . . . . . . . . . 8.11 PoDoFo::PdfColor Class Reference . . . . . . . . . . . . . . . . . . 8.11.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.11.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.11.2.1 PdfColor . . . . . . . . . . . . . . . . . . . . . . . 8.11.2.2 PdfColor . . . . . . . . . . . . . . . . . . . . . . . 8.11.2.3 PdfColor . . . . . . . . . . . . . . . . . . . . . . . 8.11.2.4 PdfColor . . . . . . . . . . . . . . . . . . . . . . . 8.11.2.5 PdfColor . . . . . . . . . . . . . . . . . . . . . . . 8.11.2.6 PdfColor . . . . . . . . . . . . . . . . . . . . . . 8.11.3 Member Function Documentation . . . . . . . . . . . . . . . 8.11.3.1 BuildColorSpace . . . . . . . . . . . . . . . . . . . 8.11.3.2 ConvertToCMYK . . . . . . . . . . . . . . . . . . 8.11.3.3 ConvertToGrayScale . . . . . . . . . . . . . . . . . 8.11.3.4 ConvertToRGB . . . . . . . . . . . . . . . . . . . 8.11.3.5 FromArray . . . . . . . . . . . . . . . . . . . . . . 8.11.3.6 FromString . . . . . . . . . . . . . . . . . . . . . . 8.11.3.7 GetAlternateColorSpace . . . . . . . . . . . . . . . 8.11.3.8 GetBlack . . . . . . . . . . . . . . . . . . . . . . . 8.11.3.9 GetBlue . . . . . . . . . . . . . . . . . . . . . . . 8.11.3.10 GetCieA . . . . . . . . . . . . . . . . . . . . . . . 8.11.3.11 GetCieB . . . . . . . . . . . . . . . . . . . . . . . 8.11.3.12 GetCieL . . . . . . . . . . . . . . . . . . . . . . . 8.11.3.13 GetColorSpace . . . . . . . . . . . . . . . . . . . . 8.11.3.14 GetColorSpaceForName . . . . . . . . . . . . . . . 8.11.3.15 GetCyan . . . . . . . . . . . . . . . . . . . . . . . 8.11.3.16 GetDensity . . . . . . . . . . . . . . . . . . . . . . 8.11.3.17 GetGrayScale . . . . . . . . . . . . . . . . . . . . 8.11.3.18 GetGreen . . . . . . . . . . . . . . . . . . . . . . . 8.11.3.19 GetMagenta . . . . . . . . . . . . . . . . . . . . . 8.11.3.20 GetName . . . . . . . . . . . . . . . . . . . . . . . 59 60 60 60 60 61 62 62 62 62 62 62 63 63 63 63 63 64 64 64 65 65 65 65 66 66 66 66 67 67 67 67 68 68
CONTENTS 8.11.3.21 GetNameForColorSpace . . . . . . . . . . . . . . . 8.11.3.22 GetRed . . . . . . . . . . . . . . . . . . . . . . . . 8.11.3.23 GetYellow . . . . . . . . . . . . . . . . . . . . . . 8.11.3.24 IsCieLab . . . . . . . . . . . . . . . . . . . . . . . 8.11.3.25 IsCMYK . . . . . . . . . . . . . . . . . . . . . . . 8.11.3.26 IsGrayScale . . . . . . . . . . . . . . . . . . . . . 8.11.3.27 IsRGB . . . . . . . . . . . . . . . . . . . . . . . . 8.11.3.28 IsSeparation . . . . . . . . . . . . . . . . . . . . . 8.11.3.29 operator!= . . . . . . . . . . . . . . . . . . . . . . 8.11.3.30 operator= . . . . . . . . . . . . . . . . . . . . . . . 8.11.3.31 operator== . . . . . . . . . . . . . . . . . . . . . . 8.11.3.32 ToArray . . . . . . . . . . . . . . . . . . . . . . . 8.12 PoDoFo::PdfComboBox Class Reference . . . . . . . . . . . . . . . 8.12.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.12.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.12.2.1 PdfComboBox . . . . . . . . . . . . . . . . . . . . 8.12.2.2 PdfComboBox . . . . . . . . . . . . . . . . . . . . 8.12.2.3 PdfComboBox . . . . . . . . . . . . . . . . . . . . 8.12.2.4 PdfComboBox . . . . . . . . . . . . . . . . . . . . 8.12.2.5 PdfComboBox . . . . . . . . . . . . . . . . . . . . 8.12.3 Member Function Documentation . . . . . . . . . . . . . . . 8.12.3.1 IsEditable . . . . . . . . . . . . . . . . . . . . . . 8.12.3.2 SetEditable . . . . . . . . . . . . . . . . . . . . . . 8.13 PoDoFo::PdfContents Class Reference . . . . . . . . . . . . . . . . . 8.13.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.13.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.13.2.1 PdfContents . . . . . . . . . . . . . . . . . . . . . 8.13.2.2 PdfContents . . . . . . . . . . . . . . . . . . . . . 8.13.2.3 PdfContents . . . . . . . . . . . . . . . . . . . . . 8.13.2.4 PdfContents . . . . . . . . . . . . . . . . . . . . . 8.13.2.5 PdfContents . . . . . . . . . . . . . . . . . . . . 8.13.3 Member Function Documentation . . . . . . . . . . . . . . . 8.13.3.1 GetContents . . . . . . . . . . . . . . . . . . . . . 8.13.3.2 GetContentsForAppending . . . . . . . . . . . . .
vii 68 69 69 69 69 69 70 70 70 70 70 71 71 71 72 72 72 72 72 72 72 72 72 73 73 73 73 73 73 74 74 74 74 74
viii
CONTENTS 8.14 PoDoFo::PdfContentsTokenizer Class Reference . . . . . . . . . . . 8.14.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.14.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.14.2.1 PdfContentsTokenizer . . . . . . . . . . . . . . . . 8.14.2.2 PdfContentsTokenizer . . . . . . . . . . . . . . . . 8.14.3 Member Function Documentation . . . . . . . . . . . . . . . 8.14.3.1 GetNextToken . . . . . . . . . . . . . . . . . . . . 8.14.3.2 ReadNext . . . . . . . . . . . . . . . . . . . . . . 8.15 PoDoFo::PdfData Class Reference . . . . . . . . . . . . . . . . . . . 8.15.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.15.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.15.2.1 PdfData . . . . . . . . . . . . . . . . . . . . . . . 8.15.2.2 PdfData . . . . . . . . . . . . . . . . . . . . . . . 8.15.2.3 PdfData . . . . . . . . . . . . . . . . . . . . . . . 8.15.3 Member Function Documentation . . . . . . . . . . . . . . . 8.15.3.1 data . . . . . . . . . . . . . . . . . . . . . . . . . 8.15.3.2 operator= . . . . . . . . . . . . . . . . . . . . . . . 8.15.3.3 Write . . . . . . . . . . . . . . . . . . . . . . . . . 8.16 PoDoFo::PdfDataType Class Reference . . . . . . . . . . . . . . . . 8.16.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.16.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.16.2.1 PdfDataType . . . . . . . . . . . . . . . . . . . . . 8.16.3 Member Function Documentation . . . . . . . . . . . . . . . 8.16.3.1 AssertMutable . . . . . . . . . . . . . . . . . . . . 8.16.3.2 GetImmutable . . . . . . . . . . . . . . . . . . . . 8.16.3.3 IsDirty . . . . . . . . . . . . . . . . . . . . . . . . 8.16.3.4 SetDirty . . . . . . . . . . . . . . . . . . . . . . . 8.16.3.5 SetImmutable . . . . . . . . . . . . . . . . . . . . 8.16.3.6 Write . . . . . . . . . . . . . . . . . . . . . . . . . 8.17 PoDoFo::PdfDate Class Reference . . . . . . . . . . . . . . . . . . . 8.17.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.17.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.17.2.1 PdfDate . . . . . . . . . . . . . . . . . . . . . . . 8.17.2.2 PdfDate . . . . . . . . . . . . . . . . . . . . . . . 74 75 75 75 75 75 75 76 77 77 77 77 77 78 78 78 78 78 79 79 80 80 80 80 80 80 80 81 81 81 81 82 82 82
CONTENTS 8.17.2.3 PdfDate . . . . . . . . . . . . . . . . . . . . . . 8.17.3 Member Function Documentation . . . . . . . . . . . . . . . 8.17.3.1 GetTime . . . . . . . . . . . . . . . . . . . . . . . 8.17.3.2 IsValid . . . . . . . . . . . . . . . . . . . . . . . . 8.17.3.3 ToString . . . . . . . . . . . . . . . . . . . . . . . 8.18 PoDoFo::PdfDestination Class Reference . . . . . . . . . . . . . . . 8.18.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.18.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.18.2.1 PdfDestination . . . . . . . . . . . . . . . . . . . . 8.18.2.2 PdfDestination . . . . . . . . . . . . . . . . . . . . 8.18.2.3 PdfDestination . . . . . . . . . . . . . . . . . . . . 8.18.2.4 PdfDestination . . . . . . . . . . . . . . . . . . . . 8.18.2.5 PdfDestination . . . . . . . . . . . . . . . . . . . . 8.18.2.6 PdfDestination . . . . . . . . . . . . . . . . . . . . 8.18.2.7 PdfDestination . . . . . . . . . . . . . . . . . . . . 8.18.2.8 PdfDestination . . . . . . . . . . . . . . . . . . . . 8.18.3 Member Function Documentation . . . . . . . . . . . . . . . 8.18.3.1 AddToDictionary . . . . . . . . . . . . . . . . . . 8.18.3.2 GetArray . . . . . . . . . . . . . . . . . . . . . . . 8.18.3.3 GetArray . . . . . . . . . . . . . . . . . . . . . . . 8.18.3.4 GetDValue . . . . . . . . . . . . . . . . . . . . . . 8.18.3.5 GetLeft . . . . . . . . . . . . . . . . . . . . . . . . 8.18.3.6 GetObject . . . . . . . . . . . . . . . . . . . . . . 8.18.3.7 GetObject . . . . . . . . . . . . . . . . . . . . . . 8.18.3.8 GetPage . . . . . . . . . . . . . . . . . . . . . . . 8.18.3.9 GetPage . . . . . . . . . . . . . . . . . . . . . . . 8.18.3.10 GetRect . . . . . . . . . . . . . . . . . . . . . . . 8.18.3.11 GetTop . . . . . . . . . . . . . . . . . . . . . . . . 8.18.3.12 GetType . . . . . . . . . . . . . . . . . . . . . . . 8.18.3.13 GetZoom . . . . . . . . . . . . . . . . . . . . . . . 8.18.3.14 operator= . . . . . . . . . . . . . . . . . . . . . . . 8.19 PoDoFo::PdfDeviceInputStream Class Reference . . . . . . . . . . . 8.19.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.19.2 Constructor & Destructor Documentation . . . . . . . . . . .
ix 82 82 82 82 83 83 84 84 84 84 84 84 85 85 85 85 86 86 86 86 86 86 87 87 87 87 88 88 88 88 88 89 89 89
CONTENTS 8.19.2.1 PdfDeviceInputStream . . . . . . . . . . . . . . . . 8.19.3 Member Function Documentation . . . . . . . . . . . . . . . 8.19.3.1 Read . . . . . . . . . . . . . . . . . . . . . . . . . 8.20 PoDoFo::PdfDeviceOutputStream Class Reference . . . . . . . . . . 8.20.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.20.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.20.2.1 PdfDeviceOutputStream . . . . . . . . . . . . . . . 8.20.3 Member Function Documentation . . . . . . . . . . . . . . . 8.20.3.1 Close . . . . . . . . . . . . . . . . . . . . . . . . . 8.20.3.2 Write . . . . . . . . . . . . . . . . . . . . . . . . . 8.21 PoDoFo::PdfDifferenceEncoding Class Reference . . . . . . . . . . . 8.21.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.21.2 Member Enumeration Documentation . . . . . . . . . . . . . 8.21.2.1 EBaseEncoding . . . . . . . . . . . . . . . . . . . 8.21.3 Constructor & Destructor Documentation . . . . . . . . . . . 8.21.3.1 PdfDifferenceEncoding . . . . . . . . . . . . . . . 8.21.3.2 PdfDifferenceEncoding . . . . . . . . . . . . . . . 8.21.3.3 PdfDifferenceEncoding . . . . . . . . . . . . . . . 8.21.3.4 PdfDifferenceEncoding . . . . . . . . . . . . . . . 8.21.3.5 PdfDifferenceEncoding . . . . . . . . . . . . . . . 8.21.4 Member Function Documentation . . . . . . . . . . . . . . . 8.21.4.1 AddToDictionary . . . . . . . . . . . . . . . . . . 8.21.4.2 ConvertToEncoding . . . . . . . . . . . . . . . . . 8.21.4.3 ConvertToUnicode . . . . . . . . . . . . . . . . . . 8.21.4.4 GetCharCode . . . . . . . . . . . . . . . . . . . . 8.21.4.5 GetDifferences . . . . . . . . . . . . . . . . . . . . 8.21.4.6 GetID . . . . . . . . . . . . . . . . . . . . . . . . 8.21.4.7 IsAutoDelete . . . . . . . . . . . . . . . . . . . . . 8.21.4.8 IsSingleByteEncoding . . . . . . . . . . . . . . . . 8.21.4.9 NameToUnicodeID . . . . . . . . . . . . . . . . . 8.21.4.10 UnicodeIDToName . . . . . . . . . . . . . . . . . 8.22 PoDoFo::PdfDocEncoding Class Reference . . . . . . . . . . . . . . 8.22.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.22.2 Constructor & Destructor Documentation . . . . . . . . . . . 89 89 89 90 90 90 90 90 90 91 91 92 92 92 92 92 93 93 93 94 94 94 94 94 95 95 95 96 96 96 96 96 97 97
CONTENTS 8.22.2.1 PdfDocEncoding . . . . . . . . . . . . . . . . . . . 8.22.3 Member Function Documentation . . . . . . . . . . . . . . . 8.22.3.1 GetToUnicodeTable . . . . . . . . . . . . . . . . . 8.23 PoDoFo::PdfDocument Class Reference . . . . . . . . . . . . . . . . 8.23.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.23.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.23.2.1 PdfDocument . . . . . . . . . . . . . . . . . . . 8.23.2.2 PdfDocument . . . . . . . . . . . . . . . . . . . . 8.23.3 Member Function Documentation . . . . . . . . . . . . . . . 8.23.3.1 AddNamedDestination . . . . . . . . . . . . . . . 8.23.3.2 Append . . . . . . . . . . . . . . . . . . . . . . . 8.23.3.3 AttachFile . . . . . . . . . . . . . . . . . . . . . . 8.23.3.4 Clear . . . . . . . . . . . . . . . . . . . . . . . . . 8.23.3.5 CreateDuplicateFontType1 . . . . . . . . . . . . . 8.23.3.6 CreateFont . . . . . . . . . . . . . . . . . . . . . . 8.23.3.7 CreateFont . . . . . . . . . . . . . . . . . . . . . . 8.23.3.8 CreateFont . . . . . . . . . . . . . . . . . . . . . . 8.23.3.9 CreateFontSubset . . . . . . . . . . . . . . . . . . 8.23.3.10 CreatePage . . . . . . . . . . . . . . . . . . . . . . 8.23.3.11 EmbedSubsetFonts . . . . . . . . . . . . . . . . . 8.23.3.12 FillXObjectFromDocumentPage . . . . . . . . . . 8.23.3.13 FixObjectReferences . . . . . . . . . . . . . . . . 8.23.3.14 GetAcroForm . . . . . . . . . . . . . . . . . . . . 8.23.3.15 GetCatalog . . . . . . . . . . . . . . . . . . . . . . 8.23.3.16 GetCatalog . . . . . . . . . . . . . . . . . . . . . . 8.23.3.17 GetFontLibrary . . . . . . . . . . . . . . . . . . . 8.23.3.18 GetInfo . . . . . . . . . . . . . . . . . . . . . . . . 8.23.3.19 GetNamedObjectFromCatalog . . . . . . . . . . . 8.23.3.20 GetNamesTree . . . . . . . . . . . . . . . . . . . . 8.23.3.21 GetObjects . . . . . . . . . . . . . . . . . . . . . . 8.23.3.22 GetObjects . . . . . . . . . . . . . . . . . . . . . . 8.23.3.23 GetOutlines . . . . . . . . . . . . . . . . . . . . . 8.23.3.24 GetPage . . . . . . . . . . . . . . . . . . . . . . . 8.23.3.25 GetPageCount . . . . . . . . . . . . . . . . . . . .
xi 97 97 97 98 100 100 100 100 100 100 101 101 101 101 102 102 103 103 104 104 104 104 105 105 105 105 106 106 106 106 107 107 107 107
xii
CONTENTS 8.23.3.26 GetPageMode . . . . . . . . . . . . . . . . . . . . 8.23.3.27 GetPagesTree . . . . . . . . . . . . . . . . . . . . 8.23.3.28 GetPdfVersion . . . . . . . . . . . . . . . . . . . . 8.23.3.29 GetTrailer . . . . . . . . . . . . . . . . . . . . . . 8.23.3.30 GetTrailer . . . . . . . . . . . . . . . . . . . . . . 8.23.3.31 GetWriteMode . . . . . . . . . . . . . . . . . . . . 8.23.3.32 InitPagesTree . . . . . . . . . . . . . . . . . . . . 8.23.3.33 IsAccessibilityAllowed . . . . . . . . . . . . . . . 8.23.3.34 IsCopyAllowed . . . . . . . . . . . . . . . . . . . 8.23.3.35 IsDocAssemblyAllowed . . . . . . . . . . . . . . . 8.23.3.36 IsEditAllowed . . . . . . . . . . . . . . . . . . . . 8.23.3.37 IsEditNotesAllowed . . . . . . . . . . . . . . . . . 8.23.3.38 IsFillAndSignAllowed . . . . . . . . . . . . . . . . 8.23.3.39 IsHighPrintAllowed . . . . . . . . . . . . . . . . . 8.23.3.40 IsLinearized . . . . . . . . . . . . . . . . . . . . . 8.23.3.41 IsPrintAllowed . . . . . . . . . . . . . . . . . . . . 8.23.3.42 SetBaseURI . . . . . . . . . . . . . . . . . . . . . 8.23.3.43 SetBindingDirection . . . . . . . . . . . . . . . . . 8.23.3.44 SetCatalog . . . . . . . . . . . . . . . . . . . . . . 8.23.3.45 SetCenterWindow . . . . . . . . . . . . . . . . . . 8.23.3.46 SetDisplayDocTitle . . . . . . . . . . . . . . . . . 8.23.3.47 SetFitWindow . . . . . . . . . . . . . . . . . . . . 8.23.3.48 SetHideMenubar . . . . . . . . . . . . . . . . . . . 8.23.3.49 SetHideToolbar . . . . . . . . . . . . . . . . . . . 8.23.3.50 SetHideWindowUI . . . . . . . . . . . . . . . . . 8.23.3.51 SetInfo . . . . . . . . . . . . . . . . . . . . . . . . 8.23.3.52 SetLanguage . . . . . . . . . . . . . . . . . . . . . 8.23.3.53 SetPageLayout . . . . . . . . . . . . . . . . . . . . 8.23.3.54 SetPageMode . . . . . . . . . . . . . . . . . . . . 8.23.3.55 SetPrintScaling . . . . . . . . . . . . . . . . . . . 8.23.3.56 SetTrailer . . . . . . . . . . . . . . . . . . . . . . 8.23.3.57 SetUseFullScreen . . . . . . . . . . . . . . . . . . 8.23.3.58 SetViewerPreference . . . . . . . . . . . . . . . . 8.23.3.59 SetViewerPreference . . . . . . . . . . . . . . . . 108 108 108 108 108 109 109 109 109 110 110 110 111 111 111 111 112 112 112 112 112 112 113 113 113 113 113 113 113 114 114 114 114 114
CONTENTS 8.24 PoDoFo::PdfElement Class Reference . . . . . . . . . . . . . . . . . 8.24.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.24.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.24.2.1 PdfElement . . . . . . . . . . . . . . . . . . . . . 8.24.2.2 PdfElement . . . . . . . . . . . . . . . . . . . . . 8.24.2.3 PdfElement . . . . . . . . . . . . . . . . . . . . . 8.24.2.4 PdfElement . . . . . . . . . . . . . . . . . . . . . 8.24.3 Member Function Documentation . . . . . . . . . . . . . . . 8.24.3.1 CreateObject . . . . . . . . . . . . . . . . . . . . . 8.24.3.2 GetNonConstObject . . . . . . . . . . . . . . . . . 8.24.3.3 GetObject . . . . . . . . . . . . . . . . . . . . . . 8.24.3.4 GetObject . . . . . . . . . . . . . . . . . . . . . . 8.24.3.5 TypeNameForIndex . . . . . . . . . . . . . . . . . 8.24.3.6 TypeNameToIndex . . . . . . . . . . . . . . . . . 8.25 PoDoFo::PdfEncoding Class Reference . . . . . . . . . . . . . . . . 8.25.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.25.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.25.2.1 PdfEncoding . . . . . . . . . . . . . . . . . . . . . 8.25.3 Member Function Documentation . . . . . . . . . . . . . . . 8.25.3.1 AddToDictionary . . . . . . . . . . . . . . . . . . 8.25.3.2 begin . . . . . . . . . . . . . . . . . . . . . . . . . 8.25.3.3 ConvertToEncoding . . . . . . . . . . . . . . . . . 8.25.3.4 ConvertToUnicode . . . . . . . . . . . . . . . . . . 8.25.3.5 end . . . . . . . . . . . . . . . . . . . . . . . . . . 8.25.3.6 GetCharCode . . . . . . . . . . . . . . . . . . . . 8.25.3.7 GetFirstChar . . . . . . . . . . . . . . . . . . . . . 8.25.3.8 GetID . . . . . . . . . . . . . . . . . . . . . . . . 8.25.3.9 GetLastChar . . . . . . . . . . . . . . . . . . . . . 8.25.3.10 IsAutoDelete . . . . . . . . . . . . . . . . . . . . . 8.25.3.11 IsSingleByteEncoding . . . . . . . . . . . . . . . . 8.25.3.12 operator< . . . . . . . . . . . . . . . . . . . . . . 8.25.3.13 operator== . . . . . . . . . . . . . . . . . . . . . . 8.26 PoDoFo::PdfEncodingDifference Class Reference . . . . . . . . . . . 8.26.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . .
xiii 114 116 116 116 116 116 117 117 117 117 118 118 118 118 119 119 120 120 120 120 120 120 121 121 121 122 122 122 122 123 123 123 123 124
xiv
CONTENTS 8.26.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.26.2.1 PdfEncodingDifference . . . . . . . . . . . . . . . 8.26.2.2 PdfEncodingDifference . . . . . . . . . . . . . . . 8.26.3 Member Function Documentation . . . . . . . . . . . . . . . 8.26.3.1 AddDifference . . . . . . . . . . . . . . . . . . . . 8.26.3.2 AddDifference . . . . . . . . . . . . . . . . . . . . 8.26.3.3 Contains . . . . . . . . . . . . . . . . . . . . . . . 8.26.3.4 GetCount . . . . . . . . . . . . . . . . . . . . . . . 8.26.3.5 operator= . . . . . . . . . . . . . . . . . . . . . . . 8.26.3.6 ToArray . . . . . . . . . . . . . . . . . . . . . . . 8.27 PoDoFo::PdfEncodingFactory Class Reference . . . . . . . . . . . . 8.27.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.27.2 Member Function Documentation . . . . . . . . . . . . . . . 8.27.2.1 FreeGlobalEncodingInstances . . . . . . . . . . . . 8.27.2.2 GlobalMacExpertEncodingInstance . . . . . . . . . 8.27.2.3 GlobalMacRomanEncodingInstance . . . . . . . . 8.27.2.4 GlobalPdfDocEncodingInstance . . . . . . . . . . 8.27.2.5 GlobalStandardEncodingInstance . . . . . . . . . . 8.27.2.6 GlobalSymbolEncodingInstance . . . . . . . . . . 8.27.2.7 GlobalWinAnsiEncodingInstance . . . . . . . . . . 8.27.2.8 GlobalZapfDingbatsEncodingInstance . . . . . . . 8.28 PoDoFo::PdfEncodingObjectFactory Class Reference . . . . . . . . . 8.28.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.28.2 Member Function Documentation . . . . . . . . . . . . . . . 8.28.2.1 CreateEncoding . . . . . . . . . . . . . . . . . . . 8.29 PoDoFo::PdfEncrypt Class Reference . . . . . . . . . . . . . . . . . 8.29.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.29.2 Member Enumeration Documentation . . . . . . . . . . . . . 8.29.2.1 EPdfEncryptAlgorithm . . . . . . . . . . . . . . . 8.29.2.2 EPdfKeyLength . . . . . . . . . . . . . . . . . . . 8.29.2.3 EPdfPermissions . . . . . . . . . . . . . . . . . . . 8.29.3 Constructor & Destructor Documentation . . . . . . . . . . . 8.29.3.1 PdfEncrypt . . . . . . . . . . . . . . . . . . . . . 8.29.4 Member Function Documentation . . . . . . . . . . . . . . . 124 124 124 124 124 124 124 125 125 125 125 126 126 126 126 126 126 127 127 127 127 128 128 128 128 128 132 132 132 132 132 133 133 133
CONTENTS 8.29.4.1 Authenticate . . . . . . . . . . . . . . . . . . . . . 8.29.4.2 CreateEncryptionDictionary . . . . . . . . . . . . . 8.29.4.3 CreateEncryptionInputStream . . . . . . . . . . . . 8.29.4.4 CreateEncryptionOutputStream . . . . . . . . . . . 8.29.4.5 CreateObjKey . . . . . . . . . . . . . . . . . . . . 8.29.4.6 CreatePdfEncrypt . . . . . . . . . . . . . . . . . . 8.29.4.7 CreatePdfEncrypt . . . . . . . . . . . . . . . . . . 8.29.4.8 CreatePdfEncrypt . . . . . . . . . . . . . . . . . . 8.29.4.9 GenerateEncryptionKey . . . . . . . . . . . . . . . 8.29.4.10 GetEnabledEncryptionAlgorithms . . . . . . . . . 8.29.4.11 GetEncryptAlgorithm . . . . . . . . . . . . . . . . 8.29.4.12 GetMD5String . . . . . . . . . . . . . . . . . . . . 8.29.4.13 IsAccessibilityAllowed . . . . . . . . . . . . . . . 8.29.4.14 IsCopyAllowed . . . . . . . . . . . . . . . . . . . 8.29.4.15 IsDocAssemblyAllowed . . . . . . . . . . . . . . . 8.29.4.16 IsEditAllowed . . . . . . . . . . . . . . . . . . . . 8.29.4.17 IsEditNotesAllowed . . . . . . . . . . . . . . . . . 8.29.4.18 IsEncryptionEnabled . . . . . . . . . . . . . . . . 8.29.4.19 IsFillAndSignAllowed . . . . . . . . . . . . . . . . 8.29.4.20 IsHighPrintAllowed . . . . . . . . . . . . . . . . . 8.29.4.21 IsPrintAllowed . . . . . . . . . . . . . . . . . . . . 8.29.4.22 operator= . . . . . . . . . . . . . . . . . . . . . . . 8.29.4.23 RC4 . . . . . . . . . . . . . . . . . . . . . . . . . 8.29.4.24 SetCurrentReference . . . . . . . . . . . . . . . . . 8.29.4.25 SetEnabledEncryptionAlgorithms . . . . . . . . . . 8.30 PoDoFo::PdfEncryptAES Class Reference . . . . . . . . . . . . . . . 8.30.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.30.2 Member Function Documentation . . . . . . . . . . . . . . . 8.30.2.1 CreateEncryptionDictionary . . . . . . . . . . . . . 8.30.2.2 CreateEncryptionInputStream . . . . . . . . . . . . 8.30.2.3 CreateEncryptionOutputStream . . . . . . . . . . . 8.31 PoDoFo::PdfEncryptRC4 Class Reference . . . . . . . . . . . . . . . 8.31.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.31.2 Member Function Documentation . . . . . . . . . . . . . . .
xv 133 133 134 134 134 135 135 136 136 136 136 136 137 137 137 138 138 138 138 139 139 139 139 140 140 140 141 141 141 141 142 142 142 143
xvi
CONTENTS 8.31.2.1 CreateEncryptionDictionary . . . . . . . . . . . . . 8.31.2.2 CreateEncryptionInputStream . . . . . . . . . . . . 8.31.2.3 CreateEncryptionOutputStream . . . . . . . . . . . 8.32 PoDoFo::PdfError Class Reference . . . . . . . . . . . . . . . . . . . 8.32.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.32.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.32.2.1 PdfError . . . . . . . . . . . . . . . . . . . . . . . 8.32.2.2 PdfError . . . . . . . . . . . . . . . . . . . . . . . 8.32.2.3 PdfError . . . . . . . . . . . . . . . . . . . . . . . 8.32.3 Member Function Documentation . . . . . . . . . . . . . . . 8.32.3.1 AddToCallstack . . . . . . . . . . . . . . . . . . . 8.32.3.2 DebugEnabled . . . . . . . . . . . . . . . . . . . . 8.32.3.3 DebugMessage . . . . . . . . . . . . . . . . . . . . 8.32.3.4 EnableDebug . . . . . . . . . . . . . . . . . . . . 8.32.3.5 EnableLogging . . . . . . . . . . . . . . . . . . . 8.32.3.6 ErrorMessage . . . . . . . . . . . . . . . . . . . . 8.32.3.7 ErrorName . . . . . . . . . . . . . . . . . . . . . . 8.32.3.8 GetCallstack . . . . . . . . . . . . . . . . . . . . . 8.32.3.9 GetError . . . . . . . . . . . . . . . . . . . . . . . 8.32.3.10 IsError . . . . . . . . . . . . . . . . . . . . . . . . 8.32.3.11 LoggingEnabled . . . . . . . . . . . . . . . . . . . 8.32.3.12 LogMessage . . . . . . . . . . . . . . . . . . . . . 8.32.3.13 LogMessage . . . . . . . . . . . . . . . . . . . . . 8.32.3.14 operator!= . . . . . . . . . . . . . . . . . . . . . . 8.32.3.15 operator!= . . . . . . . . . . . . . . . . . . . . . . 8.32.3.16 operator= . . . . . . . . . . . . . . . . . . . . . . . 8.32.3.17 operator= . . . . . . . . . . . . . . . . . . . . . . . 8.32.3.18 operator== . . . . . . . . . . . . . . . . . . . . . . 8.32.3.19 operator== . . . . . . . . . . . . . . . . . . . . . . 8.32.3.20 PrintErrorMsg . . . . . . . . . . . . . . . . . . . . 8.32.3.21 SetError . . . . . . . . . . . . . . . . . . . . . . . 8.32.3.22 SetErrorInformation . . . . . . . . . . . . . . . . . 8.32.3.23 SetErrorInformation . . . . . . . . . . . . . . . . . 8.32.3.24 SetLogMessageCallback . . . . . . . . . . . . . . 143 143 143 144 145 145 145 145 145 145 145 146 146 146 146 146 147 147 147 147 147 148 148 148 148 149 149 149 149 150 150 150 150 150
CONTENTS 8.32.3.25 what . . . . . . . . . . . . . . . . . . . . . . . . . 8.33 PoDoFo::PdfExponentialFunction Class Reference . . . . . . . . . . 8.33.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.33.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.33.2.1 PdfExponentialFunction . . . . . . . . . . . . . . . 8.33.2.2 PdfExponentialFunction . . . . . . . . . . . . . . . 8.34 PoDoFo::PdfExtGState Class Reference . . . . . . . . . . . . . . . . 8.34.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.34.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.34.2.1 PdfExtGState . . . . . . . . . . . . . . . . . . . . 8.34.2.2 PdfExtGState . . . . . . . . . . . . . . . . . . . . 8.34.3 Member Function Documentation . . . . . . . . . . . . . . . 8.34.3.1 GetIdentier . . . . . . . . . . . . . . . . . . . . . 8.34.3.2 SetBlendMode . . . . . . . . . . . . . . . . . . . . 8.34.3.3 SetFillOpacity . . . . . . . . . . . . . . . . . . . . 8.34.3.4 SetFillOverprint . . . . . . . . . . . . . . . . . . . 8.34.3.5 SetFrequency . . . . . . . . . . . . . . . . . . . . 8.34.3.6 SetNonZeroOverprint . . . . . . . . . . . . . . . . 8.34.3.7 SetOverprint . . . . . . . . . . . . . . . . . . . . . 8.34.3.8 SetRenderingIntent . . . . . . . . . . . . . . . . . 8.34.3.9 SetStrokeOpacity . . . . . . . . . . . . . . . . . . 8.34.3.10 SetStrokeOverprint . . . . . . . . . . . . . . . . . 8.35 PoDoFo::PdfFileInputStream Class Reference . . . . . . . . . . . . . 8.35.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.35.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.35.2.1 PdfFileInputStream . . . . . . . . . . . . . . . . . 8.35.3 Member Function Documentation . . . . . . . . . . . . . . . 8.35.3.1 GetFileLength . . . . . . . . . . . . . . . . . . . . 8.35.3.2 Read . . . . . . . . . . . . . . . . . . . . . . . . . 8.36 PoDoFo::PdfFileOutputStream Class Reference . . . . . . . . . . . . 8.36.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.36.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.36.2.1 PdfFileOutputStream . . . . . . . . . . . . . . . . 8.36.3 Member Function Documentation . . . . . . . . . . . . . . .
xvii 151 151 151 152 152 152 152 153 153 153 153 154 154 154 154 154 154 155 155 155 155 155 155 156 156 156 156 156 156 157 157 157 157 158
xviii
CONTENTS 8.36.3.1 Close . . . . . . . . . . . . . . . . . . . . . . . . . 8.36.3.2 Write . . . . . . . . . . . . . . . . . . . . . . . . . 158 158 158 159 159 159 159 159 159 160 160 160 160 160 161 161 161 161 162 162 162 162 163 163 164 164 164 164 164 164 165 165 165 166
8.37 PoDoFo::PdfFileSpec Class Reference . . . . . . . . . . . . . . . . . 8.37.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.37.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.37.2.1 PdfFileSpec . . . . . . . . . . . . . . . . . . . . . 8.37.3 Member Function Documentation . . . . . . . . . . . . . . . 8.37.3.1 GetFilename . . . . . . . . . . . . . . . . . . . . . 8.38 PoDoFo::PdfFileStream Class Reference . . . . . . . . . . . . . . . . 8.38.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.38.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.38.2.1 PdfFileStream . . . . . . . . . . . . . . . . . . . . 8.38.3 Member Function Documentation . . . . . . . . . . . . . . . 8.38.3.1 AppendImpl . . . . . . . . . . . . . . . . . . . . . 8.38.3.2 BeginAppendImpl . . . . . . . . . . . . . . . . . . 8.38.3.3 EndAppendImpl . . . . . . . . . . . . . . . . . . . 8.38.3.4 GetCopy . . . . . . . . . . . . . . . . . . . . . . . 8.38.3.5 GetCopy . . . . . . . . . . . . . . . . . . . . . . . 8.38.3.6 GetInternalBuffer . . . . . . . . . . . . . . . . . . 8.38.3.7 GetInternalBufferSize . . . . . . . . . . . . . . . . 8.38.3.8 GetLength . . . . . . . . . . . . . . . . . . . . . . 8.38.3.9 SetEncrypted . . . . . . . . . . . . . . . . . . . . . 8.38.3.10 Write . . . . . . . . . . . . . . . . . . . . . . . . . 8.39 PoDoFo::PdfFilter Class Reference . . . . . . . . . . . . . . . . . . . 8.39.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.39.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.39.2.1 PdfFilter . . . . . . . . . . . . . . . . . . . . . . . 8.39.2.2 PdfFilter . . . . . . . . . . . . . . . . . . . . . . 8.39.3 Member Function Documentation . . . . . . . . . . . . . . . 8.39.3.1 BeginDecode . . . . . . . . . . . . . . . . . . . . 8.39.3.2 BeginDecodeImpl . . . . . . . . . . . . . . . . . . 8.39.3.3 BeginEncode . . . . . . . . . . . . . . . . . . . . . 8.39.3.4 BeginEncodeImpl . . . . . . . . . . . . . . . . . . 8.39.3.5 CanDecode . . . . . . . . . . . . . . . . . . . . .
CONTENTS 8.39.3.6 CanEncode . . . . . . . . . . . . . . . . . . . . . . 8.39.3.7 Decode . . . . . . . . . . . . . . . . . . . . . . . . 8.39.3.8 DecodeBlock . . . . . . . . . . . . . . . . . . . . 8.39.3.9 DecodeBlockImpl . . . . . . . . . . . . . . . . . . 8.39.3.10 Encode . . . . . . . . . . . . . . . . . . . . . . . . 8.39.3.11 EncodeBlock . . . . . . . . . . . . . . . . . . . . . 8.39.3.12 EncodeBlockImpl . . . . . . . . . . . . . . . . . . 8.39.3.13 EndDecode . . . . . . . . . . . . . . . . . . . . . 8.39.3.14 EndDecodeImpl . . . . . . . . . . . . . . . . . . . 8.39.3.15 EndEncode . . . . . . . . . . . . . . . . . . . . . . 8.39.3.16 EndEncodeImpl . . . . . . . . . . . . . . . . . . . 8.39.3.17 FailEncodeDecode . . . . . . . . . . . . . . . . . . 8.39.3.18 GetType . . . . . . . . . . . . . . . . . . . . . . . 8.40 PoDoFo::PdfFilteredDecodeStream Class Reference . . . . . . . . . 8.40.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.40.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.40.2.1 PdfFilteredDecodeStream . . . . . . . . . . . . . . 8.40.3 Member Function Documentation . . . . . . . . . . . . . . . 8.40.3.1 Close . . . . . . . . . . . . . . . . . . . . . . . . . 8.40.3.2 Write . . . . . . . . . . . . . . . . . . . . . . . . . 8.41 PoDoFo::PdfFilteredEncodeStream Class Reference . . . . . . . . . . 8.41.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.41.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.41.2.1 PdfFilteredEncodeStream . . . . . . . . . . . . . . 8.41.3 Member Function Documentation . . . . . . . . . . . . . . . 8.41.3.1 Close . . . . . . . . . . . . . . . . . . . . . . . . . 8.41.3.2 Write . . . . . . . . . . . . . . . . . . . . . . . . . 8.42 PoDoFo::PdfFilterFactory Class Reference . . . . . . . . . . . . . . . 8.42.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.42.2 Member Function Documentation . . . . . . . . . . . . . . . 8.42.2.1 Create . . . . . . . . . . . . . . . . . . . . . . . . 8.42.2.2 CreateDecodeStream . . . . . . . . . . . . . . . . 8.42.2.3 CreateEncodeStream . . . . . . . . . . . . . . . . 8.42.2.4 CreateFilterList . . . . . . . . . . . . . . . . . . .
xix 166 166 167 167 168 168 168 169 169 169 170 170 170 170 171 171 171 172 172 172 172 172 173 173 173 173 173 173 174 174 174 174 175 175
xx
CONTENTS 8.42.2.5 FilterNameToType . . . . . . . . . . . . . . . . . . 8.42.2.6 FilterTypeToName . . . . . . . . . . . . . . . . . . 8.43 PoDoFo::PdfFlateFilter Class Reference . . . . . . . . . . . . . . . . 8.43.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.43.2 Member Function Documentation . . . . . . . . . . . . . . . 8.43.2.1 BeginDecodeImpl . . . . . . . . . . . . . . . . . . 8.43.2.2 BeginEncodeImpl . . . . . . . . . . . . . . . . . . 8.43.2.3 CanDecode . . . . . . . . . . . . . . . . . . . . . 8.43.2.4 CanEncode . . . . . . . . . . . . . . . . . . . . . . 8.43.2.5 DecodeBlockImpl . . . . . . . . . . . . . . . . . . 8.43.2.6 EncodeBlockImpl . . . . . . . . . . . . . . . . . . 8.43.2.7 EndDecodeImpl . . . . . . . . . . . . . . . . . . . 8.43.2.8 EndEncodeImpl . . . . . . . . . . . . . . . . . . . 8.43.2.9 GetType . . . . . . . . . . . . . . . . . . . . . . . 8.44 PoDoFo::PdfFont Class Reference . . . . . . . . . . . . . . . . . . . 8.44.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.44.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.44.2.1 PdfFont . . . . . . . . . . . . . . . . . . . . . . . 8.44.2.2 PdfFont . . . . . . . . . . . . . . . . . . . . . . . 8.44.3 Member Function Documentation . . . . . . . . . . . . . . . 8.44.3.1 AddUsedGlyphname . . . . . . . . . . . . . . . . 8.44.3.2 AddUsedSubsettingGlyphs . . . . . . . . . . . . . 8.44.3.3 EmbedFont . . . . . . . . . . . . . . . . . . . . . 8.44.3.4 EmbedSubsetFont . . . . . . . . . . . . . . . . . . 8.44.3.5 GetBaseFont . . . . . . . . . . . . . . . . . . . . . 8.44.3.6 GetEncoding . . . . . . . . . . . . . . . . . . . . . 8.44.3.7 GetFontCharSpace . . . . . . . . . . . . . . . . . . 8.44.3.8 GetFontMetrics . . . . . . . . . . . . . . . . . . . 8.44.3.9 GetFontMetrics2 . . . . . . . . . . . . . . . . . . . 8.44.3.10 GetFontScale . . . . . . . . . . . . . . . . . . . . 8.44.3.11 GetFontSize . . . . . . . . . . . . . . . . . . . . . 8.44.3.12 GetIdentier . . . . . . . . . . . . . . . . . . . . . 8.44.3.13 IsBold . . . . . . . . . . . . . . . . . . . . . . . . 8.44.3.14 IsItalic . . . . . . . . . . . . . . . . . . . . . . . . 176 176 176 177 177 177 177 178 178 178 178 179 179 179 180 181 181 181 181 182 182 182 182 182 183 183 183 183 183 184 184 184 184 184
CONTENTS 8.44.3.15 IsStrikeOut . . . . . . . . . . . . . . . . . . . . . . 8.44.3.16 IsSubsetting . . . . . . . . . . . . . . . . . . . . . 8.44.3.17 IsUnderlined . . . . . . . . . . . . . . . . . . . . . 8.44.3.18 SetFontCharSpace . . . . . . . . . . . . . . . . . . 8.44.3.19 SetFontScale . . . . . . . . . . . . . . . . . . . . . 8.44.3.20 SetFontSize . . . . . . . . . . . . . . . . . . . . . 8.44.3.21 SetStrikeOut . . . . . . . . . . . . . . . . . . . . . 8.44.3.22 SetUnderlined . . . . . . . . . . . . . . . . . . . . 8.44.3.23 WriteStringToStream . . . . . . . . . . . . . . . . 8.45 PoDoFo::PdfFontCache Class Reference . . . . . . . . . . . . . . . . 8.45.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.45.2 Member Enumeration Documentation . . . . . . . . . . . . . 8.45.2.1 EFontCreationFlags . . . . . . . . . . . . . . . . . 8.45.3 Constructor & Destructor Documentation . . . . . . . . . . . 8.45.3.1 PdfFontCache . . . . . . . . . . . . . . . . . . . . 8.45.3.2 PdfFontCache . . . . . . . . . . . . . . . . . . . 8.45.4 Member Function Documentation . . . . . . . . . . . . . . . 8.45.4.1 EmbedSubsetFonts . . . . . . . . . . . . . . . . . 8.45.4.2 EmptyCache . . . . . . . . . . . . . . . . . . . . . 8.45.4.3 GetDuplicateFontType1 . . . . . . . . . . . . . . . 8.45.4.4 GetFont . . . . . . . . . . . . . . . . . . . . . . . 8.45.4.5 GetFont . . . . . . . . . . . . . . . . . . . . . . . 8.45.4.6 GetFont . . . . . . . . . . . . . . . . . . . . . . . 8.45.4.7 GetFontLibrary . . . . . . . . . . . . . . . . . . . 8.45.4.8 GetFontSubset . . . . . . . . . . . . . . . . . . . . 8.46 PoDoFo::PdfFontCID Class Reference . . . . . . . . . . . . . . . . . 8.46.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.46.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.46.2.1 PdfFontCID . . . . . . . . . . . . . . . . . . . . . 8.46.2.2 PdfFontCID . . . . . . . . . . . . . . . . . . . . . 8.46.3 Member Function Documentation . . . . . . . . . . . . . . . 8.46.3.1 EmbedFont . . . . . . . . . . . . . . . . . . . . . 8.46.3.2 EmbedFont . . . . . . . . . . . . . . . . . . . . . 8.46.3.3 Init . . . . . . . . . . . . . . . . . . . . . . . . . .
xxi 185 185 185 185 185 185 186 186 186 186 187 187 187 187 187 188 188 188 188 188 188 189 189 190 190 190 191 191 191 191 192 192 192 192
xxii
CONTENTS 192 192 193 193 193 193 194 195 195 195 195 196 196 196 196 197 197 197 197 198 198 198 198 198 199 199 199 199 200 200 200 200 200 201
8.47 PoDoFo::PdfFontFactory Class Reference . . . . . . . . . . . . . . . 8.47.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.47.2 Member Function Documentation . . . . . . . . . . . . . . . 8.47.2.1 CreateFont . . . . . . . . . . . . . . . . . . . . . . 8.47.2.2 CreateFontObject . . . . . . . . . . . . . . . . . . 8.47.2.3 GetFontType . . . . . . . . . . . . . . . . . . . . . 8.48 PoDoFo::PdfFontMetrics Class Reference . . . . . . . . . . . . . . . 8.48.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.48.2 Member Function Documentation . . . . . . . . . . . . . . . 8.48.2.1 CharWidth . . . . . . . . . . . . . . . . . . . . . . 8.48.2.2 CharWidthMM . . . . . . . . . . . . . . . . . . . 8.48.2.3 FontTypeFromFilename . . . . . . . . . . . . . . . 8.48.2.4 GetAscent . . . . . . . . . . . . . . . . . . . . . . 8.48.2.5 GetBoundingBox . . . . . . . . . . . . . . . . . . 8.48.2.6 GetDescent . . . . . . . . . . . . . . . . . . . . . 8.48.2.7 GetFilename . . . . . . . . . . . . . . . . . . . . . 8.48.2.8 GetFontCharSpace . . . . . . . . . . . . . . . . . . 8.48.2.9 GetFontData . . . . . . . . . . . . . . . . . . . . . 8.48.2.10 GetFontDataLen . . . . . . . . . . . . . . . . . . . 8.48.2.11 GetFontname . . . . . . . . . . . . . . . . . . . . 8.48.2.12 GetFontScale . . . . . . . . . . . . . . . . . . . . 8.48.2.13 GetFontSize . . . . . . . . . . . . . . . . . . . . . 8.48.2.14 GetFontType . . . . . . . . . . . . . . . . . . . . . 8.48.2.15 GetGlyphId . . . . . . . . . . . . . . . . . . . . . 8.48.2.16 GetGlyphWidth . . . . . . . . . . . . . . . . . . . 8.48.2.17 GetGlyphWidth . . . . . . . . . . . . . . . . . . . 8.48.2.18 GetItalicAngle . . . . . . . . . . . . . . . . . . . . 8.48.2.19 GetLineSpacing . . . . . . . . . . . . . . . . . . . 8.48.2.20 GetLineSpacingMM . . . . . . . . . . . . . . . . . 8.48.2.21 GetPdfAscent . . . . . . . . . . . . . . . . . . . . 8.48.2.22 GetPdfDescent . . . . . . . . . . . . . . . . . . . . 8.48.2.23 GetStrikeOutPosition . . . . . . . . . . . . . . . . 8.48.2.24 GetStrikeOutPositionMM . . . . . . . . . . . . . . 8.48.2.25 GetStrikeoutThickness . . . . . . . . . . . . . . .
CONTENTS 8.48.2.26 GetStrikeoutThicknessMM . . . . . . . . . . . . . 8.48.2.27 GetSubsetFontnamePrex . . . . . . . . . . . . . . 8.48.2.28 GetUnderlinePosition . . . . . . . . . . . . . . . . 8.48.2.29 GetUnderlinePositionMM . . . . . . . . . . . . . . 8.48.2.30 GetUnderlineThickness . . . . . . . . . . . . . . . 8.48.2.31 GetUnderlineThicknessMM . . . . . . . . . . . . . 8.48.2.32 GetWeight . . . . . . . . . . . . . . . . . . . . . . 8.48.2.33 GetWidthArray . . . . . . . . . . . . . . . . . . . 8.48.2.34 IsSymbol . . . . . . . . . . . . . . . . . . . . . . . 8.48.2.35 SetFontCharSpace . . . . . . . . . . . . . . . . . . 8.48.2.36 SetFontScale . . . . . . . . . . . . . . . . . . . . . 8.48.2.37 SetFontSize . . . . . . . . . . . . . . . . . . . . . 8.48.2.38 SetFontType . . . . . . . . . . . . . . . . . . . . . 8.48.2.39 StringWidth . . . . . . . . . . . . . . . . . . . . . 8.48.2.40 StringWidth . . . . . . . . . . . . . . . . . . . . . 8.48.2.41 StringWidth . . . . . . . . . . . . . . . . . . . . . 8.48.2.42 StringWidth . . . . . . . . . . . . . . . . . . . . . 8.48.2.43 StringWidthMM . . . . . . . . . . . . . . . . . . . 8.48.2.44 StringWidthMM . . . . . . . . . . . . . . . . . . . 8.48.2.45 StringWidthMM . . . . . . . . . . . . . . . . . . . 8.48.2.46 UnicodeCharWidth . . . . . . . . . . . . . . . . . 8.49 PoDoFo::PdfFontSimple Class Reference . . . . . . . . . . . . . . . 8.49.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.49.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.49.2.1 PdfFontSimple . . . . . . . . . . . . . . . . . . . . 8.49.2.2 PdfFontSimple . . . . . . . . . . . . . . . . . . . . 8.49.3 Member Function Documentation . . . . . . . . . . . . . . . 8.49.3.1 EmbedFont . . . . . . . . . . . . . . . . . . . . . 8.49.3.2 EmbedFontFile . . . . . . . . . . . . . . . . . . . 8.49.3.3 Init . . . . . . . . . . . . . . . . . . . . . . . . . . 8.50 PoDoFo::PdfFontTrueType Class Reference . . . . . . . . . . . . . . 8.50.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.50.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.50.2.1 PdfFontTrueType . . . . . . . . . . . . . . . . . .
xxiii 201 201 201 201 202 202 202 202 202 203 203 203 203 203 204 204 204 205 205 205 206 206 206 207 207 207 207 207 207 208 208 208 209 209
xxiv
CONTENTS 8.50.2.2 PdfFontTrueType . . . . . . . . . . . . . . . . . . 209 209 210 210 210 210 210 210 211 211 211 211 211 212 212 212 212 213 213 213 213 214 214 214 214 215 215 215 215 216 216 216 216 216
8.51 PoDoFo::PdfFontTTFSubset Class Reference . . . . . . . . . . . . . 8.51.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.51.2 Member Enumeration Documentation . . . . . . . . . . . . . 8.51.2.1 EFontFileType . . . . . . . . . . . . . . . . . . . . 8.51.3 Constructor & Destructor Documentation . . . . . . . . . . . 8.51.3.1 PdfFontTTFSubset . . . . . . . . . . . . . . . . . 8.51.3.2 PdfFontTTFSubset . . . . . . . . . . . . . . . . . 8.51.4 Member Function Documentation . . . . . . . . . . . . . . . 8.51.4.1 AddCharacter . . . . . . . . . . . . . . . . . . . . 8.51.4.2 AddGlyph . . . . . . . . . . . . . . . . . . . . . . 8.51.4.3 BuildFont . . . . . . . . . . . . . . . . . . . . . . 8.51.4.4 GetSize . . . . . . . . . . . . . . . . . . . . . . . 8.52 PoDoFo::PdfFontType1 Class Reference . . . . . . . . . . . . . . . . 8.52.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.52.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.52.2.1 PdfFontType1 . . . . . . . . . . . . . . . . . . . . 8.52.2.2 PdfFontType1 . . . . . . . . . . . . . . . . . . . . 8.52.2.3 PdfFontType1 . . . . . . . . . . . . . . . . . . . . 8.52.3 Member Function Documentation . . . . . . . . . . . . . . . 8.52.3.1 AddUsedGlyphname . . . . . . . . . . . . . . . . 8.52.3.2 AddUsedSubsettingGlyphs . . . . . . . . . . . . . 8.52.3.3 EmbedFontFile . . . . . . . . . . . . . . . . . . . 8.52.3.4 EmbedSubsetFont . . . . . . . . . . . . . . . . . . 8.53 PoDoFo::PdfFontType1Base14 Class Reference . . . . . . . . . . . . 8.53.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.53.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.53.2.1 PdfFontType1Base14 . . . . . . . . . . . . . . . . 8.53.2.2 PdfFontType1Base14 . . . . . . . . . . . . . . . . 8.53.3 Member Function Documentation . . . . . . . . . . . . . . . 8.53.3.1 EmbedFontFile . . . . . . . . . . . . . . . . . . . 8.54 PoDoFo::PdfFunction Class Reference . . . . . . . . . . . . . . . . . 8.54.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.54.2 Constructor & Destructor Documentation . . . . . . . . . . .
CONTENTS 8.54.2.1 PdfFunction . . . . . . . . . . . . . . . . . . . . . 8.54.2.2 PdfFunction . . . . . . . . . . . . . . . . . . . . . 8.55 PoDoFo::PdfFunctionBaseShadingPattern Class Reference . . . . . . 8.55.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.55.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.55.2.1 PdfFunctionBaseShadingPattern . . . . . . . . . . 8.55.2.2 PdfFunctionBaseShadingPattern . . . . . . . . . . 8.56 PoDoFo::PdfHexFilter Class Reference . . . . . . . . . . . . . . . . 8.56.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.56.2 Member Function Documentation . . . . . . . . . . . . . . . 8.56.2.1 BeginDecodeImpl . . . . . . . . . . . . . . . . . . 8.56.2.2 CanDecode . . . . . . . . . . . . . . . . . . . . . 8.56.2.3 CanEncode . . . . . . . . . . . . . . . . . . . . . . 8.56.2.4 DecodeBlockImpl . . . . . . . . . . . . . . . . . . 8.56.2.5 EncodeBlockImpl . . . . . . . . . . . . . . . . . . 8.56.2.6 EndDecodeImpl . . . . . . . . . . . . . . . . . . . 8.56.2.7 GetType . . . . . . . . . . . . . . . . . . . . . . . 8.57 PoDoFo::PdfIdentityEncoding Class Reference . . . . . . . . . . . . 8.57.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.57.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.57.2.1 PdfIdentityEncoding . . . . . . . . . . . . . . . . . 8.57.3 Member Function Documentation . . . . . . . . . . . . . . . 8.57.3.1 AddToDictionary . . . . . . . . . . . . . . . . . . 8.57.3.2 ConvertToEncoding . . . . . . . . . . . . . . . . . 8.57.3.3 ConvertToUnicode . . . . . . . . . . . . . . . . . . 8.57.3.4 GetCharCode . . . . . . . . . . . . . . . . . . . . 8.57.3.5 GetID . . . . . . . . . . . . . . . . . . . . . . . . 8.57.3.6 IsAutoDelete . . . . . . . . . . . . . . . . . . . . . 8.57.3.7 IsSingleByteEncoding . . . . . . . . . . . . . . . . 8.58 PoDoFo::PdfImage Class Reference . . . . . . . . . . . . . . . . . . 8.58.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.58.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.58.2.1 PdfImage . . . . . . . . . . . . . . . . . . . . . . . 8.58.2.2 PdfImage . . . . . . . . . . . . . . . . . . . . . . .
xxv 216 217 217 218 218 218 218 219 219 219 219 220 220 220 220 221 221 221 222 222 222 223 223 223 223 224 224 224 224 225 225 226 226 226
xxvi
CONTENTS 8.58.2.3 PdfImage . . . . . . . . . . . . . . . . . . . . . . . 8.58.3 Member Function Documentation . . . . . . . . . . . . . . . 8.58.3.1 GetHeight . . . . . . . . . . . . . . . . . . . . . . 8.58.3.2 GetSupportedFormats . . . . . . . . . . . . . . . . 8.58.3.3 GetWidth . . . . . . . . . . . . . . . . . . . . . . 8.58.3.4 LoadFromFile . . . . . . . . . . . . . . . . . . . . 8.58.3.5 SetImageChromaKeyMask . . . . . . . . . . . . . 8.58.3.6 SetImageColorSpace . . . . . . . . . . . . . . . . 8.58.3.7 SetImageData . . . . . . . . . . . . . . . . . . . . 8.58.3.8 SetImageData . . . . . . . . . . . . . . . . . . . . 8.58.3.9 SetImageICCProle . . . . . . . . . . . . . . . . . 8.58.3.10 SetImageSoftmask . . . . . . . . . . . . . . . . . . 8.58.3.11 SetInterpolate . . . . . . . . . . . . . . . . . . . . 226 226 226 227 227 227 227 227 228 228 229 229 229 229 230 230 230 231 231 231 231 231 231 231 232 232 232 232 232 233 233 233 233 233
8.59 PoDoFo::PdfInfo Class Reference . . . . . . . . . . . . . . . . . . . 8.59.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.59.2 Member Enumeration Documentation . . . . . . . . . . . . . 8.59.2.1 EPdfInfoInitial . . . . . . . . . . . . . . . . . . . . 8.59.3 Constructor & Destructor Documentation . . . . . . . . . . . 8.59.3.1 PdfInfo . . . . . . . . . . . . . . . . . . . . . . . . 8.59.3.2 PdfInfo . . . . . . . . . . . . . . . . . . . . . . . . 8.59.3.3 PdfInfo . . . . . . . . . . . . . . . . . . . . . . . 8.59.4 Member Function Documentation . . . . . . . . . . . . . . . 8.59.4.1 GetAuthor . . . . . . . . . . . . . . . . . . . . . . 8.59.4.2 GetCreator . . . . . . . . . . . . . . . . . . . . . . 8.59.4.3 GetKeywords . . . . . . . . . . . . . . . . . . . . 8.59.4.4 GetProducer . . . . . . . . . . . . . . . . . . . . . 8.59.4.5 GetSubject . . . . . . . . . . . . . . . . . . . . . . 8.59.4.6 GetTitle . . . . . . . . . . . . . . . . . . . . . . . 8.59.4.7 GetTrapped . . . . . . . . . . . . . . . . . . . . . 8.59.4.8 SetAuthor . . . . . . . . . . . . . . . . . . . . . . 8.59.4.9 SetCreator . . . . . . . . . . . . . . . . . . . . . . 8.59.4.10 SetKeywords . . . . . . . . . . . . . . . . . . . . . 8.59.4.11 SetProducer . . . . . . . . . . . . . . . . . . . . . 8.59.4.12 SetSubject . . . . . . . . . . . . . . . . . . . . . .
CONTENTS 8.59.4.13 SetTitle . . . . . . . . . . . . . . . . . . . . . . . . 8.59.4.14 SetTrapped . . . . . . . . . . . . . . . . . . . . . . 8.60 PoDoFo::PdfInputDevice Class Reference . . . . . . . . . . . . . . . 8.60.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.60.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.60.2.1 PdfInputDevice . . . . . . . . . . . . . . . . . . . 8.60.2.2 PdfInputDevice . . . . . . . . . . . . . . . . . . . 8.60.2.3 PdfInputDevice . . . . . . . . . . . . . . . . . . . 8.60.2.4 PdfInputDevice . . . . . . . . . . . . . . . . . . 8.60.2.5 PdfInputDevice . . . . . . . . . . . . . . . . . . . 8.60.3 Member Function Documentation . . . . . . . . . . . . . . . 8.60.3.1 Bad . . . . . . . . . . . . . . . . . . . . . . . . . . 8.60.3.2 Clear . . . . . . . . . . . . . . . . . . . . . . . . . 8.60.3.3 Close . . . . . . . . . . . . . . . . . . . . . . . . . 8.60.3.4 Eof . . . . . . . . . . . . . . . . . . . . . . . . . . 8.60.3.5 GetChar . . . . . . . . . . . . . . . . . . . . . . . 8.60.3.6 IsSeekable . . . . . . . . . . . . . . . . . . . . . . 8.60.3.7 Look . . . . . . . . . . . . . . . . . . . . . . . . . 8.60.3.8 Read . . . . . . . . . . . . . . . . . . . . . . . . . 8.60.3.9 Seek . . . . . . . . . . . . . . . . . . . . . . . . . 8.60.3.10 SetSeekable . . . . . . . . . . . . . . . . . . . . . 8.60.3.11 Tell . . . . . . . . . . . . . . . . . . . . . . . . . . 8.61 PoDoFo::PdfInputStream Class Reference . . . . . . . . . . . . . . . 8.61.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.61.2 Member Function Documentation . . . . . . . . . . . . . . . 8.61.2.1 Read . . . . . . . . . . . . . . . . . . . . . . . . . 8.62 PoDoFo::PdfListBox Class Reference . . . . . . . . . . . . . . . . . 8.62.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.62.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.62.2.1 PdfListBox . . . . . . . . . . . . . . . . . . . . . . 8.62.2.2 PdfListBox . . . . . . . . . . . . . . . . . . . . . . 8.62.2.3 PdfListBox . . . . . . . . . . . . . . . . . . . . . . 8.62.2.4 PdfListBox . . . . . . . . . . . . . . . . . . . . . . 8.62.2.5 PdfListBox . . . . . . . . . . . . . . . . . . . . . .
xxvii 233 234 234 234 235 235 235 235 235 235 235 235 236 236 236 236 236 236 236 237 237 237 237 237 238 238 238 238 239 239 239 239 239 239
xxviii
CONTENTS 239 240 240 240 241 241 241 241 241 241 241 242 242 242 242 242 243 243 243 243 243 243 244 244 244 244 244 245 245 245 246 246 246 247
8.63 PoDoFo::PdfListField Class Reference . . . . . . . . . . . . . . . . . 8.63.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.63.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.63.2.1 PdfListField . . . . . . . . . . . . . . . . . . . . . 8.63.2.2 PdfListField . . . . . . . . . . . . . . . . . . . . . 8.63.2.3 PdfListField . . . . . . . . . . . . . . . . . . . . . 8.63.2.4 PdfListField . . . . . . . . . . . . . . . . . . . . . 8.63.2.5 PdfListField . . . . . . . . . . . . . . . . . . . . . 8.63.3 Member Function Documentation . . . . . . . . . . . . . . . 8.63.3.1 GetItem . . . . . . . . . . . . . . . . . . . . . . . 8.63.3.2 GetItemCount . . . . . . . . . . . . . . . . . . . . 8.63.3.3 GetItemDisplayText . . . . . . . . . . . . . . . . . 8.63.3.4 GetSelectedItem . . . . . . . . . . . . . . . . . . . 8.63.3.5 InsertItem . . . . . . . . . . . . . . . . . . . . . . 8.63.3.6 IsComboBox . . . . . . . . . . . . . . . . . . . . . 8.63.3.7 IsMultiSelect . . . . . . . . . . . . . . . . . . . . . 8.63.3.8 IsSorted . . . . . . . . . . . . . . . . . . . . . . . 8.63.3.9 IsSpellcheckingEnabled . . . . . . . . . . . . . . . 8.63.3.10 RemoveItem . . . . . . . . . . . . . . . . . . . . . 8.63.3.11 SetMultiSelect . . . . . . . . . . . . . . . . . . . . 8.63.3.12 SetSelectedItem . . . . . . . . . . . . . . . . . . . 8.63.3.13 SetSorted . . . . . . . . . . . . . . . . . . . . . . . 8.63.3.14 SetSpellcheckingEnabled . . . . . . . . . . . . . . 8.64 PoDoFo::PdfLZWFilter Class Reference . . . . . . . . . . . . . . . . 8.64.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.64.2 Member Function Documentation . . . . . . . . . . . . . . . 8.64.2.1 BeginDecodeImpl . . . . . . . . . . . . . . . . . . 8.64.2.2 BeginEncodeImpl . . . . . . . . . . . . . . . . . . 8.64.2.3 CanDecode . . . . . . . . . . . . . . . . . . . . . 8.64.2.4 CanEncode . . . . . . . . . . . . . . . . . . . . . . 8.64.2.5 DecodeBlockImpl . . . . . . . . . . . . . . . . . . 8.64.2.6 EncodeBlockImpl . . . . . . . . . . . . . . . . . . 8.64.2.7 EndDecodeImpl . . . . . . . . . . . . . . . . . . . 8.64.2.8 EndEncodeImpl . . . . . . . . . . . . . . . . . . .
CONTENTS 8.64.2.9 GetType . . . . . . . . . . . . . . . . . . . . . . . 8.65 PoDoFo::PdfMacRomanEncoding Class Reference . . . . . . . . . . 8.65.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.65.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.65.2.1 PdfMacRomanEncoding . . . . . . . . . . . . . . . 8.65.3 Member Function Documentation . . . . . . . . . . . . . . . 8.65.3.1 GetToUnicodeTable . . . . . . . . . . . . . . . . . 8.66 PoDoFo::PdfMemDocument Class Reference . . . . . . . . . . . . . 8.66.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.66.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.66.2.1 PdfMemDocument . . . . . . . . . . . . . . . . . 8.66.2.2 PdfMemDocument . . . . . . . . . . . . . . . . . 8.66.2.3 PdfMemDocument . . . . . . . . . . . . . . . . 8.66.3 Member Function Documentation . . . . . . . . . . . . . . . 8.66.3.1 DeletePages . . . . . . . . . . . . . . . . . . . . . 8.66.3.2 FreeObjectMemory . . . . . . . . . . . . . . . . . 8.66.3.3 FreeObjectMemory . . . . . . . . . . . . . . . . . 8.66.3.4 GetCatalog . . . . . . . . . . . . . . . . . . . . . . 8.66.3.5 GetCatalog . . . . . . . . . . . . . . . . . . . . . . 8.66.3.6 GetEncrypt . . . . . . . . . . . . . . . . . . . . . . 8.66.3.7 GetEncrypted . . . . . . . . . . . . . . . . . . . . 8.66.3.8 GetFont . . . . . . . . . . . . . . . . . . . . . . . 8.66.3.9 GetMarkInfo . . . . . . . . . . . . . . . . . . . . . 8.66.3.10 GetMetadata . . . . . . . . . . . . . . . . . . . . . 8.66.3.11 GetObjects . . . . . . . . . . . . . . . . . . . . . . 8.66.3.12 GetObjects . . . . . . . . . . . . . . . . . . . . . . 8.66.3.13 GetPdfVersion . . . . . . . . . . . . . . . . . . . . 8.66.3.14 GetStructTreeRoot . . . . . . . . . . . . . . . . . . 8.66.3.15 GetTrailer . . . . . . . . . . . . . . . . . . . . . . 8.66.3.16 GetWriteMode . . . . . . . . . . . . . . . . . . . . 8.66.3.17 InsertPages . . . . . . . . . . . . . . . . . . . . . . 8.66.3.18 IsAccessibilityAllowed . . . . . . . . . . . . . . . 8.66.3.19 IsCopyAllowed . . . . . . . . . . . . . . . . . . . 8.66.3.20 IsDocAssemblyAllowed . . . . . . . . . . . . . . .
xxix 247 247 248 248 248 248 248 248 250 250 250 250 251 251 251 251 252 252 252 252 253 253 253 253 253 254 254 254 254 254 255 255 255 256
xxx
CONTENTS 8.66.3.21 IsEditAllowed . . . . . . . . . . . . . . . . . . . . 8.66.3.22 IsEditNotesAllowed . . . . . . . . . . . . . . . . . 8.66.3.23 IsFillAndSignAllowed . . . . . . . . . . . . . . . . 8.66.3.24 IsHighPrintAllowed . . . . . . . . . . . . . . . . . 8.66.3.25 IsLinearized . . . . . . . . . . . . . . . . . . . . . 8.66.3.26 IsPrintAllowed . . . . . . . . . . . . . . . . . . . . 8.66.3.27 Load . . . . . . . . . . . . . . . . . . . . . . . . . 8.66.3.28 Load . . . . . . . . . . . . . . . . . . . . . . . . . 8.66.3.29 Load . . . . . . . . . . . . . . . . . . . . . . . . . 8.66.3.30 SetEncrypted . . . . . . . . . . . . . . . . . . . . . 8.66.3.31 SetEncrypted . . . . . . . . . . . . . . . . . . . . . 8.66.3.32 SetPassword . . . . . . . . . . . . . . . . . . . . . 8.66.3.33 SetPdfVersion . . . . . . . . . . . . . . . . . . . . 8.66.3.34 SetWriteMode . . . . . . . . . . . . . . . . . . . . 8.66.3.35 Write . . . . . . . . . . . . . . . . . . . . . . . . . 8.66.3.36 Write . . . . . . . . . . . . . . . . . . . . . . . . . 8.67 PoDoFo::PdfMemoryInputStream Class Reference . . . . . . . . . . 8.67.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.67.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.67.2.1 PdfMemoryInputStream . . . . . . . . . . . . . . . 8.67.3 Member Function Documentation . . . . . . . . . . . . . . . 8.67.3.1 Read . . . . . . . . . . . . . . . . . . . . . . . . . 8.68 PoDoFo::PdfMemoryOutputStream Class Reference . . . . . . . . . 8.68.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.68.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.68.2.1 PdfMemoryOutputStream . . . . . . . . . . . . . . 8.68.2.2 PdfMemoryOutputStream . . . . . . . . . . . . . . 8.68.3 Member Function Documentation . . . . . . . . . . . . . . . 8.68.3.1 Close . . . . . . . . . . . . . . . . . . . . . . . . . 8.68.3.2 GetLength . . . . . . . . . . . . . . . . . . . . . . 8.68.3.3 TakeBuffer . . . . . . . . . . . . . . . . . . . . . . 8.68.3.4 Write . . . . . . . . . . . . . . . . . . . . . . . . . 8.69 PoDoFo::PdfMemStream Class Reference . . . . . . . . . . . . . . . 8.69.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 256 256 257 257 257 257 258 258 258 259 259 260 260 260 260 261 261 261 262 262 262 262 262 263 263 263 263 263 263 264 264 264 264 265
CONTENTS 8.69.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.69.2.1 PdfMemStream . . . . . . . . . . . . . . . . . . . 8.69.2.2 PdfMemStream . . . . . . . . . . . . . . . . . . . 8.69.3 Member Function Documentation . . . . . . . . . . . . . . . 8.69.3.1 AppendImpl . . . . . . . . . . . . . . . . . . . . . 8.69.3.2 BeginAppendImpl . . . . . . . . . . . . . . . . . . 8.69.3.3 Empty . . . . . . . . . . . . . . . . . . . . . . . . 8.69.3.4 EndAppendImpl . . . . . . . . . . . . . . . . . . . 8.69.3.5 FlateCompress . . . . . . . . . . . . . . . . . . . . 8.69.3.6 Get . . . . . . . . . . . . . . . . . . . . . . . . . . 8.69.3.7 GetCopy . . . . . . . . . . . . . . . . . . . . . . . 8.69.3.8 GetCopy . . . . . . . . . . . . . . . . . . . . . . . 8.69.3.9 GetInternalBuffer . . . . . . . . . . . . . . . . . . 8.69.3.10 GetInternalBufferSize . . . . . . . . . . . . . . . . 8.69.3.11 GetLength . . . . . . . . . . . . . . . . . . . . . . 8.69.3.12 operator= . . . . . . . . . . . . . . . . . . . . . . . 8.69.3.13 Uncompress . . . . . . . . . . . . . . . . . . . . . 8.69.3.14 Write . . . . . . . . . . . . . . . . . . . . . . . . . 8.70 PoDoFo::Util::PdfMutexImpl Class Reference . . . . . . . . . . . . . 8.70.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.70.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.70.2.1 PdfMutexImpl . . . . . . . . . . . . . . . . . . . . 8.70.2.2 PdfMutexImpl . . . . . . . . . . . . . . . . . . . . 8.70.3 Member Function Documentation . . . . . . . . . . . . . . . 8.70.3.1 Lock . . . . . . . . . . . . . . . . . . . . . . . . . 8.70.3.2 Lock . . . . . . . . . . . . . . . . . . . . . . . . . 8.70.3.3 Lock . . . . . . . . . . . . . . . . . . . . . . . . . 8.70.3.4 TryLock . . . . . . . . . . . . . . . . . . . . . . . 8.70.3.5 TryLock . . . . . . . . . . . . . . . . . . . . . . . 8.70.3.6 TryLock . . . . . . . . . . . . . . . . . . . . . . . 8.70.3.7 UnLock . . . . . . . . . . . . . . . . . . . . . . . 8.70.3.8 UnLock . . . . . . . . . . . . . . . . . . . . . . . 8.70.3.9 UnLock . . . . . . . . . . . . . . . . . . . . . . . 8.71 PoDoFo::Util::PdfMutexWrapper Class Reference . . . . . . . . . . .
xxxi 265 265 266 266 266 266 266 266 267 267 267 267 268 268 268 268 269 269 269 269 270 270 270 270 270 270 270 270 270 271 271 271 271 271
xxxii
CONTENTS 8.71.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.71.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.71.2.1 PdfMutexWrapper . . . . . . . . . . . . . . . . . . 8.71.2.2 PdfMutexWrapper . . . . . . . . . . . . . . . . . 271 272 272 272 272 273 273 273 273 273 274 274 274 274 274 275 275 275 275 275 276 276 276 276 276 277 277 277 278 278 278 278 278 278
8.72 PoDoFo::PdfName Class Reference . . . . . . . . . . . . . . . . . . 8.72.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.72.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.72.2.1 PdfName . . . . . . . . . . . . . . . . . . . . . . . 8.72.2.2 PdfName . . . . . . . . . . . . . . . . . . . . . . . 8.72.2.3 PdfName . . . . . . . . . . . . . . . . . . . . . . . 8.72.2.4 PdfName . . . . . . . . . . . . . . . . . . . . . . . 8.72.2.5 PdfName . . . . . . . . . . . . . . . . . . . . . . . 8.72.3 Member Function Documentation . . . . . . . . . . . . . . . 8.72.3.1 FromEscaped . . . . . . . . . . . . . . . . . . . . 8.72.3.2 FromEscaped . . . . . . . . . . . . . . . . . . . . 8.72.3.3 GetEscapedName . . . . . . . . . . . . . . . . . . 8.72.3.4 GetLength . . . . . . . . . . . . . . . . . . . . . . 8.72.3.5 GetName . . . . . . . . . . . . . . . . . . . . . . . 8.72.3.6 operator!= . . . . . . . . . . . . . . . . . . . . . . 8.72.3.7 operator!= . . . . . . . . . . . . . . . . . . . . . . 8.72.3.8 operator< . . . . . . . . . . . . . . . . . . . . . . 8.72.3.9 operator= . . . . . . . . . . . . . . . . . . . . . . . 8.72.3.10 operator== . . . . . . . . . . . . . . . . . . . . . . 8.72.3.11 operator== . . . . . . . . . . . . . . . . . . . . . . 8.72.3.12 operator== . . . . . . . . . . . . . . . . . . . . . . 8.72.3.13 Write . . . . . . . . . . . . . . . . . . . . . . . . . 8.73 PoDoFo::PdfNamedColor Class Reference . . . . . . . . . . . . . . . 8.73.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.73.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.73.2.1 PdfNamedColor . . . . . . . . . . . . . . . . . . . 8.73.2.2 PdfNamedColor . . . . . . . . . . . . . . . . . . . 8.73.2.3 PdfNamedColor . . . . . . . . . . . . . . . . . . . 8.73.2.4 PdfNamedColor . . . . . . . . . . . . . . . . . . 8.73.3 Member Function Documentation . . . . . . . . . . . . . . .
CONTENTS 8.73.3.1 GetColor . . . . . . . . . . . . . . . . . . . . . . . 8.73.3.2 GetName . . . . . . . . . . . . . . . . . . . . . . . 8.73.3.3 operator< . . . . . . . . . . . . . . . . . . . . . . 8.73.3.4 operator< . . . . . . . . . . . . . . . . . . . . . . 8.73.3.5 operator== . . . . . . . . . . . . . . . . . . . . . . 8.74 PoDoFo::PdfObject Class Reference . . . . . . . . . . . . . . . . . . 8.74.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.74.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.74.2.1 PdfObject . . . . . . . . . . . . . . . . . . . . . . 8.74.2.2 PdfObject . . . . . . . . . . . . . . . . . . . . . . 8.74.2.3 PdfObject . . . . . . . . . . . . . . . . . . . . . . 8.74.2.4 PdfObject . . . . . . . . . . . . . . . . . . . . . . 8.74.2.5 PdfObject . . . . . . . . . . . . . . . . . . . . . . 8.74.2.6 PdfObject . . . . . . . . . . . . . . . . . . . . . . 8.74.2.7 PdfObject . . . . . . . . . . . . . . . . . . . . . . 8.74.2.8 PdfObject . . . . . . . . . . . . . . . . . . . . . . 8.74.2.9 PdfObject . . . . . . . . . . . . . . . . . . . . . . 8.74.2.10 PdfObject . . . . . . . . . . . . . . . . . . . . . . 8.74.2.11 PdfObject . . . . . . . . . . . . . . . . . . . . . . 8.74.2.12 PdfObject . . . . . . . . . . . . . . . . . . . . . . 8.74.2.13 PdfObject . . . . . . . . . . . . . . . . . . . . . . 8.74.3 Member Function Documentation . . . . . . . . . . . . . . . 8.74.3.1 DelayedStreamLoad . . . . . . . . . . . . . . . . . 8.74.3.2 DelayedStreamLoadImpl . . . . . . . . . . . . . . 8.74.3.3 EnableDelayedStreamLoading . . . . . . . . . . . 8.74.3.4 FlateCompressStream . . . . . . . . . . . . . . . . 8.74.3.5 GetByteOffset . . . . . . . . . . . . . . . . . . . . 8.74.3.6 GetIndirectKey . . . . . . . . . . . . . . . . . . . 8.74.3.7 GetObjectLength . . . . . . . . . . . . . . . . . . 8.74.3.8 GetOwner . . . . . . . . . . . . . . . . . . . . . . 8.74.3.9 GetStream . . . . . . . . . . . . . . . . . . . . . . 8.74.3.10 GetStream . . . . . . . . . . . . . . . . . . . . . . 8.74.3.11 GetStream_NoDL . . . . . . . . . . . . . . . . . . 8.74.3.12 HasStream . . . . . . . . . . . . . . . . . . . . . .
xxxiii 278 279 279 279 279 279 281 281 281 281 281 282 282 282 282 282 282 283 283 283 283 283 283 284 284 284 284 285 285 285 285 286 286 286
xxxiv
CONTENTS 8.74.3.13 MustGetIndirectKey . . . . . . . . . . . . . . . . . 8.74.3.14 operator< . . . . . . . . . . . . . . . . . . . . . . 8.74.3.15 operator= . . . . . . . . . . . . . . . . . . . . . . . 8.74.3.16 operator== . . . . . . . . . . . . . . . . . . . . . . 8.74.3.17 Reference . . . . . . . . . . . . . . . . . . . . . . 8.74.3.18 SetOwner . . . . . . . . . . . . . . . . . . . . . . 8.74.3.19 WriteObject . . . . . . . . . . . . . . . . . . . . . 286 286 287 287 287 287 287 288 288 288 288 288 290 290 290 290 290 291 291 291 291 291 291 292 292 292 292 292 293 293 293 293 293 294
8.75 PoDoFo::PdfObjectStreamParserObject Class Reference . . . . . . . 8.75.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.75.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.75.2.1 PdfObjectStreamParserObject . . . . . . . . . . . . 8.76 PoDoFo::PdfOutlineItem Class Reference . . . . . . . . . . . . . . . 8.76.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.76.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.76.2.1 PdfOutlineItem . . . . . . . . . . . . . . . . . . . 8.76.2.2 PdfOutlineItem . . . . . . . . . . . . . . . . . . . 8.76.2.3 PdfOutlineItem . . . . . . . . . . . . . . . . . . . 8.76.2.4 PdfOutlineItem . . . . . . . . . . . . . . . . . . . 8.76.3 Member Function Documentation . . . . . . . . . . . . . . . 8.76.3.1 CreateChild . . . . . . . . . . . . . . . . . . . . . 8.76.3.2 CreateNext . . . . . . . . . . . . . . . . . . . . . . 8.76.3.3 CreateNext . . . . . . . . . . . . . . . . . . . . . . 8.76.3.4 Erase . . . . . . . . . . . . . . . . . . . . . . . . . 8.76.3.5 First . . . . . . . . . . . . . . . . . . . . . . . . . 8.76.3.6 GetAction . . . . . . . . . . . . . . . . . . . . . . 8.76.3.7 GetDestination . . . . . . . . . . . . . . . . . . . . 8.76.3.8 GetParentOutline . . . . . . . . . . . . . . . . . . 8.76.3.9 GetTextColorBlue . . . . . . . . . . . . . . . . . . 8.76.3.10 GetTextColorGreen . . . . . . . . . . . . . . . . . 8.76.3.11 GetTextColorRed . . . . . . . . . . . . . . . . . . 8.76.3.12 GetTextFormat . . . . . . . . . . . . . . . . . . . . 8.76.3.13 GetTitle . . . . . . . . . . . . . . . . . . . . . . . 8.76.3.14 InsertChild . . . . . . . . . . . . . . . . . . . . . . 8.76.3.15 Last . . . . . . . . . . . . . . . . . . . . . . . . .
CONTENTS 8.76.3.16 Next . . . . . . . . . . . . . . . . . . . . . . . . . 8.76.3.17 Prev . . . . . . . . . . . . . . . . . . . . . . . . . 8.76.3.18 SetAction . . . . . . . . . . . . . . . . . . . . . . 8.76.3.19 SetDestination . . . . . . . . . . . . . . . . . . . . 8.76.3.20 SetTextColor . . . . . . . . . . . . . . . . . . . . . 8.76.3.21 SetTextFormat . . . . . . . . . . . . . . . . . . . . 8.76.3.22 SetTitle . . . . . . . . . . . . . . . . . . . . . . . . 8.77 PoDoFo::PdfOutlines Class Reference . . . . . . . . . . . . . . . . . 8.77.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.77.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.77.2.1 PdfOutlines . . . . . . . . . . . . . . . . . . . . . 8.77.2.2 PdfOutlines . . . . . . . . . . . . . . . . . . . . . 8.77.3 Member Function Documentation . . . . . . . . . . . . . . . 8.77.3.1 CreateRoot . . . . . . . . . . . . . . . . . . . . . . 8.78 PoDoFo::PdfOutputDevice Class Reference . . . . . . . . . . . . . . 8.78.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.78.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.78.2.1 PdfOutputDevice . . . . . . . . . . . . . . . . . . 8.78.2.2 PdfOutputDevice . . . . . . . . . . . . . . . . . . 8.78.2.3 PdfOutputDevice . . . . . . . . . . . . . . . . . . 8.78.2.4 PdfOutputDevice . . . . . . . . . . . . . . . . . . 8.78.2.5 PdfOutputDevice . . . . . . . . . . . . . . . . . . 8.78.2.6 PdfOutputDevice . . . . . . . . . . . . . . . . . 8.78.3 Member Function Documentation . . . . . . . . . . . . . . . 8.78.3.1 Flush . . . . . . . . . . . . . . . . . . . . . . . . . 8.78.3.2 GetLength . . . . . . . . . . . . . . . . . . . . . . 8.78.3.3 Print . . . . . . . . . . . . . . . . . . . . . . . . . 8.78.3.4 PrintV . . . . . . . . . . . . . . . . . . . . . . . . 8.78.3.5 PrintVLen . . . . . . . . . . . . . . . . . . . . . . 8.78.3.6 Read . . . . . . . . . . . . . . . . . . . . . . . . . 8.78.3.7 Seek . . . . . . . . . . . . . . . . . . . . . . . . . 8.78.3.8 Tell . . . . . . . . . . . . . . . . . . . . . . . . . . 8.78.3.9 Write . . . . . . . . . . . . . . . . . . . . . . . . . 8.79 PoDoFo::PdfOutputStream Class Reference . . . . . . . . . . . . . .
xxxv 294 294 294 294 294 295 295 295 295 296 296 296 296 296 296 297 297 297 297 297 298 298 298 298 298 298 299 299 300 300 300 300 301 301
xxxvi
CONTENTS 8.79.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.79.2 Member Function Documentation . . . . . . . . . . . . . . . 8.79.2.1 Close . . . . . . . . . . . . . . . . . . . . . . . . . 8.79.2.2 Write . . . . . . . . . . . . . . . . . . . . . . . . . 8.79.2.3 Write . . . . . . . . . . . . . . . . . . . . . . . . . 301 302 302 302 302 302 304 304 304 304 304 304 304 305 305 305 306 306 306 306 307 307 307 307 308 308 308 308 308 309 309 309 309 309
8.80 PoDoFo::PdfPage Class Reference . . . . . . . . . . . . . . . . . . . 8.80.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.80.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.80.2.1 PdfPage . . . . . . . . . . . . . . . . . . . . . . . 8.80.2.2 PdfPage . . . . . . . . . . . . . . . . . . . . . . . 8.80.2.3 PdfPage . . . . . . . . . . . . . . . . . . . . . . . 8.80.3 Member Function Documentation . . . . . . . . . . . . . . . 8.80.3.1 CreateAnnotation . . . . . . . . . . . . . . . . . . 8.80.3.2 CreateStandardPageSize . . . . . . . . . . . . . . . 8.80.3.3 DeleteAnnotation . . . . . . . . . . . . . . . . . . 8.80.3.4 DeleteAnnotation . . . . . . . . . . . . . . . . . . 8.80.3.5 GetAnnotation . . . . . . . . . . . . . . . . . . . . 8.80.3.6 GetArtBox . . . . . . . . . . . . . . . . . . . . . . 8.80.3.7 GetBleedBox . . . . . . . . . . . . . . . . . . . . 8.80.3.8 GetContents . . . . . . . . . . . . . . . . . . . . . 8.80.3.9 GetContentsForAppending . . . . . . . . . . . . . 8.80.3.10 GetCropBox . . . . . . . . . . . . . . . . . . . . . 8.80.3.11 GetField . . . . . . . . . . . . . . . . . . . . . . . 8.80.3.12 GetField . . . . . . . . . . . . . . . . . . . . . . . 8.80.3.13 GetFromResources . . . . . . . . . . . . . . . . . 8.80.3.14 GetInheritedKey . . . . . . . . . . . . . . . . . . . 8.80.3.15 GetMediaBox . . . . . . . . . . . . . . . . . . . . 8.80.3.16 GetNumAnnots . . . . . . . . . . . . . . . . . . . 8.80.3.17 GetNumFields . . . . . . . . . . . . . . . . . . . . 8.80.3.18 GetPageNumber . . . . . . . . . . . . . . . . . . . 8.80.3.19 GetPageSize . . . . . . . . . . . . . . . . . . . . . 8.80.3.20 GetResources . . . . . . . . . . . . . . . . . . . . 8.80.3.21 GetRotation . . . . . . . . . . . . . . . . . . . . . 8.80.3.22 GetTrimBox . . . . . . . . . . . . . . . . . . . . .
CONTENTS
xxxvii 8.80.3.23 SetPageHeight . . . . . . . . . . . . . . . . . . . . 8.80.3.24 SetPageWidth . . . . . . . . . . . . . . . . . . . . 8.80.3.25 SetTrimBox . . . . . . . . . . . . . . . . . . . . . 310 310 310 310 311 311 311 311 311 311 311 312 312 312 313 313 313 313 314 314 314 314 314 314 314 315 315 315 315 315 318 318 318 318
8.81 PoDoFo::PdfPagesTree Class Reference . . . . . . . . . . . . . . . . 8.81.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.81.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.81.2.1 PdfPagesTree . . . . . . . . . . . . . . . . . . . . 8.81.2.2 PdfPagesTree . . . . . . . . . . . . . . . . . . . . 8.81.2.3 PdfPagesTree . . . . . . . . . . . . . . . . . . . 8.81.3 Member Function Documentation . . . . . . . . . . . . . . . 8.81.3.1 ClearCache . . . . . . . . . . . . . . . . . . . . . 8.81.3.2 CreatePage . . . . . . . . . . . . . . . . . . . . . . 8.81.3.3 DeletePage . . . . . . . . . . . . . . . . . . . . . . 8.81.3.4 GetPage . . . . . . . . . . . . . . . . . . . . . . . 8.81.3.5 GetPage . . . . . . . . . . . . . . . . . . . . . . . 8.81.3.6 GetTotalNumberOfPages . . . . . . . . . . . . . . 8.81.3.7 InsertPage . . . . . . . . . . . . . . . . . . . . . . 8.81.3.8 InsertPage . . . . . . . . . . . . . . . . . . . . . . 8.82 PoDoFo::PdfPagesTreeCache Class Reference . . . . . . . . . . . . . 8.82.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.82.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.82.2.1 PdfPagesTreeCache . . . . . . . . . . . . . . . . . 8.82.2.2 PdfPagesTreeCache . . . . . . . . . . . . . . . . 8.82.3 Member Function Documentation . . . . . . . . . . . . . . . 8.82.3.1 AddPageObject . . . . . . . . . . . . . . . . . . . 8.82.3.2 ClearCache . . . . . . . . . . . . . . . . . . . . . 8.82.3.3 DeletePage . . . . . . . . . . . . . . . . . . . . . . 8.82.3.4 GetPage . . . . . . . . . . . . . . . . . . . . . . . 8.82.3.5 InsertPage . . . . . . . . . . . . . . . . . . . . . . 8.83 PoDoFo::PdfPainter Class Reference . . . . . . . . . . . . . . . . . . 8.83.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.83.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.83.2.1 PdfPainter . . . . . . . . . . . . . . . . . . . . . . 8.83.3 Member Function Documentation . . . . . . . . . . . . . . .
xxxviii
CONTENTS 8.83.3.1 AddText . . . . . . . . . . . . . . . . . . . . . . . 8.83.3.2 AddText . . . . . . . . . . . . . . . . . . . . . . . 8.83.3.3 ArcTo . . . . . . . . . . . . . . . . . . . . . . . . 8.83.3.4 BeginText . . . . . . . . . . . . . . . . . . . . . . 8.83.3.5 Clip . . . . . . . . . . . . . . . . . . . . . . . . . 8.83.3.6 Close . . . . . . . . . . . . . . . . . . . . . . . . . 8.83.3.7 ClosePath . . . . . . . . . . . . . . . . . . . . . . 8.83.3.8 CubicBezierTo . . . . . . . . . . . . . . . . . . . . 8.83.3.9 DrawCircle . . . . . . . . . . . . . . . . . . . . . 318 319 319 320 320 320 320 320 321 321 321 322 322 322 323 323 323 324 324 324 325 325 325 326 326 326 326 327 327 327 327 327 328 328
8.83.3.10 DrawEllipse . . . . . . . . . . . . . . . . . . . . . 8.83.3.11 DrawGlyph . . . . . . . . . . . . . . . . . . . . . 8.83.3.12 DrawImage . . . . . . . . . . . . . . . . . . . . . 8.83.3.13 DrawLine . . . . . . . . . . . . . . . . . . . . . . 8.83.3.14 DrawMultiLineText . . . . . . . . . . . . . . . . . 8.83.3.15 DrawMultiLineText . . . . . . . . . . . . . . . . . 8.83.3.16 DrawRect . . . . . . . . . . . . . . . . . . . . . . 8.83.3.17 DrawRect . . . . . . . . . . . . . . . . . . . . . . 8.83.3.18 DrawText . . . . . . . . . . . . . . . . . . . . . . 8.83.3.19 DrawText . . . . . . . . . . . . . . . . . . . . . . 8.83.3.20 DrawTextAligned . . . . . . . . . . . . . . . . . . 8.83.3.21 DrawXObject . . . . . . . . . . . . . . . . . . . . 8.83.3.22 EndText . . . . . . . . . . . . . . . . . . . . . . . 8.83.3.23 ExpandTabs . . . . . . . . . . . . . . . . . . . . . 8.83.3.24 Fill . . . . . . . . . . . . . . . . . . . . . . . . . . 8.83.3.25 FillCircle . . . . . . . . . . . . . . . . . . . . . . . 8.83.3.26 FillEllipse . . . . . . . . . . . . . . . . . . . . . . 8.83.3.27 FillRect . . . . . . . . . . . . . . . . . . . . . . . 8.83.3.28 FillRect . . . . . . . . . . . . . . . . . . . . . . . 8.83.3.29 FinishPage . . . . . . . . . . . . . . . . . . . . . . 8.83.3.30 GetFont . . . . . . . . . . . . . . . . . . . . . . . 8.83.3.31 GetMultiLineTextAsLines . . . . . . . . . . . . . . 8.83.3.32 GetPage . . . . . . . . . . . . . . . . . . . . . . . 8.83.3.33 GetPrecision . . . . . . . . . . . . . . . . . . . . . 8.83.3.34 GetTabWidth . . . . . . . . . . . . . . . . . . . . .
CONTENTS 8.83.3.35 HorizonalLineTo . . . . . . . . . . . . . . . . . . . 8.83.3.36 LineTo . . . . . . . . . . . . . . . . . . . . . . . . 8.83.3.37 MoveTextPos . . . . . . . . . . . . . . . . . . . . 8.83.3.38 MoveTo . . . . . . . . . . . . . . . . . . . . . . . 8.83.3.39 QuadCurveTo . . . . . . . . . . . . . . . . . . . . 8.83.3.40 Restore . . . . . . . . . . . . . . . . . . . . . . . . 8.83.3.41 Save . . . . . . . . . . . . . . . . . . . . . . . . . 8.83.3.42 SetClipRect . . . . . . . . . . . . . . . . . . . . . 8.83.3.43 SetClipRect . . . . . . . . . . . . . . . . . . . . . 8.83.3.44 SetColor . . . . . . . . . . . . . . . . . . . . . . . 8.83.3.45 SetColor . . . . . . . . . . . . . . . . . . . . . . . 8.83.3.46 SetColorCMYK . . . . . . . . . . . . . . . . . . . 8.83.3.47 SetCurrentStrokingColor . . . . . . . . . . . . . . 8.83.3.48 SetExtGState . . . . . . . . . . . . . . . . . . . . . 8.83.3.49 SetFont . . . . . . . . . . . . . . . . . . . . . . . . 8.83.3.50 SetGray . . . . . . . . . . . . . . . . . . . . . . . 8.83.3.51 SetLineCapStyle . . . . . . . . . . . . . . . . . . . 8.83.3.52 SetLineJoinStyle . . . . . . . . . . . . . . . . . . . 8.83.3.53 SetPage . . . . . . . . . . . . . . . . . . . . . . . 8.83.3.54 SetPrecision . . . . . . . . . . . . . . . . . . . . . 8.83.3.55 SetRenderingIntent . . . . . . . . . . . . . . . . . 8.83.3.56 SetShadingPattern . . . . . . . . . . . . . . . . . . 8.83.3.57 SetStrokeStyle . . . . . . . . . . . . . . . . . . . . 8.83.3.58 SetStrokeWidth . . . . . . . . . . . . . . . . . . . 8.83.3.59 SetStrokingColor . . . . . . . . . . . . . . . . . . 8.83.3.60 SetStrokingColor . . . . . . . . . . . . . . . . . . 8.83.3.61 SetStrokingColorCMYK . . . . . . . . . . . . . . 8.83.3.62 SetStrokingGray . . . . . . . . . . . . . . . . . . . 8.83.3.63 SetStrokingShadingPattern . . . . . . . . . . . . . 8.83.3.64 SetTabWidth . . . . . . . . . . . . . . . . . . . . . 8.83.3.65 SetTransformationMatrix . . . . . . . . . . . . . . 8.83.3.66 SmoothCurveTo . . . . . . . . . . . . . . . . . . . 8.83.3.67 SmoothQuadCurveTo . . . . . . . . . . . . . . . . 8.83.3.68 Stroke . . . . . . . . . . . . . . . . . . . . . . . .
xxxix 328 328 328 329 329 329 330 330 330 330 331 331 331 331 331 332 332 332 332 333 333 333 333 334 334 334 334 335 335 335 335 336 336 336
xl
CONTENTS 8.83.3.69 VerticalLineTo . . . . . . . . . . . . . . . . . . . . 8.83.4 Member Data Documentation . . . . . . . . . . . . . . . . . 8.83.4.1 m_curColor . . . . . . . . . . . . . . . . . . . . . 8.83.4.2 m_isTextOpen . . . . . . . . . . . . . . . . . . . . 8.83.4.3 m_nTabWidth . . . . . . . . . . . . . . . . . . . . 8.83.4.4 m_oss . . . . . . . . . . . . . . . . . . . . . . . . 8.83.4.5 m_pCanvas . . . . . . . . . . . . . . . . . . . . . 8.83.4.6 m_pFont . . . . . . . . . . . . . . . . . . . . . . . 8.83.4.7 m_pPage . . . . . . . . . . . . . . . . . . . . . . . 8.84 PoDoFo::PdfPainterMM Class Reference . . . . . . . . . . . . . . . 8.84.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.84.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.84.2.1 PdfPainterMM . . . . . . . . . . . . . . . . . . . . 8.84.3 Member Function Documentation . . . . . . . . . . . . . . . 8.84.3.1 DrawEllipseMM . . . . . . . . . . . . . . . . . . . 8.84.3.2 DrawImageMM . . . . . . . . . . . . . . . . . . . 8.84.3.3 DrawLineMM . . . . . . . . . . . . . . . . . . . . 8.84.3.4 DrawRectMM . . . . . . . . . . . . . . . . . . . . 8.84.3.5 DrawTextMM . . . . . . . . . . . . . . . . . . . . 8.84.3.6 DrawTextMM . . . . . . . . . . . . . . . . . . . . 8.84.3.7 DrawXObjectMM . . . . . . . . . . . . . . . . . . 8.84.3.8 FillEllipseMM . . . . . . . . . . . . . . . . . . . . 8.84.3.9 FillRectMM . . . . . . . . . . . . . . . . . . . . . 8.84.3.10 LineToMM . . . . . . . . . . . . . . . . . . . . . . 8.84.3.11 MoveToMM . . . . . . . . . . . . . . . . . . . . . 8.84.3.12 SetStrokeWidthMM . . . . . . . . . . . . . . . . . 8.85 PoDoFo::PdfParser Class Reference . . . . . . . . . . . . . . . . . . 8.85.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.85.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.85.2.1 PdfParser . . . . . . . . . . . . . . . . . . . . . . . 8.85.2.2 PdfParser . . . . . . . . . . . . . . . . . . . . . . . 8.85.2.3 PdfParser . . . . . . . . . . . . . . . . . . . . . . . 8.85.2.4 PdfParser . . . . . . . . . . . . . . . . . . . . . . . 8.85.2.5 PdfParser . . . . . . . . . . . . . . . . . . . . . 336 337 337 337 337 337 337 337 337 337 338 338 338 338 338 339 339 339 340 340 340 341 341 341 341 342 342 343 343 343 344 344 344 345
CONTENTS 8.85.3 Member Function Documentation . . . . . . . . . . . . . . . 8.85.3.1 CheckEOFMarker . . . . . . . . . . . . . . . . . . 8.85.3.2 FindToken . . . . . . . . . . . . . . . . . . . . . . 8.85.3.3 FindToken2 . . . . . . . . . . . . . . . . . . . . . 8.85.3.4 GetEncrypt . . . . . . . . . . . . . . . . . . . . . . 8.85.3.5 GetEncrypted . . . . . . . . . . . . . . . . . . . . 8.85.3.6 GetFileSize . . . . . . . . . . . . . . . . . . . . . 8.85.3.7 GetIgnoreBrokenObjects . . . . . . . . . . . . . . 8.85.3.8 GetLoadOnDemand . . . . . . . . . . . . . . . . . 8.85.3.9 GetNumberOfIncrementalUpdates . . . . . . . . . 8.85.3.10 GetObjects . . . . . . . . . . . . . . . . . . . . . . 8.85.3.11 GetPdfVersion . . . . . . . . . . . . . . . . . . . . 8.85.3.12 GetPdfVersionString . . . . . . . . . . . . . . . . . 8.85.3.13 GetTrailer . . . . . . . . . . . . . . . . . . . . . . 8.85.3.14 HasLinearizationDict . . . . . . . . . . . . . . . . 8.85.3.15 IsLinearized . . . . . . . . . . . . . . . . . . . . . 8.85.3.16 IsPdfFile . . . . . . . . . . . . . . . . . . . . . . . 8.85.3.17 IsStrictParsing . . . . . . . . . . . . . . . . . . . . 8.85.3.18 MergeTrailer . . . . . . . . . . . . . . . . . . . . . 8.85.3.19 ParseFile . . . . . . . . . . . . . . . . . . . . . . . 8.85.3.20 ParseFile . . . . . . . . . . . . . . . . . . . . . . . 8.85.3.21 ParseFile . . . . . . . . . . . . . . . . . . . . . . . 8.85.3.22 QuickEncryptedCheck . . . . . . . . . . . . . . . . 8.85.3.23 ReadDocumentStructure . . . . . . . . . . . . . . . 8.85.3.24 ReadObjectFromStream . . . . . . . . . . . . . . . 8.85.3.25 ReadObjects . . . . . . . . . . . . . . . . . . . . . 8.85.3.26 ReadObjectsInternal . . . . . . . . . . . . . . . . . 8.85.3.27 ReadTrailer . . . . . . . . . . . . . . . . . . . . . 8.85.3.28 ReadXRef . . . . . . . . . . . . . . . . . . . . . . 8.85.3.29 ReadXRefContents . . . . . . . . . . . . . . . . . 8.85.3.30 ReadXRefStreamContents . . . . . . . . . . . . . . 8.85.3.31 ReadXRefSubsection . . . . . . . . . . . . . . . . 8.85.3.32 SetIgnoreBrokenObjects . . . . . . . . . . . . . . . 8.85.3.33 SetPassword . . . . . . . . . . . . . . . . . . . . .
xli 345 345 345 345 346 346 346 346 346 346 347 347 347 347 347 347 348 348 348 348 349 349 349 350 350 350 350 350 351 351 351 351 352 352
xlii
CONTENTS 8.85.3.34 SetStrictParsing . . . . . . . . . . . . . . . . . . . 8.85.3.35 TakeEncrypt . . . . . . . . . . . . . . . . . . . . . 8.86 PoDoFo::PdfParserObject Class Reference . . . . . . . . . . . . . . . 8.86.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.86.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.86.2.1 PdfParserObject . . . . . . . . . . . . . . . . . . . 8.86.2.2 PdfParserObject . . . . . . . . . . . . . . . . . . . 8.86.3 Member Function Documentation . . . . . . . . . . . . . . . 8.86.3.1 DelayedLoadImpl . . . . . . . . . . . . . . . . . . 8.86.3.2 DelayedStreamLoadImpl . . . . . . . . . . . . . . 8.86.3.3 FreeObjectMemory . . . . . . . . . . . . . . . . . 8.86.3.4 HasStreamToParse . . . . . . . . . . . . . . . . . . 8.86.3.5 IsLoadOnDemand . . . . . . . . . . . . . . . . . . 8.86.3.6 ParseFile . . . . . . . . . . . . . . . . . . . . . . . 8.86.3.7 ParseStream . . . . . . . . . . . . . . . . . . . . . 8.86.3.8 SetLoadOnDemand . . . . . . . . . . . . . . . . . 8.86.3.9 SetObjectNumber . . . . . . . . . . . . . . . . . . 8.87 PoDoFo::PdfPredictorDecoder Class Reference . . . . . . . . . . . . 8.87.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.88 PoDoFo::PdfPushButton Class Reference . . . . . . . . . . . . . . . 8.88.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.88.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.88.2.1 PdfPushButton . . . . . . . . . . . . . . . . . . . . 8.88.2.2 PdfPushButton . . . . . . . . . . . . . . . . . . . . 8.88.2.3 PdfPushButton . . . . . . . . . . . . . . . . . . . . 8.88.2.4 PdfPushButton . . . . . . . . . . . . . . . . . . . . 8.88.2.5 PdfPushButton . . . . . . . . . . . . . . . . . . . . 8.88.3 Member Function Documentation . . . . . . . . . . . . . . . 8.88.3.1 GetAlternateCaption . . . . . . . . . . . . . . . . . 8.88.3.2 GetRolloverCaption . . . . . . . . . . . . . . . . . 8.88.3.3 SetAlternateCaption . . . . . . . . . . . . . . . . . 8.88.3.4 SetRolloverCaption . . . . . . . . . . . . . . . . . 8.89 PoDoFo::PdfRadialShadingPattern Class Reference . . . . . . . . . . 8.89.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 352 352 353 353 354 354 354 354 354 354 355 355 355 355 356 356 356 356 356 356 357 357 357 357 357 357 357 358 358 358 358 358 358 359
CONTENTS 8.89.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.89.2.1 PdfRadialShadingPattern . . . . . . . . . . . . . . 8.89.2.2 PdfRadialShadingPattern . . . . . . . . . . . . . . 8.90 PoDoFo::PdfRC4InputStream Class Reference . . . . . . . . . . . . 8.90.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.90.2 Member Function Documentation . . . . . . . . . . . . . . . 8.90.2.1 Read . . . . . . . . . . . . . . . . . . . . . . . . . 8.91 PoDoFo::PdfRC4OutputStream Class Reference . . . . . . . . . . . . 8.91.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.91.2 Member Function Documentation . . . . . . . . . . . . . . . 8.91.2.1 Close . . . . . . . . . . . . . . . . . . . . . . . . . 8.91.2.2 Write . . . . . . . . . . . . . . . . . . . . . . . . . 8.92 PoDoFo::PdfRC4Stream Class Reference . . . . . . . . . . . . . . . 8.92.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.92.2 Member Function Documentation . . . . . . . . . . . . . . . 8.92.2.1 Encrypt . . . . . . . . . . . . . . . . . . . . . . . 8.93 PoDoFo::PdfRect Class Reference . . . . . . . . . . . . . . . . . . . 8.93.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.93.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.93.2.1 PdfRect . . . . . . . . . . . . . . . . . . . . . . . 8.93.2.2 PdfRect . . . . . . . . . . . . . . . . . . . . . . . 8.93.2.3 PdfRect . . . . . . . . . . . . . . . . . . . . . . . 8.93.2.4 PdfRect . . . . . . . . . . . . . . . . . . . . . . . 8.93.3 Member Function Documentation . . . . . . . . . . . . . . . 8.93.3.1 FromArray . . . . . . . . . . . . . . . . . . . . . . 8.93.3.2 GetBottom . . . . . . . . . . . . . . . . . . . . . . 8.93.3.3 GetHeight . . . . . . . . . . . . . . . . . . . . . . 8.93.3.4 GetLeft . . . . . . . . . . . . . . . . . . . . . . . . 8.93.3.5 GetWidth . . . . . . . . . . . . . . . . . . . . . . 8.93.3.6 Intersect . . . . . . . . . . . . . . . . . . . . . . . 8.93.3.7 SetBottom . . . . . . . . . . . . . . . . . . . . . . 8.93.3.8 SetHeight . . . . . . . . . . . . . . . . . . . . . . 8.93.3.9 SetLeft . . . . . . . . . . . . . . . . . . . . . . . . 8.93.3.10 SetWidth . . . . . . . . . . . . . . . . . . . . . . .
xliii 359 359 360 360 360 360 360 361 361 361 361 362 362 362 362 362 362 363 363 363 363 363 363 363 363 364 364 364 364 364 365 365 365 365
xliv
CONTENTS 8.93.3.11 ToString . . . . . . . . . . . . . . . . . . . . . . . 8.93.3.12 ToVariant . . . . . . . . . . . . . . . . . . . . . . 365 365 366 366 366 366 366 367 367 367 367 367 367 368 368 368 368 369 369 369 369 370 370 370 370 370 370 371 371 371 371 371 371 372
8.94 PoDoFo::PdfRefCountedBuffer Class Reference . . . . . . . . . . . . 8.94.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.94.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.94.2.1 PdfRefCountedBuffer . . . . . . . . . . . . . . . . 8.94.2.2 PdfRefCountedBuffer . . . . . . . . . . . . . . . . 8.94.2.3 PdfRefCountedBuffer . . . . . . . . . . . . . . . . 8.94.2.4 PdfRefCountedBuffer . . . . . . . . . . . . . . . . 8.94.2.5 PdfRefCountedBuffer . . . . . . . . . . . . . . . 8.94.3 Member Function Documentation . . . . . . . . . . . . . . . 8.94.3.1 GetBuffer . . . . . . . . . . . . . . . . . . . . . . 8.94.3.2 GetSize . . . . . . . . . . . . . . . . . . . . . . . 8.94.3.3 operator< . . . . . . . . . . . . . . . . . . . . . . 8.94.3.4 operator= . . . . . . . . . . . . . . . . . . . . . . . 8.94.3.5 operator== . . . . . . . . . . . . . . . . . . . . . . 8.94.3.6 operator> . . . . . . . . . . . . . . . . . . . . . . 8.94.3.7 Resize . . . . . . . . . . . . . . . . . . . . . . . . 8.94.3.8 SetTakePossesion . . . . . . . . . . . . . . . . . . 8.94.3.9 TakePossesion . . . . . . . . . . . . . . . . . . . . 8.95 PoDoFo::PdfRefCountedInputDevice Class Reference . . . . . . . . 8.95.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.95.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.95.2.1 PdfRefCountedInputDevice . . . . . . . . . . . . . 8.95.2.2 PdfRefCountedInputDevice . . . . . . . . . . . . . 8.95.2.3 PdfRefCountedInputDevice . . . . . . . . . . . . . 8.95.2.4 PdfRefCountedInputDevice . . . . . . . . . . . . . 8.95.2.5 PdfRefCountedInputDevice . . . . . . . . . . . . . 8.95.2.6 PdfRefCountedInputDevice . . . . . . . . . . . . 8.95.3 Member Function Documentation . . . . . . . . . . . . . . . 8.95.3.1 Device . . . . . . . . . . . . . . . . . . . . . . . . 8.95.3.2 operator= . . . . . . . . . . . . . . . . . . . . . . . 8.96 PoDoFo::PdfReference Class Reference . . . . . . . . . . . . . . . . 8.96.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . .
CONTENTS 8.96.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.96.2.1 PdfReference . . . . . . . . . . . . . . . . . . . . 8.96.2.2 PdfReference . . . . . . . . . . . . . . . . . . . . 8.96.2.3 PdfReference . . . . . . . . . . . . . . . . . . . . 8.96.3 Member Function Documentation . . . . . . . . . . . . . . . 8.96.3.1 GenerationNumber . . . . . . . . . . . . . . . . . 8.96.3.2 IsIndirect . . . . . . . . . . . . . . . . . . . . . . . 8.96.3.3 ObjectNumber . . . . . . . . . . . . . . . . . . . . 8.96.3.4 operator!= . . . . . . . . . . . . . . . . . . . . . . 8.96.3.5 operator< . . . . . . . . . . . . . . . . . . . . . . 8.96.3.6 operator= . . . . . . . . . . . . . . . . . . . . . . . 8.96.3.7 operator== . . . . . . . . . . . . . . . . . . . . . . 8.96.3.8 SetGenerationNumber . . . . . . . . . . . . . . . . 8.96.3.9 SetObjectNumber . . . . . . . . . . . . . . . . . . 8.96.3.10 ToString . . . . . . . . . . . . . . . . . . . . . . . 8.96.3.11 Write . . . . . . . . . . . . . . . . . . . . . . . . . 8.97 PoDoFo::PdfRijndael Class Reference . . . . . . . . . . . . . . . . . 8.97.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.98 PoDoFo::PdfRLEFilter Class Reference . . . . . . . . . . . . . . . . 8.98.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.98.2 Member Function Documentation . . . . . . . . . . . . . . . 8.98.2.1 BeginDecodeImpl . . . . . . . . . . . . . . . . . . 8.98.2.2 BeginEncodeImpl . . . . . . . . . . . . . . . . . . 8.98.2.3 CanDecode . . . . . . . . . . . . . . . . . . . . . 8.98.2.4 CanEncode . . . . . . . . . . . . . . . . . . . . . . 8.98.2.5 DecodeBlockImpl . . . . . . . . . . . . . . . . . . 8.98.2.6 EncodeBlockImpl . . . . . . . . . . . . . . . . . . 8.98.2.7 EndEncodeImpl . . . . . . . . . . . . . . . . . . . 8.98.2.8 GetType . . . . . . . . . . . . . . . . . . . . . . . 8.99 PoDoFo::PdfSampledFunction Class Reference . . . . . . . . . . . . 8.99.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.99.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.99.2.1 PdfSampledFunction . . . . . . . . . . . . . . . . 8.99.2.2 PdfSampledFunction . . . . . . . . . . . . . . . .
xlv 372 372 372 373 373 373 373 373 374 374 374 374 374 375 375 375 375 375 376 376 376 376 377 377 377 377 378 378 378 379 379 379 379 380
xlvi
CONTENTS 380 381 381 381 381 381 381 382 382 382 382 382 382 383 383 383 384 384 384 384 384 384 384 385 385 385 386 386 386 386 386 387 388 388
8.100PoDoFo::PdfShadingPattern Class Reference . . . . . . . . . . . . . 8.100.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.100.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.100.2.1 PdfShadingPattern . . . . . . . . . . . . . . . . . . 8.100.2.2 PdfShadingPattern . . . . . . . . . . . . . . . . . . 8.100.3 Member Function Documentation . . . . . . . . . . . . . . . 8.100.3.1 GetIdentier . . . . . . . . . . . . . . . . . . . . . 8.101PoDoFo::PdfSignatureField Class Reference . . . . . . . . . . . . . . 8.101.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.101.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.101.2.1 PdfSignatureField . . . . . . . . . . . . . . . . . . 8.101.3 Member Function Documentation . . . . . . . . . . . . . . . 8.101.3.1 SetSignature . . . . . . . . . . . . . . . . . . . . . 8.101.3.2 SetSignatureDate . . . . . . . . . . . . . . . . . . 8.101.3.3 SetSignatureReason . . . . . . . . . . . . . . . . . 8.102PoDoFo::PdfSignOutputDevice Class Reference . . . . . . . . . . . . 8.102.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.102.2 Member Function Documentation . . . . . . . . . . . . . . . 8.102.2.1 AdjustByteRange . . . . . . . . . . . . . . . . . . 8.102.2.2 Flush . . . . . . . . . . . . . . . . . . . . . . . . . 8.102.2.3 GetLength . . . . . . . . . . . . . . . . . . . . . . 8.102.2.4 GetSignatureBeacon . . . . . . . . . . . . . . . . . 8.102.2.5 GetSignatureSize . . . . . . . . . . . . . . . . . . 8.102.2.6 Print . . . . . . . . . . . . . . . . . . . . . . . . . 8.102.2.7 Read . . . . . . . . . . . . . . . . . . . . . . . . . 8.102.2.8 ReadForSignature . . . . . . . . . . . . . . . . . . 8.102.2.9 Seek . . . . . . . . . . . . . . . . . . . . . . . . . 8.102.2.10SetSignature . . . . . . . . . . . . . . . . . . . . . 8.102.2.11SetSignatureSize . . . . . . . . . . . . . . . . . . . 8.102.2.12Tell . . . . . . . . . . . . . . . . . . . . . . . . . . 8.102.2.13Write . . . . . . . . . . . . . . . . . . . . . . . . . 8.103PoDoFo::PdfSimpleEncoding Class Reference . . . . . . . . . . . . . 8.103.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.103.2 Member Function Documentation . . . . . . . . . . . . . . .
CONTENTS 8.103.2.1 AddToDictionary . . . . . . . . . . . . . . . . . . 8.103.2.2 ConvertToEncoding . . . . . . . . . . . . . . . . . 8.103.2.3 ConvertToUnicode . . . . . . . . . . . . . . . . . . 8.103.2.4 GetCharCode . . . . . . . . . . . . . . . . . . . . 8.103.2.5 GetID . . . . . . . . . . . . . . . . . . . . . . . . 8.103.2.6 GetName . . . . . . . . . . . . . . . . . . . . . . . 8.103.2.7 GetToUnicodeTable . . . . . . . . . . . . . . . . . 8.103.2.8 IsAutoDelete . . . . . . . . . . . . . . . . . . . . . 8.103.2.9 IsSingleByteEncoding . . . . . . . . . . . . . . . . 8.104PoDoFo::PdfSimpleTableModel Class Reference . . . . . . . . . . . 8.104.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.104.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.104.2.1 PdfSimpleTableModel . . . . . . . . . . . . . . . . 8.104.2.2 PdfSimpleTableModel . . . . . . . . . . . . . . . . 8.104.3 Member Function Documentation . . . . . . . . . . . . . . . 8.104.3.1 GetAlignment . . . . . . . . . . . . . . . . . . . . 8.104.3.2 GetBackgroundColor . . . . . . . . . . . . . . . . 8.104.3.3 GetBorderColor . . . . . . . . . . . . . . . . . . . 8.104.3.4 GetBorderWidth . . . . . . . . . . . . . . . . . . . 8.104.3.5 GetFont . . . . . . . . . . . . . . . . . . . . . . . 8.104.3.6 GetForegroundColor . . . . . . . . . . . . . . . . . 8.104.3.7 GetImage . . . . . . . . . . . . . . . . . . . . . . 8.104.3.8 GetText . . . . . . . . . . . . . . . . . . . . . . . 8.104.3.9 GetVerticalAlignment . . . . . . . . . . . . . . . . 8.104.3.10HasBackgroundColor . . . . . . . . . . . . . . . . 8.104.3.11HasBorders . . . . . . . . . . . . . . . . . . . . . 8.104.3.12HasImage . . . . . . . . . . . . . . . . . . . . . . 8.104.3.13HasWordWrap . . . . . . . . . . . . . . . . . . . . 8.104.3.14SetAlignment . . . . . . . . . . . . . . . . . . . . 8.104.3.15SetAlignment . . . . . . . . . . . . . . . . . . . . 8.104.3.16SetBackgroundColor . . . . . . . . . . . . . . . . 8.104.3.17SetBackgroundEnabled . . . . . . . . . . . . . . . 8.104.3.18SetBorderEnabled . . . . . . . . . . . . . . . . . . 8.104.3.19SetBorderWidth . . . . . . . . . . . . . . . . . . .
xlvii 388 388 389 389 390 390 390 390 391 391 392 392 392 392 392 392 393 393 393 393 394 394 394 395 395 395 395 396 396 396 396 396 397 397
xlviii
CONTENTS 8.104.3.20SetFont . . . . . . . . . . . . . . . . . . . . . . . . 8.104.3.21SetForegroundColor . . . . . . . . . . . . . . . . . 8.104.3.22SetText . . . . . . . . . . . . . . . . . . . . . . . . 8.104.3.23SetWordWrapEnabled . . . . . . . . . . . . . . . . 397 397 397 398 398 398 398 398 399 399 399 399 400 400 400 400 402 402 402 402 402 402 403 403 403 404 404 405 405 405 405 405 406 406
8.105PoDoFo::PdfStandardEncoding Class Reference . . . . . . . . . . . . 8.105.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.105.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.105.2.1 PdfStandardEncoding . . . . . . . . . . . . . . . . 8.105.3 Member Function Documentation . . . . . . . . . . . . . . . 8.105.3.1 GetToUnicodeTable . . . . . . . . . . . . . . . . . 8.106PoDoFo::PdfStitchingFunction Class Reference . . . . . . . . . . . . 8.106.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.106.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.106.2.1 PdfStitchingFunction . . . . . . . . . . . . . . . . 8.106.2.2 PdfStitchingFunction . . . . . . . . . . . . . . . . 8.107PoDoFo::PdfStream Class Reference . . . . . . . . . . . . . . . . . . 8.107.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.107.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.107.2.1 PdfStream . . . . . . . . . . . . . . . . . . . . . . 8.107.3 Member Function Documentation . . . . . . . . . . . . . . . 8.107.3.1 Append . . . . . . . . . . . . . . . . . . . . . . . 8.107.3.2 Append . . . . . . . . . . . . . . . . . . . . . . . 8.107.3.3 Append . . . . . . . . . . . . . . . . . . . . . . . 8.107.3.4 AppendImpl . . . . . . . . . . . . . . . . . . . . . 8.107.3.5 BeginAppend . . . . . . . . . . . . . . . . . . . . 8.107.3.6 BeginAppend . . . . . . . . . . . . . . . . . . . . 8.107.3.7 BeginAppendImpl . . . . . . . . . . . . . . . . . . 8.107.3.8 EndAppend . . . . . . . . . . . . . . . . . . . . . 8.107.3.9 EndAppendImpl . . . . . . . . . . . . . . . . . . . 8.107.3.10GetCopy . . . . . . . . . . . . . . . . . . . . . . . 8.107.3.11GetCopy . . . . . . . . . . . . . . . . . . . . . . . 8.107.3.12GetFilteredCopy . . . . . . . . . . . . . . . . . . . 8.107.3.13GetFilteredCopy . . . . . . . . . . . . . . . . . . . 8.107.3.14GetInternalBuffer . . . . . . . . . . . . . . . . . .
CONTENTS 8.107.3.15GetInternalBufferSize . . . . . . . . . . . . . . . . 8.107.3.16GetLength . . . . . . . . . . . . . . . . . . . . . . 8.107.3.17IsAppending . . . . . . . . . . . . . . . . . . . . . 8.107.3.18operator= . . . . . . . . . . . . . . . . . . . . . . . 8.107.3.19Set . . . . . . . . . . . . . . . . . . . . . . . . . . 8.107.3.20Set . . . . . . . . . . . . . . . . . . . . . . . . . . 8.107.3.21Set . . . . . . . . . . . . . . . . . . . . . . . . . . 8.107.3.22Set . . . . . . . . . . . . . . . . . . . . . . . . . . 8.107.3.23Set . . . . . . . . . . . . . . . . . . . . . . . . . . 8.107.3.24SetRawData . . . . . . . . . . . . . . . . . . . . . 8.107.3.25Write . . . . . . . . . . . . . . . . . . . . . . . . . 8.108PoDoFo::PdfStreamedDocument Class Reference . . . . . . . . . . . 8.108.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.108.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.108.2.1 PdfStreamedDocument . . . . . . . . . . . . . . . 8.108.2.2 PdfStreamedDocument . . . . . . . . . . . . . . . 8.108.3 Member Function Documentation . . . . . . . . . . . . . . . 8.108.3.1 Close . . . . . . . . . . . . . . . . . . . . . . . . . 8.108.3.2 GetPdfVersion . . . . . . . . . . . . . . . . . . . . 8.108.3.3 GetWriteMode . . . . . . . . . . . . . . . . . . . . 8.108.3.4 IsAccessibilityAllowed . . . . . . . . . . . . . . . 8.108.3.5 IsCopyAllowed . . . . . . . . . . . . . . . . . . . 8.108.3.6 IsDocAssemblyAllowed . . . . . . . . . . . . . . . 8.108.3.7 IsEditAllowed . . . . . . . . . . . . . . . . . . . . 8.108.3.8 IsEditNotesAllowed . . . . . . . . . . . . . . . . . 8.108.3.9 IsFillAndSignAllowed . . . . . . . . . . . . . . . . 8.108.3.10IsHighPrintAllowed . . . . . . . . . . . . . . . . . 8.108.3.11IsLinearized . . . . . . . . . . . . . . . . . . . . . 8.108.3.12IsPrintAllowed . . . . . . . . . . . . . . . . . . . . 8.109PoDoFo::PdfString Class Reference . . . . . . . . . . . . . . . . . . 8.109.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.109.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.109.2.1 PdfString . . . . . . . . . . . . . . . . . . . . . . . 8.109.2.2 PdfString . . . . . . . . . . . . . . . . . . . . . . .
xlix 406 406 407 407 407 407 408 408 408 408 409 409 410 410 410 411 411 411 411 411 412 412 412 413 413 413 414 414 414 414 415 416 416 416
CONTENTS 8.109.2.3 PdfString . . . . . . . . . . . . . . . . . . . . . . . 8.109.2.4 PdfString . . . . . . . . . . . . . . . . . . . . . . . 8.109.2.5 PdfString . . . . . . . . . . . . . . . . . . . . . . . 8.109.2.6 PdfString . . . . . . . . . . . . . . . . . . . . . . . 8.109.2.7 PdfString . . . . . . . . . . . . . . . . . . . . . . . 8.109.2.8 PdfString . . . . . . . . . . . . . . . . . . . . . . . 8.109.2.9 PdfString . . . . . . . . . . . . . . . . . . . . . . . 8.109.2.10PdfString . . . . . . . . . . . . . . . . . . . . . . . 8.109.3 Member Function Documentation . . . . . . . . . . . . . . . 8.109.3.1 GetCharacterLength . . . . . . . . . . . . . . . . . 8.109.3.2 GetLength . . . . . . . . . . . . . . . . . . . . . . 8.109.3.3 GetString . . . . . . . . . . . . . . . . . . . . . . . 8.109.3.4 GetStringUtf8 . . . . . . . . . . . . . . . . . . . . 8.109.3.5 GetUnicode . . . . . . . . . . . . . . . . . . . . . 8.109.3.6 GetUnicodeLength . . . . . . . . . . . . . . . . . 8.109.3.7 IsHex . . . . . . . . . . . . . . . . . . . . . . . . . 8.109.3.8 IsUnicode . . . . . . . . . . . . . . . . . . . . . . 8.109.3.9 IsValid . . . . . . . . . . . . . . . . . . . . . . . . 8.109.3.10operator!= . . . . . . . . . . . . . . . . . . . . . . 8.109.3.11operator< . . . . . . . . . . . . . . . . . . . . . . 8.109.3.12operator= . . . . . . . . . . . . . . . . . . . . . . . 8.109.3.13operator== . . . . . . . . . . . . . . . . . . . . . . 8.109.3.14operator> . . . . . . . . . . . . . . . . . . . . . . 8.109.3.15SetHexData . . . . . . . . . . . . . . . . . . . . . 8.109.3.16ToUnicode . . . . . . . . . . . . . . . . . . . . . . 8.109.3.17Write . . . . . . . . . . . . . . . . . . . . . . . . . 8.110PoDoFo::PdfSymbolEncoding Class Reference . . . . . . . . . . . . 8.110.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.110.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.110.2.1 PdfSymbolEncoding . . . . . . . . . . . . . . . . . 8.110.3 Member Function Documentation . . . . . . . . . . . . . . . 8.110.3.1 GetToUnicodeTable . . . . . . . . . . . . . . . . . 8.111PoDoFo::PdfTable Class Reference . . . . . . . . . . . . . . . . . . . 8.111.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 416 416 417 417 417 417 418 418 418 418 418 419 419 419 420 420 420 420 421 421 421 421 422 422 422 423 423 424 424 424 424 424 424 425
CONTENTS 8.111.2 Member Typedef Documentation . . . . . . . . . . . . . . . 8.111.2.1 CreatePageCallback . . . . . . . . . . . . . . . . . 8.111.3 Constructor & Destructor Documentation . . . . . . . . . . . 8.111.3.1 PdfTable . . . . . . . . . . . . . . . . . . . . . . . 8.111.4 Member Function Documentation . . . . . . . . . . . . . . . 8.111.4.1 CalculateTableSize . . . . . . . . . . . . . . . . . 8.111.4.2 CheckForNewPage . . . . . . . . . . . . . . . . . 8.111.4.3 Draw . . . . . . . . . . . . . . . . . . . . . . . . . 8.111.4.4 DrawHorizontalBorders . . . . . . . . . . . . . . . 8.111.4.5 GetAutoPageBreak . . . . . . . . . . . . . . . . . 8.111.4.6 GetCols . . . . . . . . . . . . . . . . . . . . . . . 8.111.4.7 GetHeight . . . . . . . . . . . . . . . . . . . . . . 8.111.4.8 GetModel . . . . . . . . . . . . . . . . . . . . . . 8.111.4.9 GetRows . . . . . . . . . . . . . . . . . . . . . . . 8.111.4.10GetWidth . . . . . . . . . . . . . . . . . . . . . . 8.111.4.11SetAutoPageBreak . . . . . . . . . . . . . . . . . . 8.111.4.12SetColumnWidth . . . . . . . . . . . . . . . . . . 8.111.4.13SetColumnWidths . . . . . . . . . . . . . . . . . . 8.111.4.14SetModel . . . . . . . . . . . . . . . . . . . . . . . 8.111.4.15SetRowHeight . . . . . . . . . . . . . . . . . . . . 8.111.4.16SetRowHeights . . . . . . . . . . . . . . . . . . . 8.111.4.17SetTableHeight . . . . . . . . . . . . . . . . . . . 8.111.4.18SetTableWidth . . . . . . . . . . . . . . . . . . . . 8.112PoDoFo::PdfTableModel Class Reference . . . . . . . . . . . . . . . 8.112.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.112.2 Member Function Documentation . . . . . . . . . . . . . . . 8.112.2.1 GetAlignment . . . . . . . . . . . . . . . . . . . . 8.112.2.2 GetBackgroundColor . . . . . . . . . . . . . . . . 8.112.2.3 GetBorderColor . . . . . . . . . . . . . . . . . . . 8.112.2.4 GetBorderWidth . . . . . . . . . . . . . . . . . . . 8.112.2.5 GetFont . . . . . . . . . . . . . . . . . . . . . . . 8.112.2.6 GetForegroundColor . . . . . . . . . . . . . . . . . 8.112.2.7 GetImage . . . . . . . . . . . . . . . . . . . . . . 8.112.2.8 GetText . . . . . . . . . . . . . . . . . . . . . . .
li 425 425 426 426 426 426 426 427 427 428 428 428 428 428 429 429 429 430 430 430 430 431 431 431 432 432 432 432 433 433 433 433 434 434
lii
CONTENTS 8.112.2.9 GetVerticalAlignment . . . . . . . . . . . . . . . . 8.112.2.10HasBackgroundColor . . . . . . . . . . . . . . . . 8.112.2.11HasBorders . . . . . . . . . . . . . . . . . . . . . 8.112.2.12HasImage . . . . . . . . . . . . . . . . . . . . . . 8.112.2.13HasWordWrap . . . . . . . . . . . . . . . . . . . . 8.113PoDoFo::PdfTextField Class Reference . . . . . . . . . . . . . . . . 8.113.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.113.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.113.2.1 PdfTextField . . . . . . . . . . . . . . . . . . . . . 8.113.2.2 PdfTextField . . . . . . . . . . . . . . . . . . . . . 8.113.2.3 PdfTextField . . . . . . . . . . . . . . . . . . . . . 8.113.2.4 PdfTextField . . . . . . . . . . . . . . . . . . . . . 8.113.2.5 PdfTextField . . . . . . . . . . . . . . . . . . . . . 8.113.3 Member Function Documentation . . . . . . . . . . . . . . . 8.113.3.1 GetMaxLen . . . . . . . . . . . . . . . . . . . . . 8.113.3.2 GetText . . . . . . . . . . . . . . . . . . . . . . . 8.113.3.3 IsCombs . . . . . . . . . . . . . . . . . . . . . . . 8.113.3.4 IsFileField . . . . . . . . . . . . . . . . . . . . . . 8.113.3.5 IsMultiLine . . . . . . . . . . . . . . . . . . . . . 8.113.3.6 IsPasswordField . . . . . . . . . . . . . . . . . . . 8.113.3.7 IsRichText . . . . . . . . . . . . . . . . . . . . . . 8.113.3.8 IsScrollBarsEnabled . . . . . . . . . . . . . . . . . 8.113.3.9 IsSpellcheckingEnabled . . . . . . . . . . . . . . . 8.113.3.10SetCombs . . . . . . . . . . . . . . . . . . . . . . 8.113.3.11SetFileField . . . . . . . . . . . . . . . . . . . . . 8.113.3.12SetMaxLen . . . . . . . . . . . . . . . . . . . . . 8.113.3.13SetMultiLine . . . . . . . . . . . . . . . . . . . . . 8.113.3.14SetPasswordField . . . . . . . . . . . . . . . . . . 8.113.3.15SetRichText . . . . . . . . . . . . . . . . . . . . . 8.113.3.16SetScrollBarsEnabled . . . . . . . . . . . . . . . . 8.113.3.17SetSpellcheckingEnabled . . . . . . . . . . . . . . 8.113.3.18SetText . . . . . . . . . . . . . . . . . . . . . . . . 8.114PoDoFo::PdfTokenizer Class Reference . . . . . . . . . . . . . . . . 8.114.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 434 434 435 435 435 435 436 436 436 436 437 437 437 437 437 437 437 437 438 438 438 438 438 438 439 439 439 439 439 440 440 440 440 441
CONTENTS 8.114.2 Member Function Documentation . . . . . . . . . . . . . . . 8.114.2.1 DetermineDataType . . . . . . . . . . . . . . . . . 8.114.2.2 GetHexValue . . . . . . . . . . . . . . . . . . . . . 8.114.2.3 GetNextNumber . . . . . . . . . . . . . . . . . . . 8.114.2.4 GetNextToken . . . . . . . . . . . . . . . . . . . . 8.114.2.5 GetNextVariant . . . . . . . . . . . . . . . . . . . 8.114.2.6 GetNextVariant . . . . . . . . . . . . . . . . . . . 8.114.2.7 IsDelimiter . . . . . . . . . . . . . . . . . . . . . . 8.114.2.8 IsNextToken . . . . . . . . . . . . . . . . . . . . . 8.114.2.9 IsPrintable . . . . . . . . . . . . . . . . . . . . . . 8.114.2.10IsRegular . . . . . . . . . . . . . . . . . . . . . . . 8.114.2.11IsWhitespace . . . . . . . . . . . . . . . . . . . . . 8.114.2.12QuequeToken . . . . . . . . . . . . . . . . . . . . 8.114.2.13ReadArray . . . . . . . . . . . . . . . . . . . . . . 8.114.2.14ReadDictionary . . . . . . . . . . . . . . . . . . . 8.114.2.15ReadHexString . . . . . . . . . . . . . . . . . . . 8.114.2.16ReadName . . . . . . . . . . . . . . . . . . . . . . 8.114.2.17ReadString . . . . . . . . . . . . . . . . . . . . . . 8.114.3 Member Data Documentation . . . . . . . . . . . . . . . . . 8.114.3.1 HEX_NOT_FOUND . . . . . . . . . . . . . . . . 8.115PoDoFo::NonPublic::PdfTTFWriter Class Reference . . . . . . . . . 8.115.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.115.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.115.2.1 PdfTTFWriter . . . . . . . . . . . . . . . . . . . . 8.115.3 Member Function Documentation . . . . . . . . . . . . . . . 8.115.3.1 Read . . . . . . . . . . . . . . . . . . . . . . . . . 8.115.3.2 Subset . . . . . . . . . . . . . . . . . . . . . . . . 8.115.3.3 Write . . . . . . . . . . . . . . . . . . . . . . . . . 8.116PoDoFo::PdfType1Encrypt Class Reference . . . . . . . . . . . . . . 8.116.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.116.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.116.2.1 PdfType1Encrypt . . . . . . . . . . . . . . . . . . 8.116.3 Member Function Documentation . . . . . . . . . . . . . . . 8.116.3.1 Decrypt . . . . . . . . . . . . . . . . . . . . . . .
liii 441 441 442 442 442 443 443 443 443 444 444 444 444 445 445 445 445 445 446 446 446 446 446 446 447 447 447 447 447 448 448 448 448 448
liv
CONTENTS 8.116.3.2 Encrypt . . . . . . . . . . . . . . . . . . . . . . . 8.117PoDoFo::PdfVariant Class Reference . . . . . . . . . . . . . . . . . . 8.117.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.117.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.117.2.1 PdfVariant . . . . . . . . . . . . . . . . . . . . . . 8.117.2.2 PdfVariant . . . . . . . . . . . . . . . . . . . . . . 8.117.2.3 PdfVariant . . . . . . . . . . . . . . . . . . . . . . 8.117.2.4 PdfVariant . . . . . . . . . . . . . . . . . . . . . . 8.117.2.5 PdfVariant . . . . . . . . . . . . . . . . . . . . . . 8.117.2.6 PdfVariant . . . . . . . . . . . . . . . . . . . . . . 8.117.2.7 PdfVariant . . . . . . . . . . . . . . . . . . . . . . 8.117.2.8 PdfVariant . . . . . . . . . . . . . . . . . . . . . . 8.117.2.9 PdfVariant . . . . . . . . . . . . . . . . . . . . . . 8.117.2.10PdfVariant . . . . . . . . . . . . . . . . . . . . . . 8.117.2.11PdfVariant . . . . . . . . . . . . . . . . . . . . . . 8.117.3 Member Function Documentation . . . . . . . . . . . . . . . 8.117.3.1 AssertMutable . . . . . . . . . . . . . . . . . . . . 8.117.3.2 Clear . . . . . . . . . . . . . . . . . . . . . . . . . 8.117.3.3 DelayedLoad . . . . . . . . . . . . . . . . . . . . . 8.117.3.4 DelayedLoadDone . . . . . . . . . . . . . . . . . . 8.117.3.5 DelayedLoadImpl . . . . . . . . . . . . . . . . . . 8.117.3.6 EnableDelayedLoading . . . . . . . . . . . . . . . 8.117.3.7 GetArray . . . . . . . . . . . . . . . . . . . . . . . 8.117.3.8 GetArray . . . . . . . . . . . . . . . . . . . . . . . 8.117.3.9 GetArray_NoDL . . . . . . . . . . . . . . . . . . . 8.117.3.10GetArray_NoDL . . . . . . . . . . . . . . . . . . . 8.117.3.11GetBool . . . . . . . . . . . . . . . . . . . . . . . 8.117.3.12GetDataType . . . . . . . . . . . . . . . . . . . . . 8.117.3.13GetDataTypeString . . . . . . . . . . . . . . . . . 8.117.3.14GetDictionary . . . . . . . . . . . . . . . . . . . . 8.117.3.15GetDictionary . . . . . . . . . . . . . . . . . . . . 8.117.3.16GetDictionary_NoDL . . . . . . . . . . . . . . . . 8.117.3.17GetDictionary_NoDL . . . . . . . . . . . . . . . . 8.117.3.18GetImmutable . . . . . . . . . . . . . . . . . . . . 448 448 450 451 451 451 451 451 451 451 452 452 452 452 452 453 453 453 453 453 453 454 454 454 454 454 455 455 455 455 455 455 456 456
CONTENTS 8.117.3.19GetName . . . . . . . . . . . . . . . . . . . . . . . 8.117.3.20GetNumber . . . . . . . . . . . . . . . . . . . . . 8.117.3.21GetRawData . . . . . . . . . . . . . . . . . . . . . 8.117.3.22GetRawData . . . . . . . . . . . . . . . . . . . . . 8.117.3.23GetReal . . . . . . . . . . . . . . . . . . . . . . . 8.117.3.24GetReference . . . . . . . . . . . . . . . . . . . . 8.117.3.25GetString . . . . . . . . . . . . . . . . . . . . . . . 8.117.3.26IsArray . . . . . . . . . . . . . . . . . . . . . . . . 8.117.3.27IsBool . . . . . . . . . . . . . . . . . . . . . . . . 8.117.3.28IsDictionary . . . . . . . . . . . . . . . . . . . . . 8.117.3.29IsDirty . . . . . . . . . . . . . . . . . . . . . . . . 8.117.3.30IsEmpty . . . . . . . . . . . . . . . . . . . . . . . 8.117.3.31IsHexString . . . . . . . . . . . . . . . . . . . . . 8.117.3.32IsName . . . . . . . . . . . . . . . . . . . . . . . . 8.117.3.33IsNull . . . . . . . . . . . . . . . . . . . . . . . . 8.117.3.34IsNumber . . . . . . . . . . . . . . . . . . . . . . 8.117.3.35IsRawData . . . . . . . . . . . . . . . . . . . . . . 8.117.3.36IsReal . . . . . . . . . . . . . . . . . . . . . . . . 8.117.3.37IsReference . . . . . . . . . . . . . . . . . . . . . 8.117.3.38IsString . . . . . . . . . . . . . . . . . . . . . . . 8.117.3.39operator!= . . . . . . . . . . . . . . . . . . . . . . 8.117.3.40operator= . . . . . . . . . . . . . . . . . . . . . . . 8.117.3.41operator== . . . . . . . . . . . . . . . . . . . . . . 8.117.3.42SetBool . . . . . . . . . . . . . . . . . . . . . . . 8.117.3.43SetDirty . . . . . . . . . . . . . . . . . . . . . . . 8.117.3.44SetImmutable . . . . . . . . . . . . . . . . . . . . 8.117.3.45SetNumber . . . . . . . . . . . . . . . . . . . . . . 8.117.3.46SetReal . . . . . . . . . . . . . . . . . . . . . . . . 8.117.3.47ToString . . . . . . . . . . . . . . . . . . . . . . . 8.117.3.48Write . . . . . . . . . . . . . . . . . . . . . . . . . 8.117.3.49Write . . . . . . . . . . . . . . . . . . . . . . . . . 8.118PoDoFo::PdfVecObjects Class Reference . . . . . . . . . . . . . . . 8.118.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.118.2 Constructor & Destructor Documentation . . . . . . . . . . .
lv 456 456 456 457 457 457 457 457 457 458 458 458 458 458 458 459 459 459 459 459 459 459 460 460 460 460 461 461 461 461 462 462 463 463
lvi
CONTENTS 8.118.2.1 PdfVecObjects . . . . . . . . . . . . . . . . . . . . 8.118.3 Member Function Documentation . . . . . . . . . . . . . . . 8.118.3.1 AddFreeObject . . . . . . . . . . . . . . . . . . . 8.118.3.2 Attach . . . . . . . . . . . . . . . . . . . . . . . . 8.118.3.3 AutoDelete . . . . . . . . . . . . . . . . . . . . . . 8.118.3.4 begin . . . . . . . . . . . . . . . . . . . . . . . . . 8.118.3.5 begin . . . . . . . . . . . . . . . . . . . . . . . . . 8.118.3.6 BeginAppendStream . . . . . . . . . . . . . . . . . 8.118.3.7 Clear . . . . . . . . . . . . . . . . . . . . . . . . . 8.118.3.8 CollectGarbage . . . . . . . . . . . . . . . . . . . 8.118.3.9 CreateObject . . . . . . . . . . . . . . . . . . . . . 8.118.3.10CreateObject . . . . . . . . . . . . . . . . . . . . . 8.118.3.11CreateStream . . . . . . . . . . . . . . . . . . . . 8.118.3.12CreateStream . . . . . . . . . . . . . . . . . . . . 8.118.3.13Detach . . . . . . . . . . . . . . . . . . . . . . . . 8.118.3.14end . . . . . . . . . . . . . . . . . . . . . . . . . . 8.118.3.15end . . . . . . . . . . . . . . . . . . . . . . . . . . 8.118.3.16EndAppendStream . . . . . . . . . . . . . . . . . . 8.118.3.17Finish . . . . . . . . . . . . . . . . . . . . . . . . 8.118.3.18GetBack . . . . . . . . . . . . . . . . . . . . . . . 8.118.3.19GetFreeObjects . . . . . . . . . . . . . . . . . . . 8.118.3.20GetIndex . . . . . . . . . . . . . . . . . . . . . . . 8.118.3.21GetObject . . . . . . . . . . . . . . . . . . . . . . 8.118.3.22GetObjectCount . . . . . . . . . . . . . . . . . . . 8.118.3.23GetObjectDependencies . . . . . . . . . . . . . . . 8.118.3.24GetParentDocument . . . . . . . . . . . . . . . . . 8.118.3.25GetSize . . . . . . . . . . . . . . . . . . . . . . . 8.118.3.26push_back . . . . . . . . . . . . . . . . . . . . . . 8.118.3.27RemoveObject . . . . . . . . . . . . . . . . . . . . 8.118.3.28RemoveObject . . . . . . . . . . . . . . . . . . . . 8.118.3.29RenumberObjects . . . . . . . . . . . . . . . . . . 8.118.3.30Reserve . . . . . . . . . . . . . . . . . . . . . . . 8.118.3.31SetAutoDelete . . . . . . . . . . . . . . . . . . . . 8.118.3.32SetParentDocument . . . . . . . . . . . . . . . . . 463 463 463 464 464 464 464 464 464 465 465 465 466 466 466 466 466 467 467 467 467 467 467 468 468 468 468 468 469 469 469 470 470 470
CONTENTS 8.118.3.33SetStreamFactory . . . . . . . . . . . . . . . . . . 8.118.3.34Sort . . . . . . . . . . . . . . . . . . . . . . . . . 8.118.3.35WriteObject . . . . . . . . . . . . . . . . . . . . . 8.119PoDoFo::PdfWinAnsiEncoding Class Reference . . . . . . . . . . . . 8.119.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.119.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.119.2.1 PdfWinAnsiEncoding . . . . . . . . . . . . . . . . 8.119.3 Member Function Documentation . . . . . . . . . . . . . . . 8.119.3.1 GetToUnicodeTable . . . . . . . . . . . . . . . . . 8.120PoDoFo::PdfWriter Class Reference . . . . . . . . . . . . . . . . . . 8.120.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.120.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.120.2.1 PdfWriter . . . . . . . . . . . . . . . . . . . . . . 8.120.2.2 PdfWriter . . . . . . . . . . . . . . . . . . . . . . 8.120.2.3 PdfWriter . . . . . . . . . . . . . . . . . . . . . . 8.120.3 Member Function Documentation . . . . . . . . . . . . . . . 8.120.3.1 CreateFileIdentier . . . . . . . . . . . . . . . . . 8.120.3.2 FillTrailerObject . . . . . . . . . . . . . . . . . . . 8.120.3.3 GetByteOffset . . . . . . . . . . . . . . . . . . . . 8.120.3.4 GetEncrypted . . . . . . . . . . . . . . . . . . . . 8.120.3.5 GetLinearized . . . . . . . . . . . . . . . . . . . . 8.120.3.6 GetPdfVersion . . . . . . . . . . . . . . . . . . . . 8.120.3.7 GetPdfVersionString . . . . . . . . . . . . . . . . . 8.120.3.8 GetUseXRefStream . . . . . . . . . . . . . . . . . 8.120.3.9 GetWriteMode . . . . . . . . . . . . . . . . . . . . 8.120.3.10SetEncrypted . . . . . . . . . . . . . . . . . . . . . 8.120.3.11SetLinearized . . . . . . . . . . . . . . . . . . . . 8.120.3.12SetPdfVersion . . . . . . . . . . . . . . . . . . . . 8.120.3.13SetUseXRefStream . . . . . . . . . . . . . . . . . 8.120.3.14SetWriteMode . . . . . . . . . . . . . . . . . . . . 8.120.3.15Write . . . . . . . . . . . . . . . . . . . . . . . . . 8.120.3.16Write . . . . . . . . . . . . . . . . . . . . . . . . . 8.120.3.17WritePdfHeader . . . . . . . . . . . . . . . . . . . 8.120.3.18WritePdfObjects . . . . . . . . . . . . . . . . . . .
lvii 470 470 470 471 471 471 471 472 472 472 473 473 473 473 474 474 474 474 474 475 475 475 475 475 475 476 476 476 476 476 477 477 477 477
lviii
CONTENTS 8.120.3.19WriteToBuffer . . . . . . . . . . . . . . . . . . . . 8.120.4 Member Data Documentation . . . . . . . . . . . . . . . . . 8.120.4.1 m_vecObjects . . . . . . . . . . . . . . . . . . . . 477 478 478 478 479 479 479 479 480 480 480 480 481 481 481 481 481 482 482 483 483 483 483 483 483 483 484 484 484 484 484 485 485 486
8.121PoDoFo::PdfXObject Class Reference . . . . . . . . . . . . . . . . . 8.121.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.121.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.121.2.1 PdfXObject . . . . . . . . . . . . . . . . . . . . . 8.121.2.2 PdfXObject . . . . . . . . . . . . . . . . . . . . . 8.121.2.3 PdfXObject . . . . . . . . . . . . . . . . . . . . . 8.121.2.4 PdfXObject . . . . . . . . . . . . . . . . . . . . . 8.121.3 Member Function Documentation . . . . . . . . . . . . . . . 8.121.3.1 GetContents . . . . . . . . . . . . . . . . . . . . . 8.121.3.2 GetContentsForAppending . . . . . . . . . . . . . 8.121.3.3 GetIdentier . . . . . . . . . . . . . . . . . . . . . 8.121.3.4 GetObjectReference . . . . . . . . . . . . . . . . . 8.121.3.5 GetPageSize . . . . . . . . . . . . . . . . . . . . . 8.121.3.6 GetResources . . . . . . . . . . . . . . . . . . . . 8.122PoDoFo::PdfXRef Class Reference . . . . . . . . . . . . . . . . . . . 8.122.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.122.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.122.2.1 PdfXRef . . . . . . . . . . . . . . . . . . . . . . . 8.122.2.2 PdfXRef . . . . . . . . . . . . . . . . . . . . . . 8.122.3 Member Function Documentation . . . . . . . . . . . . . . . 8.122.3.1 AddObject . . . . . . . . . . . . . . . . . . . . . . 8.122.3.2 BeginWrite . . . . . . . . . . . . . . . . . . . . . 8.122.3.3 EndWrite . . . . . . . . . . . . . . . . . . . . . . . 8.122.3.4 GetOffset . . . . . . . . . . . . . . . . . . . . . . 8.122.3.5 GetSize . . . . . . . . . . . . . . . . . . . . . . . 8.122.3.6 Write . . . . . . . . . . . . . . . . . . . . . . . . . 8.122.3.7 WriteSubSection . . . . . . . . . . . . . . . . . . . 8.122.3.8 WriteXRefEntry . . . . . . . . . . . . . . . . . . . 8.123PoDoFo::PdfXRefStream Class Reference . . . . . . . . . . . . . . . 8.123.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.123.2 Constructor & Destructor Documentation . . . . . . . . . . .
CONTENTS 8.123.2.1 PdfXRefStream . . . . . . . . . . . . . . . . . . . 8.123.2.2 PdfXRefStream . . . . . . . . . . . . . . . . . . 8.123.3 Member Function Documentation . . . . . . . . . . . . . . . 8.123.3.1 BeginWrite . . . . . . . . . . . . . . . . . . . . . 8.123.3.2 EndWrite . . . . . . . . . . . . . . . . . . . . . . . 8.123.3.3 GetOffset . . . . . . . . . . . . . . . . . . . . . . 8.123.3.4 WriteSubSection . . . . . . . . . . . . . . . . . . . 8.123.3.5 WriteXRefEntry . . . . . . . . . . . . . . . . . . . 8.124PoDoFo::PdfXRefStreamParserObject Class Reference . . . . . . . . 8.124.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.124.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.124.2.1 PdfXRefStreamParserObject . . . . . . . . . . . . 8.124.3 Member Function Documentation . . . . . . . . . . . . . . . 8.124.3.1 GetPreviousOffset . . . . . . . . . . . . . . . . . . 8.124.3.2 HasPrevious . . . . . . . . . . . . . . . . . . . . . 8.125PoDoFo::PdfZapfDingbatsEncoding Class Reference . . . . . . . . . 8.125.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.125.2 Constructor & Destructor Documentation . . . . . . . . . . . 8.125.2.1 PdfZapfDingbatsEncoding . . . . . . . . . . . . . 8.125.3 Member Function Documentation . . . . . . . . . . . . . . . 8.125.3.1 GetToUnicodeTable . . . . . . . . . . . . . . . . . 8.126PoDoFo::PdfVecObjects::StreamFactory Class Reference . . . . . . . 8.126.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 8.126.2 Member Function Documentation . . . . . . . . . . . . . . . 8.126.2.1 CreateStream . . . . . . . . . . . . . . . . . . . . 8.127PoDoFo::TFontCacheElement Struct Reference . . . . . . . . . . . . 8.127.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . 9 File Documentation 9.1 PdfDenes.h File Reference . . . . . . . . . . . . . . . . . . . . . . 9.1.1 9.1.2 Detailed Description . . . . . . . . . . . . . . . . . . . . . . Dene Documentation . . . . . . . . . . . . . . . . . . . . . 9.1.2.1 9.1.2.2 ePdfBlendMode_Normal . . . . . . . . . . . . . . ePdfRenderingIntent_AbsoluteColorimetric . . . .
lix 486 486 486 486 486 486 487 487 487 488 488 488 489 489 489 489 489 490 490 490 490 490 490 491 491 491 491 493 493 495 495 495 495
lx 9.1.2.3 9.1.2.4 9.2
CONTENTS PODOFO_MAKE_VERSION_REAL . . . . . . . PODOFO_MAKE_VERSION_STR_REAL . . . . 495 495 495 497 497 497 497 497 498 498
PdfError.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . 9.2.1 9.2.2 Detailed Description . . . . . . . . . . . . . . . . . . . . . . Dene Documentation . . . . . . . . . . . . . . . . . . . . . 9.2.2.1 9.2.2.2 9.2.2.3 PODOFO_RAISE_ERROR . . . . . . . . . . . . . PODOFO_RAISE_ERROR_INFO . . . . . . . . . PODOFO_RAISE_LOGIC_IF . . . . . . . . . . .
9.3
PdfFiltersPrivate.h File Reference . . . . . . . . . . . . . . . . . . . 9.3.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . .
Chapter 1
Main Page
PdfCompilerCompat.h gathers up nastyness required for various compiler compatibility into a central place. All compiler-specic denes, wrappers, and the like should be included here and (if necessary) in PdfCompilerCompat.cpp if they must be visible to public users of the library. If the nasty platform and compiler specic hacks can be kept to PoDoFos build and need not be visible to users of the library, put them in PdfCompilerCompatPrivate.{cpp,h} instead. Please NEVER use symbols from this header or the PoDoFo::compat namespace in a "using" directive. Always explicitly reference names so its clear that youre pulling them from the compat cruft.
Main Page
Chapter 2
(Codingstyle)
This document tries to give an overview of the codingstyle used in PoDoFo. To keep the code consistent every commit should apply to this codingstyle. The codingstyle of PoDoFo is in no way perfect and is in parts not even the preferred codingstyle of the maintainers. But consistency is more important than personal preferences and most parts of the style can be applied through simple editor settings. 2006 Dominik Seichter <domseichter@web.de> 0. Overall Rule =============== Documentation is an important part of PoDoFo. Every class and method should include appropriate documentation in Doxygen format so that automatic API documentation can be generated and the code can be easily understand by everyone. The comments are most important in the header files, though additional information may also be included in the source itself if necessary. 1. Code formatting ================== 1.1 Indentation The code is indented by 4 spaces. No tabs and no discussion ;) 1.2 Brackets Brackets always start in a new line of their own. The only exception are class and struct declarations and try and catch blocks. Example: if( true ) { // do something } but
4
class MyClass { };
(Codingstyle)
If only one line follows after an if or while statement, no brackets are needed, however they may be used if the author feels that there is a possibility for future expansion in that area.
1.3 Inline functions Inline functions are declared in the class definition in the header file. They are implemented in the header file after the class definition. The author may choose to either implement them directly at the same location as the declaration or may place them at the end of the header file (preferred). 2. Naming ========= 2.1 Variables Someone started to use hungarian notation in PoDoFo. Well, the maintainer thinks this was one of the worst ideas he ever had... . Nontheless, the point is consistency and not personall preference. PoDoFo uses hungarian notation for the following types: enum typenames should start with an E enum variables should start with an e struture typesnames should start with a T struture variables should start with a t pointer should start with a p strings should start with a s c-strings should start with psz (pointer zero terminated) numbers should start with a n longs should start with a l bools should start with a b references often start with a Example: bool long char* int bDecision; lValue; pszString; nNumber;
2.2 Member variables Member variables in classes are additionally prefixed with "m_". Examples: class MyClass { private: bool m_bMemberVar; }; 2.3 Methods
5
All methods start with an uppercase letter and every new word is capitalized again. MyClass::FunctionWithLongName( long lParameter ); Properties are set using a function with the prefix "Set", and retrieved with a "Get". Also, unless there is a good reason not to - all "Getters" should be marked as const. MyClass::SetProperty( long lValue ); long MyClass::GetProperty() const; Additionally, please use the prefixes "Has" and "Is" when appropriate. E.g. PdfDictionary::HasKey(); PdfDocument::IsLinearized(); Avoid the throw() qualifier (see 3.5). 2.4 NULL-Pointers NULL Pointers are initialized in the code with the constant NULL. Please do not use 0 or 0L but use NULL. 3. General Guidelines =================== 3.1 Casting C++ style casting is strongly preferred, and the use of C-style casts will generate warnings on gcc builds. Use, as appropriate, static_cast<> const_cast<> reinterpret_cast<> Dynamic casting and typeid are not presently used in PoDoFo. const_cast<> should be avoided unless it is absolutely required, especially for const char * variables that might ever take a string literal value. 3.2 Local variable declaration Local variables should always be declared closest to their point of use, and should be declared const wherever possible. For example: Thing f() { Thing ret; // blah blah blah ret = DoSomething(); // blah blah blah return ret; } would be better written as: Thing f() { // blah blah blah Thing ret ( DoSomething() );
6
// blah blah blah return ret; } Remember your const pointers: char * x; const char * x; char * const x; const char * const x; 3.3 Static arrays Pointer to char Pointer to const char Const pointer to char Const pointer to const char
(Codingstyle)
Static data should be declared as an array of const char rather than a pointer to const char whereever possible. This will help the compiler put it in the static read only data section of the compiled object, resulting in a smaller memory footprint, faster load times, and hardware protection against accidental writes to the data. const char myStaticData[] = "This is the right way". const char * myStaticData = "Avoid this way". Two dimensional arrays may be specified in a similar way - see s_szPdfVersions in PdfDefines.{cpp,h} . Its usually better to waste a few bytes by padding the array to the length of the longest member and get it into the readonly data section of the executable than it is to use an array of pointers to char and save a few bytes. Which is best is, however, dependent on what "a few bytes" is in a given situation. 3.4 Use of temporary objects Where possible, it can be better to use a temporary rather than storing a named object, eg: DoSomething( PdfName("blah") ); rather than PdfName n("blah"); DoSomething( n ); as this makes it easier for the compiler to optimise the call, may reduce the stack size of the function, etc. Dont forget to consider the lifetime of the temporary, however. 3.5 The throw qualifier Under no circumstances use exception specifiers, even the empty exception specifier throw(). C++ checked exceptions - when implemented according to the standard - are essentially useless and may actually be costly. If you want to tell the compiler a method will not throw (as an optimisation) use a macro for __declspec(nothrow) instead. podofoapi provides appropriate macros for use in podofo. (Note that VC++ treats throw() as __declspec(nothrow) in violation of the standard, but thats all the more reason to just use __declspec(nothrow)). see: http://msdn2.microsoft.com/en-us/library/49147z04.aspx http://gcc.gnu.org/onlinedocs/gcc-3.3.1/gcc/Function-Attributes.html 3.6 Exported API
7
PoDoFo draws a distinction between exported and private API on some platforms (currently Windows DLL builds and gcc 4 with PODOFO_USE_VISIBILITY). To do this it uses some macros defined in podofoapi.h to tell the compiler whats public API that should appear in the DLL/shared librarys symbol table. The rest is not exported. This may have several positive effects depending on the particular platform and compiler. It can result in a smaller binary, better link times, help the compiler optimise better, and ensure that API intended to be private to PoDoFo _cannot_ be called from outside it. If you add new classes to PoDoFo, annotate them with PODOFO_API as shown in podofoapi.h if theyre intended as public API. If an outside user will ever need to reference those symbols directly (by constructing the class, calling its methods, etc) theyre public. Note that classes that only inherit and implement an abstract interface (adding no other public methods intended for use outside PoDoFo) thatre only constructed through a factory or through other PoDoFo classes need not be exported. If you have a class that needs to be exported as public API, but it has quite a few methods that do not need to be externally visible (private helper methods etc), you can annotate those with the PODOFO_LOCAL macro as shown in podofoapi.h . This omits just those methods from the symbol table. Note that if the methods are accessed via public or protected inline functions it is not safe to make them private. If in doubt, ask for help on podofo-users. It also helps to build PoDoFo as a DLL (Windows) or, on UNIX platforms, use gcc4 and enable visibility support. This will help catch cases where you forgot to export required API. 3.7 Memory allocations in inlined methods Its not safe to (directly) allocate or free heap memory in an inlined function, because it only works if the same runtime library is used in the shared library and the executable linking to the library. Using malloc and/or new in inlined methods will lead to crashes on MS Windows systems. It might be undetected on Linux systems (even though it is bad style on Linux, too), because most processes and libraries use the same runtime library on a Linux system. Theres also no point inlining functions that call new / delete / malloc / free, because the memory allocation is dramatically more expensive than a mere function call is. Using STL classes that may perform allocations internally is fine since they tend to carry their own std::allocator instance (or reference, anyway) around with them. 3.8 Visibility of 3rd party headers If at all possible, its desirable not to expose the use of 3rd party headers in the PoDoFo headers. Rather than including headers for required libraries, try to forward-declare required types and then include the header in the implementation (.cpp) files. If the header is widely used, you might want to put it in PdfDefinesPrivate.h . Widely used forward declarations can go in Pdf3rdPtyForwardDecl.h . Avoiding exposing used 3rd party headers means that users build systems dont need to know how to find those headers, and means that users programs
(Codingstyle)
dont get their namespaces polluted by unrelated symbols from libjpeg, zlib, libtiff, freetype, etc etc etc. As some headers (*cough*freetype*cough*) arent trivial to reliably locate, this can really simplify the build of tools that use PoDoFo. This applies to some system headers too. <windows.h> for example is a difficult and quirky header. Its behaviour is strongly affected by a variety of preprocessor definitions and it scatters macros everywhere. We shouldnt be exposing it to library users, because its quite likely theyll need to include it with different macro parameters, and theirs may conflict with ours or vice versa. If you need to include a 3rd party header to make something a direct member, consider making it a member by pointer instead, initializing it in the objects ctor and destroying it it the dtor. That way you dont need to include the 3rd partys header to get access to their type sizes in the PoDoFo headers, only in the .cpp files. See, for example, PdfMutex.h .
4. Structure ============ 4.1 Project structure The PoDoFo project is structure as follows. There are two libraries: podofo-base and podofo-doc. Podofo-base contains everythign needed to work with reading, writing and modifying PDF files and there objects. It should have a minimal set of dependencies. Podofo-doc provides a rich interface, which also allows to easily create PDF files using the PdfPainter and PdfFont infrastructure. Additionally, there are two more projects. The test/ subdirectory contains tests for both libraries. All new tests shall go to the test/unit/ sub-projects to provide unit-tests for PoDoFo. Utility programs that come with PoDoFo go into the tools/ subdirectory. These tools provide a direct benefit for end users who want to work with PDF files on the commandline and are also a nice way to showcase the features of the PoDoFo libraries to new developers.
Chapter 3
Namespace Index
3.1 Namespace List
Here is a list of all documented namespaces with brief descriptions: PoDoFo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
10
Namespace Index
Chapter 4
Class Index
4.1 Class Hierarchy
This inheritance list is sorted roughly, but not completely, alphabetically: PoDoFo::MD5Context . . . . . . . . . . . PoDoFo::NamedColorComparatorPredicate PoDoFo::PdfVecObjects::Observer . . . . . PoDoFo::PdfCanvas . . . . . . . . . . . . . PoDoFo::PdfPage . . . . . . . . . . . . PoDoFo::PdfXObject . . . . . . . . . . PoDoFo::PdfImage . . . . . . . . . PoDoFo::PdfCheckBox . . . . . . . . . . . PoDoFo::PdfColor . . . . . . . . . . . . . PoDoFo::PdfDataType . . . . . . . . . . . PoDoFo::PdfData . . . . . . . . . . . . PoDoFo::PdfName . . . . . . . . . . . PoDoFo::PdfReference . . . . . . . . . PoDoFo::PdfString . . . . . . . . . . . PoDoFo::PdfDate . . . . . . . . . . . . . . PoDoFo::PdfDestination . . . . . . . . . . PoDoFo::PdfDocument . . . . . . . . . . . PoDoFo::PdfMemDocument . . . . . . PoDoFo::PdfStreamedDocument . . . . PoDoFo::PdfElement . . . . . . . . . . . . PoDoFo::PdfAction . . . . . . . . . . . PoDoFo::PdfAnnotation . . . . . . . . PoDoFo::PdfContents . . . . . . . . . . PoDoFo::PdfDifferenceEncoding . . . . PoDoFo::PdfExtGState . . . . . . . . . PoDoFo::PdfFileSpec . . . . . . . . . . PoDoFo::PdfFont . . . . . . . . . . . . PoDoFo::PdfFontCID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 37 37 56 302 478 225 58 60 79 77 272 371 414 81 83 98 248 409 114 38 41 73 91 152 158 180 190
12
Class Index PoDoFo::PdfFontSimple . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfFontTrueType . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfFontType1 . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfFontType1Base14 . . . . . . . . . . . . . . . . . . . PoDoFo::PdfFunction . . . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfExponentialFunction . . . . . . . . . . . . . . . . . . . PoDoFo::PdfSampledFunction . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfStitchingFunction . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfOutlineItem . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfOutlines . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfPage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfPagesTree . . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfShadingPattern . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfAxialShadingPattern . . . . . . . . . . . . . . . . . . . PoDoFo::PdfFunctionBaseShadingPattern . . . . . . . . . . . . . . . PoDoFo::PdfRadialShadingPattern . . . . . . . . . . . . . . . . . . . PoDoFo::PdfXObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfEncoding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfDifferenceEncoding . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfIdentityEncoding . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfSimpleEncoding . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfDocEncoding . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfMacRomanEncoding . . . . . . . . . . . . . . . . . . . PoDoFo::PdfStandardEncoding . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfSymbolEncoding . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfWinAnsiEncoding . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfZapfDingbatsEncoding . . . . . . . . . . . . . . . . . . PoDoFo::PdfEncodingDifference . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfEncodingFactory . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfEncodingObjectFactory . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfEncrypt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfEncryptAES . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfEncryptRC4 . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfError . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfAscii85Filter . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfFlateFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfHexFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfLZWFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfRLEFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfFilterFactory . . . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfFontCache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfFontFactory . . . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfFontMetrics . . . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfFontTTFSubset . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfInputDevice . . . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfInputStream . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206 208 212 214 216 151 379 399 229 288 295 302 310 380 53 217 358 478 119 91 221 387 96 247 398 423 471 489 123 125 128 128 140 142 144 163 49 176 219 244 376 173 186 192 194 209 234 237
4.1 Class Hierarchy PoDoFo::PdfDeviceInputStream . . . . . PoDoFo::PdfFileInputStream . . . . . . . PoDoFo::PdfMemoryInputStream . . . . PoDoFo::PdfRC4InputStream . . . . . . PoDoFo::PdfListField . . . . . . . . . . . . . PoDoFo::PdfComboBox . . . . . . . . . PoDoFo::PdfListBox . . . . . . . . . . . PoDoFo::Util::PdfMutexImpl . . . . . . . . . PoDoFo::Util::PdfMutexWrapper . . . . . . . PoDoFo::PdfNamedColor . . . . . . . . . . . PoDoFo::PdfObjectStreamParserObject . . . PoDoFo::PdfOutputDevice . . . . . . . . . . PoDoFo::PdfSignOutputDevice . . . . . . PoDoFo::PdfOutputStream . . . . . . . . . . PoDoFo::PdfBufferOutputStream . . . . . PoDoFo::PdfDeviceOutputStream . . . . PoDoFo::PdfFileOutputStream . . . . . . PoDoFo::PdfFilteredDecodeStream . . . PoDoFo::PdfFilteredEncodeStream . . . . PoDoFo::PdfMemoryOutputStream . . . PoDoFo::PdfRC4OutputStream . . . . . . PoDoFo::PdfPagesTreeCache . . . . . . . . . PoDoFo::PdfPainter . . . . . . . . . . . . . . PoDoFo::PdfPainterMM . . . . . . . . . PoDoFo::PdfPredictorDecoder . . . . . . . . PoDoFo::PdfPushButton . . . . . . . . . . . PoDoFo::PdfRC4Stream . . . . . . . . . . . PoDoFo::PdfRect . . . . . . . . . . . . . . . PoDoFo::PdfRefCountedBuffer . . . . . . . . PoDoFo::PdfRefCountedInputDevice . . . . PoDoFo::PdfRijndael . . . . . . . . . . . . . PoDoFo::PdfSignatureField . . . . . . . . . . PoDoFo::PdfStream . . . . . . . . . . . . . . PoDoFo::PdfFileStream . . . . . . . . . . PoDoFo::PdfMemStream . . . . . . . . . PoDoFo::PdfTable . . . . . . . . . . . . . . . PoDoFo::PdfTableModel . . . . . . . . . . . PoDoFo::PdfSimpleTableModel . . . . . PoDoFo::PdfTextField . . . . . . . . . . . . PoDoFo::PdfTokenizer . . . . . . . . . . . . PoDoFo::PdfContentsTokenizer . . . . . PoDoFo::PdfParser . . . . . . . . . . . . PoDoFo::PdfParserObject . . . . . . . . . PoDoFo::PdfXRefStreamParserObject PoDoFo::NonPublic::PdfTTFWriter . . . . . PoDoFo::PdfType1Encrypt . . . . . . . . . . PoDoFo::PdfVariant . . . . . . . . . . . . . .
13 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89 155 261 360 239 71 238 269 271 277 288 296 383 301 54 90 157 170 172 262 361 314 315 337 356 356 362 362 366 369 375 382 400 159 264 424 431 391 435 440 74 342 353 487 446 447 448
14 PoDoFo::PdfObject . . . . . . . . . PoDoFo::PdfParserObject . . . . PoDoFo::PdfVecObjects . . . . . . . . PoDoFo::PdfWriter . . . . . . . . . . . PoDoFo::PdfXRef . . . . . . . . . . . . PoDoFo::PdfXRefStream . . . . . . PoDoFo::PdfVecObjects::StreamFactory PoDoFo::TFontCacheElement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Class Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279 353 462 472 482 485 490 491
Chapter 5
Class Index
5.1 Class List
Here are the classes, structs, unions and interfaces with brief descriptions: PoDoFo::MD5Context (Structure representing an MD5 context while ecrypting. (For internal use only) ) . . . . . . . . . . . . . . . . . . . . PoDoFo::NamedColorComparatorPredicate . . . . . . . . . . . . . . . . . PoDoFo::PdfVecObjects::Observer . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfAction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfAnnotation . . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfAscii85Filter . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfAxialShadingPattern . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfBufferOutputStream . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfCanvas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfCheckBox . . . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfColor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfComboBox . . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfContents . . . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfContentsTokenizer . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfDataType . . . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfDate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfDestination . . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfDeviceInputStream . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfDeviceOutputStream . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfDifferenceEncoding . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfDocEncoding . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfDocument . . . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfElement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfEncoding . . . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfEncodingDifference . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfEncodingFactory . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfEncodingObjectFactory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 37 37 38 41 49 53 54 56 58 60 71 73 74 77 79 81 83 89 90 91 96 98 114 119 123 125 128
16 PoDoFo::PdfEncrypt . . . . . . . . . . . PoDoFo::PdfEncryptAES . . . . . . . . PoDoFo::PdfEncryptRC4 . . . . . . . . PoDoFo::PdfError . . . . . . . . . . . . PoDoFo::PdfExponentialFunction . . . . PoDoFo::PdfExtGState . . . . . . . . . . PoDoFo::PdfFileInputStream . . . . . . PoDoFo::PdfFileOutputStream . . . . . . PoDoFo::PdfFileSpec . . . . . . . . . . PoDoFo::PdfFileStream . . . . . . . . . PoDoFo::PdfFilter . . . . . . . . . . . . PoDoFo::PdfFilteredDecodeStream . . . PoDoFo::PdfFilteredEncodeStream . . . PoDoFo::PdfFilterFactory . . . . . . . . PoDoFo::PdfFlateFilter . . . . . . . . . . PoDoFo::PdfFont . . . . . . . . . . . . . PoDoFo::PdfFontCache . . . . . . . . . PoDoFo::PdfFontCID . . . . . . . . . . PoDoFo::PdfFontFactory . . . . . . . . . PoDoFo::PdfFontMetrics . . . . . . . . . PoDoFo::PdfFontSimple . . . . . . . . . PoDoFo::PdfFontTrueType . . . . . . . . PoDoFo::PdfFontTTFSubset . . . . . . . PoDoFo::PdfFontType1 . . . . . . . . . PoDoFo::PdfFontType1Base14 . . . . . PoDoFo::PdfFunction . . . . . . . . . . PoDoFo::PdfFunctionBaseShadingPattern PoDoFo::PdfHexFilter . . . . . . . . . . PoDoFo::PdfIdentityEncoding . . . . . . PoDoFo::PdfImage . . . . . . . . . . . . PoDoFo::PdfInfo . . . . . . . . . . . . . PoDoFo::PdfInputDevice . . . . . . . . . PoDoFo::PdfInputStream . . . . . . . . . PoDoFo::PdfListBox . . . . . . . . . . . PoDoFo::PdfListField . . . . . . . . . . PoDoFo::PdfLZWFilter . . . . . . . . . PoDoFo::PdfMacRomanEncoding . . . . PoDoFo::PdfMemDocument . . . . . . . PoDoFo::PdfMemoryInputStream . . . . PoDoFo::PdfMemoryOutputStream . . . PoDoFo::PdfMemStream . . . . . . . . . PoDoFo::Util::PdfMutexImpl . . . . . . PoDoFo::Util::PdfMutexWrapper . . . . PoDoFo::PdfName . . . . . . . . . . . . PoDoFo::PdfNamedColor . . . . . . . . PoDoFo::PdfObject . . . . . . . . . . . . PoDoFo::PdfObjectStreamParserObject . PoDoFo::PdfOutlineItem . . . . . . . . . PoDoFo::PdfOutlines . . . . . . . . . . . PoDoFo::PdfOutputDevice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Class Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128 140 142 144 151 152 155 157 158 159 163 170 172 173 176 180 186 190 192 194 206 208 209 212 214 216 217 219 221 225 229 234 237 238 239 244 247 248 261 262 264 269 271 272 277 279 288 288 295 296
5.1 Class List PoDoFo::PdfOutputStream . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfPage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfPagesTree . . . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfPagesTreeCache . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfPainter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfPainterMM . . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfParser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfParserObject . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfPredictorDecoder . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfPushButton . . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfRadialShadingPattern . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfRC4InputStream . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfRC4OutputStream . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfRC4Stream . . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfRect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfRefCountedBuffer . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfRefCountedInputDevice . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfReference . . . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfRijndael (Class implementing the Rijndael cipher. (For internal use only) ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfRLEFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfSampledFunction . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfShadingPattern . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfSignatureField . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfSignOutputDevice . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfSimpleEncoding . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfSimpleTableModel . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfStandardEncoding . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfStitchingFunction . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfStream . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfStreamedDocument . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfSymbolEncoding . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfTable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfTableModel . . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfTextField . . . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfTokenizer . . . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::NonPublic::PdfTTFWriter . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfType1Encrypt . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfVariant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfVecObjects . . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfWinAnsiEncoding . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfWriter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfXObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfXRef . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfXRefStream . . . . . . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfXRefStreamParserObject . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfZapfDingbatsEncoding . . . . . . . . . . . . . . . . . . . . . PoDoFo::PdfVecObjects::StreamFactory . . . . . . . . . . . . . . . . . . . PoDoFo::TFontCacheElement . . . . . . . . . . . . . . . . . . . . . . . .
17 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301 302 310 314 315 337 342 353 356 356 358 360 361 362 362 366 369 371 375 376 379 380 382 383 387 391 398 399 400 409 414 423 424 431 435 440 446 447 448 462 471 472 478 482 485 487 489 490 491
18
Class Index
Chapter 6
File Index
6.1 File List
Here is a list of all documented les with brief descriptions: PdfDenes.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 493 PdfError.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495 PdfFiltersPrivate.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 498
20
File Index
Chapter 7
Namespace Documentation
7.1 PoDoFo Namespace Reference
Classes
class PdfCanvas class PdfNamedColor class NamedColorComparatorPredicate class PdfColor class PdfContentsTokenizer class PdfData class PdfDataType class PdfDate class PdfEncoding class PdfSimpleEncoding class PdfDocEncoding class PdfWinAnsiEncoding class PdfMacRomanEncoding class PdfStandardEncoding class PdfSymbolEncoding class PdfZapfDingbatsEncoding class PdfEncodingFactory class PdfRC4Stream class PdfRC4OutputStream class PdfRC4InputStream struct MD5Context
Structure representing an MD5 context while ecrypting. (For internal use only).
class PdfEncrypt class PdfEncryptAES class PdfEncryptRC4 class PdfError
22 class PdfFileStream class PdfFilteredEncodeStream class PdfFilteredDecodeStream class PdfFilter class PdfFilterFactory class PdfPredictorDecoder class PdfHexFilter class PdfAscii85Filter class PdfFlateFilter class PdfRLEFilter class PdfLZWFilter class PdfInputDevice class PdfInputStream class PdfFileInputStream class PdfMemoryInputStream class PdfDeviceInputStream class PdfMemStream class PdfName class PdfObject class PdfObjectStreamParserObject class PdfOutputDevice class PdfOutputStream class PdfFileOutputStream class PdfMemoryOutputStream class PdfDeviceOutputStream class PdfBufferOutputStream class PdfParser class PdfParserObject class PdfRect class PdfRefCountedBuffer class PdfRefCountedInputDevice class PdfReference class PdfRijndael
Class implementing the Rijndael cipher. (For internal use only).
class PdfStream class PdfString class PdfTokenizer class PdfVariant class PdfVecObjects class PdfWriter class PdfXRef class PdfXRefStream class PdfXRefStreamParserObject class PdfAction class PdfAnnotation
7.1 PoDoFo Namespace Reference class PdfContents class PdfDestination class PdfEncodingDifference class PdfDifferenceEncoding class PdfDocument class PdfElement class PdfEncodingObjectFactory class PdfExtGState class PdfPushButton class PdfCheckBox class PdfTextField class PdfListField class PdfComboBox class PdfListBox class PdfFileSpec class PdfFont struct TFontCacheElement class PdfFontCache class PdfFontCID class PdfFontFactory class PdfFontMetrics class PdfFontSimple class PdfFontTrueType class PdfFontTTFSubset class PdfFontType1 class PdfType1Encrypt class PdfFontType1Base14 class PdfFunction class PdfSampledFunction class PdfExponentialFunction class PdfStitchingFunction class PdfIdentityEncoding class PdfImage class PdfInfo class PdfMemDocument class PdfOutlineItem class PdfOutlines class PdfPage class PdfPagesTree class PdfPagesTreeCache class PdfPainter class PdfPainterMM class PdfShadingPattern class PdfAxialShadingPattern class PdfFunctionBaseShadingPattern class PdfRadialShadingPattern
23
24 class PdfSignatureField class PdfSignOutputDevice class PdfStreamedDocument class PdfTableModel class PdfSimpleTableModel class PdfTable class PdfXObject
Typedefs
typedef std::vector< PdfObject > PdfArrayBaseClass typedef struct PoDoFo::MD5Context MD5_CTX
Enumerations
enum EPdfContentsType { ePdfContentsType_Keyword, ePdfContentsType_Variant, ePdfContentsType_ImageData } enum EPdfVersion { ePdfVersion_1_0 = 0, ePdfVersion_1_1, ePdfVersion_1_2, ePdfVersion_1_3, ePdfVersion_1_4, ePdfVersion_1_5, ePdfVersion_1_6, ePdfVersion_1_7 } enum EPdfWriteMode { ePdfWriteMode_Compact = 0x01, ePdfWriteMode_Clean = 0x02 } enum EPdfDataType { ePdfDataType_Bool, ePdfDataType_String, ePdfDataType_HexString, ePdfDataType_Dictionary, ePdfDataType_Number, ePdfDataType_Name, ePdfDataType_Real, ePdfDataType_Array,
ePdfDataType_Null, ePdfDataType_Reference, ePdfDataType_RawData, ePdfDataType_Unknown } enum EPdfFilter { ePdfFilter_ASCIIHexDecode, ePdfFilter_ASCII85Decode , ePdfFilter_FlateDecode, ePdfFilter_RunLengthDecode } enum EPdfFontType enum EPdfColorSpace { ePdfColorSpace_DeviceGray, ePdfColorSpace_DeviceRGB, ePdfColorSpace_DeviceCMYK, ePdfColorSpace_Separation, ePdfColorSpace_CieLab } enum EPdfStrokeStyle enum EPdfLineCapStyle enum EPdfLineJoinStyle enum EPdfVerticalAlignment enum EPdfAlignment
7.1 PoDoFo Namespace Reference enum EPdfPageSize { ePdfPageSize_A0, ePdfPageSize_A1, ePdfPageSize_A2, ePdfPageSize_A3,
25
ePdfPageSize_A4, ePdfPageSize_A5, ePdfPageSize_A6, ePdfPageSize_Letter, ePdfPageSize_Legal, ePdfPageSize_Tabloid } enum EPdfPageMode enum EPdfPageLayout enum EPdfError { ePdfError_ErrOk = 0, ePdfError_FileNotFound, ePdfError_TestFailed, ePdfError_InvalidHandle,
ePdfError_InvalidDeviceOperation, ePdfError_UnexpectedEOF, ePdfError_OutOfMemory, ePdfError_ValueOutOfRange, ePdfError_InternalLogic, ePdfError_InvalidEnumValue, PageNotFound, ePdfError_NoPdfFile, ePdfError_-
ePdfError_NoXRef, ePdfError_NoTrailer, ePdfError_NoNumber, ePdfError_NoObject, ePdfError_NoEOFToken, ePdfError_InvalidTrailerSize, InvalidLinearization, ePdfError_InvalidDataType, ePdfError_InvalidXRef, ePdfError_InvalidXRefStream, InvalidXRefType, ePdfError_InvalidPredictor, ePdfError_InvalidStrokeStyle, ePdfError_InvalidHexString, InvalidStream, ePdfError_InvalidStreamLength, ePdfError_InvalidKey, ePdfError_InvalidName, InvalidEncryptionDict, ePdfError_InvalidPassword, ePdfError_InvalidFontFile, ePdfError_InvalidContentStream, UnsupportedFilter, ePdfError_UnsupportedFontFormat, ePdfError_ePdfError_ePdfError_ePdfError_ePdfError_-
ePdfError_ActionAlreadyPresent, ePdfError_WrongDestinationType, ePdfError_MissingEndStream, ePdfError_Date, ePdfError_Flate, ePdfError_FreeType, ePdfError_SignatureError, ePdfError_MutexError, ePdfError_UnsupportedImageFormat, ePdfError_CannotConvertColor, ePdfError_NotImplemented, ePdfError_DestinationAlreadyPresent, ePdfError_ChangeOnImmutable, ePdfError_Unknown = 0xffff } enum ELogSeverity { eLogSeverity_Critical, eLogSeverity_Error, eLogSeverity_Information, eLogSeverity_Warning,
eLogSeverity_Debug, eLogSeverity_None, eLogSeverity_Unknown = 0xffff } enum EPdfAction enum EPdfAnnotation enum EPdfAnnotationFlags enum EPdfDestinationType enum EPdfField enum EPdfHighlightingMode { ePdfHighlightingMode_None, ePdfHighlightingMode_Invert, ePdfHighlightingMode_InvertOutline, ePdfHighlightingMode_Push }
26
Namespace Documentation enum EPdfFunctionType { ePdfFunctionType_Sampled = ePdfFunctionType_Exponential = 2, ePdfFunctionType_Stitching = ePdfFunctionType_PostScript = 4 } enum EPdfOutlineFormat { ePdfOutlineFormat_Default = ePdfOutlineFormat_Italic = 0x01, ePdfOutlineFormat_Bold = ePdfOutlineFormat_BoldItalic = 0x03 } 0, 3,
0x00, 0x02,
Functions
template<typename T > const T PDF_MAX (const T a, const T b) template<typename T > const T PDF_MIN (const T a, const T b) void PdfLocaleImbue (std::ios_base &s) bool podofo_is_little_endian () void podofo_malloc (size_t size) void podofo_realloc (void buffer, size_t size) void podofo_free (void buffer)
Variables
const EPdfVersion ePdfVersion_Default = ePdfVersion_1_3 const int s_nNumWhiteSpaces = 6
PDF Reference, Section 3.1.1, Table 3.1, White-space characters.
7.1.1
Detailed Description
All classes, functions, types and enums of PoDoFo are members of these namespace. If you use PoDoFo, you might want to add the line: using namespace PoDoFo; to your application. PODOFO_USE_UNORDERED_MAP If you set this dene, PoDoFo will use std::tr1::unordered_map instead of std::map for PdfDictionary. Some benchmarking tests using callgrind have shown that unordered_map is a little faster for writing and AddKey but of course slower for GetKey and HasKey. As PdfDictionaries are usually very small the difference for GetKey and HasKey is not very large and should therefore be rarely noticeable. By default this dene is not set and std::map will be used.
7.1 PoDoFo Namespace Reference
27
7.1.2
7.1.2.1
Typedef Documentation
typedef std::vector<PdfObject> PoDoFo::PdfArrayBaseClass
This class represents a PdfArray Use it for all arrays that are written to a PDF le. A PdfArray can hold any PdfVariant. See also PdfVariant
7.1.3
7.1.3.1
Enumeration Type Documentation

enum PoDoFo::ELogSeverity
Used in PdfError::LogMessage to specify the log level. See also PdfError::LogMessage Enumerator: eLogSeverity_Critical Critical unexpected error eLogSeverity_Error Error eLogSeverity_Warning Warning eLogSeverity_Information Information message eLogSeverity_Debug Debug information eLogSeverity_None No specied level eLogSeverity_Unknown Unknown log level
7.1.3.2
enum PoDoFo::EPdfAction
The type of the action. PDF supports different action types, each of them has different keys and propeties. Not all action types listed here are supported yet. Please make also sure that the action type you use is supported by the PDF version you are using.
7.1.3.3
enum PoDoFo::EPdfAlignment
Enum for text alignment

28 7.1.3.4 enum PoDoFo::EPdfAnnotation
The type of the annotation. PDF supports different annotation types, each of them has different keys and propeties. Not all annotation types listed here are supported yet. Please make also sure that the annotation type you use is supported by the PDF version you are using. 7.1.3.5 enum PoDoFo::EPdfAnnotationFlags
Flags that control the appearance of a PdfAnnotation. You can OR them together and pass it to PdfAnnotation::SetFlags. 7.1.3.6 enum PoDoFo::EPdfColorSpace
Enum for the colorspaces supported by PDF. Enumerator: ePdfColorSpace_DeviceGray Gray ePdfColorSpace_DeviceRGB RGB ePdfColorSpace_DeviceCMYK CMYK ePdfColorSpace_Separation Separation ePdfColorSpace_CieLab CIE-Lab
7.1.3.7
enum PoDoFo::EPdfContentsType
An enum describing the type of a read token Enumerator: ePdfContentsType_Keyword The token is a PDF keyword. ePdfContentsType_Variant The token is a PDF variant. A variant is usually a parameter to a keyword ePdfContentsType_ImageData The "token" is raw inline image data found between ID and EI tags (see PDF ref section 4.8.6)
7.1.3.8
enum PoDoFo::EPdfDataType
Every PDF datatype that can occur in a PDF le is referenced by an own enum (e.g. Bool or String). See also PdfVariant
7.1 PoDoFo Namespace Reference Remember to update PdfVariant::GetDataTypeString() when adding members here. Enumerator: ePdfDataType_Bool Boolean datatype: Accepts the values "true" and "false" ePdfDataType_Number Number datatype for integer values ePdfDataType_Real Real datatype for oating point numbers
29
ePdfDataType_String String datatype in PDF le. Strings have the form (Hallo World!) in PDF les. See also PdfString ePdfDataType_HexString HexString datatype in PDF le. Hex encoded strings have the form <AF00BE> in PDF les. See also PdfString ePdfDataType_Name Name datatype. Names are used as keys in dictionary to reference values. See also PdfName ePdfDataType_Array An array of other PDF data types. ePdfDataType_Dictionary A dictionary associates keys with values. A key can have another dictionary as value. ePdfDataType_Null The null datatype is always null. ePdfDataType_Reference The reference datatype contains references to PDF objects in the PDF le of the form 4 0 R. See also PdfObject ePdfDataType_RawData Raw PDF data ePdfDataType_Unknown The Datatype is unknown
7.1.3.9
enum PoDoFo::EPdfDestinationType
Destination type, as per 12.3.2.2 of the Pdf spec. (see table 151 in the pdf spec) 7.1.3.10 enum PoDoFo::EPdfError
Error Code denes which are used in PdfError to describe the error. If you add an error code to this enum, please also add it to PdfError::ErrorName and PdfError::ErrorMessage.
30 See also PdfError Enumerator:
ePdfError_ErrOk The default value indicating no error. ePdfError_TestFailed Used in PoDoFo tests, to indicate that a test failed for some reason. ePdfError_InvalidHandle Null pointer was passed, but null pointer is not allowed. ePdfError_FileNotFound A le was not found or cannot be opened. ePdfError_InvalidDeviceOperation Tried to do something unsupported to an I/O device like seek a non-seekable input device ePdfError_UnexpectedEOF End of le was reached but data was expected. ePdfError_OutOfMemory Not enough memory to complete an operation. ePdfError_ValueOutOfRange The specied memory is out of the allowed range. ePdfError_InternalLogic An internal sanity check or assertion failed. ePdfError_InvalidEnumValue An invalid enum value was specied. ePdfError_PageNotFound The requested page could not be found in the PDF. ePdfError_NoPdfFile The le is no PDF le. ePdfError_NoXRef The PDF le has no or an invalid XRef table. ePdfError_NoTrailer The PDF le has no or an invalid trailer. ePdfError_NoNumber A number was expected in the PDF le, but the read string is no number. ePdfError_NoObject A object was expected and non was found. ePdfError_NoEOFToken The PDF le has no or an invalid EOF marker. ePdfError_InvalidTrailerSize The trailer size is invalid. ePdfError_InvalidLinearization The linearization directory of a web-optimized PDF le is invalid. ePdfError_InvalidDataType The passed datatype is invalid or was not recognized ePdfError_InvalidXRef The XRef table is invalid ePdfError_InvalidXRefStream A XRef steam is invalid ePdfError_InvalidXRefType The XRef type is invalid or was not found ePdfError_InvalidPredictor Invalid or unimplemented predictor ePdfError_InvalidStrokeStyle Invalid stroke style during drawing ePdfError_InvalidHexString Invalid hex string ePdfError_InvalidStream The stream is invalid ePdfError_InvalidStreamLength The stream length is invlaid ePdfError_InvalidKey The specied key is invalid
7.1 PoDoFo Namespace Reference ePdfError_InvalidName The specied Name is not valid in this context
31
ePdfError_InvalidEncryptionDict The encryption dictionary is invalid or misses a required key ePdfError_InvalidPassword The password used to open the PDF le was invalid ePdfError_InvalidFontFile The font le is invalid ePdfError_InvalidContentStream The content stream is invalid due to mismatched context pairing or other problems ePdfError_UnsupportedFilter The requested lter is not yet implemented. ePdfError_UnsupportedFontFormat This font format is not supported by PoDoFO. ePdfError_ActionAlreadyPresent An Action was already present when trying to add a Destination ePdfError_WrongDestinationType The requested eld is not available for the given destination type ePdfError_MissingEndStream The required token endstream was not found. ePdfError_Date Date/time error ePdfError_Flate Error in zlib ePdfError_FreeType Error in FreeType ePdfError_SignatureError Error in signature ePdfError_MutexError Error during a mutex operation ePdfError_UnsupportedImageFormat This image format is not supported by PoDoFO. ePdfError_CannotConvertColor This color format cannot be converted. ePdfError_NotImplemented This feature is currently not implemented. ePdfError_DestinationAlreadyPresent An destination was already present when trying to add a Action ePdfError_ChangeOnImmutable Changing values on immutable objects is not allowed. ePdfError_Unknown Unknown error
7.1.3.11
enum PoDoFo::EPdfField
The type of PDF eld 7.1.3.12 enum PoDoFo::EPdfFilter
Every lter that can be used to encode a stream in a PDF le is referenced by an own enum value. Common lters are ePdfFilter_FlateDecode (i.e. Zip) or ePdfFilter_ASCIIHexDecode
32 Enumerator:
ePdfFilter_ASCIIHexDecode Converts data from and to hexadecimal. creases size of the data by a factor of 2! See also PdfHexFilter ePdfFilter_ASCII85Decode Converts to and from Ascii85 encoding. See also PdfAscii85Filter
In-
ePdfFilter_FlateDecode Compress data using the Flate algorithm of ZLib. This lter is recommended to be used always. See also PdfFlateFilter ePdfFilter_RunLengthDecode Run length decode data. See also PdfRLEFilter
7.1.3.13
enum PoDoFo::EPdfFontType
Enum for the different font formats supported by PoDoFo 7.1.3.14 enum PoDoFo::EPdfFunctionType
The function type of a mathematical function in a PDF le. Enumerator: ePdfFunctionType_Sampled A sampled function (Type1). ePdfFunctionType_Exponential An exponential interpolation function (Type2). ePdfFunctionType_Stitching A stitching function (Type3). ePdfFunctionType_PostScript A PostScript calculator function (Type4).
7.1.3.15
enum PoDoFo::EPdfHighlightingMode
The possible highlighting modes for a PdfField. I.e the visual effect that is to be used when the mouse button is pressed. The default value is ePdfHighlightingMode_Invert Enumerator: ePdfHighlightingMode_None Do no highlighting.
7.1 PoDoFo Namespace Reference ePdfHighlightingMode_Invert Invert the PdfField. ePdfHighlightingMode_InvertOutline Invert the elds border.
33
ePdfHighlightingMode_Push Display the elds down appearance (requires an additional appearance stream to be set).
7.1.3.16
enum PoDoFo::EPdfLineCapStyle
Enum for line cap styles when drawing. 7.1.3.17 enum PoDoFo::EPdfLineJoinStyle
Enum for line join styles when drawing. 7.1.3.18 enum PoDoFo::EPdfOutlineFormat
The title of an outline item can be displayed in different formating styles since PDF 1.4. Enumerator: ePdfOutlineFormat_Default Default format ePdfOutlineFormat_Italic Italic ePdfOutlineFormat_Bold Bold ePdfOutlineFormat_BoldItalic Bold Italic
7.1.3.19
enum PoDoFo::EPdfPageLayout
Enum holding the supported of types of "PageLayouts" that dene how Acrobat will display the pages in relation to each other See also PdfDocument
7.1.3.20
enum PoDoFo::EPdfPageMode
Enum holding the supported of types of "PageModes" that dene which (if any) of the "panels" are opened in Acrobat when the document is opened. See also PdfDocument
34 7.1.3.21 enum PoDoFo::EPdfPageSize
Enum holding the supported page sizes by PoDoFo. Can be used to construct a PdfRect structure with measurements of a page object. See also PdfPage Enumerator: ePdfPageSize_A0 DIN A0 ePdfPageSize_A1 DIN A1 ePdfPageSize_A2 DIN A2 ePdfPageSize_A3 DIN A3 ePdfPageSize_A4 DIN A4 ePdfPageSize_A5 DIN A5 ePdfPageSize_A6 DIN A6 ePdfPageSize_Letter Letter ePdfPageSize_Legal Legal ePdfPageSize_Tabloid Tabloid
7.1.3.22
enum PoDoFo::EPdfStrokeStyle
Enum for the different stroke styles that can be set when drawing to a PDF le (mostly for line drawing). 7.1.3.23 enum PoDoFo::EPdfVersion
Enum to identify diferent versions of the PDF le format Enumerator: ePdfVersion_1_0 PDF 1.0 ePdfVersion_1_1 PDF 1.1 ePdfVersion_1_2 PDF 1.2 ePdfVersion_1_3 PDF 1.3 ePdfVersion_1_4 PDF 1.4 ePdfVersion_1_5 PDF 1.5 ePdfVersion_1_6 PDF 1.6 ePdfVersion_1_7 PDF 1.7
7.1 PoDoFo Namespace Reference 7.1.3.24 enum PoDoFo::EPdfVerticalAlignment
35
Enum for vertical text alignment 7.1.3.25 enum PoDoFo::EPdfWriteMode
Specify additional options for writing the PDF. Enumerator: ePdfWriteMode_Compact Try to write the PDF as compact as possible (Default). ePdfWriteMode_Clean Create a PDF that is readable in a text editor, i.e. insert spaces and linebreaks between tokens.
7.1.4
7.1.4.1
Function Documentation
template<typename T > const T PoDoFo::PDF_MAX ( const T a, const T b )
PDF_MAX(x,y) Returns the maximum of x and y
7.1.4.2
template<typename T > const T PoDoFo::PDF_MIN ( const T a, const T b )
PDF_MIN(x,y) Returns the minimum of x and y
7.1.4.3
void PODOFO_API PoDoFo::PdfLocaleImbue ( std::ios_base & )
Imbue the passed stream with a locale that will be safe to do I/O of the low level PDF format with. PDF document structure I/O is done with the C++ standard library IOStreams code. By default, this will adapt to the current locale. Thats not good at all when doing I/O of PDF data structures, which follow POSIX/english locale conventions irrespective of runtime locale. Make sure to to call this function on any stream you intend to use for PDF I/O. Avoid using this stream for anything that should be done in the regional locale.
36 Warning
This method may throw ePdfError_InvalidDeviceOperation if your STL does not support the locale string in PdfIOLocale . If you fail to call this on a stream you use for PDF I/O you will encounter problems like German and other European users getting numbers in the format "10110,4" or even "10.110,4" instead of "10110.4" . 7.1.4.4 PODOFO_API void PoDoFo::podofo_free ( void buffer )
Wrapper around free of the c-library used by PoDoFo. Use this to free memory allocated inside of PoDoFo with podofo_malloc. 7.1.4.5 bool PoDoFo::podofo_is_little_endian ( )
Check during runtime if the current architecture is big- or little-endian. Returns true if the architecture is little-endian
7.1.4.6
PODOFO_API void PoDoFo::podofo_malloc ( size_t size )
Wrapper around malloc of the c-library used by PoDoFo. Is used to allocate buffers inside of PoDoFo. 7.1.4.7 PODOFO_API void PoDoFo::podofo_realloc ( void buffer, size_t size )
Wrapper around realloc of the c-library used by PoDoFo.
7.1.5
7.1.5.1
Variable Documentation
const EPdfVersion PoDoFo::ePdfVersion_Default = ePdfVersion_1_3
The default PDF Version used by new PDF documents in PoDoFo.
Chapter 8
Class Documentation
8.1 PoDoFo::MD5Context Struct Reference
8.1.1
8.2
PoDoFo::NamedColorComparatorPredicate Class Reference

8.2.1
Predicate to allow binary search in the list of PdfNamedColors using for example std::equal_range.
8.3
PoDoFo::PdfVecObjects::Observer Class Reference
#include <PdfVecObjects.h> Inherited by PoDoFo::PdfImmediateWriter[private].
Public Member Functions

virtual void ParentDestructed ()=0 virtual void BeginAppendStream (const PdfStream pStream)=0
38
Class Documentation virtual void EndAppendStream (const PdfStream pStream)=0
8.3.1
Every observer of PdfVecObjects has to implement this interface.
8.3.2
8.3.2.1
Member Function Documentation

virtual void PoDoFo::PdfVecObjects::Observer::BeginAppendStream ( const PdfStream pStream ) [pure virtual]
Called whenever appending to a stream is started. Parameters pStream the stream object the user currently writes to.
8.3.2.2
virtual void PoDoFo::PdfVecObjects::Observer::EndAppendStream ( const PdfStream pStream ) [pure virtual]
Called whenever appending to a stream has ended. Parameters pStream the stream object the user currently writes to.
8.3.2.3
virtual void PoDoFo::PdfVecObjects::Observer::ParentDestructed ( [pure virtual]
This method is called when the observed PdfVecObjects is delted. No more method may be called on the observable after this method was called on the observer.
8.4
PoDoFo::PdfAction Class Reference
#include <PdfAction.h> Inheritance diagram for PoDoFo::PdfAction:
PoDoFo::PdfElement
PoDoFo::PdfAction
8.4 PoDoFo::PdfAction Class Reference
39

PdfAction (EPdfAction eAction, PdfVecObjects pParent) PdfAction (EPdfAction eAction, PdfDocument pParent) PdfAction (PdfObject pObject) void SetURI (const PdfString &sUri) PdfString GetURI () const bool HasURI () const EPdfAction GetType () const void AddToDictionary (PdfDictionary &dictionary) const
8.4.1
An action that can be performed in a PDF document
8.4.2
8.4.2.1
Constructor & Destructor Documentation

PoDoFo::PdfAction::PdfAction ( EPdfAction eAction, PdfVecObjects pParent )
Create a new PdfAction object Parameters eAction type of this action pParent parent of this action
8.4.2.2
PoDoFo::PdfAction::PdfAction ( EPdfAction eAction, PdfDocument pParent )
Create a new PdfAction object Parameters eAction type of this action pParent parent of this action
8.4.2.3
PoDoFo::PdfAction::PdfAction ( PdfObject pObject )
Create a PdfAction object from an existing PdfObject

40
Class Documentation
8.4.3
8.4.3.1

void PoDoFo::PdfAction::AddToDictionary ( PdfDictionary & dictionary ) const
Adds this action to an dictionary. This method handles the all the complexities of making sure its added correctly If this action is empty. Nothing will be added. Parameters dictionary the action will be added to this dictionary
8.4.3.2
EPdfAction PoDoFo::PdfAction::GetType (
) const [inline]
Get the type of this action Returns the type of this action
8.4.3.3
PdfString PoDoFo::PdfAction::GetURI (
) const
Get the URI of an ePdfAction_URI Returns an URI
8.4.3.4 Returns
bool PoDoFo::PdfAction::HasURI (
) const
true if this action has an URI
8.4.3.5
void PoDoFo::PdfAction::SetURI ( const PdfString & sUri )
Set the URI of an ePdfAction_URI Parameters sUri must be a correct URI as PdfString
8.5 PoDoFo::PdfAnnotation Class Reference
41
8.5
PoDoFo::PdfAnnotation Class Reference
#include <PdfAnnotation.h> Inheritance diagram for PoDoFo::PdfAnnotation:
PoDoFo::PdfElement
PoDoFo::PdfAnnotation

PdfAnnotation (PdfPage pPage, EPdfAnnotation eAnnot, const PdfRect &rRect, PdfVecObjects pParent) PdfAnnotation (PdfObject pObject, PdfPage pPage) void SetAppearanceStream (PdfXObject pObject) bool HasAppearanceStream () const PdfRect GetRect () const void SetFlags (pdf_uint32 uiFlags) pdf_uint32 GetFlags () const void SetBorderStyle (double dHCorner, double dVCorner, double dWidth) void SetBorderStyle (double dHCorner, double dVCorner, double dWidth, const PdfArray &rStrokeStyle) void SetTitle (const PdfString &sTitle) PdfString GetTitle () const void SetContents (const PdfString &sContents) PdfString GetContents () const void SetDestination (const PdfDestination &rDestination) PdfDestination GetDestination (PdfDocument pDoc) const bool HasDestination () const void SetAction (const PdfAction &rAction) PdfAction GetAction () const bool HasAction () const void SetOpen (bool b) bool GetOpen () const bool HasFileAttachement () const void SetFileAttachement (const PdfFileSpec &rFileSpec) PdfFileSpec GetFileAttachement () const PdfArray GetQuadPoints () const void SetQuadPoints (const PdfArray &rQuadPoints) PdfArray GetColor () const void SetColor (double r, double g, double b) void SetColor (double c, double m, double y, double k) void SetColor (double gray)
42 void SetColor () EPdfAnnotation GetType () const PdfPage GetPage () const
Class Documentation
8.5.1
An annotation to a PdfPage To create an annotation use PdfPage::CreateAnnotation See also PdfPage::CreateAnnotation
8.5.2
8.5.2.1

PoDoFo::PdfAnnotation::PdfAnnotation ( PdfPage pPage, EPdfAnnotation eAnnot, const PdfRect & rRect, PdfVecObjects pParent )
Create a new annotation object Parameters pPage the parent page of this annotation eAnnot type of the annotation rRect the rectangle in which the annotation will appear on the page pParent parent of this annotation See also PdfPage::CreateAnnotation
8.5.2.2
PoDoFo::PdfAnnotation::PdfAnnotation ( PdfObject pObject, PdfPage pPage )
Create a PdfAnnotation from an existing object Parameters pObject the annotations object pPage the page of the annotation
8.5.3
8.5.3.1

PdfAction PoDoFo::PdfAnnotation::GetAction ( ) const
Get the action that is executed for this annotation

8.5 PoDoFo::PdfAnnotation Class Reference Returns an action object. The action object is owned by the PdfAnnotation. See also SetAction
43
8.5.3.2
PdfArray PoDoFo::PdfAnnotation::GetColor (
) const
Get the color key of the Annotation dictionary which denes the color of the annotation, as per 8.4 of the pdf spec. The PdfArray contains 0 to four numbers, depending on the colorspace in which the color is specied 0 numbers means the annotation is transparent 1 number species the intensity of the color in grayscale 3 numbers specie the color in the RGB colorspace and 4 numbers specify the color in the CMYK colorspace Returns a PdfArray of either 0, 1, 3 or 4 numbers depending on the colorspace in which the color is specied
8.5.3.3
PdfString PoDoFo::PdfAnnotation::GetContents (
) const
Get the text of this annotation Returns the contents of this annotation See also SetContents
8.5.3.4
PdfDestination PoDoFo::PdfAnnotation::GetDestination ( PdfDocument pDoc ) const
Get the destination of a link annotations Parameters pDoc a PdfDocument owning this annotation. This is required to resolve names and pages. Returns a destination object See also SetDestination
44 8.5.3.5
Class Documentation PdfFileSpec PoDoFo::PdfAnnotation::GetFileAttachement ( ) const
Get a le attachement of this annotation. Returns a le specication object. The le specication object is owned by the PdfAnnotation. See also SetFileAttachement
8.5.3.6
pdf_uint32 PoDoFo::PdfAnnotation::GetFlags (
) const
Get the ags of this annotation. Returns the ags which is an unsigned 32bit integer with different EPdfAnnotationFlags ORed together. See also SetFlags
8.5.3.7 Returns
bool PoDoFo::PdfAnnotation::GetOpen (
) const
true if this annotation should be opened immediately by the viewer
8.5.3.8
PdfPage PoDoFo::PdfAnnotation::GetPage (
) const [inline]
Get the page of this PdfField Returns the page of this PdfField
8.5.3.9
PdfArray PoDoFo::PdfAnnotation::GetQuadPoints (
) const
Get the quad points associated with the annotation (if appropriate). This array is used in text markup annotations to describe the regions affected by the markup (i.e. the hilighted words, one quadrilateral per word) Returns a PdfArray of 8xn numbers describing the x,y coordinates of BL BR TR TL corners of the quadrilaterals. If inappropriate, returns an empty array.
8.5 PoDoFo::PdfAnnotation Class Reference 8.5.3.10 PdfRect PoDoFo::PdfAnnotation::GetRect ( ) const
45
Get the rectangle of this annotation Returns a rectangle
8.5.3.11
PdfString PoDoFo::PdfAnnotation::GetTitle (
) const
Get the title of this annotation Returns the title of this annotation See also SetTitle
8.5.3.12
EPdfAnnotation PoDoFo::PdfAnnotation::GetType ( [inline]
) const
Get the type of this annotation Returns the annotation type
8.5.3.13 Returns
bool PoDoFo::PdfAnnotation::HasAction (
) const
true if this annotation has an action
8.5.3.14 Returns
bool PoDoFo::PdfAnnotation::HasAppearanceStream (
) const
true if this annotation has an appearance stream
8.5.3.15 Returns
bool PoDoFo::PdfAnnotation::HasDestination (
) const
true if this annotation has an destination
46 8.5.3.16 Returns true if this annotation has a le attachement
Class Documentation bool PoDoFo::PdfAnnotation::HasFileAttachement ( ) const
8.5.3.17
void PoDoFo::PdfAnnotation::SetAction ( const PdfAction & rAction )
Set the action that is executed for this annotation Parameters rAction an action object See also GetAction
8.5.3.18
void PoDoFo::PdfAnnotation::SetAppearanceStream ( PdfXObject pObject )
Set an appearance stream for this object to specify its visual appearance Parameters pObject an XObject
8.5.3.19
void PoDoFo::PdfAnnotation::SetBorderStyle ( double dHCorner, double dVCorner, double dWidth )
Set the annotations border style. Parameters dHCorner horitzontal corner radius dVCorner vertical corner radius dWidth width of border
8.5.3.20
void PoDoFo::PdfAnnotation::SetBorderStyle ( double dHCorner, double dVCorner, double dWidth, const PdfArray & rStrokeStyle )
Set the annotations border style. Parameters dHCorner horitzontal corner radius
8.5 PoDoFo::PdfAnnotation Class Reference dVCorner vertical corner radius dWidth width of border rStrokeStyle a custom stroke style pattern
47
8.5.3.21
void PoDoFo::PdfAnnotation::SetColor (
Set the C key of the Annotation dictionary to an empty array, which, as per 8.4 of the pdf spec., makes the annotation transparent 8.5.3.22 void PoDoFo::PdfAnnotation::SetColor ( double r, double g, double b )
Set the C key of the Annotation dictionary, which denes the color of the annotation, as per 8.4 of the pdf spec. Parameters give the color in rgb colorspace coordinates Parameters r number from 0 to 1, the intensity of the red channel g number from 0 to 1, the intensity of the green channel b number from 0 to 1, the intensity of the blue channel
8.5.3.23
void PoDoFo::PdfAnnotation::SetColor ( double gray )
Set the C key of the Annotation dictionary, which denes the color of the annotation, as per 8.4 of the pdf spec. Parameters give the color in grayscale colorspace coordinates Parameters gray number from 0 to 1, the intensity of the black
8.5.3.24
void PoDoFo::PdfAnnotation::SetColor ( double c, double m, double y, double k )
Set the C key of the Annotation dictionary, which denes the color of the annotation, as per 8.4 of the pdf spec. Parameters give the color in cmyk colorspace coordinates Parameters c number from 0 to 1, the intensity of the cyan channel m number from 0 to 1, the intensity of the magneta channel y number from 0 to 1, the intensity of the yellow channel k number from 0 to 1, the intensity of the black channel
48 8.5.3.25
Class Documentation void PoDoFo::PdfAnnotation::SetContents ( const PdfString & sContents )
Set the text of this annotation. Parameters sContents text of the annoation as string in PDF format See also GetContents
8.5.3.26
void PoDoFo::PdfAnnotation::SetDestination ( const PdfDestination & rDestination )
Set the destination for link annotations Parameters rDestination target of the link See also GetDestination
8.5.3.27
void PoDoFo::PdfAnnotation::SetFileAttachement ( const PdfFileSpec & rFileSpec )
Set a le attachment for this annotation. The type of this annotation has to be ePdfAnnotation_FileAttachement for le attachements to work. Parameters rFileSpec a le specication
8.5.3.28
void PoDoFo::PdfAnnotation::SetFlags ( pdf_uint32 uiFlags )
Set the ags of this annotation. Parameters uiFlags is an unsigned 32bit integer with different EPdfAnnotationFlags ORed together. See also GetFlags
8.6 PoDoFo::PdfAscii85Filter Class Reference 8.5.3.29 void PoDoFo::PdfAnnotation::SetOpen ( bool b )
49
Sets wether this annotation is initialy open. You should always set this true for popup annotations. Parameters b if true open it
8.5.3.30
void PoDoFo::PdfAnnotation::SetQuadPoints ( const PdfArray & rQuadPoints )
Set the quad points associated with the annotation (if appropriate). This array is used in text markup annotations to describe the regions affected by the markup (i.e. the hilighted words, one quadrilateral per word) Parameters rQuadPoints a PdfArray of 8xn numbers describing the x,y coordinates of BL BR TR TL corners of the quadrilaterals.
8.5.3.31
void PoDoFo::PdfAnnotation::SetTitle ( const PdfString & sTitle )
Set the title of this annotation. Parameters sTitle title of the annoation as string in PDF format See also GetTitle
8.6
PoDoFo::PdfAscii85Filter Class Reference
#include <PdfFiltersPrivate.h> Inheritance diagram for PoDoFo::PdfAscii85Filter:
PoDoFo::PdfFilter
PoDoFo::PdfAscii85Filter
50
Class Documentation

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
8.6.1
The Ascii85 lter.
8.6.2
8.6.2.1

void PoDoFo::PdfAscii85Filter::BeginDecodeImpl ( const PdfDictionary ) [virtual]
Real implementation of BeginDecode(). NEVER call this method directly. By default this function does nothing. If your lter 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.
8.6.2.2
void PoDoFo::PdfAscii85Filter::BeginEncodeImpl (
) [virtual]
Begin encoding data using this lter. Called by PdfFilter::BeginEncode. See also EncodeBlockImpl EndEncodeImpl PdfFilter::BeginEncode Reimplemented from PoDoFo::PdfFilter.
8.6 PoDoFo::PdfAscii85Filter Class Reference 8.6.2.3 bool PoDoFo::PdfAscii85Filter::CanDecode ( virtual] ) const [inline,
51
Check wether the decoding is implemented for this lter. Returns true if the lter is able to decode data Implements PoDoFo::PdfFilter. 8.6.2.4 bool PoDoFo::PdfAscii85Filter::CanEncode ( virtual] ) const [inline,
Check wether the encoding is implemented for this lter. Returns true if the lter is able to encode data Implements PoDoFo::PdfFilter. 8.6.2.5 void PoDoFo::PdfAscii85Filter::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 youre going to store it, as ownership is not transferred to the lter 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. 8.6.2.6 void PoDoFo::PdfAscii85Filter::EncodeBlockImpl ( const char pBuffer, pdf_long lLen ) [virtual]
Encode a block of data and write it to the PdfOutputStream specied by BeginEncodeImpl. BeginEncodeImpl() has to be called before this function.
52 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. 8.6.2.7 void PoDoFo::PdfAscii85Filter::EndDecodeImpl (
Class Documentation
) [virtual]
Real implementation of EndDecode(). NEVER call this method directly. By the time this method returns, all ltered data must be written to the stream and the lter 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. 8.6.2.8 void PoDoFo::PdfAscii85Filter::EndEncodeImpl ( ) [virtual]
Finish encoding of data. See also BeginEncodeImpl EncodeBlockImpl Reimplemented from PoDoFo::PdfFilter. 8.6.2.9 EPdfFilter PoDoFo::PdfAscii85Filter::GetType ( virtual] ) const [inline,
GetType of this lter. Returns the GetType of this lter Implements PoDoFo::PdfFilter.
8.7 PoDoFo::PdfAxialShadingPattern Class Reference
53
8.7
PoDoFo::PdfAxialShadingPattern Class Reference
#include <PdfShadingPattern.h> Inheritance diagram for PoDoFo::PdfAxialShadingPattern:
PoDoFo::PdfElement PoDoFo::PdfShadingPattern PoDoFo::PdfAxialShadingPattern

PdfAxialShadingPattern (double dX0, double dY0, double dX1, double dY1, const PdfColor &rStart, const PdfColor &rEnd, PdfVecObjects pParent) PdfAxialShadingPattern (double dX0, double dY0, double dX1, double dY1, const PdfColor &rStart, const PdfColor &rEnd, PdfDocument pParent)
8.7.1
A shading pattern that is a simple axial shading between two colors.
8.7.2
8.7.2.1

PoDoFo::PdfAxialShadingPattern::PdfAxialShadingPattern ( double dX0, double dY0, double dX1, double dY1, const PdfColor & rStart, const PdfColor & rEnd, PdfVecObjects pParent )
Create an axial shading pattern Parameters dX0 the starting x coordinate dY0 the starting y coordinate dX1 the ending x coordinate dY1 the ending y coordinate rStart the starting color rEnd the ending color pParent the parent
54 8.7.2.2
Class Documentation PoDoFo::PdfAxialShadingPattern::PdfAxialShadingPattern ( double dX0, double dY0, double dX1, double dY1, const PdfColor & rStart, const PdfColor & rEnd, PdfDocument pParent )
Create an axial shading pattern Parameters dX0 the starting x coordinate dY0 the starting y coordinate dX1 the ending x coordinate dY1 the ending y coordinate rStart the starting color rEnd the ending color pParent the parent
8.8
PoDoFo::PdfBufferOutputStream Class Reference
#include <PdfOutputStream.h> Inheritance diagram for PoDoFo::PdfBufferOutputStream:
PoDoFo::PdfOutputStream PoDoFo::PdfBufferOutputStream

PdfBufferOutputStream (PdfRefCountedBuffer pBuffer) virtual pdf_long Write (const char pBuffer, pdf_long lLen) virtual void Close () pdf_long GetLength () const
8.8.1
An output stream that writes to a PdfRefCountedBuffer. The PdfRefCountedBuffer is resized automatically if necessary.
8.8 PoDoFo::PdfBufferOutputStream Class Reference
55
8.8.2
8.8.2.1

PoDoFo::PdfBufferOutputStream::PdfBufferOutputStream ( PdfRefCountedBuffer pBuffer ) [inline]
Write to an already opened input device Parameters pBuffer data is written to this buffer
8.8.3
8.8.3.1

virtual void PoDoFo::PdfBufferOutputStream::Close ( virtual] ) [inline,
Close the PdfOutputStream. This method may throw exceptions and has to be called before the descructor to end writing. No more data may be written to the output device after calling close. Implements PoDoFo::PdfOutputStream.
8.8.3.2
pdf_long PoDoFo::PdfBufferOutputStream::GetLength ( [inline]
) const
Returns the length of the buffers contents
8.8.3.3
pdf_long PoDoFo::PdfBufferOutputStream::Write ( const char pBuffer, pdf_long lLen ) [virtual]
Write data to the output stream Parameters pBuffer the data is read from this buffer lLen the size of the buffer Returns the number of bytes written, -1 if an error ocurred Implements PoDoFo::PdfOutputStream.
56
Class Documentation
8.9
PoDoFo::PdfCanvas Class Reference
#include <PdfCanvas.h> Inheritance diagram for PoDoFo::PdfCanvas:

PoDoFo::PdfCanvas PoDoFo::PdfPage PoDoFo::PdfXObject PoDoFo::PdfImage

virtual PdfCanvas () virtual PdfObject GetContents () const =0 virtual PdfObject GetContentsForAppending () const =0 virtual PdfObject GetResources () const =0 virtual const PdfRect GetPageSize () const =0 void AddColorResource (const PdfColor &rColor) void AddResource (const PdfName &rIdentier, const PdfReference &rRef, const PdfName &rName)
Static Public Member Functions

static const PdfArray & GetProcSet ()
8.9.1
A interface that provides the necessary features for a painter to draw onto a PdfObject.
8.9.2
8.9.2.1

virtual PoDoFo::PdfCanvas::PdfCanvas ( ) [inline, virtual]
Virtual destructor to avoid compiler warnings

8.9 PoDoFo::PdfCanvas Class Reference
57
8.9.3
8.9.3.1

void PoDoFo::PdfCanvas::AddColorResource ( const PdfColor & rColor )
Register a colourspace for a (separation) colour in the resource dictionary of this page or XObbject so that it can be used for any following drawing operations. Parameters rColor reference to the PdfColor
8.9.3.2
void PoDoFo::PdfCanvas::AddResource ( const PdfName & rIdentier, const PdfReference & rRef, const PdfName & rName )
Register an object in the resource dictionary of this page or XObbject so that it can be used for any following drawing operations. Parameters rIdentier identier of this object, e.g. /Ft0 rRef reference to the object you want to register rName register under this key in the resource dictionary
8.9.3.3
virtual PdfObject PoDoFo::PdfCanvas::GetContents ( [pure virtual]
) const
Get access to the contents object of this page. If you want to draw onto the page, you have to add drawing commands to the stream of the Contents object. Returns a contents object Implemented in PoDoFo::PdfPage, and PoDoFo::PdfXObject. 8.9.3.4 virtual PdfObject PoDoFo::PdfCanvas::GetContentsForAppending ( ) const [pure virtual]
Get access an object that you can use to ADD drawing to. If you want to draw onto the page, you have to add drawing commands to the stream of the Contents object. Returns a contents object Implemented in PoDoFo::PdfPage, and PoDoFo::PdfXObject.
58 8.9.3.5
Class Documentation virtual const PdfRect PoDoFo::PdfCanvas::GetPageSize ( [pure virtual] ) const
Get the current page size in PDF Units Returns a PdfRect containing the page size available for drawing Implemented in PoDoFo::PdfPage, and PoDoFo::PdfXObject. 8.9.3.6 const PdfArray & PoDoFo::PdfCanvas::GetProcSet ( ) [static]
Get a reference to a static procset PdfArray. Returns a reference to a static procset PdfArray
8.9.3.7
virtual PdfObject PoDoFo::PdfCanvas::GetResources ( [pure virtual]
) const
Get access to the resources object of this page. This is most likely an internal object. Returns a resources object Implemented in PoDoFo::PdfPage, and PoDoFo::PdfXObject.
8.10
PoDoFo::PdfCheckBox Class Reference
#include <PdfField.h> Inherits PoDoFo::PdfButton.

PdfCheckBox (PdfAnnotation pWidget, PdfAcroForm pParent) PdfCheckBox (PdfPage pPage, const PdfRect &rRect, PdfAcroForm pParent) PdfCheckBox (PdfPage pPage, const PdfRect &rRect, PdfDocument pDoc) PdfCheckBox (PdfPage pPage, const PdfRect &rRect, PdfStreamedDocument pDoc) PdfCheckBox (const PdfField &rhs) void SetAppearanceChecked (const PdfXObject &rXObject) void SetAppearanceUnchecked (const PdfXObject &rXObject) void SetChecked (bool bChecked) bool IsChecked () const
8.10 PoDoFo::PdfCheckBox Class Reference
59
8.10.1
A checkbox can be checked or unchecked by the user
8.10.2
8.10.2.1

PoDoFo::PdfCheckBox::PdfCheckBox ( PdfAnnotation pWidget, PdfAcroForm pParent )
Create a new PdfCheckBox
8.10.2.2
PoDoFo::PdfCheckBox::PdfCheckBox ( PdfPage pPage, const PdfRect & rRect, PdfAcroForm pParent )
8.10.2.3
PoDoFo::PdfCheckBox::PdfCheckBox ( PdfPage pPage, const PdfRect & rRect, PdfDocument pDoc )
8.10.2.4
PoDoFo::PdfCheckBox::PdfCheckBox ( PdfPage pPage, const PdfRect & rRect, PdfStreamedDocument pDoc )
8.10.2.5
PoDoFo::PdfCheckBox::PdfCheckBox ( const PdfField & rhs )
Create a PdfCheckBox from a PdfField Parameters rhs a PdfField that is a check box Raises an error if PdfField::GetType() != ePdfField_CheckBox
8.10.3
8.10.3.1 Returns

bool PoDoFo::PdfCheckBox::IsChecked ( ) const
true if the checkbox is checked
60 8.10.3.2
Class Documentation void PoDoFo::PdfCheckBox::SetAppearanceChecked ( const PdfXObject & rXObject )
Set the appearance stream which is displayed when the checkbox is checked. Parameters rXObject an xobject which contains the drawing commands for a checked checkbox
8.10.3.3
void PoDoFo::PdfCheckBox::SetAppearanceUnchecked ( const PdfXObject & rXObject )
Set the appearance stream which is displayed when the checkbox is unchecked. Parameters rXObject an xobject which contains the drawing commands for an unchecked checkbox
8.10.3.4
void PoDoFo::PdfCheckBox::SetChecked ( bool bChecked )
Sets the state of this checkbox Parameters bChecked if true the checkbox will be checked
8.11
PoDoFo::PdfColor Class Reference
#include <PdfColor.h> Inherited by PoDoFo::PdfColorCieLab, PoDoFo::PdfColorCMYK, PoDoFo::PdfColorGray, PoDoFo::PdfColorRGB, PoDoFo::PdfColorSeparation, PoDoFo::PdfColorSeparationAll, and PoDoFo::PdfColorSeparationNone.

PdfColor () PdfColor (double dGray) PdfColor (double dRed, double dGreen, double dBlue) PdfColor (double dCyan, double dMagenta, double dYellow, double dBlack) PdfColor (const PdfColor &rhs) virtual PdfColor () const PdfColor & operator= (const PdfColor &rhs) bool operator== (const PdfColor &rhs) const
8.11 PoDoFo::PdfColor Class Reference bool operator!= (const PdfColor &rhs) const bool IsGrayScale () const bool IsRGB () const bool IsCMYK () const bool IsSeparation () const bool IsCieLab () const EPdfColorSpace GetColorSpace () const EPdfColorSpace GetAlternateColorSpace () const double GetGrayScale () const double GetRed () const double GetGreen () const double GetBlue () const double GetCyan () const double GetMagenta () const double GetYellow () const double GetBlack () const const std::string GetName () const double GetDensity () const double GetCieL () const double GetCieA () const double GetCieB () const PdfColor ConvertToGrayScale () const PdfColor ConvertToRGB () const PdfColor ConvertToCMYK () const PdfArray ToArray () const PdfObject BuildColorSpace (PdfVecObjects pOwner) const
61

static PdfColor FromString (const char pszName) static PdfColor FromArray (const PdfArray &rArray) static EPdfColorSpace GetColorSpaceForName (const PdfName &rName) static PdfName GetNameForColorSpace (EPdfColorSpace eColorSpace)
8.11.1
A color object can represent either a grayscale value, a RGB color, a CMYK color, a separation color or a CieLab color. All drawing functions in PoDoFo accept a PdfColor object to specify a drawing color in one of these colorspaces. Derived classes PdfColorGray, PdfColorRGB, PdfColorCMYK, PdfColorSeparation and PdfColorCieLab are available for easy construction
62
Class Documentation
8.11.2
8.11.2.1

PoDoFo::PdfColor::PdfColor ( )
Create a PdfColor object that is RGB black. 8.11.2.2 PoDoFo::PdfColor::PdfColor ( double dGray ) [explicit]
Create a new PdfColor object with a grayscale value. Parameters dGray a grayscalue value between 0.0 and 1.0
8.11.2.3
PoDoFo::PdfColor::PdfColor ( double dRed, double dGreen, double dBlue )
Create a new PdfColor object with a RGB color Parameters dRed the value of the red component, must be between 0.0 and 1.0 dGreen the value of the green component, must be between 0.0 and 1.0 dBlue the value of the blue component, must be between 0.0 and 1.0
8.11.2.4
PoDoFo::PdfColor::PdfColor ( double dCyan, double dMagenta, double dYellow, double dBlack )
Create a new PdfColor object with a CMYK color Parameters dCyan the value of the cyan component, must be between 0.0 and 1.0 dMagenta the value of the magenta component, must be between 0.0 and 1.0 dYellow the value of the yellow component, must be between 0.0 and 1.0 dBlack the value of the black component, must be between 0.0 and 1.0
8.11.2.5
PoDoFo::PdfColor::PdfColor ( const PdfColor & rhs )
Copy constructor Parameters rhs copy rhs into this object
8.11 PoDoFo::PdfColor Class Reference 8.11.2.6 Destructor PoDoFo::PdfColor::PdfColor ( ) [virtual]
63
8.11.3
8.11.3.1

PdfObject PoDoFo::PdfColor::BuildColorSpace ( PdfVecObjects pOwner ) const
Creates a colorspace object from a color to insert into resources. Parameters pOwner a pointer to the owner of the generated object Returns a PdfObject pointer, which can be insert into resources, NULL if not needed
8.11.3.2
PdfColor PoDoFo::PdfColor::ConvertToCMYK (
) const
Converts the color object into a CMYK color object. This is only a convinience function. It might be useful for on screen display but is in NO WAY suitable to professional printing! Returns a CMYK color object See also IsCMYK()
8.11.3.3
PdfColor PoDoFo::PdfColor::ConvertToGrayScale (
) const
Converts the color object into a grayscale color object. This is only a convinience function. It might be useful for on screen display but is in NO WAY suitable to professional printing! Returns a grayscale color object See also IsGrayScale()
64 8.11.3.4 PdfColor PoDoFo::PdfColor::ConvertToRGB (
Class Documentation ) const
Converts the color object into a RGB color object. This is only a convinience function. It might be useful for on screen display but is in NO WAY suitable to professional printing! Returns a RGB color object See also IsRGB()
8.11.3.5
PdfColor PoDoFo::PdfColor::FromArray ( const PdfArray & rArray ) [static]
Creates a color object from a PdfArray which represents a color. Raises an exception if this is no PdfColor! Parameters rArray an array that must be a color PdfArray Returns a PdfColor object
8.11.3.6
PdfColor PoDoFo::PdfColor::FromString ( const char pszName ) [static]
Creates a color object from a string. Parameters pszName a string describing a color. Supported values are: single gray values as string (e.g. 0.5) a named color (e.g. auquamarine or magenta) hex values (e.g. FF002A (RGB) or FF12AB3D (CMYK)) PdfArrays Returns a PdfColor object
8.11 PoDoFo::PdfColor Class Reference 8.11.3.7 EPdfColorSpace PoDoFo::PdfColor::GetAlternateColorSpace ( const [inline] )
65
Get the alternate colorspace of this PdfColor object Returns the colorspace of this PdfColor object (must be separation)
8.11.3.8
double PoDoFo::PdfColor::GetBlack (
) const [inline]
Get the black color value of this object. Throws an exception if this is no CMYK or separation color object. Returns the black color value of this object (between 0.0 and 1.0) See also IsCMYK
8.11.3.9
double PoDoFo::PdfColor::GetBlue (
) const [inline]
Get the blue color value of this object. Throws an exception if this is no RGB color object. Returns the blue color value of this object (between 0.0 and 1.0) See also IsRGB
8.11.3.10
double PoDoFo::PdfColor::GetCieA (
) const [inline]
Get the A color value of this object. Throws an exception if this is no CIE-Lab color object. Returns the A color value of this object (between -128.0 and 127.0) See also IsCieLab
66 8.11.3.11 double PoDoFo::PdfColor::GetCieB (
Class Documentation ) const [inline]
Get the B color value of this object. Throws an exception if this is no CIE-Lab color object. Returns the B color value of this object (between -128.0 and 127.0) See also IsCieLab
8.11.3.12
double PoDoFo::PdfColor::GetCieL (
) const [inline]
Get the L color value of this object. Throws an exception if this is no CIE-Lab color object. Returns the L color value of this object (between 0.0 and 100.0) See also IsCieLab
8.11.3.13
EPdfColorSpace PoDoFo::PdfColor::GetColorSpace ( [inline]
) const
Get the colorspace of this PdfColor object Returns the colorspace of this PdfColor object
8.11.3.14
EPdfColorSpace PoDoFo::PdfColor::GetColorSpaceForName ( const PdfName & rName ) [static]
Convert a name into a colorspace enum. Parameters rName name representing a colorspace such as DeviceGray Returns colorspace enum or ePdfColorSpace_Unknown if name is unknown See also GetNameForColorSpace
8.11 PoDoFo::PdfColor Class Reference 8.11.3.15 double PoDoFo::PdfColor::GetCyan ( ) const [inline]
67
Get the cyan color value of this object. Throws an exception if this is no CMYK or separation color object. Returns the cyan color value of this object (between 0.0 and 1.0) See also IsCMYK
8.11.3.16
double PoDoFo::PdfColor::GetDensity (
) const [inline]
Get the density color value of this object. Throws an exception if this is no separation color object. Returns the density value of this object (between 0.0 and 1.0) See also IsSeparation
8.11.3.17
double PoDoFo::PdfColor::GetGrayScale (
) const [inline]
Get the grayscale color value of this object. Throws an exception if this is no grayscale color object. Returns the grayscale color value of this object (between 0.0 and 1.0) See also IsGrayScale
8.11.3.18
double PoDoFo::PdfColor::GetGreen (
) const [inline]
Get the green color value of this object. Throws an exception if this is no RGB color object. Returns the green color value of this object (between 0.0 and 1.0)
68 See also IsRGB
Class Documentation
8.11.3.19
double PoDoFo::PdfColor::GetMagenta (
) const [inline]
Get the magenta color value of this object. Throws an exception if this is no CMYK or separation color object. Returns the magenta color value of this object (between 0.0 and 1.0) See also IsCMYK
8.11.3.20
const std::string PoDoFo::PdfColor::GetName ( ) const [inline]
Get the separation name of this object. Throws an exception if this is no separation color object. Returns the name of this object See also IsSeparation
8.11.3.21
PdfName PoDoFo::PdfColor::GetNameForColorSpace ( EPdfColorSpace eColorSpace ) [static]
Convert a colorspace enum value into a name such as DeviceRGB Parameters eColorSpace a colorspace Returns a name See also GetColorSpaceForName
8.11 PoDoFo::PdfColor Class Reference 8.11.3.22 double PoDoFo::PdfColor::GetRed ( ) const [inline]
69
Get the red color value of this object. Throws an exception if this is no RGB color object. Returns the red color value of this object (between 0.0 and 1.0) See also IsRGB
8.11.3.23
double PoDoFo::PdfColor::GetYellow (
) const [inline]
Get the yellow color value of this object. Throws an exception if this is no CMYK or separation color object. Returns the yellow color value of this object (between 0.0 and 1.0) See also IsCMYK
8.11.3.24
bool PoDoFo::PdfColor::IsCieLab (
) const [inline]
Test if this is a CIE-Lab color. Returns true if this is a lab Color object
8.11.3.25
bool PoDoFo::PdfColor::IsCMYK (
) const [inline]
Test if this is a CMYK color. Returns true if this is a CMYK PdfColor object
8.11.3.26
bool PoDoFo::PdfColor::IsGrayScale (
) const [inline]
Test if this is a grayscale color. Returns true if this is a grayscale PdfColor object
70 8.11.3.27 bool PoDoFo::PdfColor::IsRGB (
Test if this is a RGB color. Returns true if this is a RGB PdfColor object
8.11.3.28
bool PoDoFo::PdfColor::IsSeparation (
) const [inline]
Test if this is a separation color. Returns true if this is a separation PdfColor object
8.11.3.29
bool PoDoFo::PdfColor::operator!= ( const PdfColor & rhs ) const [inline]
Test for inequality of colors. Parameters rhs color to compare ro Returns true if object color is not equal to rhs
8.11.3.30
const PdfColor & PoDoFo::PdfColor::operator= ( const PdfColor & rhs )
Assignment operator Parameters rhs copy rhs into this object Returns a reference to this color object
8.11.3.31
bool PoDoFo::PdfColor::operator== ( const PdfColor & rhs ) const [inline]
Test for equality of colors.

8.12 PoDoFo::PdfComboBox Class Reference Parameters rhs color to compare ro Returns true if object color is equal to rhs
71
8.11.3.32
PdfArray PoDoFo::PdfColor::ToArray (
) const
Creates a PdfArray which represents a color from a color. Returns a PdfArray object
8.12
PoDoFo::PdfComboBox Class Reference
#include <PdfField.h> Inheritance diagram for PoDoFo::PdfComboBox:
PoDoFo::PdfListField
PoDoFo::PdfComboBox

PdfComboBox (PdfAnnotation pWidget, PdfAcroForm pParent) PdfComboBox (PdfPage pPage, const PdfRect &rRect, PdfAcroForm pParent) PdfComboBox (PdfPage pPage, const PdfRect &rRect, PdfDocument pDoc) PdfComboBox (PdfPage pPage, const PdfRect &rRect, PdfStreamedDocument pDoc) PdfComboBox (const PdfField &rhs) void SetEditable (bool bEdit) bool IsEditable () const
8.12.1
A combo box with a drop down list of items.

72
Class Documentation
8.12.2
8.12.2.1

PoDoFo::PdfComboBox::PdfComboBox ( PdfAnnotation pWidget, PdfAcroForm pParent )
Create a new PdfTextField 8.12.2.2 PoDoFo::PdfComboBox::PdfComboBox ( PdfPage pPage, const PdfRect & rRect, PdfAcroForm pParent )
Create a new PdfTextField 8.12.2.3 PoDoFo::PdfComboBox::PdfComboBox ( PdfPage pPage, const PdfRect & rRect, PdfDocument pDoc )
Create a new PdfTextField 8.12.2.4 PoDoFo::PdfComboBox::PdfComboBox ( PdfPage pPage, const PdfRect & rRect, PdfStreamedDocument pDoc )
Create a new PdfTextField 8.12.2.5 PoDoFo::PdfComboBox::PdfComboBox ( const PdfField & rhs )
Create a PdfComboBox from a PdfField Parameters rhs a PdfField that is a PdfComboBox Raises an error if PdfField::GetType() != ePdfField_ComboBox
8.12.3
8.12.3.1 Returns

bool PoDoFo::PdfComboBox::IsEditable ( ) const [inline]
true if this is an editable combobox
8.12.3.2
void PoDoFo::PdfComboBox::SetEditable ( bool bEdit ) [inline]
Sets the combobox to be editable Parameters bEdit if true the combobox can be edited by the user
8.13 PoDoFo::PdfContents Class Reference By default a combobox is not editable
73
8.13
PoDoFo::PdfContents Class Reference
#include <PdfContents.h> Inheritance diagram for PoDoFo::PdfContents:
PoDoFo::PdfElement
PoDoFo::PdfContents

PdfContents (PdfDocument pParent) PdfContents (PdfVecObjects pParent) PdfContents (PdfObject inObj) PdfContents (PdfPage pParent) virtual PdfContents () virtual PdfObject GetContents () const virtual PdfObject GetContentsForAppending () const
8.13.1
A interface that provides a wrapper around "PDF content" - the instructions that are used to draw on the PDF "canvas".
8.13.2
8.13.2.1

PoDoFo::PdfContents::PdfContents ( PdfDocument pParent )
Construct a new/empty set of contents in the owning objects 8.13.2.2 PoDoFo::PdfContents::PdfContents ( PdfVecObjects pParent )
Construct a new/empty set of contents in the owning objects 8.13.2.3 PoDoFo::PdfContents::PdfContents ( PdfObject inObj )
Construct the contents from an existing PdfObject

74 8.13.2.4
Class Documentation PoDoFo::PdfContents::PdfContents ( PdfPage pParent )
Create the contents for an existing page which does not yet have a contents object. Parameters pParent a /Contents key will be added to this page and a contents object will be created.
8.13.2.5
virtual PoDoFo::PdfContents::PdfContents ( virtual]
) [inline,
Virtual destructor - because ALL destructors should be...
8.13.3
8.13.3.1

virtual PdfObject PoDoFo::PdfContents::GetContents ( [inline, virtual] ) const
Get access to the raw contents object. It will either be a PdfStream or a PdfArray Returns a contents object
8.13.3.2
PdfObject PoDoFo::PdfContents::GetContentsForAppending ( const [virtual]
Get access to an object into which you can add contents at the end of the "stream".
8.14
PoDoFo::PdfContentsTokenizer Class Reference
#include <PdfContentsTokenizer.h> Inheritance diagram for PoDoFo::PdfContentsTokenizer:
PoDoFo::PdfTokenizer
PoDoFo::PdfContentsTokenizer
8.14 PoDoFo::PdfContentsTokenizer Class Reference
75

PdfContentsTokenizer (const char pBuffer, long lLen) PdfContentsTokenizer (PdfCanvas pCanvas) bool ReadNext (EPdfContentsType &reType, const char &rpszKeyword, PoDoFo::PdfVariant &rVariant) bool GetNextToken (const char &pszToken, EPdfTokenType peType=NULL)
8.14.1
This class is a parser for content streams in PDF documents. The parsed content stream can be used and modied in various ways. This class is currently work in progress and subject to change!
8.14.2
8.14.2.1

PoDoFo::PdfContentsTokenizer::PdfContentsTokenizer ( const char pBuffer, long lLen ) [inline]
Construct a PdfContentsTokenizer from an existing buffer. Usually a stream from a PdfPage. Parameters pBuffer pointer to a buffer lLen length of the buffer
8.14.2.2
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 pCanvas an object that hold a PDF contents stream
8.14.3
8.14.3.1

bool PoDoFo::PdfContentsTokenizer::GetNextToken ( const char & pszToken, EPdfTokenType peType = NULL ) [virtual]
Reads the next token from the current le position ignoring all comments.
76 Parameters
Class Documentation
[out] pszToken On true return, set to a pointer to the read token (a NULLterminated C string). The pointer is to memory owned by PdfTokenizer and must NOT be freed. The contents are invalidated on the next call to GetNextToken(..) and by the destruction of the PdfTokenizer. Undened on false return. [out] peType On true return, if not NULL the type of the read token will be stored into this parameter. Undened on false return. Returns True if a token was read, false if there are no more tokens to read. See also GetBuffer Reimplemented from PoDoFo::PdfTokenizer.
8.14.3.2
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 dened 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 undened. As a special case, reType may be set to ePdfContentsType_ImageData. In this case rpszzKeyword is undened, and rVariant contains a PdfData variant containing the byte sequence between the ID and BI keywords sans the one byte of leading- and trailingwhite space. No lter decoding is performed. Parameters [out] reType will be set to either keyword or variant if true is returned. Undened if false is returned. [out] rpszKeyword if pType is set to ePdfContentsType_Keyword this will point to the keyword, otherwise the value is undened. 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] rVariant if pType is set to ePdfContentsType_Variant or ePdfContentsType_ImageData this will be set to the read variant, otherwise the value is undened.
8.15 PoDoFo::PdfData Class Reference
77
8.15
PoDoFo::PdfData Class Reference
#include <PdfData.h> Inheritance diagram for PoDoFo::PdfData:
PoDoFo::PdfDataType PoDoFo::PdfData

PdfData (const char pszData) PdfData (const char pszData, size_t dataSize) PdfData (const PdfData &rhs) void Write (PdfOutputDevice pDevice, EPdfWriteMode eWriteMode, const PdfEncrypt pEncrypt=NULL) const const PdfData & operator= (const PdfData &rhs) const std::string & data () const
8.15.1
A datatype that allows to write abitrary data to a PDF le. The user of this class has to ensure that the data written to the PDF le using this class is valid data for a PDF le! This class is used in PoDoFo to pad PdfVariants.
8.15.2
8.15.2.1

PoDoFo::PdfData::PdfData ( const char pszData ) [inline]
Create a new PdfData object with valid PdfData The contained data has to be a valid value in a PDF le. It will be written directly to the PDF le. Parameters pszData a null-terminated string to be copied.
8.15.2.2
PoDoFo::PdfData::PdfData ( const char pszData, size_t dataSize ) [inline]
Create a new PdfData object with valid PdfData.

78 Parameters pszData a char buffer to be copied. dataSize size of buffer
Class Documentation
8.15.2.3
PoDoFo::PdfData::PdfData ( const PdfData & rhs ) [inline]
Copy an existing PdfData Parameters rhs another PdfData to copy
8.15.3
8.15.3.1

const std::string & PoDoFo::PdfData::data ( ) const [inline]
Access the data as a std::string Returns a const reference to the contained data
8.15.3.2
const PdfData & PoDoFo::PdfData::operator= ( const PdfData & rhs ) [inline]
Copy an existing PdfData Parameters rhs another PdfData to copy Returns this object
8.15.3.3
void PoDoFo::PdfData::Write ( PdfOutputDevice pDevice, EPdfWriteMode eWriteMode, const PdfEncrypt pEncrypt = NULL ) const [virtual]
Write the complete datatype to a le. Parameters pDevice write the object to this device eWriteMode additional options for writing this object
8.16 PoDoFo::PdfDataType Class Reference
79
pEncrypt an encryption object which is used to encrypt this object or NULL to not encrypt this object PdfData cannot do any encryption for you. So the encryption object will be ignored as it is also the case for the write mode! Implements PoDoFo::PdfDataType.
8.16
PoDoFo::PdfDataType Class Reference
#include <PdfDataType.h> Inheritance diagram for PoDoFo::PdfDataType:

PoDoFo::PdfDataType PoDoFo::PdfData PoDoFo::PdfName PoDoFo::PdfReference PoDoFo::PdfString

virtual void Write (PdfOutputDevice pDevice, EPdfWriteMode eWriteMode, const PdfEncrypt pEncrypt=NULL) const =0 virtual bool IsDirty () const virtual void SetDirty (bool bDirty) void SetImmutable (bool bImmutable) bool GetImmutable () const
Protected Member Functions

PdfDataType () void AssertMutable () const
8.16.1
An interface for all PDF datatype classes. See also PdfName PdfArray PdfReference PdfVariant PdfDictionary PdfString
80
Class Documentation
8.16.2
8.16.2.1

PoDoFo::PdfDataType::PdfDataType ( ) [protected]
Create a new PdfDataType. Can only be called by subclasses
8.16.3
8.16.3.1

void PoDoFo::PdfDataType::AssertMutable ( protected] ) const [inline,
Will throw an exception if called on an immutable object, so this should be called before actually changing a value! 8.16.3.2 bool PoDoFo::PdfDataType::GetImmutable ( ) const [inline]
Retrieve if an object is immutable. This is used by PdfImmediateWriter and PdfStreamedDocument so that no keys can be added to an object after setting stream data on it. Returns true if the object is immutable
8.16.3.3
bool PoDoFo::PdfDataType::IsDirty (
) const [virtual]
The dirty ag is set if this variant has been modied after construction. Usually the dirty ag is also set if you call any non-const member function as we cannot determine if you actually changed something or not. Returns true if the value is dirty and has been modied since construction
8.16.3.4
void PoDoFo::PdfDataType::SetDirty ( bool bDirty ) [virtual]
Sets the dirty ag of this PdfVariant Parameters bDirty true if this PdfVariant has been modied from the outside See also IsDirty
8.17 PoDoFo::PdfDate Class Reference 8.16.3.5 void PoDoFo::PdfDataType::SetImmutable ( bool bImmutable ) [inline]
81
Sets this object to immutable, so that no keys can be edited or changed. Parameters bImmutable if true set the object to be immutable This is used by PdfImmediateWriter and PdfStreamedDocument so that no keys can be added to an object after setting stream data on it. 8.16.3.6 virtual void PoDoFo::PdfDataType::Write ( PdfOutputDevice pDevice, EPdfWriteMode eWriteMode, const PdfEncrypt pEncrypt = NULL ) const [pure virtual]
Write the complete datatype to a le. Parameters pDevice write the object to this device eWriteMode additional options for writing this object pEncrypt an encryption object which is used to encrypt this object or NULL to not encrypt this object Implemented in PoDoFo::PdfData, PoDoFo::PdfName, PoDoFo::PdfReference, and PoDoFo::PdfString.
8.17
PoDoFo::PdfDate Class Reference
#include <PdfDate.h>

PdfDate () PdfDate (const time_t &t) virtual PdfDate () bool IsValid () const const time_t & GetTime () const void ToString (PdfString &rsString) const
8.17.1
This class is a date datatype as specied in the PDF reference. You can easily convert from Unix time_t to the PDF time representation and back. Dates like these are used for example in the PDF info dictionary for the creation time and date of the PDF le.
82 PdfDate objects are immutable. From the PDF reference:
Class Documentation
PDF denes a standard date format, which closely follows that of the international standard ASN.1 (Abstract Syntax Notation One), dened in ISO/IEC 8824 (see the Bibliography). A date is a string of the form (D:YYYYMMDDHHmmSSOHHmm)
8.17.2
8.17.2.1

PoDoFo::PdfDate::PdfDate ( )
Create a PdfDate object with the current date and time. 8.17.2.2 PoDoFo::PdfDate::PdfDate ( const time_t & t )
Create a PdfDate with a specied date and time Parameters t the date and time of this object Use IsValid to check wether the time_t could be converted to a valid PdfDate object. See also IsValid()
8.17.2.3
PoDoFo::PdfDate::PdfDate (
) [virtual]
Delete the PdfDate object
8.17.3
8.17.3.1 Returns

const time_t & PoDoFo::PdfDate::GetTime ( ) const [inline]
the date and time of this PdfDate in seconds since epoch.
8.17.3.2
bool PoDoFo::PdfDate::IsValid (
) const [inline]
You can use this function to check wether the date you passed to the constructor could be converted to a valid pdf date string or a valid time_t. Returns true if the PdfDate object is valid
8.18 PoDoFo::PdfDestination Class Reference 8.17.3.3 void PoDoFo::PdfDate::ToString ( PdfString & rsString ) const [inline]
83
The value returned by this function can be used in any PdfObject where a date is needed. Parameters rsString write the date to a PdfString
8.18
PoDoFo::PdfDestination Class Reference
#include <PdfDestination.h>

PdfDestination (PdfVecObjects pParent) PdfDestination (PdfObject pObject, PdfDocument pDocument) PdfDestination (PdfObject pObject, PdfVecObjects pVecObjects) PdfDestination (const eFit=ePdfDestinationFit_Fit) PdfPage pPage, EPdfDestinationFit
PdfDestination (const PdfPage pPage, const PdfRect &rRect) PdfDestination (const PdfPage pPage, double dLeft, double dTop, double dZoom) PdfDestination (const PdfPage pPage, EPdfDestinationFit eFit, double dValue) PdfDestination (const PdfDestination &rhs) const PdfDestination & operator= (const PdfDestination &rhs) PdfPage GetPage (PdfDocument pDoc) PdfPage GetPage (PdfVecObjects pVecObjects) EPdfDestinationType GetType () const double GetZoom () const PdfRect GetRect () const double GetTop () const double GetLeft () const double GetDValue () const PdfObject GetObject () const PdfObject GetObject () const PdfArray & GetArray () const PdfArray & GetArray () const void AddToDictionary (PdfDictionary &dictionary) const
84
Class Documentation
8.18.1
A destination in a PDF le. A destination can either be a page or an action. See also PdfOutlineItem PdfAnnotation PdfDocument
8.18.2
8.18.2.1

PoDoFo::PdfDestination::PdfDestination ( PdfVecObjects pParent )
Create an empty destination - points to nowhere 8.18.2.2 PoDoFo::PdfDestination::PdfDestination ( PdfObject pObject, PdfDocument pDocument )
Create a new PdfDestination from an existing PdfObject (such as loaded from a doc) Parameters pObject the object to construct from pDocument a PDF document owning this destination, needed to resolve pages
8.18.2.3
PoDoFo::PdfDestination::PdfDestination ( PdfObject pObject, PdfVecObjects pVecObjects )
Create a new PdfDestination from an existing PdfObject (such as loaded from a doc) Parameters pObject the object to construct from pVecObjects a PdfVecObjects owning this destination, needed to resolve pages
8.18.2.4
PoDoFo::PdfDestination::PdfDestination ( const PdfPage pPage, EPdfDestinationFit eFit = ePdfDestinationFit_Fit )
Create a new PdfDestination with a page as destination Parameters pPage a page which is the destination eFit t mode for the page. ePdfDestinationFit_FitB Must be ePdfDestinationFit_Fit or
8.18 PoDoFo::PdfDestination Class Reference 8.18.2.5 PoDoFo::PdfDestination::PdfDestination ( const PdfPage pPage, const PdfRect & rRect )
85
Create a destination to a page with its contents magnied to t into the given rectangle Parameters pPage a page which is the destination rRect magnify the page so that the contents of the rectangle are visible
8.18.2.6
PoDoFo::PdfDestination::PdfDestination ( const PdfPage pPage, double dLeft, double dTop, double dZoom )
Create a new destination to a page with specied left and top coordinates and a zoom factor. Parameters pPage a page which is the destination dLeft left coordinate dTop top coordinate dZoom zoom factor in the viewer
8.18.2.7
PoDoFo::PdfDestination::PdfDestination ( const PdfPage pPage, EPdfDestinationFit eFit, double dValue )
Create a new destination to a page. Parameters pPage a page which is the destination eFit t mode for the Page. Allowed values are ePdfDestinationFit_FitH, ePdfDestinationFit_FitV, ePdfDestinationFit_FitBH, ePdfDestinationFit_FitBV dValue value which is a required argument for the selected t mode
8.18.2.8
PoDoFo::PdfDestination::PdfDestination ( const PdfDestination & rhs )
Copy an existing PdfDestination Parameters rhs copy this PdfDestination

86
Class Documentation
8.18.3
8.18.3.1

void PoDoFo::PdfDestination::AddToDictionary ( PdfDictionary & dictionary ) const
Adds this destination to an dictionary. This method handles the all the complexities of making sure its added correctly If this destination is empty. Nothing will be added. Parameters dictionary the destination will be added to this dictionary
8.18.3.2
PdfArray & PoDoFo::PdfDestination::GetArray (
) [inline]
Get access to the internal array Returns the internal PdfArray
8.18.3.3
const PdfArray & PoDoFo::PdfDestination::GetArray ( [inline]
) const
Get access to the internal array This is an overloaded member function. Returns the internal PdfArray
8.18.3.4
double PoDoFo::PdfDestination::GetDValue (
) const [inline]
Get the destination Value Destination must be of type FitH, FitV or FitBH, otherwise exception is thrown Returns the destination Value
8.18.3.5
double PoDoFo::PdfDestination::GetLeft (
) const [inline]
Get the destination Left position Destination must be of type XYZ, FitV or FitR otherwise exception is thrown. Returns the Left position
8.18 PoDoFo::PdfDestination Class Reference 8.18.3.6 const PdfObject PoDoFo::PdfDestination::GetObject ( [inline] ) const
87
Get access to the internal object This is an overloaded member function. Returns the internal PdfObject
8.18.3.7
PdfObject PoDoFo::PdfDestination::GetObject (
) [inline]
Get access to the internal object Returns the internal PdfObject
8.18.3.8
PdfPage PoDoFo::PdfDestination::GetPage ( PdfDocument pDoc )
Get the page that this destination points to Requires that this PdfDestination was somehow created by or from a PdfDocument. Wont work otherwise. Parameters pDoc a PDF document owning this destination, needed to resolve pages Returns the referenced PdfPage
8.18.3.9
PdfPage PoDoFo::PdfDestination::GetPage ( PdfVecObjects pVecObjects )
Get the page that this destination points to Requires that this PdfDestination was somehow created by or from a PdfDocument. Wont work otherwise. Parameters pVecObjects a PdfVecObjects owning this destination, needed to resolve pages Returns the referenced PdfPage
88 8.18.3.10 PdfRect PoDoFo::PdfDestination::GetRect (
Get the destination rect Destination must be of type FirR otherwise exception is thrown Returns the destination rect
8.18.3.11
double PoDoFo::PdfDestination::GetTop (
) const [inline]
Get the destination Top position Destination must be of type XYZ, FitH, FitR, FitBH otherwise exception is thrown. Returns the Top position
8.18.3.12
EPdfDestinationType PoDoFo::PdfDestination::GetType ( [inline]
) const
Get the destination t type Returns the t type
8.18.3.13
double PoDoFo::PdfDestination::GetZoom (
) const [inline]
Get the destination zoom Destination must be of type XYZ otherwise exception is thrown. Returns the zoom
8.18.3.14
const PdfDestination & PoDoFo::PdfDestination::operator= ( const PdfDestination & rhs )
Copy an existing PdfDestination Parameters rhs copy this PdfDestination Returns this object
8.19 PoDoFo::PdfDeviceInputStream Class Reference
89
8.19
PoDoFo::PdfDeviceInputStream Class Reference
#include <PdfInputStream.h> Inheritance diagram for PoDoFo::PdfDeviceInputStream:
PoDoFo::PdfInputStream PoDoFo::PdfDeviceInputStream

PdfDeviceInputStream (PdfInputDevice pDevice) virtual pdf_long Read (char pBuffer, pdf_long lLen)
8.19.1
An input stream that reads data from an input device
8.19.2
8.19.2.1

PoDoFo::PdfDeviceInputStream::PdfDeviceInputStream ( PdfInputDevice pDevice )
Read from an alread opened input device Parameters pDevice an input device
8.19.3
8.19.3.1

pdf_long PoDoFo::PdfDeviceInputStream::Read ( char pBuffer, pdf_long lLen ) [virtual]
Read data from the input stream Parameters pBuffer the data will be stored into this buffer lLen the size of the buffer and number of bytes that will be read Returns the number of bytes read, -1 if an error ocurred and zero if no more bytes are available for reading.
90 Implements PoDoFo::PdfInputStream.
Class Documentation
8.20
PoDoFo::PdfDeviceOutputStream Class Reference
#include <PdfOutputStream.h> Inheritance diagram for PoDoFo::PdfDeviceOutputStream:
PoDoFo::PdfOutputStream PoDoFo::PdfDeviceOutputStream

PdfDeviceOutputStream (PdfOutputDevice pDevice) virtual pdf_long Write (const char pBuffer, pdf_long lLen) virtual void Close ()
8.20.1
An output stream that writes to a PdfOutputDevice
8.20.2
8.20.2.1

PoDoFo::PdfDeviceOutputStream::PdfDeviceOutputStream ( PdfOutputDevice pDevice )
Write to an already opened input device Parameters pDevice an output device
8.20.3
8.20.3.1

virtual void PoDoFo::PdfDeviceOutputStream::Close ( ) [inline, virtual]
Close the PdfOutputStream. This method may throw exceptions and has to be called before the descructor to end writing. No more data may be written to the output device after calling close.
8.21 PoDoFo::PdfDifferenceEncoding Class Reference Implements PoDoFo::PdfOutputStream. 8.20.3.2 pdf_long PoDoFo::PdfDeviceOutputStream::Write ( const char pBuffer, pdf_long lLen ) [virtual]
91
8.21
PoDoFo::PdfDifferenceEncoding Class Reference
#include <PdfDifferenceEncoding.h> Inheritance diagram for PoDoFo::PdfDifferenceEncoding:

PoDoFo::PdfEncoding PoDoFo::PdfElement
PoDoFo::PdfDifferenceEncoding
Public Types
enum EBaseEncoding { eBaseEncoding_Font, eBaseEncoding_WinAnsi, eBaseEncoding_MacRoman, eBaseEncoding_MacExpert }

PdfDifferenceEncoding (const PdfEncodingDifference &rDifference, PdfDocument pParent, bool bAutoDelete=true) PdfDifferenceEncoding (const PdfEncodingDifference &rDifference, PdfVecObjects pParent, bool bAutoDelete=true) PdfDifferenceEncoding (const PdfEncodingDifference &rDifference, EBaseEncoding eBaseEncoding, PdfDocument pParent, bool bAutoDelete=true) PdfDifferenceEncoding (const PdfEncodingDifference &rDifference, EBaseEncoding eBaseEncoding, PdfVecObjects pParent, bool bAutoDelete=true) PdfDifferenceEncoding (PdfObject pObject, bool bAutoDelete=true)
92
Class Documentation virtual void AddToDictionary (PdfDictionary &rDictionary) const virtual PdfString ConvertToUnicode (const PdfString &rEncodedString, const PdfFont pFont) const virtual PdfRefCountedBuffer ConvertToEncoding (const PdfString &rString, const PdfFont pFont) const virtual bool IsAutoDelete () const virtual bool IsSingleByteEncoding () const const PdfEncodingDifference & GetDifferences () const virtual pdf_utf16be GetCharCode (int nIndex) const

static pdf_utf16be NameToUnicodeID (const PdfName &rName) static PdfName UnicodeIDToName (pdf_utf16be inCodePoint)

virtual const PdfName & GetID () const
8.21.1
PdfDifferenceEncoding is an encoding, which is based on either the fonts encoding or a predened encoding and denes differences to this base encoding.
8.21.2
8.21.2.1
Member Enumeration Documentation

enum PoDoFo::PdfDifferenceEncoding::EBaseEncoding
Denes the base encoding from which a PdfDifferenceEncoding differs. Enumerator: eBaseEncoding_Font Use The fonts encoding as base. eBaseEncoding_WinAnsi Use WinAnsiEncoding as base encoding. eBaseEncoding_MacRoman Use MacRomanEncoding as base encoding. eBaseEncoding_MacExpert Use MacExpertEncoding as base encoding.
8.21.3
8.21.3.1

PoDoFo::PdfDifferenceEncoding::PdfDifferenceEncoding ( const PdfEncodingDifference & rDifference, PdfDocument pParent, bool bAutoDelete = true )
Create a new PdfDifferenceEncoding which is based on the fonts encoding.

8.21 PoDoFo::PdfDifferenceEncoding Class Reference Parameters rDifference the differences in this encoding pParent parent PdfVecObjects. Add a newly created object to this vector. bAutoDelete if true the encoding is deleted by its owning font
93
8.21.3.2
PoDoFo::PdfDifferenceEncoding::PdfDifferenceEncoding ( const PdfEncodingDifference & rDifference, PdfVecObjects pParent, bool bAutoDelete = true )
Create a new PdfDifferenceEncoding which is based on the fonts encoding. Parameters rDifference the differences in this encoding pParent parent PdfDocument. Add a newly created object to this vector. bAutoDelete if true the encoding is deleted by its owning font
8.21.3.3
PoDoFo::PdfDifferenceEncoding::PdfDifferenceEncoding ( const PdfEncodingDifference & rDifference, EBaseEncoding eBaseEncoding, PdfDocument pParent, bool bAutoDelete = true )
Create a new PdfDifferenceEncoding which is based on a predened encoding. Parameters rDifference the differences in this encoding eBaseEncoding the base encoding of this font pParent parent PdfDocument. Add a newly created object to this vector. bAutoDelete if true the encoding is deleted by its owning font
8.21.3.4
PoDoFo::PdfDifferenceEncoding::PdfDifferenceEncoding ( const PdfEncodingDifference & rDifference, EBaseEncoding eBaseEncoding, PdfVecObjects pParent, bool bAutoDelete = true )
Create a new PdfDifferenceEncoding which is based on a predened encoding. Parameters rDifference the differences in this encoding eBaseEncoding the base encoding of this font pParent parent PdfVecObjects. Add a newly created object to this vector. bAutoDelete if true the encoding is deleted by its owning font
94 8.21.3.5
Class Documentation PoDoFo::PdfDifferenceEncoding::PdfDifferenceEncoding ( PdfObject pObject, bool bAutoDelete = true )
Create a new PdfDifferenceEncoding from an existing object in a PDF le. Parameters pObject an existing differences encoding bAutoDelete if true the encoding is deleted by its owning font
8.21.4
8.21.4.1

void PoDoFo::PdfDifferenceEncoding::AddToDictionary ( PdfDictionary & rDictionary ) const [virtual]
Add this encoding object to a dictionary usually be adding an /Encoding key in font dictionaries. Parameters rDictionary add the encoding to this dictionary
8.21.4.2
PdfRefCountedBuffer PoDoFo::PdfDifferenceEncoding::ConvertToEncoding ( const PdfString & rString, const PdfFont pFont ) const [virtual]
Convert a unicode PdfString to a string encoded with this encoding. Parameters rString an unicode PdfString. pFont the font for which this string is converted Returns an encoded PdfRefCountedBuffer. The PdfRefCountedBuffer is treated as a series of bytes and is allowed to have 0 bytes. The returned buffer must not be a unicode string.
8.21.4.3
PdfString PoDoFo::PdfDifferenceEncoding::ConvertToUnicode ( const PdfString & rEncodedString, const PdfFont pFont ) const [virtual]
Convert a string that is encoded with this encoding to an unicode PdfString.

8.21 PoDoFo::PdfDifferenceEncoding Class Reference Parameters
95
rEncodedString a string encoded by this encoding. Usually this string was read from a content stream. pFont the font for which this string is converted Returns an unicode PdfString.
8.21.4.4
pdf_utf16be PoDoFo::PdfDifferenceEncoding::GetCharCode ( int nIndex ) const [virtual]
Get the unicode character code for this encoding at the position nIndex. nIndex is a position between GetFirstChar() and GetLastChar() Parameters nIndex character code at position index Returns unicode character code See also GetFirstChar GetLastChar Will throw an exception if nIndex is out of range. 8.21.4.5 const PdfEncodingDifference & PoDoFo::PdfDifferenceEncoding::GetDifferences ( [inline]
) const
Get read-only access to the object containing the actual differences. Returns the container with the actual differences
8.21.4.6
const PdfName & PoDoFo::PdfDifferenceEncoding::GetID ( [inline, protected, virtual]
) const
Get a unique ID for this encoding which can used for comparisons! Returns a unique id for this encoding!
96 8.21.4.7 Returns
Class Documentation bool PoDoFo::PdfDifferenceEncoding::IsAutoDelete ( [inline, virtual] ) const
true if this encoding should be deleted automatically with the font.
8.21.4.8 Returns
bool PoDoFo::PdfDifferenceEncoding::IsSingleByteEncoding ( const [inline, virtual]
true if this is a single byte encoding with a maximum of 256 values.
8.21.4.9
pdf_utf16be PoDoFo::PdfDifferenceEncoding::NameToUnicodeID ( const PdfName & rName ) [static]
Convert a standard character name to a unicode code point Parameters rName a standard character name Returns an unicode code point
8.21.4.10
PdfName PoDoFo::PdfDifferenceEncoding::UnicodeIDToName ( pdf_utf16be inCodePoint ) [static]
Convert an unicode code point to a standard character name Parameters inCodePoint a code point Returns a standard character name of /.notdef if none could be found
8.22
PoDoFo::PdfDocEncoding Class Reference
#include <PdfEncoding.h> Inheritance diagram for PoDoFo::PdfDocEncoding:

8.22 PoDoFo::PdfDocEncoding Class Reference
97
PoDoFo::PdfEncoding PoDoFo::PdfSimpleEncoding PoDoFo::PdfDocEncoding

PdfDocEncoding ()

virtual const pdf_utf16be GetToUnicodeTable () const
8.22.1
The PdfDocEncoding is the default encoding for all strings in PoDoFo which are data in the PDF le. Do not allocate this class yourself, as allocations might be expensive. Try using PdfFont::DocEncoding. See also PdfFont::DocEncoding
8.22.2
8.22.2.1

PoDoFo::PdfDocEncoding::PdfDocEncoding ( ) [inline]
Create a new PdfDocEncoding
8.22.3
8.22.3.1

const pdf_utf16be PoDoFo::PdfDocEncoding::GetToUnicodeTable ( ) const [protected, virtual]
Gets a table of 256 short values which are the big endian unicode code points that are assigned to the 256 values of this encoding. This table is used internally to convert an encoded string of this encoding to and from unicode.
98 Returns an array of 256 big endian unicode code points Implements PoDoFo::PdfSimpleEncoding.
Class Documentation
8.23
PoDoFo::PdfDocument Class Reference
#include <PdfDocument.h> Inheritance diagram for PoDoFo::PdfDocument:

PoDoFo::PdfDocument
PoDoFo::PdfMemDocument
PoDoFo::PdfStreamedDocument

virtual PdfDocument () virtual EPdfWriteMode GetWriteMode () const =0 virtual EPdfVersion GetPdfVersion () const =0 virtual bool IsLinearized () const =0 PdfInfo GetInfo () const PdfOutlines GetOutlines (bool bCreate=ePdfCreateObject) PdfNamesTree GetNamesTree (bool bCreate=ePdfCreateObject) PdfAcroForm GetAcroForm (bool bCreate=ePdfCreateObject, PdfAcroForm::EPdfAcroFormDefaulAppearance eDefaultAppearance=PdfAcroForm::ePdfAcroFormDefaultAppearance_BlackText12pt) PdfPagesTree GetPagesTree () const int GetPageCount () const PdfPage GetPage (int nIndex) const PdfFont CreateFont (const char pszFontName, const PdfEncoding const pEncoding=PdfEncodingFactory::GlobalWinAnsiEncodingInstance(), PdfFontCache::EFontCreationFlags eFontCreationFlags=PdfFontCache::eFontCreationFlags_AutoSelectBase14, bool bEmbedd=true) PdfFont CreateFont (const char pszFontName, bool bBold, bool bItalic, const PdfEncoding const pEncoding=PdfEncodingFactory::GlobalWinAnsiEncodingInstance(), PdfFontCache::EFontCreationFlags eFontCreationFlags=PdfFontCache::eFontCreationFlags_AutoSelectBase14, bool bEmbedd=true, const char pszFileName=NULL) PdfFont CreateFont (FT_Face face, const PdfEncoding const pEncoding=PdfEncodingFactory::GlobalWinAnsiEncodingInstance(), bool bEmbedd=true) PdfFont CreateDuplicateFontType1 (PdfFont pFont, const char pszSufx)
8.23 PoDoFo::PdfDocument Class Reference
99
PdfFont CreateFontSubset (const char pszFontName, bool bBold, bool bItalic, const PdfEncoding const pEncoding=PdfEncodingFactory::GlobalWinAnsiEncodingInstance(), const char pszFileName=NULL) FT_Library GetFontLibrary () const void EmbedSubsetFonts () PdfPage CreatePage (const PdfRect &rSize) const PdfDocument & Append (const PdfMemDocument &rDoc, bool bAppendAll=true) PdfRect FillXObjectFromDocumentPage (PdfXObject pXObj, const PdfMemDocument &rDoc, int nPage, bool bUseTrimBox) void AttachFile (const PdfFileSpec &rFileSpec) void AddNamedDestination (const PdfDestination &rDest, const PdfString &rsName) void SetPageMode (EPdfPageMode inMode) EPdfPageMode GetPageMode (void) const void SetUseFullScreen (void) void SetPageLayout (EPdfPageLayout inLayout) void SetHideToolbar (void) void SetHideMenubar (void) void SetHideWindowUI (void) void SetFitWindow (void) void SetCenterWindow (void) void SetDisplayDocTitle (void) void SetPrintScaling (PdfName &inScalingType) void SetBaseURI (const std::string &inBaseURI) void SetLanguage (const std::string &inLanguage) void SetBindingDirection (PdfName &inDirection) virtual bool IsPrintAllowed () const =0 virtual bool IsEditAllowed () const =0 virtual bool IsCopyAllowed () const =0 virtual bool IsEditNotesAllowed () const =0 virtual bool IsFillAndSignAllowed () const =0 virtual bool IsAccessibilityAllowed () const =0 virtual bool IsDocAssemblyAllowed () const =0 virtual bool IsHighPrintAllowed () const =0 PdfVecObjects GetObjects () const PdfVecObjects GetObjects () const

PdfDocument () void SetInfo (PdfInfo pInfo) PdfObject GetCatalog () const PdfObject GetCatalog () const void SetCatalog (PdfObject pObject)
100
Class Documentation PdfObject GetTrailer () const PdfObject GetTrailer () const void SetTrailer (PdfObject pObject) PdfObject GetNamedObjectFromCatalog (const char pszName) const void InitPagesTree () void FixObjectReferences (PdfObject pObject, int difference) void SetViewerPreference (const PdfName &whichPref, const PdfObject &valueObj) void SetViewerPreference (const PdfName &whichPref, bool inValue) void Clear ()
8.23.1
PdfDocument is the core interface for working with PDF documents. PdfDocument provides easy access to the individual pages in the PDF le and to certain special dictionaries. PdfDocument cannot be used directly. Use PdfMemDocument whenever you want to change the object structure of a PDF le. When you are only creating PDF les, please use PdfStreamedDocument which is usually faster for creating PDFs. See also PdfStreamedDocument PdfMemDocument
8.23.2
8.23.2.1

PoDoFo::PdfDocument::PdfDocument ( ) [virtual]
Close down/destruct the PdfDocument
8.23.2.2
PoDoFo::PdfDocument::PdfDocument (
) [protected]
Construct a new (empty) PdfDocument
8.23.3
8.23.3.1

void PoDoFo::PdfDocument::AddNamedDestination ( const PdfDestination & rDest, const PdfString & rsName )
Adds a PdfDestination into the global Names tree with the specied name, optionally replacing one of the same name
8.23 PoDoFo::PdfDocument Class Reference Parameters rDest the destination to be assigned rsName the name for the destination
101
8.23.3.2
const PdfDocument & PoDoFo::PdfDocument::Append ( const PdfMemDocument & rDoc, bool bAppendAll = true )
Appends another PdfDocument to this document Parameters rDoc the document to append bAppendAll species whether pages and outlines are appended too Returns this document
8.23.3.3
void PoDoFo::PdfDocument::AttachFile ( const PdfFileSpec & rFileSpec )
Attach a le to the document. Parameters rFileSpec a le specication
8.23.3.4
void PoDoFo::PdfDocument::Clear (
) [protected]
Clear all internal variables And reset PdfDocument to an intial state
8.23.3.5
PdfFont PoDoFo::PdfDocument::CreateDuplicateFontType1 ( PdfFont pFont, const char pszSufx )
Creates a duplicate Type1-PdfFont with a new Id Parameters pFont is the existing font pszSufx Sufx to add to font-id The returned object is owned by the PdfDocument. TODO: DS: Make this generic so that it will work for any font type!
102 8.23.3.6
Class Documentation PdfFont PoDoFo::PdfDocument::CreateFont ( FT_Face face, const PdfEncoding const pEncoding = PdfEncodingFactory::GlobalWinAnsiEncodingInstance(), bool bEmbedd = true )
Creates a PdfFont object Parameters face a valid freetype font handle (will be freed by PoDoFo) pEncoding the encoding of the font. The font will not take ownership of this object. bEmbedd species whether this font should be embedded in the PDF le. Embedding fonts is usually a good idea. Returns PdfFont a pointer to a new PdfFont object. The returned object is owned by the PdfDocument.
8.23.3.7
PdfFont PoDoFo::PdfDocument::CreateFont ( const char pszFontName, const PdfEncoding const pEncoding = PdfEncodingFactory::GlobalWinAnsiEncodingInstance(), PdfFontCache::EFontCreationFlags eFontCreationFlags = PdfFontCache::eFontCreationFlags_AutoSelectBase14, bool bEmbedd = true )
Creates a PdfFont object Parameters pszFontName name of the font as it is known to the system pEncoding the encoding of the font. The font will not take ownership of this object. eFontCreationFlags special ag to specify how fonts should be created bEmbedd species whether this font should be embedded in the PDF le. Embedding fonts is usually a good idea. Returns PdfFont a pointer to a new PdfFont object. The returned object is owned by the PdfDocument.
8.23 PoDoFo::PdfDocument Class Reference 8.23.3.8
103
PdfFont PoDoFo::PdfDocument::CreateFont ( const char pszFontName, bool bBold, bool bItalic, const PdfEncoding const pEncoding = PdfEncodingFactory::GlobalWinAnsiEncodingInstance(), PdfFontCache::EFontCreationFlags eFontCreationFlags = PdfFontCache::eFontCreationFlags_AutoSelectBase14, bool bEmbedd = true, const char pszFileName = NULL )
Creates a PdfFont object Parameters pszFontName name of the font as it is known to the system bBold if true search for a bold font bItalic if true search for an italic font pEncoding the encoding of the font. The font will not take ownership of this object. eFontCreationFlags special ag to specify how fonts should be created bEmbedd species whether this font should be embedded in the PDF le. Embedding fonts is usually a good idea. pszFileName path to a valid font le Returns PdfFont a pointer to a new PdfFont object.
8.23.3.9
PdfFont PoDoFo::PdfDocument::CreateFontSubset ( const char pszFontName, bool bBold, bool bItalic, const PdfEncoding const pEncoding = PdfEncodingFactory::GlobalWinAnsiEncodingInstance(), const char pszFileName = NULL )
Creates a font subset which contains only a few characters and is embedded. THIS WORKS ONLY FOR TTF FONTS! Parameters pszFontName name of the font as it is known to the system bBold if true search for a bold font bItalic if true search for an italic font pEncoding the encoding of the font. The font will not take ownership of this object. pszFileName optional path of a fontle which should be used Returns PdfFont a pointer to a new PdfFont object.
104 8.23.3.10
Class Documentation PdfPage PoDoFo::PdfDocument::CreatePage ( const PdfRect & rSize )
Creates a new page object and inserts it into the internal page tree. The returned page is owned by the PdfDocument and will get deleted along with it! Parameters rSize a PdfRect spezifying the size of the page (i.e the /MediaBox key) in 1/1000th mm Returns a pointer to a PdfPage object
8.23.3.11
void PoDoFo::PdfDocument::EmbedSubsetFonts (
Embeds all pending subset-fonts, is automatically done on Write(). Just call explicit in case PdfDocument is needed as XObject 8.23.3.12 PdfRect PoDoFo::PdfDocument::FillXObjectFromDocumentPage ( PdfXObject pXObj, const PdfMemDocument & rDoc, int nPage, bool bUseTrimBox )
Fill an existing empty XObject from a page of another document Parameters pXObj pointer to the XOject rDoc the document to embedd into XObject nPage page-number to embedd into XObject bUseTrimBox if true try to use trimbox for size of xobject Returns the bounding box
8.23.3.13
void PoDoFo::PdfDocument::FixObjectReferences ( PdfObject pObject, int difference ) [protected]
Recursively changes every PdfReference in the PdfObject and in any child that is either an PdfArray or a direct object. The reference is changed so that difference is added to the object number if the reference. Parameters pObject object to change difference add this value to every reference that is encountered
8.23 PoDoFo::PdfDocument Class Reference 8.23.3.14 PdfAcroForm PoDoFo::PdfDocument::GetAcroForm ( bool bCreate = ePdfCreateObject, PdfAcroForm::EPdfAcroFormDefaulAppearance eDefaultAppearance = PdfAcroForm::ePdfAcroFormDefaultAppearance_BlackText12pt )
105
Get access to the AcroForm dictionary Parameters bCreate create the object if it does not exist (ePdfCreateObject) or return NULL if it does not exist eDefaultAppearance species if a default appearence shall be created Returns PdfObject the AcroForm dictionary
8.23.3.15
PdfObject PoDoFo::PdfDocument::GetCatalog ( protected]
) [inline,
Get access to the internal Catalog dictionary or root object. Returns PdfObject the documents catalog Reimplemented in PoDoFo::PdfMemDocument. 8.23.3.16 const PdfObject PoDoFo::PdfDocument::GetCatalog ( [inline, protected] ) const
Get access to the internal Catalog dictionary or root object. Returns PdfObject the documents catalog Reimplemented in PoDoFo::PdfMemDocument. 8.23.3.17 FT_Library PoDoFo::PdfDocument::GetFontLibrary ( [inline] ) const
Returns the font library from font cache Returns the internal handle to the freetype library
106 8.23.3.18 PdfInfo PoDoFo::PdfDocument::GetInfo (
Get access to the internal Info dictionary You can set the author, title etc. of the document using the info dictionary. Returns the info dictionary
8.23.3.19
PdfObject PoDoFo::PdfDocument::GetNamedObjectFromCatalog ( const char pszName ) const [protected]
Get a dictioary from the catalog dictionary by its name. Parameters pszName will be converted into a PdfName Returns the dictionary if it was found or NULL
8.23.3.20
PdfNamesTree PoDoFo::PdfDocument::GetNamesTree ( bool bCreate = ePdfCreateObject )
Get access to the Names dictionary (where all the named objects are stored) The returned PdfNamesTree object is owned by the PdfDocument. Parameters bCreate create the object if it does not exist (ePdfCreateObject) or return NULL if it does not exist Returns the Names dictionary
8.23.3.21
PdfVecObjects PoDoFo::PdfDocument::GetObjects ( [inline]
Get access to the internal vector of objects or root object. Returns the vector of objects Reimplemented in PoDoFo::PdfMemDocument.
8.23 PoDoFo::PdfDocument Class Reference 8.23.3.22 const PdfVecObjects PoDoFo::PdfDocument::GetObjects ( [inline]
107 ) const
Get access to the internal vector of objects or root object. Returns the vector of objects Reimplemented in PoDoFo::PdfMemDocument. 8.23.3.23 PdfOutlines PoDoFo::PdfDocument::GetOutlines ( bool bCreate = ePdfCreateObject )
Get access to the Outlines (Bookmarks) dictionary The returned outlines object is owned by the PdfDocument. Parameters bCreate create the object if it does not exist (ePdfCreateObject) or return NULL if it does not exist Returns the Outlines/Bookmarks dictionary
8.23.3.24
PdfPage PoDoFo::PdfDocument::GetPage ( int nIndex ) const
Get the PdfPage for a specic page in a document The returned page is owned by the PdfDocument and will get deleted along with it! Parameters nIndex which page (0-based) Returns a pointer to a PdfPage for the requested page. The returned object is owned by the PdfDocument.
8.23.3.25
int PoDoFo::PdfDocument::GetPageCount (
) const
Get the total number of pages in a document Returns int number of pages
108 8.23.3.26
Class Documentation EPdfPageMode PoDoFo::PdfDocument::GetPageMode ( void ) const
Gets the opening mode for a document Returns which mode is set
8.23.3.27
PdfPagesTree PoDoFo::PdfDocument::GetPagesTree ( [inline]
) const
Get access to the pages tree. Better use GetPage and CreatePage methods. Returns the PdfPagesTree of this document.
8.23.3.28
virtual EPdfVersion PoDoFo::PdfDocument::GetPdfVersion ( const [pure virtual]
Get the PDF version of the document Returns EPdfVersion version of the pdf document Implemented in PoDoFo::PdfMemDocument, and PoDoFo::PdfStreamedDocument. 8.23.3.29 PdfObject PoDoFo::PdfDocument::GetTrailer ( protected] ) [inline,
Get access to the internal trailer dictionary or root object. Returns PdfObject the documents catalog
8.23.3.30
const PdfObject PoDoFo::PdfDocument::GetTrailer ( [inline, protected]
) const
Get access to the internal trailer dictionary or root object. Returns PdfObject the documents catalog Reimplemented in PoDoFo::PdfMemDocument.
8.23 PoDoFo::PdfDocument Class Reference 8.23.3.31 virtual EPdfWriteMode PoDoFo::PdfDocument::GetWriteMode ( const [pure virtual]
109 )
Get the write mode used for wirting the PDF Returns the write mode Implemented in PoDoFo::PdfMemDocument, and PoDoFo::PdfStreamedDocument.
8.23.3.32
void PoDoFo::PdfDocument::InitPagesTree (
) [protected]
Internal method for initializing the pages tree for this document
8.23.3.33
virtual bool PoDoFo::PdfDocument::IsAccessibilityAllowed ( ) const [pure virtual]
Checks if it is allowed to extract text and graphics to support users with disabillities Every PDF consuming applications has to adhere this value! Returns true if you are allowed to extract text and graphics to support users with disabillities See also PdfEncrypt to set own document permissions. Implemented in PoDoFo::PdfMemDocument, and PoDoFo::PdfStreamedDocument.
8.23.3.34
virtual bool PoDoFo::PdfDocument::IsCopyAllowed ( [pure virtual]
) const
Checks if text and graphics extraction is allowed. Every PDF consuming applications has to adhere this value! Returns true if you are allowed to extract text and graphics from this document See also PdfEncrypt to set own document permissions. Implemented in PoDoFo::PdfMemDocument, and PoDoFo::PdfStreamedDocument.
110 8.23.3.35
Class Documentation virtual bool PoDoFo::PdfDocument::IsDocAssemblyAllowed ( const [pure virtual] )
Checks if it is allowed to insert, create, rotate, delete pages or add bookmarks Every PDF consuming applications has to adhere this value! Returns true if you are allowed to insert, create, rotate, delete pages or add bookmarks See also PdfEncrypt to set own document permissions. Implemented in PoDoFo::PdfMemDocument, and PoDoFo::PdfStreamedDocument.
8.23.3.36
virtual bool PoDoFo::PdfDocument::IsEditAllowed ( [pure virtual]
) const
Checks if modiying this document (besides annotations, form elds or changing pages) is allowed. Every PDF consuming applications has to adhere this value! Returns true if you are allowed to mody this document See also PdfEncrypt to set own document permissions. Implemented in PoDoFo::PdfMemDocument, and PoDoFo::PdfStreamedDocument.
8.23.3.37
virtual bool PoDoFo::PdfDocument::IsEditNotesAllowed ( [pure virtual]
) const
Checks if it is allowed to add or modify annotations or form elds Every PDF consuming applications has to adhere this value! Returns true if you are allowed to add or modify annotations or form elds See also PdfEncrypt to set own document permissions. Implemented in PoDoFo::PdfMemDocument, and PoDoFo::PdfStreamedDocument.
8.23 PoDoFo::PdfDocument Class Reference 8.23.3.38 virtual bool PoDoFo::PdfDocument::IsFillAndSignAllowed ( [pure virtual]
111 ) const
Checks if it is allowed to ll in existing form or signature elds Every PDF consuming applications has to adhere this value! Returns true if you are allowed to ll in existing form or signature elds See also PdfEncrypt to set own document permissions. Implemented in PoDoFo::PdfMemDocument, and PoDoFo::PdfStreamedDocument. 8.23.3.39 virtual bool PoDoFo::PdfDocument::IsHighPrintAllowed ( [pure virtual] ) const
Checks if it is allowed to print a high quality version of this document Every PDF consuming applications has to adhere this value! Returns true if you are allowed to print a high quality version of this document See also PdfEncrypt to set own document permissions. Implemented in PoDoFo::PdfMemDocument, and PoDoFo::PdfStreamedDocument. 8.23.3.40 virtual bool PoDoFo::PdfDocument::IsLinearized ( virtual] ) const [pure
Returns wether this PDF document is linearized, aka weboptimized Returns true if the PDF document is linearized Implemented in PoDoFo::PdfMemDocument, and PoDoFo::PdfStreamedDocument. 8.23.3.41 virtual bool PoDoFo::PdfDocument::IsPrintAllowed ( [pure virtual] ) const
Checks if printing this document is allowed. Every PDF consuming applications has to adhere this value!
112 Returns true if you are allowed to print this document See also PdfEncrypt to set own document permissions.
Class Documentation
Implemented in PoDoFo::PdfMemDocument, and PoDoFo::PdfStreamedDocument. 8.23.3.42 void PoDoFo::PdfDocument::SetBaseURI ( const std::string & inBaseURI )
Set the documents Viewer Preferences: Set the base URI of the document TODO: DS document value! 8.23.3.43 void PoDoFo::PdfDocument::SetBindingDirection ( PdfName & inDirection )
Set the documents Viewer Preferences: 8.23.3.44 void PoDoFo::PdfDocument::SetCatalog ( PdfObject pObject ) [inline, protected]
Set the catalog of this PdfDocument deleting the old one. Parameters pObject the new catalog object It will be owned by PdfDocument.
8.23.3.45
void PoDoFo::PdfDocument::SetCenterWindow ( void )
Set the documents Viewer Preferences: Center the document in the viewers window 8.23.3.46 void PoDoFo::PdfDocument::SetDisplayDocTitle ( void )
Set the documents Viewer Preferences: Display the title from the document information in the title of the viewer. See also SetTitle
8.23.3.47
void PoDoFo::PdfDocument::SetFitWindow ( void )
Set the documents Viewer Preferences: Fit the document in the viewers window
8.23 PoDoFo::PdfDocument Class Reference 8.23.3.48 void PoDoFo::PdfDocument::SetHideMenubar ( void )
113
Set the documents Viewer Preferences: Hide the menubar in the viewer
8.23.3.49
void PoDoFo::PdfDocument::SetHideToolbar ( void )
Set the documents Viewer Preferences: Hide the toolbar in the viewer
8.23.3.50
void PoDoFo::PdfDocument::SetHideWindowUI ( void )
Set the documents Viewer Preferences: Show only the documents contents and no controll elements such as buttons and scrollbars in the viewer
8.23.3.51
void PoDoFo::PdfDocument::SetInfo ( PdfInfo pInfo ) [protected]
Set the info object containing meta information. Deletes any old info object. Parameters pInfo the new info object (will be owned by PdfDocument)
8.23.3.52
void PoDoFo::PdfDocument::SetLanguage ( const std::string & inLanguage )
Set the documents Viewer Preferences: Set the language of the document
8.23.3.53
void PoDoFo::PdfDocument::SetPageLayout ( EPdfPageLayout inLayout )
Sets the page layout for a document
8.23.3.54
void PoDoFo::PdfDocument::SetPageMode ( EPdfPageMode inMode )
Sets the opening mode for a document Parameters inMode which mode to set
114 8.23.3.55
Class Documentation void PoDoFo::PdfDocument::SetPrintScaling ( PdfName & inScalingType )
Set the documents Viewer Preferences: Set the default print scaling of the document TODO: DS use an enum here! 8.23.3.56 void PoDoFo::PdfDocument::SetTrailer ( PdfObject pObject ) [protected]
Set the trailer of this PdfDocument deleting the old one. Parameters pObject the new trailer object It will be owned by PdfDocument.
8.23.3.57
void PoDoFo::PdfDocument::SetUseFullScreen ( void )
Sets the opening mode for a document to be in full screen 8.23.3.58 void PoDoFo::PdfDocument::SetViewerPreference ( const PdfName & whichPref, bool inValue ) [protected]
Low level APIs for setting a viewer preference Convinience overload. Parameters whichPref the dictionary key to set inValue the object to be set
8.23.3.59
void PoDoFo::PdfDocument::SetViewerPreference ( const PdfName & whichPref, const PdfObject & valueObj ) [protected]
Low level APIs for setting a viewer preference Parameters whichPref the dictionary key to set valueObj the object to be set
8.24
PoDoFo::PdfElement Class Reference
#include <PdfElement.h> Inheritance diagram for PoDoFo::PdfElement:

8.24 PoDoFo::PdfElement Class Reference

PoDoFo::PdfElement PoDoFo::PdfAction PoDoFo::PdfAnnotation PoDoFo::PdfContents PoDoFo::PdfDifferenceEncoding PoDoFo::PdfExtGState PoDoFo::PdfFileSpec PoDoFo::PdfFont PoDoFo::PdfFunction PoDoFo::PdfInfo PoDoFo::PdfOutlineItem PoDoFo::PdfPage PoDoFo::PdfPagesTree PoDoFo::PdfShadingPattern PoDoFo::PdfXObject
115

PdfObject GetObject () const PdfObject GetObject () const

PdfElement (const char pszType, PdfVecObjects pParent) PdfElement (const char pszType, PdfDocument pParent) PdfElement (const char pszType, PdfObject pObject) PdfElement (EPdfDataType eExpectedDataType, PdfObject pObject) const char TypeNameForIndex (int i, const char ppTypes, long lLen) const int TypeNameToIndex (const char pszType, const char ppTypes, long lLen, int nUnknownValue) const PdfObject CreateObject (const char pszType=NULL) PdfObject GetNonConstObject () const
116
Class Documentation
8.24.1
PdfElement is a common base class for all elements in a PDF le. For example pages, action and annotations. Every PDF element has one PdfObject and provides an easier interface to modify the contents of the dictionary. A PdfElement base class can be created from an existing PdfObject or created from scratch. In the later case, the PdfElement creates a PdfObject and adds it to a vector of objects. A PdfElement cannot be created directly. Use one of the subclasses which implement real functionallity. See also PdfPage PdfAction PdfAnnotation
8.24.2
8.24.2.1

PoDoFo::PdfElement::PdfElement ( const char pszType, PdfVecObjects pParent ) [protected]
Creates a new PdfElement Parameters pszType type entry of the elements object pParent parent vector of objects. Add a newly created object to this vector.
8.24.2.2
PoDoFo::PdfElement::PdfElement ( const char pszType, PdfDocument pParent ) [protected]
Creates a new PdfElement Parameters pszType type entry of the elements object pParent parent PdfDocument. Add a newly created object to this vector.
8.24.2.3
PoDoFo::PdfElement::PdfElement ( const char pszType, PdfObject pObject ) [protected]
Create a PdfElement from an existing PdfObject The object must be a dictionary.

8.24 PoDoFo::PdfElement Class Reference Parameters
117
pszType type entry of the elements object. Throws an exception if the type in the PdfObject differs from pszType. pObject pointer to the PdfObject that is modied by this PdfElement
8.24.2.4
PoDoFo::PdfElement::PdfElement ( EPdfDataType eExpectedDataType, PdfObject pObject ) [protected]
Create a PdfElement from an existing PdfObject The object might be of any data type, PdfElement will throw an exception if the PdfObject if not of the same datatype as the expected one. This is necessary in rare cases. E.g. in PdfContents. Parameters eExpectedDataType the expected datatype of this object pObject pointer to the PdfObject that is modied by this PdfElement
8.24.3
8.24.3.1

PdfObject PoDoFo::PdfElement::CreateObject ( const char pszType = NULL ) [protected]
Create a PdfObject in the parent of this PdfElement which might either be a PdfStreamedDocument, a PdfDocument or a PdfVecObjects Use this function in an own subclass of PdfElement to create new PdfObjects. Parameters pszType an optional /Type key of the created object Returns a PdfObject which is owned by the parent
8.24.3.2
PdfObject PoDoFo::PdfElement::GetNonConstObject ( [inline, protected]
) const
Get access to the internal object. Use this method if you need access to the internal object in a const-method without having to do a const cast. Returns the internal PdfObject
118 8.24.3.3
Class Documentation const PdfObject PoDoFo::PdfElement::GetObject ( [inline] ) const
Get access to the internal object This is an overloaded member function. Returns the internal PdfObject
8.24.3.4
PdfObject PoDoFo::PdfElement::GetObject (
) [inline]
Get access to the internal object Returns the internal PdfObject
8.24.3.5
const char PoDoFo::PdfElement::TypeNameForIndex ( int i, const char ppTypes, long lLen ) const [protected]
Convert an enum or index to its string representation which can be written to the PDF le. This is a helper function for various PdfElement subclasses that need strings and enums for their SubTypes keys. Parameters i the index or enum value ppTypes an array of strings containing the string mapping of the index lLen the length of the string array Returns the string representation or NULL for values out of range
8.24.3.6
int PoDoFo::PdfElement::TypeNameToIndex ( const char pszType, const char ppTypes, long lLen, int nUnknownValue ) const [protected]
Convert a string type to an array index or enum. This is a helper function for various PdfElement subclasses that need strings and enums for their SubTypes keys. Parameters pszType the type as string
8.25 PoDoFo::PdfEncoding Class Reference ppTypes an array of strings containing the string mapping of the index lLen the length of the string array nUnknownValue the value that is returned when the type is unknown Returns the index of the string in the array
119
8.25
PoDoFo::PdfEncoding Class Reference
#include <PdfEncoding.h> Inheritance diagram for PoDoFo::PdfEncoding:

PoDoFo::PdfEncoding PoDoFo::PdfDifferenceEncoding PoDoFo::PdfDocEncoding PoDoFo::PdfIdentityEncoding PoDoFo::PdfMacRomanEncoding PoDoFo::PdfSimpleEncoding PoDoFo::PdfStandardEncoding PoDoFo::PdfSymbolEncoding PoDoFo::PdfWinAnsiEncoding PoDoFo::PdfZapfDingbatsEncoding

bool operator== (const PdfEncoding &rhs) const bool operator< (const PdfEncoding &rhs) const virtual void AddToDictionary (PdfDictionary &rDictionary) const =0 virtual PdfString ConvertToUnicode (const PdfString &rEncodedString, const PdfFont pFont) const =0 virtual PdfRefCountedBuffer ConvertToEncoding (const PdfString &rString, const PdfFont pFont) const =0 virtual bool IsAutoDelete () const =0 virtual bool IsSingleByteEncoding () const =0 int GetFirstChar () const int GetLastChar () const const_iterator begin () const const_iterator end () const virtual pdf_utf16be GetCharCode (int nIndex) const =0

PdfEncoding (int nFirstChar, int nLastChar) virtual const PdfName & GetID () const =0
8.25.1
A PdfEncoding is in PdfFont to transform a text string into a representation so that it can be displayed in a PDF le. PdfEncoding can also be used to convert strings from a PDF le back into a PdfString.
120
Class Documentation
8.25.2
8.25.2.1

PoDoFo::PdfEncoding::PdfEncoding ( int nFirstChar, int nLastChar ) [protected]
Create a new PdfEncoding. Parameters nFirstChar the rst supported character code (either a byte value in the current encoding or a unicode value) nLastChar the last supported character code, must be larger than nFirstChar (either a byte value in the current encoding or a unicode value)
8.25.3
8.25.3.1

virtual void PoDoFo::PdfEncoding::AddToDictionary ( PdfDictionary & rDictionary ) const [pure virtual]
Add this encoding object to a dictionary usually be adding an /Encoding key in font dictionaries. Parameters rDictionary add the encoding to this dictionary Implemented in PoDoFo::PdfSimpleEncoding, and PoDoFo::PdfIdentityEncoding. 8.25.3.2 PdfEncoding::const_iterator PoDoFo::PdfEncoding::begin ( [inline] ) const
Iterate over all unicode character points in this encoding, beginning with the rst. Returns iterator pointing to the rst dened unicode character
8.25.3.3
virtual PdfRefCountedBuffer PoDoFo::PdfEncoding::ConvertToEncoding ( const PdfString & rString, const PdfFont pFont ) const [pure virtual]
Convert a unicode PdfString to a string encoded with this encoding. Parameters rString an unicode PdfString.
8.25 PoDoFo::PdfEncoding Class Reference pFont the font for which this string is converted Returns
121
an encoded PdfRefCountedBuffer. The PdfRefCountedBuffer is treated as a series of bytes and is allowed to have 0 bytes. The returned buffer must not be a unicode string. Implemented in PoDoFo::PdfSimpleEncoding, and PoDoFo::PdfIdentityEncoding.
8.25.3.4
virtual PdfString PoDoFo::PdfEncoding::ConvertToUnicode ( const PdfString & rEncodedString, const PdfFont pFont ) const [pure virtual]
Convert a string that is encoded with this encoding to an unicode PdfString. Parameters rEncodedString a string encoded by this encoding. Usually this string was read from a content stream. pFont the font for which this string is converted Returns an unicode PdfString. Implemented in PoDoFo::PdfSimpleEncoding, and PoDoFo::PdfIdentityEncoding.
8.25.3.5
PdfEncoding::const_iterator PoDoFo::PdfEncoding::end ( [inline]
) const
Iterate over all unicode character points in this encoding, beginning with the rst. Returns iterator pointing at the end
8.25.3.6
virtual pdf_utf16be PoDoFo::PdfEncoding::GetCharCode ( int nIndex ) const [pure virtual]
Get the unicode character code for this encoding at the position nIndex. nIndex is a position between GetFirstChar() and GetLastChar() Parameters nIndex character code at position index
122 Returns unicode character code See also GetFirstChar GetLastChar Will throw an exception if nIndex is out of range.
Class Documentation
Implemented in PoDoFo::PdfSimpleEncoding, and PoDoFo::PdfIdentityEncoding.
8.25.3.7 Returns
int PoDoFo::PdfEncoding::GetFirstChar (
) const [inline]
the rst character code that is dened for this encoding
8.25.3.8
virtual const PdfName& PoDoFo::PdfEncoding::GetID ( [protected, pure virtual]
) const
Get a unique ID for this encoding which can used for comparisons! Returns a unique id for this encoding! Implemented in PoDoFo::PdfSimpleEncoding, and PoDoFo::PdfIdentityEncoding.
8.25.3.9 Returns
int PoDoFo::PdfEncoding::GetLastChar (
) const [inline]
the last character code that is dened for this encoding
8.25.3.10
virtual bool PoDoFo::PdfEncoding::IsAutoDelete ( virtual]
) const [pure
Returns true if this encoding should be deleted automatically with the font. Implemented in PoDoFo::PdfSimpleEncoding, and PoDoFo::PdfIdentityEncoding.
8.26 PoDoFo::PdfEncodingDifference Class Reference 8.25.3.11 Returns true if this is a single byte encoding with a maximum of 256 values. virtual bool PoDoFo::PdfEncoding::IsSingleByteEncoding ( [pure virtual]
123 ) const
Implemented in PoDoFo::PdfSimpleEncoding, and PoDoFo::PdfIdentityEncoding. 8.25.3.12 bool PoDoFo::PdfEncoding::operator< ( const PdfEncoding & rhs ) const [inline]
Comparison operator. Parameters rhs the PdfEncoding to which this encoding should be compared Returns true if this encoding is less than the specied.
8.25.3.13
bool PoDoFo::PdfEncoding::operator== ( const PdfEncoding & rhs ) const [inline]
Comparison operator. Parameters rhs the PdfEncoding to which this encoding should be compared Returns true if both encodings are the same.
8.26
PoDoFo::PdfEncodingDifference Class Reference
#include <PdfDifferenceEncoding.h>

PdfEncodingDifference () PdfEncodingDifference (const PdfEncodingDifference &rhs) const PdfEncodingDifference & operator= (const PdfEncodingDifference &rhs) void AddDifference (int nCode) void AddDifference (int nCode, const PdfName &rName) bool Contains (int nCode, PdfName &rName, pdf_utf16be &rValue) const void ToArray (PdfArray &rArray) size_t GetCount () const
124
Class Documentation
8.26.1
A helper class for PdfDifferenceEncoding that can be used to create a differences array.
8.26.2
8.26.2.1

PoDoFo::PdfEncodingDifference::PdfEncodingDifference ( )
Create a PdfEncodingDifference object. 8.26.2.2 PoDoFo::PdfEncodingDifference::PdfEncodingDifference ( const PdfEncodingDifference & rhs )
Copy a PdfEncodingDifference object.
8.26.3
8.26.3.1

void PoDoFo::PdfEncodingDifference::AddDifference ( int nCode )
Add a difference to the object. Parameters nCode unicode code point of the difference (0 to 255 are legal values) See also AddDifference if you know the name of the code point use the overload below which is faster
8.26.3.2
void PoDoFo::PdfEncodingDifference::AddDifference ( int nCode, const PdfName & rName )
Add a difference to the object. Parameters nCode unicode code point of the difference (0 to 255 are legal values) rName name of the different code point or .notdef if none
8.26.3.3
bool PoDoFo::PdfEncodingDifference::Contains ( int nCode, PdfName & rName, pdf_utf16be & rValue ) const
Tests if the specied code is part of the differences.

8.27 PoDoFo::PdfEncodingFactory Class Reference Parameters nCode test if the given code is part of the differences
125
rName write the associated name into this object if the code is part of the difference rValue write the associated unicode value of the name to this value Returns true if the code is part of the difference
8.26.3.4
size_t PoDoFo::PdfEncodingDifference::GetCount ( [inline]
) const
Get the number of differences in this object. If the user added .notdef as a difference it is counted, even it is no real difference in the nal encoding. Returns the number of differences in this object
8.26.3.5
const PdfEncodingDifference & PoDoFo::PdfEncodingDifference::operator= ( const PdfEncodingDifference & rhs )
Copy a PdfEncodingDifference object. 8.26.3.6 void PoDoFo::PdfEncodingDifference::ToArray ( PdfArray & rArray )
Convert the PdfEncodingDifference to an array Parameters rArray write to this array
8.27
PoDoFo::PdfEncodingFactory Class Reference
#include <PdfEncodingFactory.h>

static const PdfEncoding GlobalPdfDocEncodingInstance () static const PdfEncoding GlobalWinAnsiEncodingInstance () static const PdfEncoding GlobalMacRomanEncodingInstance ()
126
Class Documentation static const PdfEncoding GlobalStandardEncodingInstance () static const PdfEncoding GlobalMacExpertEncodingInstance () static const PdfEncoding GlobalSymbolEncodingInstance () static const PdfEncoding GlobalZapfDingbatsEncodingInstance () static void FreeGlobalEncodingInstances ()
8.27.1
This factory creates a PdfEncoding from an existing object in the PDF.
8.27.2
8.27.2.1

void PoDoFo::PdfEncodingFactory::FreeGlobalEncodingInstances ( ) [static]
Frees the memory allocated by the global encoding instancess in this singleton. PoDoFo will reallocated these encodings as soon as they are needed again. + Only call this method if no other class of PoDoFo exists anymore, as PdfString etc contain pointers to the global instances. 8.27.2.2 const PdfEncoding PoDoFo::PdfEncodingFactory::GlobalMacExpertEncodingInstance ( [static]
Singleton method which returns a global instance of MacExpertEncoding. Returns global instance of MacExpertEncoding
8.27.2.3
const PdfEncoding PoDoFo::PdfEncodingFactory::GlobalMacRomanEncodingInstance ( [static]
Singleton method which returns a global instance of MacRomanEncoding. Returns global instance of MacRomanEncoding
8.27.2.4
const PdfEncoding PoDoFo::PdfEncodingFactory::GlobalPdfDocEncodingInstance ( [static]
Singleton method which returns a global instance of PdfDocEncoding.

8.27 PoDoFo::PdfEncodingFactory Class Reference Returns global instance of PdfDocEncoding
127
8.27.2.5
const PdfEncoding PoDoFo::PdfEncodingFactory::GlobalStandardEncodingInstance ( [static]
Singleton method which returns a global instance of StandardEncoding. Returns global instance of StandardEncoding
8.27.2.6
const PdfEncoding PoDoFo::PdfEncodingFactory::GlobalSymbolEncodingInstance ( [static]
Singleton method which returns a global instance of SymbolEncoding. Returns global instance of SymbolEncoding
8.27.2.7
const PdfEncoding PoDoFo::PdfEncodingFactory::GlobalWinAnsiEncodingInstance ( [static]
Singleton method which returns a global instance of WinAnsiEncoding. Returns global instance of WinAnsiEncoding
8.27.2.8
const PdfEncoding PoDoFo::PdfEncodingFactory::GlobalZapfDingbatsEncodingInstance ( [static]
Singleton method which returns a global instance of ZapfDingbatsEncoding. Returns global instance of ZapfDingbatsEncoding
128
Class Documentation
8.28
PoDoFo::PdfEncodingObjectFactory Class Reference
#include <PdfEncodingObjectFactory.h>

static const PdfEncoding CreateEncoding (PdfObject pObject)
8.28.1
This factory creates a PdfEncoding from an existing object in the PDF.
8.28.2
8.28.2.1

const PdfEncoding PoDoFo::PdfEncodingObjectFactory::CreateEncoding ( PdfObject pObject ) [static]
Create a new PdfEncoding from either an encoding name or an encoding dictionary. Parameters pObject must be a name or an encoding dictionary Returns a PdfEncoding or NULL
8.29
PoDoFo::PdfEncrypt Class Reference
#include <PdfEncrypt.h> Inheritance diagram for PoDoFo::PdfEncrypt:
PoDoFo::PdfEncrypt PoDoFo::PdfEncryptAES PoDoFo::PdfEncryptRC4
Public Types
enum EPdfKeyLength
8.29 PoDoFo::PdfEncrypt Class Reference enum EPdfPermissions {
129
ePdfPermissions_Print = 0x00000004, ePdfPermissions_Edit = 0x00000008, ePdfPermissions_Copy = 0x00000010, ePdfPermissions_EditNotes = 0x00000020, ePdfPermissions_FillAndSign = 0x00000100, ePdfPermissions_Accessible = 0x00000200, ePdfPermissions_DocAssembly = 0x00000400, ePdfPermissions_HighPrint = 0x00000800 } enum EPdfEncryptAlgorithm { ePdfEncryptAlgorithm_RC4V1 = 1, ePdfEncryptAlgorithm_RC4V2 = 2, ePdfEncryptAlgorithm_AESV2 = 4 }

virtual PdfEncrypt () const PdfEncrypt & operator= (const PdfEncrypt &rhs) void GenerateEncryptionKey (const PdfString &documentId) virtual void CreateEncryptionDictionary (PdfDictionary &rDictionary) const =0 virtual PdfOutputStream CreateEncryptionOutputStream (PdfOutputStream pOutputStream)=0 virtual PdfInputStream CreateEncryptionInputStream (PdfInputStream pInputStream)=0 bool Authenticate (const std::string &password, const PdfString &documentId) EPdfEncryptAlgorithm GetEncryptAlgorithm () const bool IsPrintAllowed () const bool IsEditAllowed () const bool IsCopyAllowed () const bool IsEditNotesAllowed () const bool IsFillAndSignAllowed () const bool IsAccessibilityAllowed () const bool IsDocAssemblyAllowed () const bool IsHighPrintAllowed () const const unsigned char GetUValue () const
Get the U object value (user).
const unsigned char GetOValue () const

Get the O object value (owner).
int GetPValue () const

Get the P object value (protection).
int GetRevision () const

Get the revision number of the encryption method.
int GetKeyLength () const

Get the key length of the encryption key in bits.
130 void Encrypt (std::string &str, pdf_long inputLen) const

Encrypt a wxString.
Class Documentation
virtual void Encrypt (unsigned char str, pdf_long len) const =0

Encrypt a character string.
virtual pdf_long CalculateStreamLength (pdf_long length) const

Calculate stream size.
virtual pdf_long CalculateStreamOffset () const

Calculate stream offset.
void SetCurrentReference (const PdfReference &rRef)

static PdfEncrypt CreatePdfEncrypt (const std::string &userPassword, const std::string &ownerPassword, int protection=ePdfPermissions_Print|ePdfPermissions_Edit|ePdfPermissions_Copy|ePdfPermissions_EditNotes|ePdfPermissions_FillAndSign|ePdfPermissions_Accessible|ePdfPermissions_DocAssembly|ePdfPermissions_HighPrint, EPdfEncryptAlgorithm eAlgorithm=ePdfEncryptAlgorithm_RC4V1, EPdfKeyLength eKeyLength=ePdfKeyLength_40) static PdfEncrypt CreatePdfEncrypt (const PdfObject pObject) static PdfEncrypt CreatePdfEncrypt (const PdfEncrypt &rhs) static int GetEnabledEncryptionAlgorithms () static void SetEnabledEncryptionAlgorithms (int nEncryptionAlgorithms) static bool IsEncryptionEnabled (EPdfEncryptAlgorithm eAlgorithm) static PdfString GetMD5String (const unsigned char pBuffer, int nLength)

void PadPassword (const std::string &password, unsigned char pswd[32])
Pad a password to 32 characters.
void ComputeOwnerKey (unsigned char userPad[32], unsigned char ownerPad[32], int keylength, int revision, bool authenticate, unsigned char ownerKey[32])
Compute owner key.
void ComputeEncryptionKey (const std::string &documentID, unsigned char userPad[32], unsigned char ownerKey[32], int pValue, int keyLength, int revision, unsigned char userKey[32])
Compute encryption key and user key.
bool CheckKey (unsigned char key1[32], unsigned char key2[32])

8.29 PoDoFo::PdfEncrypt Class Reference

Check two keys for equality.
131
void RC4 (unsigned char key, int keylen, unsigned char textin, pdf_long textlen, unsigned char textout)
RC4 encryption.
void GenerateInitialVector (unsigned char iv[16])

Generate initial vector.
void CreateObjKey (unsigned char objkey[16], int pnKeyLen) const
Static Protected Member Functions

static void GetMD5Binary (const unsigned char data, int length, unsigned char digest)
Calculate the binary MD5 message digest of the given data.
Protected Attributes
EPdfEncryptAlgorithm m_eAlgorithm
The used encryption algorithm.
int m_keyLength
Length of encryption key.
int m_rValue
Revision.
int m_pValue
P entry in pdf document.
EPdfKeyLength m_eKeyLength
The key length.
std::string m_userPass
User password.
std::string m_ownerPass
Owner password.
unsigned char m_rc4key [16]

last RC4 key
unsigned char m_rc4last [256]

132
last RC4 state table
Class Documentation
unsigned char m_uValue [32]

U entry in pdf document.
unsigned char m_oValue [32]

O entry in pdf document.
8.29.1
Class representing PDF encryption methods. (For internal use only) Based on code from Ulrich Telle: http://wxcode.sourceforge.net/components/wxpdfdoc/ Original Copyright header: A class that is used to encrypt a PDF le and set document permisions on the PDF le. As a user of this class, you have only to instanciate a object of this class and pass it to PdfWriter, PdfMemDocument, PdfStreamedDocument or PdfImmediateWriter. You do not have to call any other method of this class. The above classes know how to handle encryption using Pdfencrypt.
8.29.2
8.29.2.1

enum PoDoFo::PdfEncrypt::EPdfEncryptAlgorithm
The encryption algorithm. Enumerator: ePdfEncryptAlgorithm_RC4V1 RC4 Version 1 encryption using a 40bit key. ePdfEncryptAlgorithm_RC4V2 RC4 Version 2 encryption using a key with 40128bit. ePdfEncryptAlgorithm_AESV2 AES encryption with an 128 bit key (PDF1.6).
8.29.2.2
enum PoDoFo::PdfEncrypt::EPdfKeyLength
A enum specifying a valid keylength for a PDF encryption key. Keys must be in the range 40 to 128 bit and have to be a multiple of 8. Adobe Reader supports only keys with 40 or 128bit!
8.29.2.3
enum PoDoFo::PdfEncrypt::EPdfPermissions
Set user permissions/restrictions on a document

8.29 PoDoFo::PdfEncrypt Class Reference Enumerator:
133
ePdfPermissions_Print Allow printing the document. ePdfPermissions_Edit Allow modifying the document besides annotations, form elds or chaning pages. ePdfPermissions_Copy Allow text and graphic extraction. ePdfPermissions_EditNotes Add or modify text annoations or form elds (if ePdfPermissions_Edit is set also allow to create interactive form elds including signature). ePdfPermissions_FillAndSign Fill in existing form or signature elds. ePdfPermissions_Accessible Extract text and graphics to support user with disabillities. ePdfPermissions_DocAssembly Assemble the document: insert, create, rotate delete pages or add bookmarks. ePdfPermissions_HighPrint Print a high resolution version of the document.
8.29.3
8.29.3.1

PoDoFo::PdfEncrypt::PdfEncrypt ( ) [virtual]
Destruct the PdfEncrypt object
8.29.4
8.29.4.1

bool PoDoFo::PdfEncrypt::Authenticate ( const std::string & password, const PdfString & documentId )
Tries to authenticate a user using either the user or owner password Parameters password owner or user password documentId the documentId of the PDF le Returns true if either the owner or user password matches password
8.29.4.2
virtual void PoDoFo::PdfEncrypt::CreateEncryptionDictionary ( PdfDictionary & rDictionary ) const [pure virtual]
Fill all keys into a encryption dictionary. This dictionary is usually added to the PDF les trailer under the /Encryption key. Parameters rDictionary an empty dictionary which is lled with information about the used encryption algorithm
134
Class Documentation
Implemented in PoDoFo::PdfEncryptAES, and PoDoFo::PdfEncryptRC4. 8.29.4.3 virtual PdfInputStream PoDoFo::PdfEncrypt::CreateEncryptionInputStream ( PdfInputStream pInputStream ) [pure virtual]
Create a PdfInputStream that decrypts all data read from it using the current settings of the PdfEncrypt object. Warning: Currently only RC4 based encryption is supported using output streams! Parameters pInputStream the created PdfInputStream reads all decrypted data to this input stream. Returns a PdfInputStream that decrypts all data. Implemented in PoDoFo::PdfEncryptAES, and PoDoFo::PdfEncryptRC4. 8.29.4.4 virtual PdfOutputStream PoDoFo::PdfEncrypt::CreateEncryptionOutputStream ( PdfOutputStream pOutputStream ) [pure virtual]
Create a PdfOutputStream that encrypts all data written to it using the current settings of the PdfEncrypt object. Warning: Currently only RC4 based encryption is supported using output streams! Parameters pOutputStream the created PdfOutputStream writes all encrypted data to this output stream. Returns a PdfOutputStream that encryts all data. Implemented in PoDoFo::PdfEncryptAES, and PoDoFo::PdfEncryptRC4. 8.29.4.5 void PoDoFo::PdfEncrypt::CreateObjKey ( unsigned char objkey[16], int pnKeyLen ) const [protected]
Create the encryption key for the current object. Parameters objkey pointer to an array of at least MD5_HASHBYTES (=16) bytes length pnKeyLen pointer to an integer where the actual keylength is stored.
8.29 PoDoFo::PdfEncrypt Class Reference 8.29.4.6 PdfEncrypt PoDoFo::PdfEncrypt::CreatePdfEncrypt ( const PdfObject pObject ) [static]
135
Initialize a PdfEncrypt object from an encryption dictionary in a PDF le. This is required for encrypting a PDF le, but handled internally in PdfParser for you. Will use only encrypting algorithms that are enabled. Parameters pObject a PDF encryption dictionary See also GetEnabledEncryptionAlgorithms
8.29.4.7
PdfEncrypt PoDoFo::PdfEncrypt::CreatePdfEncrypt ( const std::string & userPassword, const std::string & ownerPassword, int protection = ePdfPermissions_Print | ePdfPermissions_Edit | ePdfPermissions_Copy | ePdfPermissions_EditNotes | ePdfPermissions_FillAndSign | ePdfPermissions_Accessible | ePdfPermissions_DocAssembly | ePdfPermissions_HighPrint, EPdfEncryptAlgorithm eAlgorithm = ePdfEncryptAlgorithm_RC4V1, EPdfKeyLength eKeyLength = ePdfKeyLength_40 ) [static]
Create a PdfEncrypt object which can be used to encrypt a PDF le. Parameters userPassword the user password (if empty the user does not have to enter a password to open the document) ownerPassword the owner password protection several EPdfPermissions values ored together to set the users permissions for this document eAlgorithm the revision of the encryption algorithm to be used eKeyLength the length of the encryption key ranging from 40 to 128 bits (only used if eAlgorithm == ePdfEncryptAlgorithm_RC4V2) See also GenerateEncryptionKey with the documentID to generate the real encryption key using this information
136 8.29.4.8
Class Documentation PdfEncrypt PoDoFo::PdfEncrypt::CreatePdfEncrypt ( const PdfEncrypt & rhs ) [static]
Copy constructor Parameters rhs another PdfEncrypt object which is copied
8.29.4.9
void PoDoFo::PdfEncrypt::GenerateEncryptionKey ( const PdfString & documentId )
Generate encryption key from user and owner passwords and protection key Parameters documentId the documentId of the current document
8.29.4.10
int PoDoFo::PdfEncrypt::GetEnabledEncryptionAlgorithms ( [static]
Retrieve the list of encryption algorithms that are used when loading a PDF document. By default all alogrithms are enabled. See also IsEncryptionEnabled SetEnabledEncryptionAlgorithms Returns an ored together list of all enabled encryption algorithms
8.29.4.11
PdfEncrypt::EPdfEncryptAlgorithm PoDoFo::PdfEncrypt::GetEncryptAlgorithm (
) const [inline]
Get the encryption algorithm of this object. Returns the EPdfEncryptAlgorithm of this object
8.29.4.12
PdfString PoDoFo::PdfEncrypt::GetMD5String ( const unsigned char pBuffer, int nLength ) [static]
Create a PdfString of MD5 data generated from a buffer in memory.

8.29 PoDoFo::PdfEncrypt Class Reference Parameters pBuffer the buffer of which to calculate the MD5 sum nLength the length of the buffer Returns an MD5 sum as PdfString
137
8.29.4.13
bool PoDoFo::PdfEncrypt::IsAccessibilityAllowed ( [inline]
) const
Checks if it is allowed to extract text and graphics to support users with disabillities Every PDF consuming applications has to adhere this value! Returns true if you are allowed to extract text and graphics to support users with disabillities See also PdfEncrypt to set own document permissions.
8.29.4.14
bool PoDoFo::PdfEncrypt::IsCopyAllowed (
) const [inline]
Checks if text and graphics extraction is allowed. Every PDF consuming applications has to adhere this value! Returns true if you are allowed to extract text and graphics from this document See also PdfEncrypt to set own document permissions.
8.29.4.15
bool PoDoFo::PdfEncrypt::IsDocAssemblyAllowed ( [inline]
) const
Checks if it is allowed to insert, create, rotate, delete pages or add bookmarks Every PDF consuming applications has to adhere this value! Returns true if you are allowed to insert, create, rotate, delete pages or add bookmarks See also PdfEncrypt to set own document permissions.
138 8.29.4.16 bool PoDoFo::PdfEncrypt::IsEditAllowed (
Checks if modiying this document (besides annotations, form elds or changing pages) is allowed. Every PDF consuming applications has to adhere this value! Returns true if you are allowed to mody this document See also PdfEncrypt to set own document permissions.
8.29.4.17
bool PoDoFo::PdfEncrypt::IsEditNotesAllowed ( [inline]
) const
Checks if it is allowed to add or modify annotations or form elds Every PDF consuming applications has to adhere this value! Returns true if you are allowed to add or modify annotations or form elds See also PdfEncrypt to set own document permissions.
8.29.4.18
bool PoDoFo::PdfEncrypt::IsEncryptionEnabled ( EPdfEncryptAlgorithm eAlgorithm ) [static]
Test if a certain encryption algorithm is enabled for loading PDF documents. Returns ture if the encryption algorithm is enabled See also GetEnabledEncryptionAlgorithms SetEnabledEncryptionAlgorithms
8.29.4.19
bool PoDoFo::PdfEncrypt::IsFillAndSignAllowed ( [inline]
) const
Checks if it is allowed to ll in existing form or signature elds Every PDF consuming applications has to adhere this value!
8.29 PoDoFo::PdfEncrypt Class Reference Returns true if you are allowed to ll in existing form or signature elds See also PdfEncrypt to set own document permissions.
139
8.29.4.20
bool PoDoFo::PdfEncrypt::IsHighPrintAllowed ( [inline]
) const
Checks if it is allowed to print a high quality version of this document Every PDF consuming applications has to adhere this value! Returns true if you are allowed to print a high quality version of this document See also PdfEncrypt to set own document permissions.
8.29.4.21
bool PoDoFo::PdfEncrypt::IsPrintAllowed (
) const [inline]
Checks if printing this document is allowed. Every PDF consuming applications has to adhere this value! Returns true if you are allowed to print this document See also PdfEncrypt to set own document permissions.
8.29.4.22
const PdfEncrypt & PoDoFo::PdfEncrypt::operator= ( const PdfEncrypt & rhs )
Assignment operator Parameters rhs another PdfEncrypt object which is copied
8.29.4.23
void PoDoFo::PdfEncrypt::RC4 ( unsigned char key, int keylen, unsigned char textin, pdf_long textlen, unsigned char textout ) [protected]
RC4 encryption. RC4 is the standard encryption algorithm used in PDF format
140 8.29.4.24
Class Documentation void PoDoFo::PdfEncrypt::SetCurrentReference ( const PdfReference & rRef ) [inline]
Set the reference of the object that is currently encrypted. This value will be used in following calls of Encrypt to encrypt the object. See also Encrypt
8.29.4.25
void PoDoFo::PdfEncrypt::SetEnabledEncryptionAlgorithms ( int nEncryptionAlgorithms ) [static]
Specify the list of encryption algorithms that should be used by PoDoFo when loading a PDF document. This can be used to disable for example AES encryption/decryption which is unstable in certain cases. See also GetEnabledEncryptionAlgorithms IsEncryptionEnabled
8.30
PoDoFo::PdfEncryptAES Class Reference
#include <PdfEncrypt.h> Inheritance diagram for PoDoFo::PdfEncryptAES:
PoDoFo::PdfEncrypt PoDoFo::PdfEncryptAES

void Encrypt (unsigned char str, pdf_long len) const
pdf_long CalculateStreamOffset () const

Calculate stream offset.
PdfInputStream pInputStream)
CreateEncryptionInputStream
(PdfInputStream
8.30 PoDoFo::PdfEncryptAES Class Reference PdfOutputStream CreateEncryptionOutputStream pOutputStream) pdf_long CalculateStreamLength (pdf_long length) const
Calculate stream size.
141 (PdfOutputStream
void CreateEncryptionDictionary (PdfDictionary &rDictionary) const
8.30.1
A class that is used to encrypt a PDF le (AES-128) Client code is working only with PdfEncrypt class and knows nothing about PdfEncryptAES, it is created through CreatePdfEncrypt factory method
8.30.2
8.30.2.1

void PoDoFo::PdfEncryptAES::CreateEncryptionDictionary ( PdfDictionary & rDictionary ) const [virtual]
Fill all keys into a encryption dictionary. This dictionary is usually added to the PDF les trailer under the /Encryption key. Parameters rDictionary an empty dictionary which is lled with information about the used encryption algorithm Implements PoDoFo::PdfEncrypt. 8.30.2.2 PdfInputStream PoDoFo::PdfEncryptAES::CreateEncryptionInputStream ( PdfInputStream pInputStream ) [virtual]
Create a PdfInputStream that decrypts all data read from it using the current settings of the PdfEncrypt object. Warning: Currently only RC4 based encryption is supported using output streams! Parameters pInputStream the created PdfInputStream reads all decrypted data to this input stream. Returns a PdfInputStream that decrypts all data. Implements PoDoFo::PdfEncrypt.
142 8.30.2.3
Class Documentation PdfOutputStream PoDoFo::PdfEncryptAES::CreateEncryptionOutputStream ( PdfOutputStream pOutputStream ) [virtual]
Create a PdfOutputStream that encrypts all data written to it using the current settings of the PdfEncrypt object. Warning: Currently only RC4 based encryption is supported using output streams! Parameters pOutputStream the created PdfOutputStream writes all encrypted data to this output stream. Returns a PdfOutputStream that encryts all data. Implements PoDoFo::PdfEncrypt.
8.31
PoDoFo::PdfEncryptRC4 Class Reference
#include <PdfEncrypt.h> Inheritance diagram for PoDoFo::PdfEncryptRC4:
PoDoFo::PdfEncrypt PoDoFo::PdfEncryptRC4

void Encrypt (unsigned char str, pdf_long len) const
PdfInputStream CreateEncryptionInputStream (PdfInputStream pInputStream) PdfOutputStream CreateEncryptionOutputStream (PdfOutputStream pOutputStream) void CreateEncryptionDictionary (PdfDictionary &rDictionary) const
8.31.1
A class that is used to encrypt a PDF le (RC4 40-bit and 128-bit) Client code is working only with PdfEncrypt class and knows nothing about PdfEncryptRC4, it is created through CreatePdfEncrypt factory method
8.31 PoDoFo::PdfEncryptRC4 Class Reference
143
8.31.2
8.31.2.1

void PoDoFo::PdfEncryptRC4::CreateEncryptionDictionary ( PdfDictionary & rDictionary ) const [virtual]
Fill all keys into a encryption dictionary. This dictionary is usually added to the PDF les trailer under the /Encryption key. Parameters rDictionary an empty dictionary which is lled with information about the used encryption algorithm Implements PoDoFo::PdfEncrypt. 8.31.2.2 PdfInputStream PoDoFo::PdfEncryptRC4::CreateEncryptionInputStream ( PdfInputStream pInputStream ) [virtual]
Create a PdfInputStream that decrypts all data read from it using the current settings of the PdfEncrypt object. Warning: Currently only RC4 based encryption is supported using output streams! Parameters pInputStream the created PdfInputStream reads all decrypted data to this input stream. Returns a PdfInputStream that decrypts all data. Implements PoDoFo::PdfEncrypt. 8.31.2.3 PdfOutputStream PoDoFo::PdfEncryptRC4::CreateEncryptionOutputStream ( PdfOutputStream pOutputStream ) [virtual]
Create a PdfOutputStream that encrypts all data written to it using the current settings of the PdfEncrypt object. Warning: Currently only RC4 based encryption is supported using output streams! Parameters pOutputStream the created PdfOutputStream writes all encrypted data to this output stream. Returns a PdfOutputStream that encryts all data.
144 Implements PoDoFo::PdfEncrypt.
Class Documentation
8.32
PoDoFo::PdfError Class Reference
#include <PdfError.h>

PdfError () PdfError (const EPdfError &eCode, const char pszFile=NULL, int line=0, const char pszInformation=NULL) PdfError (const PdfError &rhs) const PdfError & operator= (const PdfError &rhs) const PdfError & operator= (const EPdfError &eCode) bool operator== (const PdfError &rhs) bool operator== (const EPdfError &eCode) bool operator!= (const PdfError &rhs) bool operator!= (const EPdfError &eCode) EPdfError GetError () const const TDequeErrorInfo & GetCallstack () const void SetError (const EPdfError &eCode, const char pszFile=NULL, int line=0, const char pszInformation=NULL) void SetErrorInformation (const char pszInformation) void SetErrorInformation (const wchar_t pszInformation) void AddToCallstack (const char pszFile=NULL, int line=0, const char pszInformation=NULL) bool IsError () const void PrintErrorMsg () const virtual const char what () const throw ()

static LogMessageCallback SetLogMessageCallback (LogMessageCallback fLogMessageCallback) static PODOFO_NOTHROW const char ErrorName (EPdfError eCode) static const char ErrorMessage (EPdfError eCode) static void LogMessage (ELogSeverity eLogSeverity, const char pszMsg,...) static void LogMessage (ELogSeverity eLogSeverity, const wchar_t pszMsg,...) static void EnableLogging (bool bEnable) static bool LoggingEnabled () static void DebugMessage (const char pszMsg,...) static void EnableDebug (bool bEnable) static bool DebugEnabled ()
8.32 PoDoFo::PdfError Class Reference
145
8.32.1
The error handling class of PoDoFo lib. Whenever a function encounters an error a PdfError object is returned. A PdfError with Error() == ErrOk means successfull execution. This class provides also meaningfull error descriptions.
8.32.2
8.32.2.1

PoDoFo::PdfError::PdfError ( )
Create a PdfError object initialized to ErrOk 8.32.2.2 PoDoFo::PdfError::PdfError ( const EPdfError & eCode, const char pszFile = NULL, int line = 0, const char pszInformation = NULL )
Create a PdfError object with a given error code. Parameters eCode the error code of this object pszFile the le in which the error has occured. Use the compiler macro __FILE__ to initialize the eld. line the line in which the error has occured. Use the compiler macro __LINE__ to initialize the eld. pszInformation additional information on this error which mayy be formatted like printf
8.32.2.3
PoDoFo::PdfError::PdfError ( const PdfError & rhs )
Copy constructor Parameters rhs copy the contents of rhs into this object
8.32.3
8.32.3.1

void PoDoFo::PdfError::AddToCallstack ( const char pszFile = NULL, int line = 0, const char pszInformation = NULL ) [inline]
Add callstack information to an error object. Always call this function if you get an error object but do not handle the error but throw it again.
146 Parameters
Class Documentation
pszFile the lename of the source le causing the error or NULL. Typically you will use the gcc macro __FILE__ here. line the line of source causing the error or 0. Typically you will use the gcc macro __LINE__ here. pszInformation additional information on the error. e.g. how to x the error. This string is intended to be shown to the user.
8.32.3.2
static bool PoDoFo::PdfError::DebugEnabled ( static]
) [inline,
Is the display of debugging messages enabled or not? 8.32.3.3 void PoDoFo::PdfError::DebugMessage ( const char pszMsg, [static] ... )
Log a message to the logging system dened for PoDoFo for debugging Parameters pszMsg the message to be logged
8.32.3.4
static void PoDoFo::PdfError::EnableDebug ( bool bEnable ) [inline, static]
Enable or disable the display of debugging messages Parameters bEnable enable (true) or disable (false)
8.32.3.5
static void PoDoFo::PdfError::EnableLogging ( bool bEnable ) [inline, static]
Enable or disable Logging Parameters bEnable enable (true) or disable (false)
8.32.3.6
const char PoDoFo::PdfError::ErrorMessage ( EPdfError eCode ) [static]
Get the error message for a certain error code.

8.32 PoDoFo::PdfError Class Reference Returns
147
the error message or NULL if no error message for the specied error code is available.
8.32.3.7
const char PoDoFo::PdfError::ErrorName ( EPdfError eCode ) [static]
Get the name for a certain error code. Returns the name or NULL if no name for the specied error code is available. < The encryption dictionary is invalid or misses a required key < The password used to open the PDF le was invalid < This font format is not supported by PoDoFO. < This image format is not supported by PoDoFO. < This color format cannot be converted. 8.32.3.8 const TDequeErrorInfo & PoDoFo::PdfError::GetCallstack ( [inline] ) const
Get access to the internal callstack of this error Returns the callstack
8.32.3.9
EPdfError PoDoFo::PdfError::GetError (
) const [inline]
Return the error code of this object Returns the error code of this object
8.32.3.10 Returns
bool PoDoFo::PdfError::IsError (
) const [inline]
true if an error code was set and false if the error code is ePdfError_ErrOk
8.32.3.11
static bool PoDoFo::PdfError::LoggingEnabled ( static]
) [inline,
Is the display of debugging messages enabled or not?

148 8.32.3.12
Class Documentation void PoDoFo::PdfError::LogMessage ( ELogSeverity eLogSeverity, const char pszMsg, ... ) [static]
Log a message to the logging system dened for PoDoFo. Parameters eLogSeverity the sevirity of the log message pszMsg the message to be logged
8.32.3.13
void PoDoFo::PdfError::LogMessage ( ELogSeverity eLogSeverity, const wchar_t pszMsg, ... ) [static]
Log a message to the logging system dened for PoDoFo. Parameters eLogSeverity the sevirity of the log message pszMsg the message to be logged
8.32.3.14
bool PoDoFo::PdfError::operator!= ( const PdfError & rhs )
Comparison operator compares 2 PdfError objects Parameters rhs another PdfError object Returns true if both objects have the different error code.
8.32.3.15
bool PoDoFo::PdfError::operator!= ( const EPdfError & eCode )
Overloaded comparison operator compares 2 PdfError objects Parameters eCode an erroce code Returns true if this object has different error code.
8.32 PoDoFo::PdfError Class Reference 8.32.3.16
149
const PdfError & PoDoFo::PdfError::operator= ( const EPdfError & eCode )
Overloaded assignment operator Parameters eCode a EPdfError code Returns this object
8.32.3.17
const PdfError & PoDoFo::PdfError::operator= ( const PdfError & rhs )
Assignment operator Parameters rhs another PdfError object Returns this object
8.32.3.18
bool PoDoFo::PdfError::operator== ( const EPdfError & eCode )
Overloaded comparison operator compares 2 PdfError objects Parameters eCode an erroce code Returns true if this object has the same error code.
8.32.3.19
bool PoDoFo::PdfError::operator== ( const PdfError & rhs )
Comparison operator compares 2 PdfError objects Parameters rhs another PdfError object Returns true if both objects have the same error code.
150 8.32.3.20 void PoDoFo::PdfError::PrintErrorMsg (
Class Documentation ) const
Print an error message to stderr 8.32.3.21 void PoDoFo::PdfError::SetError ( const EPdfError & eCode, const char pszFile = NULL, int line = 0, const char pszInformation = NULL ) [inline]
Set the error code of this object. Parameters eCode the error code of this object pszFile the lename of the source le causing the error or NULL. Typically you will use the gcc macro __FILE__ here. line the line of source causing the error or 0. Typically you will use the gcc macro __LINE__ here. pszInformation additional information on the error. e.g. how to x the error. This string is intended to be shown to the user.
8.32.3.22
void PoDoFo::PdfError::SetErrorInformation ( const char pszInformation ) [inline]
Set additional error informatiom Parameters pszInformation additional information on the error. e.g. how to x the error. This string is intended to be shown to the user.
8.32.3.23
void PoDoFo::PdfError::SetErrorInformation ( const wchar_t pszInformation ) [inline]
Set additional error informatiom Parameters pszInformation additional information on the error. e.g. how to x the error. This string is intended to be shown to the user.
8.32.3.24
PdfError::LogMessageCallback PoDoFo::PdfError::SetLogMessageCallback ( LogMessageCallback fLogMessageCallback ) [static]
Set a global static LogMessageCallback functor to repleace stderr output in LogMessageInternal

8.33 PoDoFo::PdfExponentialFunction Class Reference Parameters fLogMessageCallback the pointer to the new callback functor object Returns the pointer to the previous callback functor object
151
8.32.3.25
const char PoDoFo::PdfError::what ( [virtual]
) const throw ()
Reimplemented from std::exception. Returns a c string describing the error. Annotated throw() in deance of CODINGSTYLE.txt because we cant discard qualiers on override.
8.33
PoDoFo::PdfExponentialFunction Class Reference
#include <PdfFunction.h> Inheritance diagram for PoDoFo::PdfExponentialFunction:
PoDoFo::PdfElement PoDoFo::PdfFunction PoDoFo::PdfExponentialFunction

PdfExponentialFunction (const PdfArray &rDomain, const PdfArray &rC0, const PdfArray &rC1, double dExponent, PdfVecObjects pParent) PdfExponentialFunction (const PdfArray &rDomain, const PdfArray &rC0, const PdfArray &rC1, double dExponent, PdfDocument pParent)
8.33.1
This class is a PdfExponentialFunction.

152
Class Documentation
8.33.2
8.33.2.1

PoDoFo::PdfExponentialFunction::PdfExponentialFunction ( const PdfArray & rDomain, const PdfArray & rC0, const PdfArray & rC1, double dExponent, PdfVecObjects pParent )
Create a new PdfExponentialFunction object. Parameters rDomain this array describes the input parameters of this PdfFunction. If this function has m input parameters, this array has to contain 2m numbers where each number describes either the lower or upper boundary of the input range. rC0 rC1 dExponent pParent parent vector of objects
8.33.2.2
PoDoFo::PdfExponentialFunction::PdfExponentialFunction ( const PdfArray & rDomain, const PdfArray & rC0, const PdfArray & rC1, double dExponent, PdfDocument pParent )
Create a new PdfExponentialFunction object. Parameters rDomain this array describes the input parameters of this PdfFunction. If this function has m input parameters, this array has to contain 2m numbers where each number describes either the lower or upper boundary of the input range. rC0 rC1 dExponent pParent parent document
8.34
PoDoFo::PdfExtGState Class Reference
#include <PdfExtGState.h> Inheritance diagram for PoDoFo::PdfExtGState:
PoDoFo::PdfElement
PoDoFo::PdfExtGState
8.34 PoDoFo::PdfExtGState Class Reference
153

PdfExtGState (PdfVecObjects pParent) PdfExtGState (PdfDocument pParent) const PdfName & GetIdentier () const void SetFillOpacity (oat opac) void SetStrokeOpacity (oat opac) void SetBlendMode (char blendMode) void SetOverprint (bool enable=true) void SetFillOverprint (bool enable=true) void SetStrokeOverprint (bool enable=true) void SetNonZeroOverprint (bool enable=true) void SetRenderingIntent (char intent) void SetFrequency (double frequency)
8.34.1
This class wraps the ExtGState object used in the Resource Dictionary of a Contentsupporting element (page, Pattern, etc.) The main usage is for transparency, but it also support a variety of prepress features.
8.34.2
8.34.2.1

PoDoFo::PdfExtGState::PdfExtGState ( PdfVecObjects pParent )
Create a new PdfExtGState object which will introduce itself automatically to every page object it is used on. Parameters pParent parent vector of objects
8.34.2.2
PoDoFo::PdfExtGState::PdfExtGState ( PdfDocument pParent )
Create a new PdfExtGState object which will introduce itself automatically to every page object it is used on. Parameters pParent parent document
154
Class Documentation
8.34.3
8.34.3.1

const PdfName & PoDoFo::PdfExtGState::GetIdentier ( [inline] ) const
Returns the identier of this ExtGState how it is known in the pages resource dictionary. Returns PdfName containing the identier (e.g. /ExtGS13)
8.34.3.2
void PoDoFo::PdfExtGState::SetBlendMode ( char blendMode )
Sets the transparency blend mode Parameters blendMode one of the predened blending modes (see Podofo.h)
8.34.3.3
void PoDoFo::PdfExtGState::SetFillOpacity ( oat opac )
Sets the opacity value to be used for ll operations Parameters opac a oating point value from 0 (transparent) to 1 (opaque)
8.34.3.4
void PoDoFo::PdfExtGState::SetFillOverprint ( bool enable = true )
Enables/Disables overprinting for Fill operations Parameters enable enable or disable
8.34.3.5
void PoDoFo::PdfExtGState::SetFrequency ( double frequency )
Set the frequency for halftones Parameters frequency screen frequency, measured in halftone cells per inch in device space
8.35 PoDoFo::PdfFileInputStream Class Reference 8.34.3.6
155
void PoDoFo::PdfExtGState::SetNonZeroOverprint ( bool enable = true )
Enables/Disables non-zero overprint mode Parameters enable enable or disable
8.34.3.7
void PoDoFo::PdfExtGState::SetOverprint ( bool enable = true )
Enables/Disables overprinting for both Fill & Stroke Parameters enable enable or disable
8.34.3.8
void PoDoFo::PdfExtGState::SetRenderingIntent ( char intent )
Set the Rendering Intent Parameters intent one of the predened intents (see Podofo.h)
8.34.3.9
void PoDoFo::PdfExtGState::SetStrokeOpacity ( oat opac )
Sets the opacity value to be used for stroking operations Parameters opac a oating point value from 0 (transparent) to 1 (opaque)
8.34.3.10
void PoDoFo::PdfExtGState::SetStrokeOverprint ( bool enable = true )
Enables/Disables overprinting for Stroke operations Parameters enable enable or disable
8.35
PoDoFo::PdfFileInputStream Class Reference
#include <PdfInputStream.h>
156 Inheritance diagram for PoDoFo::PdfFileInputStream:
Class Documentation
PoDoFo::PdfInputStream PoDoFo::PdfFileInputStream

PdfFileInputStream (const char pszFilename) virtual pdf_long Read (char pBuffer, pdf_long lLen) pdf_long GetFileLength ()
8.35.1
An input stream that reads data from a le
8.35.2
8.35.2.1

PoDoFo::PdfFileInputStream::PdfFileInputStream ( const char pszFilename )
Open a le for reading data Parameters pszFilename the lename of the le to read
8.35.3
8.35.3.1

pdf_long PoDoFo::PdfFileInputStream::GetFileLength ( )
Get the length of the le. Returns the le length
8.35.3.2
pdf_long PoDoFo::PdfFileInputStream::Read ( char pBuffer, pdf_long lLen ) [virtual]
Read data from the input stream

8.36 PoDoFo::PdfFileOutputStream Class Reference Parameters pBuffer the data will be stored into this buffer lLen the size of the buffer and number of bytes that will be read Returns
157
the number of bytes read, -1 if an error ocurred and zero if no more bytes are available for reading. Implements PoDoFo::PdfInputStream.
8.36
PoDoFo::PdfFileOutputStream Class Reference
#include <PdfOutputStream.h> Inheritance diagram for PoDoFo::PdfFileOutputStream:
PoDoFo::PdfOutputStream PoDoFo::PdfFileOutputStream

PdfFileOutputStream (const char pszFilename) virtual pdf_long Write (const char pBuffer, pdf_long lLen) virtual void Close ()
8.36.1
An output stream that writes data to a le
8.36.2
8.36.2.1

PoDoFo::PdfFileOutputStream::PdfFileOutputStream ( const char pszFilename )
Open a le for writing data Parameters pszFilename the lename of the le to read
158
Class Documentation
8.36.3
8.36.3.1

void PoDoFo::PdfFileOutputStream::Close ( ) [virtual]
8.36.3.2
pdf_long PoDoFo::PdfFileOutputStream::Write ( const char pBuffer, pdf_long lLen ) [virtual]
8.37
PoDoFo::PdfFileSpec Class Reference
#include <PdfFileSpec.h> Inheritance diagram for PoDoFo::PdfFileSpec:
PoDoFo::PdfElement PoDoFo::PdfFileSpec

PdfFileSpec (const char pszFilename, const unsigned char data, ptrdiff_t size, PdfVecObjects pParent) const PdfString & GetFilename () const
8.38 PoDoFo::PdfFileStream Class Reference
159
8.37.1
A le specication is used in the PDF le to referr to another le. The other le can be a le outside of the PDF or can be embedded into the PDF le itself.
8.37.2
8.37.2.1

PoDoFo::PdfFileSpec::PdfFileSpec ( const char pszFilename, const unsigned char data, ptrdiff_t size, PdfVecObjects pParent )
Embeds the le in memory from "data" buffer under "pszFileName" e name.
8.37.3
8.37.3.1 Returns

const PdfString & PoDoFo::PdfFileSpec::GetFilename ( ) const
the lename of this le specication. if no general name is available it will try the Unix, Mac and DOS keys too.
8.38
PoDoFo::PdfFileStream Class Reference
#include <PdfFileStream.h> Inheritance diagram for PoDoFo::PdfFileStream:
PoDoFo::PdfStream
PoDoFo::PdfFileStream

PdfFileStream (PdfObject pParent, PdfOutputDevice pDevice) void SetEncrypted (PdfEncrypt pEncrypt) virtual void Write (PdfOutputDevice pDevice, PdfEncrypt pEncrypt=NULL) virtual void GetCopy (char pBuffer, pdf_long lLen) const virtual void GetCopy (PdfOutputStream pStream) const virtual pdf_long GetLength () const

virtual const char GetInternalBuffer () const
160
Class Documentation virtual pdf_long GetInternalBufferSize () const virtual void BeginAppendImpl (const TVecFilters &vecFilters) virtual void AppendImpl (const char pszString, size_t lLen) virtual void EndAppendImpl ()
8.38.1
A PDF stream can be appended to any PdfObject and can contain arbitrary data. Most of the time it will contain either drawing commands to draw onto a page or binary data like a font or an image. A PdfFileStream writes all data directly to an output device without keeping it in memory. PdfFileStream is used automatically when creating PDF les using PdfImmediateWriter. See also PdfVecObjects PdfStream PdfMemoryStream PdfFileStream
8.38.2
8.38.2.1

PoDoFo::PdfFileStream::PdfFileStream ( PdfObject pParent, PdfOutputDevice pDevice )
Create a new PdfFileStream object which has a parent PdfObject. The stream will be deleted along with the parent. This constructor will be called by PdfObject::Stream() for you. Parameters pParent parent object pDevice output device
8.38.3
8.38.3.1

void PoDoFo::PdfFileStream::AppendImpl ( const char pszString, size_t lLen ) [protected, virtual]
Append a binary buffer to the current stream contents. Parameters pszString a buffer lLen length of the buffer
8.38 PoDoFo::PdfFileStream Class Reference See also BeginAppend Append EndAppend Implements PoDoFo::PdfStream. 8.38.3.2
161
void PoDoFo::PdfFileStream::BeginAppendImpl ( const TVecFilters & vecFilters ) [protected, virtual]
Begin appending data to this stream. Clears the current stream contents. Parameters vecFilters use this lters to encode any data written to the stream. Implements PoDoFo::PdfStream. 8.38.3.3 void PoDoFo::PdfFileStream::EndAppendImpl ( virtual] ) [protected,
Finish appending data to the stream Implements PoDoFo::PdfStream. 8.38.3.4 void PoDoFo::PdfFileStream::GetCopy ( PdfOutputStream pStream ) const [virtual]
Get a copy of a the stream and write it to a PdfOutputStream Parameters pStream data is written to this stream. Implements PoDoFo::PdfStream. 8.38.3.5 void PoDoFo::PdfFileStream::GetCopy ( char pBuffer, pdf_long lLen ) const [virtual]
Get a malloced buffer of the current stream. No lters will be applied to the buffer, so if the stream is Flate compressed the compressed copy will be returned. The caller has to free() the buffer. This is currently not implemented for PdfFileStreams and will raise an ePdfError_InternalLogic exception Parameters pBuffer pointer to the buffer
162 lLen pointer to the buffer length Returns ErrOk on success. Implements PoDoFo::PdfStream. 8.38.3.6
Class Documentation
const char PoDoFo::PdfFileStream::GetInternalBuffer ( [inline, protected, virtual]
) const
Required for the GetFilteredCopy implementation Returns a handle to the internal buffer Implements PoDoFo::PdfStream. 8.38.3.7 pdf_long PoDoFo::PdfFileStream::GetInternalBufferSize ( [inline, protected, virtual] ) const
Required for the GetFilteredCopy implementation Returns the size of the internal buffer Implements PoDoFo::PdfStream. 8.38.3.8 pdf_long PoDoFo::PdfFileStream::GetLength ( virtual] ) const [inline,
Get the streams length with all lters applied (eg the compressed length of a Flate compressed stream). Returns the length of the stream with all lters applied Implements PoDoFo::PdfStream. 8.38.3.9 void PoDoFo::PdfFileStream::SetEncrypted ( PdfEncrypt pEncrypt )
Set an encryption object which is used to encrypt all data written to this stream. Parameters pEncrypt an encryption object or NULL if no encryption should be done
8.39 PoDoFo::PdfFilter Class Reference 8.38.3.10
163
void PoDoFo::PdfFileStream::Write ( PdfOutputDevice pDevice, PdfEncrypt pEncrypt = NULL ) [virtual]
Write the stream to an output device Parameters pDevice write to this outputdevice. pEncrypt encrypt stream data using this object Implements PoDoFo::PdfStream.
8.39
PoDoFo::PdfFilter Class Reference
#include <PdfFilter.h> Inheritance diagram for PoDoFo::PdfFilter:

PoDoFo::PdfFilter
PoDoFo::PdfAscii85Filter
PoDoFo::PdfFlateFilter
PoDoFo::PdfHexFilter
PoDoFo::PdfLZWFilter
PoDoFo::PdfRLEFilter

PdfFilter () virtual PdfFilter () virtual bool CanEncode () const =0 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 () virtual bool CanDecode () const =0 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 () virtual EPdfFilter GetType () const =0

PODOFO_NOTHROW void FailEncodeDecode () virtual void BeginEncodeImpl ()
164
Class Documentation virtual void EncodeBlockImpl (const char pBuffer, pdf_long lLen)=0 virtual void EndEncodeImpl () virtual void BeginDecodeImpl (const PdfDictionary ) virtual void DecodeBlockImpl (const char pBuffer, pdf_long lLen)=0 virtual void EndDecodeImpl ()
8.39.1
Every lter in PoDoFo has to implement this interface. The two methods Encode and Decode have to be implemented for every lter. The output buffers are malloced in the functions and have to be freed by the caller.
8.39.2
8.39.2.1

PoDoFo::PdfFilter::PdfFilter ( )
Construct and initialize a new lter 8.39.2.2 PoDoFo::PdfFilter::PdfFilter ( ) [inline, virtual]
All classes with virtual functions need a virtual destructor
8.39.3
8.39.3.1

void PoDoFo::PdfFilter::BeginDecode ( PdfOutputStream pOutput, const PdfDictionary pDecodeParms = NULL ) [inline]
Begin progressively decoding data using this lter. This method sets the lters output stream and may perform other operations dened by particular lter implementations. It calls BeginDecodeImpl(). Parameters pOutput decoded data will be written to this stream. pDecodeParms a dictionary containing addiational information for decoding Call DecodeBlock() to decode blocks of data and use EndDecode to nish the decoding process. See also DecodeBlock EndDecode
8.39 PoDoFo::PdfFilter Class Reference 8.39.3.2 virtual void PoDoFo::PdfFilter::BeginDecodeImpl ( const PdfDictionary ) [inline, protected, virtual]
165
Real implementation of BeginDecode(). NEVER call this method directly. By default this function does nothing. If your lter 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 in PoDoFo::PdfHexFilter, PoDoFo::PdfAscii85Filter, oFo::PdfFlateFilter, PoDoFo::PdfRLEFilter, and PoDoFo::PdfLZWFilter. 8.39.3.3 PoD-
void PoDoFo::PdfFilter::BeginEncode ( PdfOutputStream pOutput ) [inline]
Begin progressively encoding data using this lter. This method sets the lters output stream and may perform other operations dened by particular lter implementations. It calls BeginEncodeImpl(). Parameters pOutput encoded data will be written to this stream. Call EncodeBlock() to encode blocks of data and use EndEncode to nish the encoding process. See also EncodeBlock EndEncode
8.39.3.4
virtual void PoDoFo::PdfFilter::BeginEncodeImpl ( protected, virtual]
) [inline,
Real implementation of BeginEncode(). NEVER call this method directly. By default this function does nothing. If your lter needs to do setup for encoding, you should override this method. PdfFilter ensures that a valid stream is available when this method is called, and that EndEncode() was called since the last BeginEncode()/EncodeBlock(). See also BeginEncode
166 Reimplemented in PoDoFo::PdfAscii85Filter, oFo::PdfRLEFilter, and PoDoFo::PdfLZWFilter.
Class Documentation PoDoFo::PdfFlateFilter, PoD-
8.39.3.5
virtual bool PoDoFo::PdfFilter::CanDecode ( virtual]
) const [pure
Check wether the decoding is implemented for this lter. Returns true if the lter is able to decode data Implemented in PoDoFo::PdfHexFilter, PoDoFo::PdfAscii85Filter, oFo::PdfFlateFilter, PoDoFo::PdfRLEFilter, and PoDoFo::PdfLZWFilter. PoD-
8.39.3.6
virtual bool PoDoFo::PdfFilter::CanEncode ( virtual]
) const [pure
Check wether encoding is implemented for this lter. Returns true if the lter is able to encode data Implemented in PoDoFo::PdfHexFilter, PoDoFo::PdfAscii85Filter, oFo::PdfFlateFilter, PoDoFo::PdfRLEFilter, and PoDoFo::PdfLZWFilter. PoD-
8.39.3.7
void PoDoFo::PdfFilter::Decode ( const char pInBuffer, pdf_long lInLen, char ppOutBuffer, pdf_long plOutLen, const PdfDictionary pDecodeParms = NULL ) const
Decodes a buffer using a lter. The buffer will malloced and has to be freed by the caller. Parameters pInBuffer input buffer lInLen length of the input buffer ppOutBuffer pointer to the buffer of the decoded data plOutLen pointer to the length of the output buffer pDecodeParms optional pointer to an decode parameters dictionary containing additional information to decode the data. This pointer must be NULL if no decode parameter dictionary is available.
8.39 PoDoFo::PdfFilter Class Reference 8.39.3.8 void PoDoFo::PdfFilter::DecodeBlock ( const char pBuffer, pdf_long lLen ) [inline]
167
Decode a block of data and write it to the PdfOutputStream specied by BeginDecode. Ownership of the block is not taken and remains with the caller. The lter implementation need not immediately process the buffer, and might internally buffer some or all of it. However, if it does this the buffers contents will be copied, so it is guaranteed to be safe to free the passed buffer after this call returns. This method is a wrapper around DecodeBlockImpl(). BeginDecode() must be called before this function. Parameters pBuffer pointer to a buffer with data to encode lLen length of data to encode. Call EndDecode() after all data has been decoded See also BeginDecode EndDecode
8.39.3.9
virtual void PoDoFo::PdfFilter::DecodeBlockImpl ( const char pBuffer, pdf_long lLen ) [protected, pure 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 youre going to store it, as ownership is not transferred to the lter 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 Implemented in PoDoFo::PdfHexFilter, PoDoFo::PdfAscii85Filter, oFo::PdfFlateFilter, PoDoFo::PdfRLEFilter, and PoDoFo::PdfLZWFilter.
PoD-
168 8.39.3.10
Class Documentation void PoDoFo::PdfFilter::Encode ( const char pInBuffer, pdf_long lInLen, char ppOutBuffer, pdf_long plOutLen ) const
Encodes a buffer using a lter. The buffer will malloced and has to be freed by the caller. This function uses BeginEncode()/EncodeBlock()/EndEncode() internally, so its not safe to use when progressive encoding is in progress. Parameters pInBuffer input buffer lInLen length of the input buffer ppOutBuffer pointer to the buffer of the encoded data plOutLen pointer to the length of the output buffer
8.39.3.11
void PoDoFo::PdfFilter::EncodeBlock ( const char pBuffer, pdf_long lLen ) [inline]
Encode a block of data and write it to the PdfOutputStream specied by BeginEncode. Ownership of the block is not taken and remains with the caller. The lter implementation need not immediately process the buffer, and might internally buffer some or all of it. However, if it does this the buffers contents will be copied, so it is guaranteed to be safe to free the passed buffer after this call returns. This method is a wrapper around EncodeBlockImpl(). BeginEncode() must be called before this function. Parameters pBuffer pointer to a buffer with data to encode lLen length of data to encode. Call EndEncode() after all data has been encoded See also BeginEncode EndEncode
8.39.3.12
virtual void PoDoFo::PdfFilter::EncodeBlockImpl ( const char pBuffer, pdf_long lLen ) [protected, pure virtual]
Real implementation of EncodeBlock(). NEVER call this method directly. You must override this method to encode the buffer passed by the caller.
8.39 PoDoFo::PdfFilter Class Reference
169
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 youre going to store it, as ownership is not transferred to the lter 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 Implemented in PoDoFo::PdfHexFilter, PoDoFo::PdfAscii85Filter, oFo::PdfFlateFilter, PoDoFo::PdfRLEFilter, and PoDoFo::PdfLZWFilter. 8.39.3.13 void PoDoFo::PdfFilter::EndDecode ( ) [inline] PoD-
Finish decoding of data and reset the streams state. See also BeginDecode DecodeBlock
8.39.3.14
virtual void PoDoFo::PdfFilter::EndDecodeImpl ( protected, virtual]
) [inline,
Real implementation of EndDecode(). NEVER call this method directly. By the time this method returns, all ltered data must be written to the stream and the lter 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 in PoDoFo::PdfHexFilter, PoDoFo::PdfAscii85Filter, oFo::PdfFlateFilter, and PoDoFo::PdfLZWFilter. 8.39.3.15 void PoDoFo::PdfFilter::EndEncode ( ) [inline] PoD-
Finish encoding of data and reset the streams state. See also BeginEncode EncodeBlock
170 8.39.3.16
Class Documentation virtual void PoDoFo::PdfFilter::EndEncodeImpl ( protected, virtual] ) [inline,
Real implementation of EndEncode(). NEVER call this method directly. By the time this method returns, all ltered data must be written to the stream and the lter must be in a state where BeginEncode() can be safely called. PdfFilter ensures that a valid stream is available when this method is called, and ensures that BeginEncodeImpl() has been called. See also EndEncode Reimplemented in PoDoFo::PdfAscii85Filter, oFo::PdfRLEFilter, and PoDoFo::PdfLZWFilter. PoDoFo::PdfFlateFilter, PoD-
8.39.3.17
void PoDoFo::PdfFilter::FailEncodeDecode ( protected]
) [inline,
Indicate that the lter has failed, and will be non-functional until BeginEncode() or BeginDecode() is next called. Call this instead of EndEncode() or EndDecode if something went wrong. It clears the stream output but otherwise does nothing. After this method is called futher calls to EncodeBlock(), DecodeBlock(), EndDecode() and EndEncode() before the next BeginEncode() or BeginDecode() are guaranteed to throw without calling their virtual implementations.
8.39.3.18
virtual EPdfFilter PoDoFo::PdfFilter::GetType ( virtual]
) const [pure
Type of this lter. Returns the type of this lter Implemented in PoDoFo::PdfHexFilter, PoDoFo::PdfAscii85Filter, oFo::PdfFlateFilter, PoDoFo::PdfRLEFilter, and PoDoFo::PdfLZWFilter. PoD-
8.40
PoDoFo::PdfFilteredDecodeStream Class Reference
Inheritance diagram for PoDoFo::PdfFilteredDecodeStream:

8.40 PoDoFo::PdfFilteredDecodeStream Class Reference
171
PoDoFo::PdfOutputStream PoDoFo::PdfFilteredDecodeStream

PdfFilteredDecodeStream (PdfOutputStream pOutputStream, const EPdfFilter eFilter, bool bOwnStream, const PdfDictionary pDecodeParms=NULL) virtual pdf_long Write (const char pBuffer, pdf_long lLen) virtual void Close ()
8.40.1
Create a lter that is a PdfOutputStream. All data written to this stream is decoded using a lter and written to another PdfOutputStream. The passed output stream is owned by this PdfOutputStream and deleted along with it.
8.40.2
8.40.2.1

PoDoFo::PdfFilteredDecodeStream::PdfFilteredDecodeStream ( PdfOutputStream pOutputStream, const EPdfFilter eFilter, bool bOwnStream, const PdfDictionary pDecodeParms = NULL ) [inline]
Create a ltered output stream. All data written to this stream is decoded using the passed lter type and written to the passed output stream which will be deleted by this PdfFilteredEncodeStream. Parameters pOutputStream write all data to this output stream after decoding the data. The PdfOutputStream is deleted along with this object. eFilter use this lter for decoding. bOwnStream if true pOutputStream will be deleted along with this lter pDecodeParms additional parameters for decoding
172
Class Documentation
8.40.3
8.40.3.1

virtual void PoDoFo::PdfFilteredDecodeStream::Close ( [inline, virtual] )
Close the PdfOutputStream. This method may throw exceptions and has to be called before the descructor to end writing. No more data may be written to the output device after calling close. Implements PoDoFo::PdfOutputStream. 8.40.3.2 virtual pdf_long PoDoFo::PdfFilteredDecodeStream::Write ( const char pBuffer, pdf_long lLen ) [inline, virtual]
Write data to the output stream Parameters pBuffer the data is read from this buffer lLen the size of the buffer Implements PoDoFo::PdfOutputStream.
8.41
PoDoFo::PdfFilteredEncodeStream Class Reference
Inheritance diagram for PoDoFo::PdfFilteredEncodeStream:
PoDoFo::PdfOutputStream PoDoFo::PdfFilteredEncodeStream

PdfFilteredEncodeStream (PdfOutputStream pOutputStream, const EPdfFilter eFilter, bool bOwnStream) virtual pdf_long Write (const char pBuffer, pdf_long lLen) virtual void Close ()
8.41.1
Create a lter that is a PdfOutputStream.

8.42 PoDoFo::PdfFilterFactory Class Reference
173
All data written to this stream is encoded using a lter and written to another PdfOutputStream. The passed output stream is owned by this PdfOutputStream and deleted along with it.
8.41.2
8.41.2.1

PoDoFo::PdfFilteredEncodeStream::PdfFilteredEncodeStream ( PdfOutputStream pOutputStream, const EPdfFilter eFilter, bool bOwnStream ) [inline]
Create a ltered output stream. All data written to this stream is encoded using the passed lter type and written to the passed output stream which will be deleted by this PdfFilteredEncodeStream. Parameters pOutputStream write all data to this output stream after encoding the data. eFilter use this lter for encoding. bOwnStream if true pOutputStream will be deleted along with this lter
8.41.3
8.41.3.1

virtual void PoDoFo::PdfFilteredEncodeStream::Close ( [inline, virtual] )
Close the PdfOutputStream. This method may throw exceptions and has to be called before the descructor to end writing. No more data may be written to the output device after calling close. Implements PoDoFo::PdfOutputStream. 8.41.3.2 virtual pdf_long PoDoFo::PdfFilteredEncodeStream::Write ( const char pBuffer, pdf_long lLen ) [inline, virtual]
8.42
PoDoFo::PdfFilterFactory Class Reference
#include <PdfFilter.h>
174
Class Documentation

static std::auto_ptr< PdfFilter > Create (const EPdfFilter eFilter) static PdfOutputStream CreateEncodeStream (const TVecFilters &lters, PdfOutputStream pStream) static PdfOutputStream CreateDecodeStream (const TVecFilters &lters, PdfOutputStream pStream, const PdfDictionary pDictionary=NULL) static EPdfFilter FilterNameToType (const PdfName &name, bool bSupportShortNames=true) static const char FilterTypeToName (EPdfFilter eFilter) static TVecFilters CreateFilterList (const PdfObject pObject)
8.42.1
A factory to create a lter object for a lter GetType from the EPdfFilter enum. All lters should be created using this factory.
8.42.2
8.42.2.1

std::auto_ptr< PdfFilter > PoDoFo::PdfFilterFactory::Create ( const EPdfFilter eFilter ) [static]
Create a lter from an enum. Ownership is transferred to the caller, who should let the auto_ptr the lter is returned in take care of freeing it when theyre done with it. Parameters eFilter the GetType of lter that should be created. Returns a new PdfFilter allocated using new or NULL if no lter is available for this type.
8.42.2.2
PdfOutputStream PoDoFo::PdfFilterFactory::CreateDecodeStream ( const TVecFilters & lters, PdfOutputStream pStream, const PdfDictionary pDictionary = NULL ) [static]
Create a PdfOutputStream that applies a list of lters on all data written to it. Parameters lters a list of lters pStream write all data to this PdfOutputStream after it has been decoded.
8.42 PoDoFo::PdfFilterFactory Class Reference
175
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 lters. Returns a new PdfOutputStream that has to be deleted by the caller. See also PdfFilterFactory::CreateFilterList
8.42.2.3
PdfOutputStream PoDoFo::PdfFilterFactory::CreateEncodeStream ( const TVecFilters & lters, PdfOutputStream pStream ) [static]
Create a PdfOutputStream that applies a list of lters on all data written to it. Parameters lters a list of lters pStream write all data to this PdfOutputStream after it has been encoded. Returns a new PdfOutputStream that has to be deleted by the caller. See also PdfFilterFactory::CreateFilterList
8.42.2.4
TVecFilters PoDoFo::PdfFilterFactory::CreateFilterList ( const PdfObject pObject ) [static]
The passed PdfObject has to be a dictionary with a Filters key, an array of lter names or a lter name. Parameters pObject must dene a list of lters. Returns a list of lters
176 8.42.2.5
Class Documentation EPdfFilter PoDoFo::PdfFilterFactory::FilterNameToType ( const PdfName & name, bool bSupportShortNames = true ) [static]
Converts a lter name to the corresponding enum Parameters name of the lter without leading bSupportShortNames the PDF Reference supports several short names for lters (e.g. AHx for AsciiHexDecode), if true support for these short names will be enabled. This is often used in inline images. Returns the lter as enum
8.42.2.6
const char PoDoFo::PdfFilterFactory::FilterTypeToName ( EPdfFilter eFilter ) [static]
Converts a lter type enum to the corresponding PdfName Parameters eFilter a lter type Returns the lter as name
8.43
PoDoFo::PdfFlateFilter Class Reference
#include <PdfFiltersPrivate.h> Inheritance diagram for PoDoFo::PdfFlateFilter:
PoDoFo::PdfFilter
PoDoFo::PdfFlateFilter

virtual bool CanEncode () const virtual void BeginEncodeImpl () virtual void EncodeBlockImpl (const char pBuffer, pdf_long lLen) virtual void EndEncodeImpl ()
8.43 PoDoFo::PdfFlateFilter Class Reference virtual bool CanDecode () const virtual void BeginDecodeImpl (const PdfDictionary pDecodeParms) virtual void DecodeBlockImpl (const char pBuffer, pdf_long lLen) virtual void EndDecodeImpl () virtual EPdfFilter GetType () const
177
8.43.1
The ate lter.
8.43.2
8.43.2.1

void PoDoFo::PdfFlateFilter::BeginDecodeImpl ( const PdfDictionary pDecodeParms ) [virtual]
Real implementation of BeginDecode(). NEVER call this method directly. By default this function does nothing. If your lter 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(). Parameters pDecodeParms additional parameters for decoding data See also BeginDecode Reimplemented from PoDoFo::PdfFilter.
8.43.2.2
void PoDoFo::PdfFlateFilter::BeginEncodeImpl (
) [virtual]
178 8.43.2.3 bool PoDoFo::PdfFlateFilter::CanDecode ( virtual]
Class Documentation ) const [inline,
Check wether the decoding is implemented for this lter. Returns true if the lter is able to decode data Implements PoDoFo::PdfFilter. 8.43.2.4 bool PoDoFo::PdfFlateFilter::CanEncode ( virtual] ) const [inline,
Check wether the encoding is implemented for this lter. Returns true if the lter is able to encode data Implements PoDoFo::PdfFilter. 8.43.2.5 void PoDoFo::PdfFlateFilter::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 youre going to store it, as ownership is not transferred to the lter 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. 8.43.2.6 void PoDoFo::PdfFlateFilter::EncodeBlockImpl ( const char pBuffer, pdf_long lLen ) [virtual]
8.43 PoDoFo::PdfFlateFilter Class Reference 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. 8.43.2.7 void PoDoFo::PdfFlateFilter::EndDecodeImpl ( ) [virtual]
179
Real implementation of EndDecode(). NEVER call this method directly. By the time this method returns, all ltered data must be written to the stream and the lter 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. 8.43.2.8 void PoDoFo::PdfFlateFilter::EndEncodeImpl ( ) [virtual]
Finish encoding of data. See also BeginEncodeImpl EncodeBlockImpl Reimplemented from PoDoFo::PdfFilter. 8.43.2.9 EPdfFilter PoDoFo::PdfFlateFilter::GetType ( virtual] ) const [inline,
180
Class Documentation
8.44
PoDoFo::PdfFont Class Reference
#include <PdfFont.h> Inheritance diagram for PoDoFo::PdfFont:

PoDoFo::PdfElement PoDoFo::PdfFont PoDoFo::PdfFontCID PoDoFo::PdfFontTrueType PoDoFo::PdfFontSimple PoDoFo::PdfFontType1 PoDoFo::PdfFontType1Base14

PdfFont (PdfFontMetrics pMetrics, const PdfEncoding const pEncoding, PdfVecObjects pParent) PdfFont (PdfFontMetrics pMetrics, const PdfEncoding const pEncoding, PdfObject pObject) void SetFontSize (oat fSize) oat GetFontSize () const void SetFontScale (oat fScale) oat GetFontScale () const void SetFontCharSpace (oat fCharSpace) oat GetFontCharSpace () const void SetUnderlined (bool bUnder) bool IsUnderlined () const bool IsBold () const bool IsItalic () const void SetStrikeOut (bool bStrikeOut) bool IsStrikeOut () const const PdfName & GetIdentier () const const PdfEncoding GetEncoding () const const PdfFontMetrics GetFontMetrics () const PdfFontMetrics GetFontMetrics2 () virtual void WriteStringToStream (const PdfString &rsString, PdfStream pStream) virtual void EmbedFont () virtual void AddUsedSubsettingGlyphs (const PdfString &sText, long lStringLen) virtual void AddUsedGlyphname (const char pszGlyphName) virtual void EmbedSubsetFont () bool IsSubsetting () const
8.44 PoDoFo::PdfFont Class Reference
181

const PdfName & GetBaseFont () const
8.44.1
Before you can draw text on a PDF document, you have to create a font object rst. You can reuse this font object as often as you want. Use PdfDocument::CreateFont to create a new font object. It will choose a correct subclass using PdfFontFactory. This is only an abstract base class which is implemented for different font formats.
8.44.2
8.44.2.1

PoDoFo::PdfFont::PdfFont ( PdfFontMetrics pMetrics, const PdfEncoding const pEncoding, PdfVecObjects pParent )
Create a new PdfFont object which will introduce itself automatically to every page object it is used on. The font has a default font size of 12.0pt. Parameters pMetrics pointer to a font metrics object. The font in the PDF le will match this fontmetrics object. The metrics object is deleted along with the font. pEncoding the encoding of this font. The font will not take ownership of this object. pParent parent of the font object
8.44.2.2
PoDoFo::PdfFont::PdfFont ( PdfFontMetrics pMetrics, const PdfEncoding const pEncoding, PdfObject pObject )
Create a PdfFont based on an existing PdfObject Parameters pMetrics pointer to a font metrics object. The font in the PDF le will match this fontmetrics object. The metrics object is deleted along with the font. pEncoding the encoding of this font. The font will not take ownership of this object. pObject an existing PdfObject
182
Class Documentation
8.44.3
8.44.3.1

void PoDoFo::PdfFont::AddUsedGlyphname ( const char pszGlyphName ) [virtual]
Remember the glyphname in case of subsetting Parameters pszGlyphName Name of the glyph to remember Reimplemented in PoDoFo::PdfFontType1. 8.44.3.2 void PoDoFo::PdfFont::AddUsedSubsettingGlyphs ( const PdfString & sText, long lStringLen ) [virtual]
Remember the glyphs used in the string in case of subsetting Parameters sText the text string which should be printed (is not allowed to be NULL!) lStringLen draw only lLen characters of pszText Only call if IsSubsetting() returns true. Might throw an exception otherwise. See also IsSubsetting Reimplemented in PoDoFo::PdfFontType1. 8.44.3.3 void PoDoFo::PdfFont::EmbedFont ( ) [virtual]
Embeds the font into PDF page Reimplemented in PoDoFo::PdfFontCID, and PoDoFo::PdfFontSimple. 8.44.3.4 void PoDoFo::PdfFont::EmbedSubsetFont ( ) [virtual]
Embeds pending subset-font into PDF page Only call if IsSubsetting() returns true. Might throw an exception otherwise. See also IsSubsetting Reimplemented in PoDoFo::PdfFontType1.
8.44 PoDoFo::PdfFont Class Reference 8.44.3.5 const PdfName & PoDoFo::PdfFont::GetBaseFont ( [inline, protected] ) const
183
Get the base font name of this font Returns the base font name
8.44.3.6
const PdfEncoding PoDoFo::PdfFont::GetEncoding ( [inline]
) const
Returns a reference to the fonts encoding Returns a PdfEncoding object.
8.44.3.7
oat PoDoFo::PdfFont::GetFontCharSpace (
) const [inline]
Retrieve the current character spacing of this font object Returns the current font character spacing
8.44.3.8
const PdfFontMetrics PoDoFo::PdfFont::GetFontMetrics ( [inline]
) const
Returns a handle to the fontmetrics object of this font. This can be used for size calculations of text strings when drawn using this font. Returns a handle to the font metrics object
8.44.3.9
PdfFontMetrics PoDoFo::PdfFont::GetFontMetrics2 ( [inline]
Returns a handle to the fontmetrics object of this font. This can be used for size calculations of text strings when drawn using this font. Returns a handle to the font metrics object
184 8.44.3.10 oat PoDoFo::PdfFont::GetFontScale (
Retrieve the current horizontal scaling of this font object Returns the current font scaling
8.44.3.11
oat PoDoFo::PdfFont::GetFontSize (
) const [inline]
Retrieve the current font size of this font object Returns the current font size
8.44.3.12
const PdfName & PoDoFo::PdfFont::GetIdentier ( [inline]
) const
Returns the identier of this font how it is known in the pages resource dictionary. Returns PdfName containing the identier (e.g. /Ft13)
8.44.3.13 Returns
bool PoDoFo::PdfFont::IsBold (
) const [inline]
true if this font is bold See also IsItalic IsUnderlined
8.44.3.14 Returns
bool PoDoFo::PdfFont::IsItalic (
) const [inline]
true if this font is italic See also IsBold IsUnderlined
8.44 PoDoFo::PdfFont Class Reference 8.44.3.15 Returns true if the font is striked out bool PoDoFo::PdfFont::IsStrikeOut ( ) const [inline]
185
8.44.3.16
bool PoDoFo::PdfFont::IsSubsetting (
) const [inline]
Check if this is a subsetting font. Returns true if this is a subsetting font
8.44.3.17 Returns
bool PoDoFo::PdfFont::IsUnderlined (
) const [inline]
true if the font is underlined See also IsBold IsItalic
8.44.3.18
void PoDoFo::PdfFont::SetFontCharSpace ( oat fCharSpace ) [inline]
Set the character spacing of the font Parameters fCharSpace character spacing in percent
8.44.3.19
void PoDoFo::PdfFont::SetFontScale ( oat fScale ) [inline]
Set the horizontal scaling of the font for compressing (< 100) and expanding (>100) Parameters fScale scaling in percent
8.44.3.20
void PoDoFo::PdfFont::SetFontSize ( oat fSize ) [inline]
Set the font size before drawing with this font. Parameters fSize font size in points
186 8.44.3.21
Class Documentation void PoDoFo::PdfFont::SetStrikeOut ( bool bStrikeOut ) [inline]
Set the strikeout property of the font Parameters bStrikeOut if true any text drawn with this font by a PdfPainter will be strikedout. Default is false
8.44.3.22
void PoDoFo::PdfFont::SetUnderlined ( bool bUnder ) [inline]
Set the underlined property of the font Parameters bUnder if true any text drawn with this font by a PdfPainter will be underlined. Default is false
8.44.3.23
void PoDoFo::PdfFont::WriteStringToStream ( const PdfString & rsString, PdfStream pStream ) [virtual]
Write a PdfString to a PdfStream in a format so that it can be used with this font. This is used by PdfPainter::DrawText to display a text string. The following PDF operator will be Tj Parameters rsString a unicode or ansi string which will be displayed pStream the string will be appended to pStream without any leading or following whitespaces.
8.45
PoDoFo::PdfFontCache Class Reference
#include <PdfFontCache.h>
Public Types
enum EFontCreationFlags { eFontCreationFlags_None = 0, eFontCreationFlags_AutoSelectBase14 = 1, eFontCreationFlags_Type1Subsetting = 2 }

PdfFontCache (PdfVecObjects pParent)
8.45 PoDoFo::PdfFontCache Class Reference
187
PdfFontCache () void EmptyCache () PdfFont GetFont (PdfObject pObject) PdfFont GetFont (const char pszFontName, bool bBold, bool bItalic, bool bEmbedd, EFontCreationFlags eFontCreationFlags=eFontCreationFlags_AutoSelectBase14, const PdfEncoding const =PdfEncodingFactory::GlobalWinAnsiEncodingInstance(), const char pszFileName=NULL) PdfFont GetFont (FT_Face face, bool bEmbedd, const PdfEncoding const =PdfEncodingFactory::GlobalWinAnsiEncodingInstance()) PdfFont GetDuplicateFontType1 (PdfFont pFont, const char pszSufx) PdfFont GetFontSubset (const char pszFontName, bool bBold, bool bItalic, const PdfEncoding const =PdfEncodingFactory::GlobalWinAnsiEncodingInstance(), const char pszFileName=NULL) void EmbedSubsetFonts () FT_Library GetFontLibrary () const
8.45.1
This class assists PdfDocument with caching font information. Additional to font caching, this class is also responsible for font matching. PdfFont is an actual font that can be used in a PDF le (i.e. it does also font embedding) and PdfFontMetrics provides only metrics informations. This class is an internal class of PoDoFo and should not be used in user applications See also PdfDocument
8.45.2
8.45.2.1

enum PoDoFo::PdfFontCache::EFontCreationFlags
Flags to control font creation. Enumerator: eFontCreationFlags_None No special settings. eFontCreationFlags_AutoSelectBase14 Create automatically a base14 font if the fontname matches one of them. eFontCreationFlags_Type1Subsetting Create subsetted type1-font, which includes only used characters.
8.45.3
8.45.3.1

PoDoFo::PdfFontCache::PdfFontCache ( PdfVecObjects pParent )
Create an empty font cache

188 Parameters
Class Documentation
pParent a PdfVecObjects which is required to create new font objects
8.45.3.2
PoDoFo::PdfFontCache::PdfFontCache (
Destroy and empty the font cache
8.45.4
8.45.4.1

void PoDoFo::PdfFontCache::EmbedSubsetFonts ( )
Embeds all pending subset-fonts 8.45.4.2 void PoDoFo::PdfFontCache::EmptyCache ( )
Empty the internal font cache. This should be done when ever a new document is created or openened. 8.45.4.3 PdfFont PoDoFo::PdfFontCache::GetDuplicateFontType1 ( PdfFont pFont, const char pszSufx )
Get a font with specic id from the cache. If the font does not yet exist, copy from existing type1-font and set id. Parameters pFont an existing font pszSufx Sufx to add to font-id Returns a PdfFont object or NULL if the font could not be created or found.
8.45.4.4
PdfFont PoDoFo::PdfFontCache::GetFont ( FT_Face face, bool bEmbedd, const PdfEncoding const pEncoding = PdfEncodingFactory::GlobalWinAnsiEncodingInstance() )
Get a font from the cache. If the font does not yet exist, add it to the cache. Parameters face a valid freetype font face (will be freed by PoDoFo) bEmbedd if true a font for embedding into PDF will be created
8.45 PoDoFo::PdfFontCache Class Reference
189
pEncoding the encoding of the font. The font will not take ownership of this object. Returns a PdfFont object or NULL if the font could not be created or found.
8.45.4.5
PdfFont PoDoFo::PdfFontCache::GetFont ( PdfObject pObject )
Get a font from the cache. If the font does not yet exist, add it to the cache. This font is created from an existing object. Parameters pObject a PdfObject that is a font Returns a PdfFont object or NULL if the font could not be created or found.
8.45.4.6
PdfFont PoDoFo::PdfFontCache::GetFont ( const char pszFontName, bool bBold, bool bItalic, bool bEmbedd, EFontCreationFlags eFontCreationFlags = eFontCreationFlags_AutoSelectBase14, const PdfEncoding const pEncoding = PdfEncodingFactory::GlobalWinAnsiEncodingInstance(), const char pszFileName = NULL )
Get a font from the cache. If the font does not yet exist, add it to the cache. Parameters pszFontName a valid fontname bBold if true search for a bold font bItalic if true search for an italic font bEmbedd if true a font for embedding into PDF will be created eFontCreationFlags special ag to specify how fonts should be created pEncoding the encoding of the font. The font will not take ownership of this object. pszFileName optional path to a valid font le Returns a PdfFont object or NULL if the font could not be created or found.
190 8.45.4.7
Class Documentation FT_Library PoDoFo::PdfFontCache::GetFontLibrary ( [inline] ) const
Returns the font library from font cache Returns the internal handle to the freetype library
8.45.4.8
PdfFont PoDoFo::PdfFontCache::GetFontSubset ( const char pszFontName, bool bBold, bool bItalic, const PdfEncoding const pEncoding = PdfEncodingFactory::GlobalWinAnsiEncodingInstance(), const char pszFileName = NULL )
Get a fontsubset from the cache. If the font does not yet exist, add it to the cache. Parameters pszFontName a valid fontname bBold if true search for a bold font bItalic if true search for an italic font pEncoding the encoding of the font. All characters of the encoding will be included in this subset. The font will not take ownership of this object. pszFileName optional path to a valid font le Returns a PdfFont object or NULL if the font could not be created or found.
8.46
PoDoFo::PdfFontCID Class Reference
#include <PdfFontCID.h> Inheritance diagram for PoDoFo::PdfFontCID:
PoDoFo::PdfElement
PoDoFo::PdfFont
PoDoFo::PdfFontCID
8.46 PoDoFo::PdfFontCID Class Reference
191

PdfFontCID (PdfFontMetrics pMetrics, const PdfEncoding const pEncoding, PdfVecObjects pParent, bool bEmbed=true) PdfFontCID (PdfFontMetrics pMetrics, const PdfEncoding const pEncoding, PdfObject pObject, bool bEmbed) virtual void EmbedFont ()

void Init (bool bEmbed) void EmbedFont (PdfObject pDescriptor)
8.46.1
A PdfFont that represents a CID font.
8.46.2
8.46.2.1

PoDoFo::PdfFontCID::PdfFontCID ( PdfFontMetrics pMetrics, const PdfEncoding const pEncoding, PdfVecObjects pParent, bool bEmbed = true )
Create a new CID font. Parameters pMetrics pointer to a font metrics object. The font in the PDF le will match this fontmetrics object. The metrics object is deleted along with the font. pEncoding the encoding of this font. The font will not take ownership of this object. pParent parent of the font object bEmbed species the embedding of font
8.46.2.2
PoDoFo::PdfFontCID::PdfFontCID ( PdfFontMetrics pMetrics, const PdfEncoding const pEncoding, PdfObject pObject, bool bEmbed )
Create a PdfFont based on an existing PdfObject Parameters pMetrics pointer to a font metrics object. The font in the PDF le will match this fontmetrics object. The metrics object is deleted along with the font. pEncoding the encoding of this font. The font will not take ownership of this object.
192 pObject an existing PdfObject bEmbed species the embedding of font
Class Documentation
8.46.3
8.46.3.1

void PoDoFo::PdfFontCID::EmbedFont ( ) [virtual]
Embeds the font into PDF page Reimplemented from PoDoFo::PdfFont. 8.46.3.2 void PoDoFo::PdfFontCID::EmbedFont ( PdfObject pDescriptor ) [protected]
Embed the font le directly into the PDF le. Parameters pDescriptor font descriptor object
8.46.3.3
void PoDoFo::PdfFontCID::Init ( bool bEmbed ) [protected]
Initialize this font object. Parameters bEmbed if true embed the font data into the PDF le.
8.47
PoDoFo::PdfFontFactory Class Reference
#include <PdfFontFactory.h>

static PdfFont CreateFontObject (PdfFontMetrics pMetrics, int nFlags, const PdfEncoding const pEncoding, PdfVecObjects pParent) static PdfFont CreateFont (FT_Library pLibrary, PdfObject pObject) static EPdfFontType GetFontType (const char pszFilename)
8.47.1
This is a factory class which knows which implementation of PdfFont is required for a certain font type with certain features (like encoding).
8.47 PoDoFo::PdfFontFactory Class Reference
193
8.47.2
8.47.2.1

PdfFont PoDoFo::PdfFontFactory::CreateFont ( FT_Library pLibrary, PdfObject pObject ) [static]
Create a new PdfFont from an existing font in a PDF le. Parameters pLibrary handle to the FreeType library, so that a PdfFontMetrics can be constructed for this font pObject a PDF font object
8.47.2.2
PdfFont PoDoFo::PdfFontFactory::CreateFontObject ( PdfFontMetrics pMetrics, int nFlags, const PdfEncoding const pEncoding, PdfVecObjects pParent ) [static]
Create a new PdfFont object. Parameters pMetrics pointer to a font metrics object. The font in the PDF le will match this fontmetrics object. The metrics object is deleted along with the created font. In case of an error, it is deleted here. nFlags font ags ored together, specifying the font style and if it should be embedded pEncoding the encoding of this font. pParent the parent of the created font. Returns a new PdfFont object or NULL
8.47.2.3
EPdfFontType PoDoFo::PdfFontFactory::GetFontType ( const char pszFilename ) [static]
Try to guess the fonttype from a the lename of a font le. Parameters pszFilename lename of a fontle Returns the font type
194
Class Documentation
8.48
PoDoFo::PdfFontMetrics Class Reference
#include <PdfFontMetrics.h> Inherited by PoDoFo::PdfFontMetricsBase14, PoDoFo::PdfFontMetricsFreetype, and PoDoFo::PdfFontMetricsObject.

virtual void GetWidthArray (PdfVariant &var, unsigned int nFirst, unsigned int nLast) const =0 virtual double GetGlyphWidth (int nGlyphId) const =0 virtual double GetGlyphWidth (const char pszGlyphname) const =0 virtual void GetBoundingBox (PdfArray &array) const =0 double StringWidth (const PdfString &rsString) const double StringWidth (const char pszText, pdf_long nLength=0) const double StringWidth (const pdf_utf16be pszText, unsigned int nLength=0) const double StringWidth (const wchar_t pszText, unsigned int nLength=0) const unsigned long StringWidthMM (const char pszText, unsigned int nLength=0) const unsigned long StringWidthMM (const pdf_utf16be pszText, unsigned int nLength=0) const unsigned long StringWidthMM (const wchar_t pszText, unsigned int nLength=0) const virtual double CharWidth (unsigned char c) const =0 virtual double UnicodeCharWidth (unsigned short c) const =0 unsigned long CharWidthMM (unsigned char c) const virtual double GetLineSpacing () const =0 unsigned long GetLineSpacingMM () const virtual double GetUnderlineThickness () const =0 unsigned long GetUnderlineThicknessMM () const virtual double GetUnderlinePosition () const =0 long GetUnderlinePositionMM () const virtual double GetStrikeOutPosition () const =0 unsigned long GetStrikeOutPositionMM () const virtual double GetStrikeoutThickness () const =0 unsigned long GetStrikeoutThicknessMM () const const char GetFilename () const virtual const char GetFontData () const =0 virtual pdf_long GetFontDataLen () const =0 virtual const char GetFontname () const =0 const char GetSubsetFontnamePrex () const virtual unsigned int GetWeight () const =0 virtual double GetAscent () const =0 virtual double GetPdfAscent () const =0 virtual double GetDescent () const =0 virtual double GetPdfDescent () const =0
8.48 PoDoFo::PdfFontMetrics Class Reference virtual int GetItalicAngle () const =0 void SetFontSize (oat fSize) oat GetFontSize () const void SetFontScale (oat fScale) oat GetFontScale () const void SetFontCharSpace (oat fCharSpace) oat GetFontCharSpace () const EPdfFontType GetFontType () const virtual long GetGlyphId (long lUnicode) const =0 virtual bool IsSymbol () const =0
195

static EPdfFontType FontTypeFromFilename (const char pszFilename)

void SetFontType (EPdfFontType eFontType)
8.48.1
This abstract class provides access to fontmetrics informations.
8.48.2
8.48.2.1

virtual double PoDoFo::PdfFontMetrics::CharWidth ( unsigned char c ) const [pure virtual]
Retrieve the width of the given character in PDF units in the current font Parameters c character Returns the width in PDF units
8.48.2.2
unsigned long PoDoFo::PdfFontMetrics::CharWidthMM ( unsigned char c ) const [inline]
Retrieve the width of the given character in 1/1000th mm in the current font Parameters c character
196 Returns the width in 1/1000th mm
Class Documentation
8.48.2.3
EPdfFontType PoDoFo::PdfFontMetrics::FontTypeFromFilename ( const char pszFilename ) [static]
Try to detect the internal fonttype from the le extension of a fontle. Parameters pszFilename must be the lename of a font le Returns font type
8.48.2.4
virtual double PoDoFo::PdfFontMetrics::GetAscent ( [pure virtual]
) const
Get the ascent of this font in PDF units for the current font size. Returns the ascender for this font See also GetPdfAscent
8.48.2.5
virtual void PoDoFo::PdfFontMetrics::GetBoundingBox ( PdfArray & array ) const [pure virtual]
Create the bounding box array as required by the PDF reference so that it can be written directly to a PDF le. Parameters array write the bounding box to this array.
8.48.2.6
virtual double PoDoFo::PdfFontMetrics::GetDescent ( [pure virtual]
) const
Get the descent of this font in PDF units for the current font size. This value is usually negative!
8.48 PoDoFo::PdfFontMetrics Class Reference Returns the descender for this font See also GetPdfDescent
197
8.48.2.7
const char PoDoFo::PdfFontMetrics::GetFilename ( [inline]
) const
Get a pointer to the path of the font le. Returns a zero terminated string containing the lename of the font le
8.48.2.8
oat PoDoFo::PdfFontMetrics::GetFontCharSpace ( [inline]
) const
Retrieve the current character spacing of this metrics object Returns the current font character spacing
8.48.2.9
virtual const char PoDoFo::PdfFontMetrics::GetFontData ( [pure virtual]
) const
Get a pointer to the actual font data - if it was loaded from memory. Returns a binary buffer of data containing the font data
8.48.2.10
virtual pdf_long PoDoFo::PdfFontMetrics::GetFontDataLen ( const [pure virtual]
Get the length of the actual font data - if it was loaded from memory. Returns a the length of the font data
198 8.48.2.11
Class Documentation virtual const char PoDoFo::PdfFontMetrics::GetFontname ( const [pure virtual] )
Get a string with the postscript name of the font. Returns the postscript name of the font or NULL string if no postscript name is available.
8.48.2.12
oat PoDoFo::PdfFontMetrics::GetFontScale (
) const [inline]
Retrieve the current horizontal scaling of this metrics object Returns the current font scaling
8.48.2.13
oat PoDoFo::PdfFontMetrics::GetFontSize (
) const [inline]
Retrieve the current font size of this metrics object Returns the current font size
8.48.2.14 Returns
EPdfFontType PoDoFo::PdfFontMetrics::GetFontType ( [inline]
) const
the fonttype of the loaded font
8.48.2.15
virtual long PoDoFo::PdfFontMetrics::GetGlyphId ( long lUnicode ) const [pure virtual]
Get the glyph id for a unicode character in the current font. Parameters lUnicode the unicode character value Returns the glyhph id for the character or 0 if the glyph was not found.
8.48 PoDoFo::PdfFontMetrics Class Reference 8.48.2.16 virtual double PoDoFo::PdfFontMetrics::GetGlyphWidth ( int nGlyphId ) const [pure virtual]
199
Get the width of a single glyph id Parameters nGlyphId id of the glyph Returns the width of a single glyph id
8.48.2.17
virtual double PoDoFo::PdfFontMetrics::GetGlyphWidth ( const char pszGlyphname ) const [pure virtual]
Get the width of a single named glyph Parameters pszGlyphname name of the glyph Returns the width of a single named glyph
8.48.2.18
virtual int PoDoFo::PdfFontMetrics::GetItalicAngle ( [pure virtual]
) const
Get the italic angle of this font. Used to build the font dictionay Returns the italic angle of this font.
8.48.2.19
virtual double PoDoFo::PdfFontMetrics::GetLineSpacing ( [pure virtual]
) const
Retrieve the line spacing for this font Returns the linespacing in PDF units
200 8.48.2.20
Class Documentation unsigned long PoDoFo::PdfFontMetrics::GetLineSpacingMM ( const [inline] )
Retrieve the line spacing for this font Returns the linespacing in 1/1000th mm
8.48.2.21
virtual double PoDoFo::PdfFontMetrics::GetPdfAscent ( [pure virtual]
) const
Get the ascent of this font Used to build the font dictionay Returns the ascender for this font See also GetAscent
8.48.2.22
virtual double PoDoFo::PdfFontMetrics::GetPdfDescent ( [pure virtual]
) const
Get the descent of this font Used to build the font dictionay Returns the descender for this font See also GetDescent
8.48.2.23
virtual double PoDoFo::PdfFontMetrics::GetStrikeOutPosition ( const [pure virtual]
Return the position of the strikeout for the current font size in PDF units Returns the underline position in PDF units
8.48.2.24
unsigned long PoDoFo::PdfFontMetrics::GetStrikeOutPositionMM ( ) const [inline]
Return the position of the strikeout for the current font size in 1/1000th mm
8.48 PoDoFo::PdfFontMetrics Class Reference Returns the underline position in 1/1000th mm
201
8.48.2.25
virtual double PoDoFo::PdfFontMetrics::GetStrikeoutThickness ( const [pure virtual]
Get the width of the strikeout for the current font size in PDF units Returns the thickness of the strikeout in PDF units
8.48.2.26
unsigned long PoDoFo::PdfFontMetrics::GetStrikeoutThicknessMM ( ) const [inline]
Get the width of the strikeout for the current font size in 1/1000th mm Returns the thickness of the strikeout in 1/1000th mm
8.48.2.27
const char PoDoFo::PdfFontMetrics::GetSubsetFontnamePrex ( ) const [inline]
Returns NULL or a 6 uppercase letter and "+" sign prex used for font subsets
8.48.2.28
virtual double PoDoFo::PdfFontMetrics::GetUnderlinePosition ( const [pure virtual]
Return the position of the underline for the current font size in PDF units Returns the underline position in PDF units
8.48.2.29
long PoDoFo::PdfFontMetrics::GetUnderlinePositionMM ( [inline]
) const
Return the position of the underline for the current font size in 1/1000th mm Returns the underline position in 1/1000th mm
202 8.48.2.30
Class Documentation virtual double PoDoFo::PdfFontMetrics::GetUnderlineThickness ( ) const [pure virtual]
Get the width of the underline for the current font size in PDF units Returns the thickness of the underline in PDF units
8.48.2.31
unsigned long PoDoFo::PdfFontMetrics::GetUnderlineThicknessMM ( ) const [inline]
Get the width of the underline for the current font size in 1/1000th mm Returns the thickness of the underline in 1/1000th mm
8.48.2.32
virtual unsigned int PoDoFo::PdfFontMetrics::GetWeight ( [pure virtual]
) const
Get the weight of this font. Used to build the font dictionay Returns the weight of this font (500 is normal).
8.48.2.33
virtual void PoDoFo::PdfFontMetrics::GetWidthArray ( PdfVariant & var, unsigned int nFirst, unsigned int nLast ) const [pure virtual]
Create a width array for this font which is a required part of every font dictionary. Parameters var the nal width array is written to this PdfVariant nFirst rst character to be in the array nLast last character code to be in the array
8.48.2.34
virtual bool PoDoFo::PdfFontMetrics::IsSymbol ( virtual]
) const [pure
Symbol fonts do need special treatment in a few cases. Use this method to check if the current font is a symbol font. Symbold fonts are detected by checking if they use FT_ENCODING_MS_SYMBOL as internal encoding. Returns true if this is a symbol font
8.48 PoDoFo::PdfFontMetrics Class Reference 8.48.2.35 void PoDoFo::PdfFontMetrics::SetFontCharSpace ( oat fCharSpace ) [inline]
203
Set the character spacing of this metrics object Parameters fCharSpace character spacing in percent
8.48.2.36
void PoDoFo::PdfFontMetrics::SetFontScale ( oat fScale ) [inline]
Set the horizontal scaling of the font for compressing (< 100) and expanding (>100) This is typically called from PdfFont for you. Parameters fScale scaling in percent
8.48.2.37
void PoDoFo::PdfFontMetrics::SetFontSize ( oat fSize ) [inline]
Set the font size of this metrics object for width and height calculations. This is typically called from PdfFont for you. Parameters fSize font size in points
8.48.2.38
void PoDoFo::PdfFontMetrics::SetFontType ( EPdfFontType eFontType ) [inline, protected]
Set the fonttype. Parameters eFontType fonttype
8.48.2.39
double PoDoFo::PdfFontMetrics::StringWidth ( const pdf_utf16be pszText, unsigned int nLength = 0 ) const
Retrieve the width of a given text string in PDF units when drawn with the current font Parameters pszText a text string of which the width should be calculated
204
Class Documentation nLength if != 0 only the width of the nLength rst characters is calculated
Returns the width in PDF units
8.48.2.40
double PoDoFo::PdfFontMetrics::StringWidth ( const char pszText, pdf_long nLength = 0 ) const
Retrieve the width of a given text string in PDF units when drawn with the current font Parameters pszText a text string of which the width should be calculated nLength if != 0 only the width of the nLength rst characters is calculated Returns the width in PDF units
8.48.2.41
double PoDoFo::PdfFontMetrics::StringWidth ( const PdfString & rsString ) const [inline]
Retrieve the width of a given text string in PDF units when drawn with the current font Parameters rsString a PdfString from which the width shall be calculated Returns the width in PDF units This is an overloaded method for your convinience! 8.48.2.42 double PoDoFo::PdfFontMetrics::StringWidth ( const wchar_t pszText, unsigned int nLength = 0 ) const
Retrieve the width of a given text string in PDF units when drawn with the current font Parameters pszText a text string of which the width should be calculated nLength if != 0 only the width of the nLength rst characters is calculated Returns the width in PDF units
8.48 PoDoFo::PdfFontMetrics Class Reference 8.48.2.43
205
unsigned long PoDoFo::PdfFontMetrics::StringWidthMM ( const wchar_t pszText, unsigned int nLength = 0 ) const [inline]
Retrieve the width of a given text string in 1/1000th mm when drawn with the current font Parameters pszText a text string of which the width should be calculated nLength if != 0 only the width of the nLength rst characters is calculated Returns the width in 1/1000th mm
8.48.2.44
unsigned long PoDoFo::PdfFontMetrics::StringWidthMM ( const char pszText, unsigned int nLength = 0 ) const [inline]
8.48.2.45
unsigned long PoDoFo::PdfFontMetrics::StringWidthMM ( const pdf_utf16be pszText, unsigned int nLength = 0 ) const [inline]
206 8.48.2.46
Class Documentation virtual double PoDoFo::PdfFontMetrics::UnicodeCharWidth ( unsigned short c ) const [pure virtual]
Retrieve the width of the given character in PDF units in the current font Parameters c character Returns the width in PDF units
8.49
PoDoFo::PdfFontSimple Class Reference
#include <PdfFontSimple.h> Inheritance diagram for PoDoFo::PdfFontSimple:

PoDoFo::PdfElement PoDoFo::PdfFont PoDoFo::PdfFontSimple PoDoFo::PdfFontTrueType PoDoFo::PdfFontType1 PoDoFo::PdfFontType1Base14

PdfFontSimple (PdfFontMetrics pMetrics, const PdfEncoding const pEncoding, PdfVecObjects pParent) PdfFontSimple (PdfFontMetrics pMetrics, const PdfEncoding const pEncoding, PdfObject pObject) virtual void EmbedFont ()

void Init (bool bEmbed, const PdfName &rsSubType) virtual void EmbedFontFile (PdfObject pDescriptor)=0
8.49.1
This is a common base class for simple fonts like truetype or type1 fonts.
8.49 PoDoFo::PdfFontSimple Class Reference
207
8.49.2
8.49.2.1

PoDoFo::PdfFontSimple::PdfFontSimple ( PdfFontMetrics pMetrics, const PdfEncoding const pEncoding, PdfVecObjects pParent )
Create a new PdfFont object which will introduce itself automatically to every page object it is used on. The font has a default font size of 12.0pt. Parameters pMetrics pointer to a font metrics object. The font in the PDF le will match this fontmetrics object. The metrics object is deleted along with the font. pEncoding the encoding of this font. The encoding will be owned by this font and will be deleted along with it. pParent parent of the font object
8.49.2.2
PoDoFo::PdfFontSimple::PdfFontSimple ( PdfFontMetrics pMetrics, const PdfEncoding const pEncoding, PdfObject pObject )
Create a PdfFont based on an existing PdfObject Parameters pMetrics pointer to a font metrics object. The font in the PDF le will match this fontmetrics object. The metrics object is deleted along with the font. pEncoding the encoding of this font. The encoding will be owned by this font and will be deleted along with it. pObject an existing PdfObject
8.49.3
8.49.3.1

void PoDoFo::PdfFontSimple::EmbedFont ( ) [virtual]
Embeds the font into PDF page Reimplemented from PoDoFo::PdfFont. 8.49.3.2 virtual void PoDoFo::PdfFontSimple::EmbedFontFile ( PdfObject pDescriptor ) [protected, pure virtual]
Embed the font le directly into the PDF le. Parameters pDescriptor font descriptor object
208
Class Documentation
Implemented in PoDoFo::PdfFontType1, and PoDoFo::PdfFontType1Base14.
8.49.3.3
void PoDoFo::PdfFontSimple::Init ( bool bEmbed, const PdfName & rsSubType ) [protected]
Initialize this font object. Parameters bEmbed if true embed the font data into the PDF le. rsSubType the subtype of the real font.
8.50
PoDoFo::PdfFontTrueType Class Reference
#include <PdfFontTrueType.h> Inheritance diagram for PoDoFo::PdfFontTrueType:

PoDoFo::PdfElement PoDoFo::PdfFont PoDoFo::PdfFontSimple PoDoFo::PdfFontTrueType

PdfFontTrueType (PdfFontMetrics pMetrics, const PdfEncoding const pEncoding, PdfVecObjects pParent, bool bEmbed) PdfFontTrueType (PdfFontMetrics pMetrics, const PdfEncoding const pEncoding, PdfObject pObject)
8.50.1
A PdfFont implementation that can be used to embedd truetype fonts into a PDF le or to draw with truetype fonts. TrueType fonts are always embedded as suggested in the PDF reference.
8.51 PoDoFo::PdfFontTTFSubset Class Reference
209
8.50.2
8.50.2.1

PoDoFo::PdfFontTrueType::PdfFontTrueType ( PdfFontMetrics pMetrics, const PdfEncoding const pEncoding, PdfVecObjects pParent, bool bEmbed )
Create a new TrueType font. It will get embedded automatically. Parameters pMetrics pointer to a font metrics object. The font in the PDF le will match this fontmetrics object. The metrics object is deleted along with the font. pEncoding the encoding of this font. The font will not take ownership of this object. pParent parent of the font object bEmbed if true the font will get embedded.
8.50.2.2
PoDoFo::PdfFontTrueType::PdfFontTrueType ( PdfFontMetrics pMetrics, const PdfEncoding const pEncoding, PdfObject pObject )
8.51
PoDoFo::PdfFontTTFSubset Class Reference
#include <PdfFontTTFSubset.h>
Public Types
enum EFontFileType { eFontFileType_TTF, eFontFileType_OTF, eFontFileType_Unknown } eFontFileType_TTC,

PdfFontTTFSubset (const char pszFontFileName, PdfFontMetrics pMetrics, unsigned short nFaceIndex=0)
210
Class Documentation PdfFontTTFSubset (PdfInputDevice pDevice, PdfFontMetrics pMetrics, EFontFileType eType, unsigned short nFaceIndex=0) void BuildFont (PdfOutputDevice pOutputDevice) void AddGlyph (unsigned short nGlyphIndex) void AddCharacter (pdf_utf16be nCharCode) size_t GetSize () const
8.51.1
This class is able to build a new TTF font with only certain glyphs from an existing font.
8.51.2
8.51.2.1

enum PoDoFo::PdfFontTTFSubset::EFontFileType
Internal enum specifying the type of a fontle. Enumerator: eFontFileType_TTF TrueType Font. eFontFileType_TTC TrueType Collection. eFontFileType_OTF OpenType Font. eFontFileType_Unknown Unknown.
8.51.3
8.51.3.1

PoDoFo::PdfFontTTFSubset::PdfFontTTFSubset ( const char pszFontFileName, PdfFontMetrics pMetrics, unsigned short nFaceIndex = 0 )
Create a new PdfFontTTFSubset from an existing TTF font le. Parameters pszFontFileName path to a TTF le pMetrics font metrics object for this font nFaceIndex index of the face inside of the font
8.51.3.2
PoDoFo::PdfFontTTFSubset::PdfFontTTFSubset ( PdfInputDevice pDevice, PdfFontMetrics pMetrics, EFontFileType eType, unsigned short nFaceIndex = 0 )
Create a new PdfFontTTFSubset from an existing TTF font le using an input device.
8.51 PoDoFo::PdfFontTTFSubset Class Reference Parameters pDevice a PdfInputDevice pMetrics font metrics object for this font eType the type of the font nFaceIndex index of the face inside of the font
211
8.51.4
8.51.4.1

void PoDoFo::PdfFontTTFSubset::AddCharacter ( pdf_utf16be nCharCode ) [inline]
Add an unicode character to the subset Parameters nCharCode unicode character code
8.51.4.2
void PoDoFo::PdfFontTTFSubset::AddGlyph ( unsigned short nGlyphIndex )
Add a new glyph index to the subset. Parameters nGlyphIndex include this glyph in the nal font Already existing values are ignored, so that every glyph can be added only once. 8.51.4.3 void PoDoFo::PdfFontTTFSubset::BuildFont ( PdfOutputDevice pOutputDevice )
Actually generate the subsetted font Parameters pOutputDevice write the font to this device
8.51.4.4
size_t PoDoFo::PdfFontTTFSubset::GetSize (
) const [inline]
Get the number of glyphs in this font. Returns the number of glyphs in this font.
212
Class Documentation
8.52
PoDoFo::PdfFontType1 Class Reference
#include <PdfFontType1.h> Inheritance diagram for PoDoFo::PdfFontType1:

PoDoFo::PdfElement PoDoFo::PdfFont PoDoFo::PdfFontSimple PoDoFo::PdfFontType1

PdfFontType1 (PdfFontMetrics pMetrics, const PdfEncoding const pEncoding, PdfVecObjects pParent, bool bEmbed) PdfFontType1 (PdfFontMetrics pMetrics, const PdfEncoding const pEncoding, PdfObject pObject) PdfFontType1 (PdfFontType1 pFont, PdfFontMetrics pMetrics, const char pszSufx, PdfVecObjects pParent)

virtual void AddUsedSubsettingGlyphs (const PdfString &sText, lStringLen) virtual void AddUsedGlyphname (const char sGlyphName) virtual void EmbedSubsetFont () virtual void EmbedFontFile (PdfObject pDescriptor) long
8.52.1
A PdfFont implementation that can be used to embedd type1 fonts into a PDF le or to draw with type1 fonts.
8.52.2
8.52.2.1

PoDoFo::PdfFontType1::PdfFontType1 ( PdfFontMetrics pMetrics, const PdfEncoding const pEncoding, PdfVecObjects pParent, bool bEmbed )
Create a new Type1 font object.

8.52 PoDoFo::PdfFontType1 Class Reference Parameters
213
pMetrics pointer to a font metrics object. The font in the PDF le will match this fontmetrics object. The metrics object is deleted along with the font. pEncoding the encoding of this font. The font will not take ownership of this object. pParent parent of the font object bEmbed if true the font will get embedded.
8.52.2.2
PoDoFo::PdfFontType1::PdfFontType1 ( PdfFontMetrics pMetrics, const PdfEncoding const pEncoding, PdfObject pObject )
8.52.2.3
PoDoFo::PdfFontType1::PdfFontType1 ( PdfFontType1 pFont, PdfFontMetrics pMetrics, const char pszSufx, PdfVecObjects pParent )
Create a PdfFont based on an existing PdfFont with a new id Parameters pFont pointer to existing font pMetrics pointer to a font metrics object. The font in the PDF le will match this fontmetrics object. The metrics object is deleted along with the font. pszSufx Sufx to add to font-id pParent parent of the font object
8.52.3
8.52.3.1

void PoDoFo::PdfFontType1::AddUsedGlyphname ( const char sGlyphName ) [protected, virtual]
Remember the glyphname in case of subsetting Parameters sGlyphName Name of the glyph to remember Reimplemented from PoDoFo::PdfFont.
214 8.52.3.2
Class Documentation void PoDoFo::PdfFontType1::AddUsedSubsettingGlyphs ( const PdfString & sText, long lStringLen ) [protected, virtual]
Remember the glyphs used in the string in case of subsetting Parameters sText the text string which should be printed (is not allowed to be NULL!) lStringLen draw only lLen characters of pszText Reimplemented from PoDoFo::PdfFont. void PoDoFo::PdfFontType1::EmbedFontFile ( PdfObject pDescriptor ) [protected, virtual]
8.52.3.3
Embed the font le directly into the PDF le. Parameters pDescriptor font descriptor object Implements PoDoFo::PdfFontSimple.
8.52.3.4
void PoDoFo::PdfFontType1::EmbedSubsetFont ( virtual]
) [protected,
Embeds pending subset-font into PDF page Reimplemented from PoDoFo::PdfFont.
8.53
PoDoFo::PdfFontType1Base14 Class Reference
#include <PdfFontType1Base14.h> Inheritance diagram for PoDoFo::PdfFontType1Base14:

PoDoFo::PdfElement PoDoFo::PdfFont PoDoFo::PdfFontSimple PoDoFo::PdfFontType1Base14
8.53 PoDoFo::PdfFontType1Base14 Class Reference
215

PdfFontType1Base14 (PdfFontMetrics pMetrics, const PdfEncoding const pEncoding, PdfVecObjects pParent) PdfFontType1Base14 (PdfFontMetrics pMetrics, const PdfEncoding const pEncoding, PdfObject pObject)

virtual void EmbedFontFile (PdfObject pDescriptor)
8.53.1
A PdfFont implementation that can be used draw with base14 type1 fonts into a PDF le.
8.53.2
8.53.2.1

PoDoFo::PdfFontType1Base14::PdfFontType1Base14 ( PdfFontMetrics pMetrics, const PdfEncoding const pEncoding, PdfVecObjects pParent )
Create a new Type1 font object. Parameters pMetrics pointer to a font metrics object. The font in the PDF le will match this fontmetrics object. The metrics object is deleted along with the font. pEncoding the encoding of this font. The font will not take ownership of this object. pParent parent of the font object
8.53.2.2
PoDoFo::PdfFontType1Base14::PdfFontType1Base14 ( PdfFontMetrics pMetrics, const PdfEncoding const pEncoding, PdfObject pObject )
Create a new Type1 font object based on an existing PdfObject Parameters pMetrics pointer to a font metrics object. The font in the PDF le will match this fontmetrics object. The metrics object is deleted along with the font. pEncoding the encoding of this font. The font will not take ownership of this object. pObject an existing PdfObject
216
Class Documentation
8.53.3
8.53.3.1

void PoDoFo::PdfFontType1Base14::EmbedFontFile ( PdfObject pDescriptor ) [protected, virtual]
Embed the font le directly into the PDF le. Parameters pDescriptor font descriptor object Implements PoDoFo::PdfFontSimple.
8.54
PoDoFo::PdfFunction Class Reference
#include <PdfFunction.h> Inheritance diagram for PoDoFo::PdfFunction:

PoDoFo::PdfElement PoDoFo::PdfFunction PoDoFo::PdfExponentialFunction PoDoFo::PdfSampledFunction PoDoFo::PdfStitchingFunction

PdfFunction (EPdfFunctionType eType, const PdfArray &rDomain, PdfVecObjects pParent) PdfFunction (EPdfFunctionType eType, const PdfArray &rDomain, PdfDocument pParent)
8.54.1
This class denes a PdfFunction. A function can be used in various ways in a PDF le. Examples are device dependent rasterization for high quality printing or color transformation functions for certain colorspaces.
8.54.2
8.54.2.1

PoDoFo::PdfFunction::PdfFunction ( EPdfFunctionType eType, const PdfArray & rDomain, PdfVecObjects pParent ) [protected]
Create a new PdfFunction object.

8.55 PoDoFo::PdfFunctionBaseShadingPattern Class Reference Parameters eType the function type
217
rDomain this array describes the input parameters of this PdfFunction. If this function has m input parameters, this array has to contain 2m numbers where each number describes either the lower or upper boundary of the input range. pParent parent vector of objects
8.54.2.2
PoDoFo::PdfFunction::PdfFunction ( EPdfFunctionType eType, const PdfArray & rDomain, PdfDocument pParent ) [protected]
Create a new PdfFunction object. Parameters eType the function type rDomain this array describes the input parameters of this PdfFunction. If this function has m input parameters, this array has to contain 2m numbers where each number describes either the lower or upper boundary of the input range. pParent parent document
8.55
PoDoFo::PdfFunctionBaseShadingPattern Class Reference
#include <PdfShadingPattern.h> Inheritance diagram for PoDoFo::PdfFunctionBaseShadingPattern:
PoDoFo::PdfElement PoDoFo::PdfShadingPattern PoDoFo::PdfFunctionBaseShadingPattern

PdfFunctionBaseShadingPattern (const PdfColor &rLL, const PdfColor &rUL, const PdfColor &rLR, const PdfColor &rUR, const PdfArray &rMatrix, PdfVecObjects pParent)
218
Class Documentation PdfFunctionBaseShadingPattern (const PdfColor &rLL, const PdfColor &rUL, const PdfColor &rLR, const PdfColor &rUR, const PdfArray &rMatrix, PdfDocument pParent)
8.55.1
A shading pattern that is an 2D shading between four colors.
8.55.2
8.55.2.1

PoDoFo::PdfFunctionBaseShadingPattern::PdfFunctionBaseShadingPattern ( const PdfColor & rLL, const PdfColor & rUL, const PdfColor & rLR, const PdfColor & rUR, const PdfArray & rMatrix, PdfVecObjects pParent )
Create an 2D shading pattern Parameters rLL the color on lower left corner rUL the color on upper left corner rLR the color on lower right corner rUR the color on upper right corner rMatrix the transformation matrix mapping the coordinate space specied by the Domain entry into the shadings target coordinate space pParent the parent
8.55.2.2
PoDoFo::PdfFunctionBaseShadingPattern::PdfFunctionBaseShadingPattern ( const PdfColor & rLL, const PdfColor & rUL, const PdfColor & rLR, const PdfColor & rUR, const PdfArray & rMatrix, PdfDocument pParent )
Create an 2D shading pattern Parameters rLL the color on lower left corner rUL the color on upper left corner rLR the color on lower right corner rUR the color on upper right corner rMatrix the transformation matrix mapping the coordinate space specied by the Domain entry into the shadings target coordinate space pParent the parent
8.56 PoDoFo::PdfHexFilter Class Reference
219
8.56
PoDoFo::PdfHexFilter Class Reference
#include <PdfFiltersPrivate.h> Inheritance diagram for PoDoFo::PdfHexFilter:
PoDoFo::PdfFilter
PoDoFo::PdfHexFilter

virtual bool CanEncode () const virtual void EncodeBlockImpl (const char pBuffer, pdf_long lLen) 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
8.56.1
The ascii hex lter.
8.56.2
8.56.2.1

void PoDoFo::PdfHexFilter::BeginDecodeImpl ( const PdfDictionary ) [virtual]
220 8.56.2.2 bool PoDoFo::PdfHexFilter::CanDecode ( virtual]
Check wether the decoding is implemented for this lter. Returns true if the lter is able to decode data Implements PoDoFo::PdfFilter. 8.56.2.3 bool PoDoFo::PdfHexFilter::CanEncode ( virtual] ) const [inline,
Check wether the encoding is implemented for this lter. Returns true if the lter is able to encode data Implements PoDoFo::PdfFilter. 8.56.2.4 void PoDoFo::PdfHexFilter::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 youre going to store it, as ownership is not transferred to the lter 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. 8.56.2.5 void PoDoFo::PdfHexFilter::EncodeBlockImpl ( const char pBuffer, pdf_long lLen ) [virtual]
8.57 PoDoFo::PdfIdentityEncoding Class Reference 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.
221
8.56.2.6
void PoDoFo::PdfHexFilter::EndDecodeImpl (
) [virtual]
Real implementation of EndDecode(). NEVER call this method directly. By the time this method returns, all ltered data must be written to the stream and the lter 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.
8.56.2.7
EPdfFilter PoDoFo::PdfHexFilter::GetType ( virtual]
) const [inline,
8.57
PoDoFo::PdfIdentityEncoding Class Reference
#include <PdfIdentityEncoding.h> Inheritance diagram for PoDoFo::PdfIdentityEncoding:

222
Class Documentation
PoDoFo::PdfEncoding PoDoFo::PdfIdentityEncoding

PdfIdentityEncoding (int nFirstChar=0, int nLastChar=0xffff, bool bAutoDelete=true) virtual void AddToDictionary (PdfDictionary &rDictionary) const virtual PdfString ConvertToUnicode (const PdfString &rEncodedString, const PdfFont pFont) const virtual PdfRefCountedBuffer ConvertToEncoding (const PdfString &rString, const PdfFont pFont) const virtual bool IsAutoDelete () const virtual bool IsSingleByteEncoding () const virtual pdf_utf16be GetCharCode (int nIndex) const

virtual const PdfName & GetID () const
8.57.1
PdfIdentityEncoding is a two-byte encoding which can be used with TrueType fonts to represent all characters present in a font. If the font contains all unicode glyphs, PdfIdentityEncoding will support all unicode characters.
8.57.2
8.57.2.1

PoDoFo::PdfIdentityEncoding::PdfIdentityEncoding ( int nFirstChar = 0, int nLastChar = 0xffff, bool bAutoDelete = true )
Create a new PdfIdentityEncoding. Parameters nFirstChar the rst supported unicode character code (at least 0) nLastChar the last supported unicode character code, must be larger than nFirstChar (max value is 0xffff) bAutoDelete if true the encoding is deleted by its owning font
8.57 PoDoFo::PdfIdentityEncoding Class Reference
223
8.57.3
8.57.3.1

void PoDoFo::PdfIdentityEncoding::AddToDictionary ( PdfDictionary & rDictionary ) const [virtual]
Add this encoding object to a dictionary usually be adding an /Encoding key in font dictionaries. Parameters rDictionary add the encoding to this dictionary Implements PoDoFo::PdfEncoding. 8.57.3.2 PdfRefCountedBuffer PoDoFo::PdfIdentityEncoding::ConvertToEncoding ( const PdfString & rString, const PdfFont pFont ) const [virtual]
Convert a unicode PdfString to a string encoded with this encoding. Parameters rString an unicode PdfString. pFont the font for which this string is converted Returns an encoded PdfRefCountedBuffer. The PdfRefCountedBuffer is treated as a series of bytes and is allowed to have 0 bytes. The returned buffer must not be a unicode string. Implements PoDoFo::PdfEncoding. 8.57.3.3 PdfString PoDoFo::PdfIdentityEncoding::ConvertToUnicode ( const PdfString & rEncodedString, const PdfFont pFont ) const [virtual]
Convert a string that is encoded with this encoding to an unicode PdfString. Parameters rEncodedString a string encoded by this encoding. Usually this string was read from a content stream. pFont the font for which this string is converted Returns an unicode PdfString. Implements PoDoFo::PdfEncoding.
224 8.57.3.4
Class Documentation pdf_utf16be PoDoFo::PdfIdentityEncoding::GetCharCode ( int nIndex ) const [virtual]
Get the unicode character code for this encoding at the position nIndex. nIndex is a position between GetFirstChar() and GetLastChar() Parameters nIndex character code at position index Returns unicode character code See also GetFirstChar GetLastChar Will throw an exception if nIndex is out of range. Implements PoDoFo::PdfEncoding. 8.57.3.5 const PdfName & PoDoFo::PdfIdentityEncoding::GetID ( [inline, protected, virtual] ) const
Get a unique ID for this encoding which can used for comparisons! Returns a unique id for this encoding! Implements PoDoFo::PdfEncoding. 8.57.3.6 bool PoDoFo::PdfIdentityEncoding::IsAutoDelete ( [inline, virtual] ) const
PdfIdentityEncoding is usually delete along with the font. Returns true if this encoding should be deleted automatically with the font. Implements PoDoFo::PdfEncoding. 8.57.3.7 Returns true if this is a single byte encoding with a maximum of 256 values. Implements PoDoFo::PdfEncoding.
bool PoDoFo::PdfIdentityEncoding::IsSingleByteEncoding ( [inline, virtual]
) const
8.58 PoDoFo::PdfImage Class Reference
225
8.58
PoDoFo::PdfImage Class Reference
#include <PdfImage.h> Inheritance diagram for PoDoFo::PdfImage:

PoDoFo::PdfElement PoDoFo::PdfCanvas
PoDoFo::PdfXObject PoDoFo::PdfImage

PdfImage (PdfVecObjects pParent, const char pszPrex=NULL) PdfImage (PdfDocument pParent, const char pszPrex=NULL) PdfImage (PdfObject pObject) void SetImageColorSpace (EPdfColorSpace eColorSpace) void SetImageICCProle (PdfInputStream pStream, long lColorComponents, EPdfColorSpace eAlternateColorSpace=ePdfColorSpace_DeviceRGB) void SetImageSoftmask (const PdfImage pSoftmask) double GetWidth () const double GetHeight () const void SetImageData (unsigned int nWidth, unsigned int nHeight, unsigned int nBitsPerComponent, PdfInputStream pStream) void SetImageData (unsigned int nWidth, unsigned int nHeight, unsigned int nBitsPerComponent, PdfInputStream pStream, const TVecFilters &vecFilters) void LoadFromFile (const char pszFilename) void SetImageChromaKeyMask (pdf_int64 r, pdf_int64 g, pdf_int64 b, pdf_int64 threshold=0) void SetInterpolate (bool bValue)

static const char GetSupportedFormats ()
8.58.1
A PdfImage object is needed when ever you want to embedd an image le into a PDF document. The PdfImage object is embedded once and can be drawn as often as you want on any page in the document using PdfPainter
226 See also GetImageReference PdfPainter::DrawImage SetImageData
Class Documentation
8.58.2
8.58.2.1

PoDoFo::PdfImage::PdfImage ( PdfVecObjects pParent, const char pszPrex = NULL )
Constuct a new PdfImage object Parameters pParent parent vector of this image pszPrex optional prex for XObject-name
8.58.2.2
PoDoFo::PdfImage::PdfImage ( PdfDocument pParent, const char pszPrex = NULL )
Constuct a new PdfImage object This is an overloaded constructor. Parameters pParent parent document pszPrex optional prex for XObject-name
8.58.2.3
PoDoFo::PdfImage::PdfImage ( PdfObject pObject )
Construct an image from an existing PdfObject Parameters pObject a PdfObject that has to be an image
8.58.3
8.58.3.1

double PoDoFo::PdfImage::GetHeight ( ) const [inline]
Get the height of the image when drawn in PDF units Returns the height in PDF units
8.58 PoDoFo::PdfImage Class Reference 8.58.3.2 const char PoDoFo::PdfImage::GetSupportedFormats ( [static] )
227
Get a list of all image formats supported by this PoDoFo build. Example: { "JPEG", "TIFF", NULL } Returns a zero terminates list of all supported image formats
8.58.3.3
double PoDoFo::PdfImage::GetWidth (
) const [inline]
Get the width of the image when drawn in PDF units Returns the width in PDF units
8.58.3.4
void PoDoFo::PdfImage::LoadFromFile ( const char pszFilename )
Load the image data from a le Parameters pszFilename
8.58.3.5
void PoDoFo::PdfImage::SetImageChromaKeyMask ( pdf_int64 r, pdf_int64 g, pdf_int64 b, pdf_int64 threshold = 0 )
Set an color/chroma-key mask on an image. The masked color will not be painted, i.e. masked as being transparent. Parameters r red RGB value of color that should be masked g green RGB value of color that should be masked b blue RGB value of color that should be masked threshold colors are masked that are in the range [(r-threshold, r+threshold),(gthreshold, g+threshold),(b-threshold, b+threshold)]
8.58.3.6
void PoDoFo::PdfImage::SetImageColorSpace ( EPdfColorSpace eColorSpace )
Set the color space of this image. The default value is ePdfColorSpace_DeviceRGB.
228 Parameters
Class Documentation
eColorSpace one of ePdfColorSpace_DeviceGray, ePdfColorSpace_DeviceRGB and ePdfColorSpace_DeviceCMYK See also SetImageICCProle to set an ICC prole instead of a simple colorspace
8.58.3.7
void PoDoFo::PdfImage::SetImageData ( unsigned int nWidth, unsigned int nHeight, unsigned int nBitsPerComponent, PdfInputStream pStream, const TVecFilters & vecFilters )
Set the actual image data from an input stream Parameters nWidth width of the image in pixels nHeight height of the image in pixels nBitsPerComponent bits per color component of the image (depends on the image colorspace you have set but is 8 in most cases) pStream stream supplieding raw image data vecFilters these lters will be applied to compress the image data
8.58.3.8
void PoDoFo::PdfImage::SetImageData ( unsigned int nWidth, unsigned int nHeight, unsigned int nBitsPerComponent, PdfInputStream pStream )
Set the actual image data from an input stream The image data will be ate compressed. If you want no compression or another lter to be applied use the overload of SetImageData which takes a TVecFilters as argument. Parameters nWidth width of the image in pixels nHeight height of the image in pixels nBitsPerComponent bits per color component of the image (depends on the image colorspace you have set but is 8 in most cases) pStream stream supplieding raw image data See also SetImageData
8.59 PoDoFo::PdfInfo Class Reference 8.58.3.9 void PoDoFo::PdfImage::SetImageICCProle ( PdfInputStream pStream, long lColorComponents, EPdfColorSpace eAlternateColorSpace = ePdfColorSpace_DeviceRGB )
229
Set an ICC prole for this image. Parameters pStream an input stream from which the ICC proles data can be read lColorComponents the number of colorcomponents of the ICC prole eAlternateColorSpace an alternate colorspace to use if the ICC prole cannot be used See also SetImageColorSpace to set an colorspace instead of an ICC prole for this image
8.58.3.10
void PoDoFo::PdfImage::SetImageSoftmask ( const PdfImage pSoftmask )
Set a softmask for this image. Parameters pSoftmask a PdfImage pointer to the image, which is to be set as softmask, must be 8-Bit-Grayscale
8.58.3.11
void PoDoFo::PdfImage::SetInterpolate ( bool bValue )
Apply an interpolation to the image if the source resolution is lower than the resolution of the output device. Default is false. Parameters bValue whether the image should be interpolated
8.59
PoDoFo::PdfInfo Class Reference
#include <PdfInfo.h> Inheritance diagram for PoDoFo::PdfInfo:
PoDoFo::PdfElement
PoDoFo::PdfInfo
230
Class Documentation
Public Types
enum EPdfInfoInitial { ePdfInfoInitial_WriteCreationTime = 0x01, ePdfInfoInitial_WriteModicationTime = 0x02, ePdfInfoInitial_WriteProducer = 0x04 }

PdfInfo (PdfVecObjects pParent, int WriteCreationTime|ePdfInfoInitial_WriteProducer) PdfInfo (PdfObject pObject, int WriteModicationTime) PdfInfo () void SetAuthor (const PdfString &sAuthor) const PdfString & GetAuthor () const void SetCreator (const PdfString &sCreator) const PdfString & GetCreator () const void SetKeywords (const PdfString &sKeywords) const PdfString & GetKeywords () const void SetSubject (const PdfString &sSubject) const PdfString & GetSubject () const void SetTitle (const PdfString &sTitle) const PdfString & GetTitle () const void SetProducer (const PdfString &sProducer) const PdfString & GetProducer () const void SetTrapped (const PdfName &sTrapped) const PdfName & GetTrapped () const eInitial=ePdfInfoInitial_eInitial=ePdfInfoInitial_-
8.59.1
This class provides access to the documents info dictionary, which provides information about the PDF document.
8.59.2
8.59.2.1

enum PoDoFo::PdfInfo::EPdfInfoInitial
Enum to speciy the initial information of the info dictionary. Enumerator: ePdfInfoInitial_WriteCreationTime Write the creation time (current time). Default for new documents. ePdfInfoInitial_WriteModicationTime Write the modication time (current time). Default for loaded documents. ePdfInfoInitial_WriteProducer Write producer key. Default for new documents.
8.59 PoDoFo::PdfInfo Class Reference
231
8.59.3
8.59.3.1

PoDoFo::PdfInfo::PdfInfo ( PdfVecObjects pParent, int eInitial = ePdfInfoInitial_WriteCreationTime | ePdfInfoInitial_WriteProducer )
Create a new PdfInfo object Parameters pParent the parent of this object eInitial which information should be writting initially to the information dictionary
8.59.3.2
PoDoFo::PdfInfo::PdfInfo ( PdfObject pObject, int eInitial = ePdfInfoInitial_WriteModificationTime )
Create a PdfInfo object from an existing object in the PDF le. Parameters pObject must be an info dictionary. eInitial which information should be writting initially to the information
8.59.3.3 Destructor
PoDoFo::PdfInfo::PdfInfo (
8.59.4
8.59.4.1

const PdfString & PoDoFo::PdfInfo::GetAuthor ( [inline] ) const
Get the author of the document Returns the author
8.59.4.2
const PdfString & PoDoFo::PdfInfo::GetCreator ( [inline]
) const
Get the creator of the document Returns the creator

232 8.59.4.3
Class Documentation const PdfString & PoDoFo::PdfInfo::GetKeywords ( [inline] ) const
Get the keywords of the document Returns the keywords
8.59.4.4
const PdfString & PoDoFo::PdfInfo::GetProducer ( [inline]
) const
Get the producer of the document Returns the producer
8.59.4.5
const PdfString & PoDoFo::PdfInfo::GetSubject ( [inline]
) const
Get the subject of the document Returns the subject
8.59.4.6
const PdfString & PoDoFo::PdfInfo::GetTitle (
) const [inline]
Get the title of the document Returns the title
8.59.4.7
const PdfName & PoDoFo::PdfInfo::GetTrapped ( [inline]
) const
Get the trapping state of the document Returns the title
8.59 PoDoFo::PdfInfo Class Reference 8.59.4.8 void PoDoFo::PdfInfo::SetAuthor ( const PdfString & sAuthor )
233
Set the author of the document. Parameters sAuthor author
8.59.4.9
void PoDoFo::PdfInfo::SetCreator ( const PdfString & sCreator )
Set the creator of the document. Typically the name of the application using the library. Parameters sCreator creator
8.59.4.10
void PoDoFo::PdfInfo::SetKeywords ( const PdfString & sKeywords )
Set keywords for this document Parameters sKeywords a list of keywords
8.59.4.11
void PoDoFo::PdfInfo::SetProducer ( const PdfString & sProducer )
Set the producer of the document. Parameters sProducer producer
8.59.4.12
void PoDoFo::PdfInfo::SetSubject ( const PdfString & sSubject )
Set the subject of the document. Parameters sSubject subject
8.59.4.13
void PoDoFo::PdfInfo::SetTitle ( const PdfString & sTitle )
Set the title of the document. Parameters sTitle title

234 8.59.4.14
Class Documentation void PoDoFo::PdfInfo::SetTrapped ( const PdfName & sTrapped )
Set the trapping state of the document. Parameters sTrapped trapped
8.60
PoDoFo::PdfInputDevice Class Reference
#include <PdfInputDevice.h>

PdfInputDevice (const char pszFilename) PdfInputDevice (const char pBuffer, size_t lLen) PdfInputDevice (const std::istream pInStream) virtual PdfInputDevice () virtual void Close () virtual std::streamoff Tell () const virtual int GetChar () const virtual int Look () const virtual void Seek (std::streamoff off, std::ios_base::seekdir dir=std::ios_base::beg) virtual std::streamoff Read (char pBuffer, std::streamsize lLen) virtual PODOFO_NOTHROW bool Eof () const virtual PODOFO_NOTHROW bool Bad () const virtual PODOFO_NOTHROW void Clear (std::ios_base::iostate state=std::ios_base::goodbit) const PODOFO_NOTHROW bool IsSeekable () const

PODOFO_NOTHROW void SetSeekable (bool bIsSeekable) PdfInputDevice ()
8.60.1
This class provides an Input device which operates either on a le, a buffer in memory or any arbitrary std::istream This class is suitable for inheritance to provide input devices of your own for PoDoFo. Just overide the required virtual methods.
8.60 PoDoFo::PdfInputDevice Class Reference
235
8.60.2
8.60.2.1

PoDoFo::PdfInputDevice::PdfInputDevice ( const char pszFilename )
Construct a new PdfInputDevice that reads all data from a le. Parameters pszFilename path to a le that will be opened and all data is read from this le.
8.60.2.2
PoDoFo::PdfInputDevice::PdfInputDevice ( const char pBuffer, size_t lLen )
Construct a new PdfInputDevice that reads all data from a memory buffer. The buffer will not be owned by this object - it is COPIED. Parameters pBuffer a buffer in memory lLen the length of the buffer in memory
8.60.2.3
PoDoFo::PdfInputDevice::PdfInputDevice ( const std::istream pInStream )
Construct a new PdfInputDevice that reads all data from a std::istream. Parameters pInStream read from this std::istream
8.60.2.4
PoDoFo::PdfInputDevice::PdfInputDevice (
) [virtual]
Destruct the PdfInputDevice object and close any open les. 8.60.2.5 PoDoFo::PdfInputDevice::PdfInputDevice ( ) [protected]
CAN NOT Construct a new PdfInputDevice without an input source. However subclasses may well need to do just that.
8.60.3
8.60.3.1 Returns

bool PoDoFo::PdfInputDevice::Bad ( virtual] ) const [inline,
True if there was an error in an I/O operation

236 8.60.3.2
Class Documentation void PoDoFo::PdfInputDevice::Clear ( std::ios_base::iostate state = std::ios_base::goodbit ) const [inline, virtual]
Set the stream error state. By default, clears badbit, eofbit and failbit. 8.60.3.3 void PoDoFo::PdfInputDevice::Close ( ) [virtual]
Close the input device. No further operations may be performed on this device after calling this function. 8.60.3.4 Returns True if the stream is at EOF bool PoDoFo::PdfInputDevice::Eof ( virtual] ) const [inline,
8.60.3.5
int PoDoFo::PdfInputDevice::GetChar (
) const [virtual]
Get next char from stream. Returns the next character from the stream
8.60.3.6 Returns
bool PoDoFo::PdfInputDevice::IsSeekable (
) const [inline]
True if the stream is seekable. Subclasses can control this value with SetIsSeekable(bool) .
8.60.3.7
int PoDoFo::PdfInputDevice::Look (
) const [virtual]
Peek at next char in stream. /returns the next char in the stream 8.60.3.8 std::streamoff PoDoFo::PdfInputDevice::Read ( char pBuffer, std::streamsize lLen ) [virtual]
Read a certain number of bytes from the input device. Parameters pBuffer store bytes in this buffer. The buffer has to be large enough. lLen number of bytes to read.
8.61 PoDoFo::PdfInputStream Class Reference Returns
237
the number of bytes that have been read. If reading was successfull the number of read bytes is equal to lLen.
8.60.3.9
void PoDoFo::PdfInputDevice::Seek ( std::streamoff off, std::ios_base::seekdir dir = std::ios_base::beg ) [virtual]
Seek the device to the position offset from the begining Parameters off from the beginning of the le dir where to start (start, cur, end) A non-seekable input device will throw an InvalidDeviceOperation. 8.60.3.10 void PoDoFo::PdfInputDevice::SetSeekable ( bool bIsSeekable ) [inline, protected]
Control whether or or not this stream is agged seekable. 8.60.3.11 std::streamoff PoDoFo::PdfInputDevice::Tell ( [virtual] ) const
Get the current position in le. /returns the current position in the le
8.61
PoDoFo::PdfInputStream Class Reference
#include <PdfInputStream.h> Inheritance diagram for PoDoFo::PdfInputStream:

PoDoFo::PdfInputStream PoDoFo::PdfDeviceInputStream PoDoFo::PdfFileInputStream PoDoFo::PdfMemoryInputStream PoDoFo::PdfRC4InputStream

virtual pdf_long Read (char pBuffer, pdf_long lLen)=0
8.61.1
An interface for reading blocks of data from an a data source.

238
Class Documentation
8.61.2
8.61.2.1

virtual pdf_long PoDoFo::PdfInputStream::Read ( char pBuffer, pdf_long lLen ) [pure virtual]
Read data from the input stream Parameters pBuffer the data will be stored into this buffer lLen the size of the buffer and number of bytes that will be read Returns the number of bytes read, -1 if an error ocurred and zero if no more bytes are available for reading. Implemented in PoDoFo::PdfRC4InputStream, PoDoFo::PdfFileInputStream, PoDoFo::PdfMemoryInputStream, and PoDoFo::PdfDeviceInputStream.
8.62
PoDoFo::PdfListBox Class Reference
#include <PdfField.h> Inheritance diagram for PoDoFo::PdfListBox:
PoDoFo::PdfListBox

PdfListBox (PdfAnnotation pWidget, PdfAcroForm pParent) PdfListBox (PdfPage pPage, const PdfRect &rRect, PdfAcroForm pParent) PdfListBox (PdfPage pPage, const PdfRect &rRect, PdfDocument pDoc) PdfListBox (PdfPage pPage, const PdfRect &rRect, PdfStreamedDocument pDoc) PdfListBox (const PdfField &rhs)
8.62.1
A list box
8.63 PoDoFo::PdfListField Class Reference
239
8.62.2
8.62.2.1

PoDoFo::PdfListBox::PdfListBox ( PdfAnnotation pWidget, PdfAcroForm pParent )
Create a new PdfTextField
8.62.2.2
PoDoFo::PdfListBox::PdfListBox ( PdfPage pPage, const PdfRect & rRect, PdfAcroForm pParent )
8.62.2.3
PoDoFo::PdfListBox::PdfListBox ( PdfPage pPage, const PdfRect & rRect, PdfDocument pDoc )
8.62.2.4
PoDoFo::PdfListBox::PdfListBox ( PdfPage pPage, const PdfRect & rRect, PdfStreamedDocument pDoc )
8.62.2.5
PoDoFo::PdfListBox::PdfListBox ( const PdfField & rhs )
Create a PdfListBox from a PdfField Parameters rhs a PdfField that is a PdfComboBox Raises an error if PdfField::GetType() != ePdfField_ListBox
8.63
PoDoFo::PdfListField Class Reference
#include <PdfField.h> Inheritance diagram for PoDoFo::PdfListField:
PoDoFo::PdfComboBox
PoDoFo::PdfListBox
240
Class Documentation

PdfListField (const PdfField &rhs) void InsertItem (const PdfString &rsValue, const PdfString &rsDisplayName=PdfString::StringNull) void RemoveItem (int nIndex) const PdfString GetItem (int nIndex) const const PdfString GetItemDisplayText (int nIndex) const size_t GetItemCount () const void SetSelectedItem (int nIndex) int GetSelectedItem () const bool IsComboBox () const void SetSpellcheckingEnabled (bool bSpellcheck) bool IsSpellcheckingEnabled () const void SetSorted (bool bSorted) bool IsSorted () const void SetMultiSelect (bool bMulti) bool IsMultiSelect () const

PdfListField (EPdfField eField, PdfAnnotation pWidget, PdfAcroForm pParent) PdfListField (EPdfField eField, PdfPage pPage, const PdfRect &rRect, PdfAcroForm pParent) PdfListField (EPdfField eField, PdfPage pPage, const PdfRect &rRect, PdfDocument pDoc) PdfListField (EPdfField eField, PdfPage pPage, const PdfRect &rRect, PdfStreamedDocument pDoc)
8.63.1
A list of items in a PDF le. You cannot create this object directly, use PdfComboBox or PdfListBox instead. See also PdfComboBox PdfListBox
8.63.2
8.63.2.1

PoDoFo::PdfListField::PdfListField ( EPdfField eField, PdfAnnotation pWidget, PdfAcroForm pParent ) [protected]

8.63 PoDoFo::PdfListField Class Reference 8.63.2.2 PoDoFo::PdfListField::PdfListField ( EPdfField eField, PdfPage pPage, const PdfRect & rRect, PdfAcroForm pParent ) [protected]
241
8.63.2.3
PoDoFo::PdfListField::PdfListField ( EPdfField eField, PdfPage pPage, const PdfRect & rRect, PdfDocument pDoc ) [protected]
8.63.2.4
PoDoFo::PdfListField::PdfListField ( EPdfField eField, PdfPage pPage, const PdfRect & rRect, PdfStreamedDocument pDoc ) [protected]
8.63.2.5
PoDoFo::PdfListField::PdfListField ( const PdfField & rhs )
Create a PdfListField from a PdfField Parameters rhs a PdfField that is a list eld Internal usage only.
8.63.3
8.63.3.1

const PdfString PoDoFo::PdfListField::GetItem ( int nIndex ) const
Parameters nIndex index of the item Returns the value of the item at the specied index
8.63.3.2 Returns
size_t PoDoFo::PdfListField::GetItemCount (
) const
the number of items in this list
242 8.63.3.3
Class Documentation const PdfString PoDoFo::PdfListField::GetItemDisplayText ( int nIndex ) const
Parameters nIndex index of the item Returns the display text of the item or if it has no display text its value is returned. This call is equivalent to GetItem() in this case See also GetItem
8.63.3.4
int PoDoFo::PdfListField::GetSelectedItem (
) const
Sets the currently selected item Returns the selected item or -1 if no item was selected
8.63.3.5
void PoDoFo::PdfListField::InsertItem ( const PdfString & rsValue, const PdfString & rsDisplayName = PdfString::StringNull )
Inserts a new item into the list Parameters rsValue the value of the item rsDisplayName an optional display string that is displayed in the viewer instead of the value
8.63.3.6 Returns
bool PoDoFo::PdfListField::IsComboBox (
) const [inline]
true if this PdfListField is a PdfComboBox and false if it is a PdfListBox
8.63.3.7 Returns
bool PoDoFo::PdfListField::IsMultiSelect (
) const [inline]
true if multi selection is enabled for this list
8.63 PoDoFo::PdfListField Class Reference 8.63.3.8 Returns true if sorting is enabled bool PoDoFo::PdfListField::IsSorted ( ) const [inline]
243
8.63.3.9 Returns
bool PoDoFo::PdfListField::IsSpellcheckingEnabled ( [inline]
) const
true if spellchecking is enabled for this combobox
8.63.3.10
void PoDoFo::PdfListField::RemoveItem ( int nIndex )
Removes an item for the list Parameters nIndex index of the item to remove
8.63.3.11
void PoDoFo::PdfListField::SetMultiSelect ( bool bMulti ) [inline]
Sets wether multiple items can be selected by the user in the list. Parameters bMulti if true multiselect will be enabled By default multiselection is turned off. 8.63.3.12 void PoDoFo::PdfListField::SetSelectedItem ( int nIndex )
Sets the currently selected item Parameters nIndex index of the currently selected item
8.63.3.13
void PoDoFo::PdfListField::SetSorted ( bool bSorted ) [inline]
Enable or disable sorting of items. The sorting does not happen in acrobat reader but whenever adding items using PoDoFo or another PDF editing application. Parameters bSorted enable/disable sorting
244 8.63.3.14
Class Documentation void PoDoFo::PdfListField::SetSpellcheckingEnabled ( bool bSpellcheck ) [inline]
Enable/disable spellchecking for this combobox Parameters bSpellcheck if true spellchecking will be enabled combobox are spellchecked by default
8.64
PoDoFo::PdfLZWFilter Class Reference
#include <PdfFiltersPrivate.h> Inheritance diagram for PoDoFo::PdfLZWFilter:
PoDoFo::PdfFilter
PoDoFo::PdfLZWFilter

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
8.64.1
The LZW lter.
8.64.2
8.64.2.1

void PoDoFo::PdfLZWFilter::BeginDecodeImpl ( const PdfDictionary pDecodeParms ) [virtual]
Real implementation of BeginDecode(). NEVER call this method directly.

8.64 PoDoFo::PdfLZWFilter Class Reference
245
By default this function does nothing. If your lter 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.
8.64.2.2
void PoDoFo::PdfLZWFilter::BeginEncodeImpl (
) [virtual]
8.64.2.3
bool PoDoFo::PdfLZWFilter::CanDecode ( virtual]
) const [inline,
Check wether the decoding is implemented for this lter. Returns true if the lter is able to decode data Implements PoDoFo::PdfFilter.
8.64.2.4
bool PoDoFo::PdfLZWFilter::CanEncode ( virtual]
) const [inline,
Check wether the encoding is implemented for this lter. Returns true if the lter is able to encode data Implements PoDoFo::PdfFilter.
246 8.64.2.5
Class Documentation 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 youre going to store it, as ownership is not transferred to the lter 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. 8.64.2.6 void PoDoFo::PdfLZWFilter::EncodeBlockImpl ( const char pBuffer, pdf_long lLen ) [virtual]
Encode a block of data and write it to the PdfOutputStream specied 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. 8.64.2.7 void PoDoFo::PdfLZWFilter::EndDecodeImpl ( ) [virtual]
Real implementation of EndDecode(). NEVER call this method directly. By the time this method returns, all ltered data must be written to the stream and the lter 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.
8.65 PoDoFo::PdfMacRomanEncoding Class Reference See also EndDecode Reimplemented from PoDoFo::PdfFilter. 8.64.2.8 void PoDoFo::PdfLZWFilter::EndEncodeImpl ( ) [virtual]
247
Finish encoding of data. See also BeginEncodeImpl EncodeBlockImpl Reimplemented from PoDoFo::PdfFilter. 8.64.2.9 EPdfFilter PoDoFo::PdfLZWFilter::GetType ( virtual] ) const [inline,
8.65
PoDoFo::PdfMacRomanEncoding Class Reference
#include <PdfEncoding.h> Inheritance diagram for PoDoFo::PdfMacRomanEncoding:
PoDoFo::PdfEncoding PoDoFo::PdfSimpleEncoding PoDoFo::PdfMacRomanEncoding

PdfMacRomanEncoding ()
248
Class Documentation

8.65.1
Do not allocate this class yourself, as allocations might be expensive. Try using PdfFont::MacRomanEncoding. See also PdfFont::MacRomanEncoding
8.65.2
8.65.2.1

PoDoFo::PdfMacRomanEncoding::PdfMacRomanEncoding ( [inline] )
Create a new PdfMacRomanEncoding
8.65.3
8.65.3.1

const pdf_utf16be PoDoFo::PdfMacRomanEncoding::GetToUnicodeTable ( ) const [protected, virtual]
Gets a table of 256 short values which are the big endian unicode code points that are assigned to the 256 values of this encoding. This table is used internally to convert an encoded string of this encoding to and from unicode. Returns an array of 256 big endian unicode code points Implements PoDoFo::PdfSimpleEncoding.
8.66
PoDoFo::PdfMemDocument Class Reference
#include <PdfMemDocument.h> Inheritance diagram for PoDoFo::PdfMemDocument:

8.66 PoDoFo::PdfMemDocument Class Reference
249
PoDoFo::PdfDocument
PoDoFo::PdfMemDocument

PdfMemDocument () PdfMemDocument (const char pszFilename) virtual PdfMemDocument () void Load (const char pszFilename) void Load (const char pBuffer, long lLen) void Load (const PdfRefCountedInputDevice &rDevice) void Write (const char pszFilename) void Write (PdfOutputDevice pDevice) void SetWriteMode (EPdfWriteMode eWriteMode) virtual EPdfWriteMode GetWriteMode () const void SetPdfVersion (EPdfVersion eVersion) EPdfVersion GetPdfVersion () const void SetPassword (const std::string &sPassword) void SetEncrypted (const std::string &userPassword, const std::string &ownerPassword, int protection=PdfEncrypt::ePdfPermissions_Print|PdfEncrypt::ePdfPermissions_Edit|PdfEncrypt::ePdfPermissions_Copy|PdfEncrypt::ePdfPermissions_EditNotes|PdfEncrypt::ePdfPermissions_FillAndSign|PdfEncrypt::ePdfPermissions_Accessible|PdfEncrypt::ePdfPermissions_DocAssembly|PdfEncrypt::ePdfPermissions_HighPrint, PdfEncrypt::EPdfEncryptAlgorithm eAlgorithm=PdfEncrypt::ePdfEncryptAlgorithm_RC4V1, PdfEncrypt::EPdfKeyLength eKeyLength=PdfEncrypt::ePdfKeyLength_40) void SetEncrypted (const PdfEncrypt &pEncrypt) bool GetEncrypted () const bool IsLinearized () const const PdfVecObjects & GetObjects () const PdfVecObjects & GetObjects () PdfObject GetCatalog () const PdfObject GetCatalog () const const PdfObject GetTrailer () const PdfObject GetStructTreeRoot () const PdfObject GetMetadata () const PdfObject GetMarkInfo () const PdfFont GetFont (PdfObject pObject) const PdfMemDocument & InsertPages (const PdfMemDocument &rDoc, int inFirstPage, int inNumPages) void DeletePages (int inFirstPage, int inNumPages) virtual bool IsPrintAllowed () const
250
Class Documentation virtual bool IsEditAllowed () const virtual bool IsCopyAllowed () const virtual bool IsEditNotesAllowed () const virtual bool IsFillAndSignAllowed () const virtual bool IsAccessibilityAllowed () const virtual bool IsDocAssemblyAllowed () const virtual bool IsHighPrintAllowed () const void FreeObjectMemory (const PdfReference &rRef, bool bForce=false) void FreeObjectMemory (PdfObject pObj, bool bForce=false) const PdfEncrypt GetEncrypt () const
8.66.1
PdfMemDocument is the core class for reading and manipulating PDF les and writing them back to disk. PdfMemDocument was designed to allow easy access to the object structur of a PDF le. PdfMemDocument should be used whenever you want to change the object structure of a PDF le. When you are only creating PDF les, please use PdfStreamedDocument which is usually faster for creating PDFs. See also PdfDocument PdfStreamedDocument PdfParser PdfWriter
8.66.2
8.66.2.1

PoDoFo::PdfMemDocument::PdfMemDocument ( )
Construct a new (empty) PdfMemDocument 8.66.2.2 PoDoFo::PdfMemDocument::PdfMemDocument ( const char pszFilename )
Construct a PdfMemDocument from an existing PDF (on disk) Parameters pszFilename lename of the le which is going to be parsed/opened This might throw a PdfError( ePdfError_InvalidPassword ) exception if a password is required to read this PDF. Call SetPassword with the correct password in this case.
8.66 PoDoFo::PdfMemDocument Class Reference See also SetPassword
251
8.66.2.3
PoDoFo::PdfMemDocument::PdfMemDocument (
) [virtual]
Close down/destruct the PdfMemDocument
8.66.3
8.66.3.1

void PoDoFo::PdfMemDocument::DeletePages ( int inFirstPage, int inNumPages )
Deletes one or more pages from this document It does NOT remove any PdfObjects from memory - just the reference from the pages tree. If you want to delete resources of this page, you have to delete them yourself, but the resources might be used by other pages, too. Parameters inFirstPage the rst page number to delete (0-based) inNumPages the number of pages to delete Returns this document
8.66.3.2
void PoDoFo::PdfMemDocument::FreeObjectMemory ( const PdfReference & rRef, bool bForce = false )
Tries to free all memory allocated by the given PdfObject (variables and streams) and reads it from disk again if it is requested another time. This will only work if load on demand is used. Other- wise any call to this method will be ignored. Load on demand is currently always enabled when using PdfMemDocument. If the object is dirty if will not be freed. Parameters rRef free all memory allocated by the object with this reference. bForce if true the object will be freed even if IsDirty() returns true. So you will loose any changes made to this object. This is an overloaded member for your convinience.
252 8.66.3.3
Class Documentation void PoDoFo::PdfMemDocument::FreeObjectMemory ( PdfObject pObj, bool bForce = false )
Tries to free all memory allocated by the given PdfObject (variables and streams) and reads it from disk again if it is requested another time. This will only work if load on demand is used. Other- wise any call to this method will be ignored. Load on demand is currently always enabled when using PdfMemDocument. If the object is dirty if will not be freed. Parameters pObj free object from memory bForce if true the object will be freed even if IsDirty() returns true. So you will loose any changes made to this object. See also IsDirty
8.66.3.4
const PdfObject PoDoFo::PdfMemDocument::GetCatalog ( [inline]
) const
Get access to the internal Catalog dictionary or root object. Returns PdfObject the documents catalog or NULL if no catalog is available Reimplemented from PoDoFo::PdfDocument. 8.66.3.5 PdfObject PoDoFo::PdfMemDocument::GetCatalog ( [inline] )
Get access to the internal Catalog dictionary or root object. Returns PdfObject the documents catalog or NULL if no catalog is available Reimplemented from PoDoFo::PdfDocument. 8.66.3.6 Returns the parsers encryption object or NULL if the read PDF le was not encrypted const PdfEncrypt PoDoFo::PdfMemDocument::GetEncrypt ( const [inline] )
8.66 PoDoFo::PdfMemDocument Class Reference 8.66.3.7 Returns true if this PdfMemDocument creates an encrypted PDF le bool PoDoFo::PdfMemDocument::GetEncrypted ( [inline] ) const
253
8.66.3.8
PdfFont PoDoFo::PdfMemDocument::GetFont ( PdfObject pObject )
Creates a PdfFont object from an existing font. Parameters pObject a PdfObject that is a font Returns PdfFont a pointer to a new PdfFont object. The returned object is owned by the PdfDocument.
8.66.3.9
PdfObject PoDoFo::PdfMemDocument::GetMarkInfo ( [inline]
) const
Get access to the MarkInfo dictionary (ISO 32000-1:2008 14.7.1) Returns PdfObject the MarkInfo dictionary
8.66.3.10
PdfObject PoDoFo::PdfMemDocument::GetMetadata ( [inline]
) const
Get access to the Metadata stream Returns PdfObject the Metadata stream (should be in XML, using XMP grammar)
8.66.3.11
PdfVecObjects& PoDoFo::PdfMemDocument::GetObjects ( [inline]
Get a reference to the sorted internal objects vector. This is an overloaded function for your convinience. Returns the internal objects vector. Reimplemented from PoDoFo::PdfDocument.
254 8.66.3.12
Class Documentation const PdfVecObjects& PoDoFo::PdfMemDocument::GetObjects ( const [inline] )
Get a reference to the sorted internal objects vector. Returns the internal objects vector. Reimplemented from PoDoFo::PdfDocument. 8.66.3.13 EPdfVersion PoDoFo::PdfMemDocument::GetPdfVersion ( [inline, virtual] ) const
Get the PDF version of the document Returns EPdfVersion version of the pdf document Implements PoDoFo::PdfDocument. 8.66.3.14 PdfObject PoDoFo::PdfMemDocument::GetStructTreeRoot ( const [inline] )
Get access to the StructTreeRoot dictionary Returns PdfObject the StructTreeRoot dictionary
8.66.3.15
const PdfObject PoDoFo::PdfMemDocument::GetTrailer ( [inline]
) const
Get the trailer dictionary which can be written unmodied to a pdf le. Reimplemented from PoDoFo::PdfDocument. 8.66.3.16 virtual EPdfWriteMode PoDoFo::PdfMemDocument::GetWriteMode ( ) const [inline, virtual]
Get the write mode used for wirting the PDF Returns the write mode Implements PoDoFo::PdfDocument.
8.66 PoDoFo::PdfMemDocument Class Reference 8.66.3.17
255
const PdfMemDocument & PoDoFo::PdfMemDocument::InsertPages ( const PdfMemDocument & rDoc, int inFirstPage, int inNumPages )
Copies one or more pages from another PdfMemDocument to this document Parameters rDoc the document to append inFirstPage the rst page number to copy (0-based) inNumPages the number of pages to copy Returns this document
8.66.3.18
bool PoDoFo::PdfMemDocument::IsAccessibilityAllowed ( [inline, virtual]
) const
Checks if it is allowed to extract text and graphics to support users with disabillities Every PDF consuming applications has to adhere this value! Returns true if you are allowed to extract text and graphics to support users with disabillities See also PdfEncrypt to set own document permissions. Implements PoDoFo::PdfDocument.
8.66.3.19
bool PoDoFo::PdfMemDocument::IsCopyAllowed ( [inline, virtual]
) const
Checks if text and graphics extraction is allowed. Every PDF consuming applications has to adhere this value! Returns true if you are allowed to extract text and graphics from this document See also PdfEncrypt to set own document permissions. Implements PoDoFo::PdfDocument.
256 8.66.3.20
Class Documentation bool PoDoFo::PdfMemDocument::IsDocAssemblyAllowed ( [inline, virtual] ) const
Checks if it is allowed to insert, create, rotate, delete pages or add bookmarks Every PDF consuming applications has to adhere this value! Returns true if you are allowed to insert, create, rotate, delete pages or add bookmarks See also PdfEncrypt to set own document permissions. Implements PoDoFo::PdfDocument.
8.66.3.21
bool PoDoFo::PdfMemDocument::IsEditAllowed ( [inline, virtual]
) const
Checks if modiying this document (besides annotations, form elds or changing pages) is allowed. Every PDF consuming applications has to adhere this value! Returns true if you are allowed to mody this document See also PdfEncrypt to set own document permissions. Implements PoDoFo::PdfDocument.
8.66.3.22
bool PoDoFo::PdfMemDocument::IsEditNotesAllowed ( [inline, virtual]
) const
Checks if it is allowed to add or modify annotations or form elds Every PDF consuming applications has to adhere this value! Returns true if you are allowed to add or modify annotations or form elds See also PdfEncrypt to set own document permissions. Implements PoDoFo::PdfDocument.
8.66 PoDoFo::PdfMemDocument Class Reference 8.66.3.23 bool PoDoFo::PdfMemDocument::IsFillAndSignAllowed ( [inline, virtual]
257 ) const
Checks if it is allowed to ll in existing form or signature elds Every PDF consuming applications has to adhere this value! Returns true if you are allowed to ll in existing form or signature elds See also PdfEncrypt to set own document permissions. Implements PoDoFo::PdfDocument. 8.66.3.24 bool PoDoFo::PdfMemDocument::IsHighPrintAllowed ( [inline, virtual] ) const
Checks if it is allowed to print a high quality version of this document Every PDF consuming applications has to adhere this value! Returns true if you are allowed to print a high quality version of this document See also PdfEncrypt to set own document permissions. Implements PoDoFo::PdfDocument. 8.66.3.25 bool PoDoFo::PdfMemDocument::IsLinearized ( [inline, virtual] ) const
Returns wether this PDF document is linearized, aka weboptimized Returns true if the PDF document is linearized Implements PoDoFo::PdfDocument. 8.66.3.26 bool PoDoFo::PdfMemDocument::IsPrintAllowed ( [inline, virtual] ) const
Checks if printing this document is allowed. Every PDF consuming applications has to adhere this value!
258 Returns true if you are allowed to print this document See also PdfEncrypt to set own document permissions. Implements PoDoFo::PdfDocument. 8.66.3.27
Class Documentation
void PoDoFo::PdfMemDocument::Load ( const char pBuffer, long lLen )
Load a PdfMemDocument from a buffer in memory Parameters pBuffer a memory area containing the PDF data lLen length of the buffer This might throw a PdfError( ePdfError_InvalidPassword ) exception if a password is required to read this PDF. Call SetPassword with the correct password in this case. See also SetPassword
8.66.3.28
void PoDoFo::PdfMemDocument::Load ( const PdfRefCountedInputDevice & rDevice )
Load a PdfMemDocument from a PdfRefCountedInputDevice Parameters rDevice the input device containing the PDF This might throw a PdfError( ePdfError_InvalidPassword ) exception if a password is required to read this PDF. Call SetPassword with the correct password in this case. See also SetPassword
8.66.3.29
void PoDoFo::PdfMemDocument::Load ( const char pszFilename )
Load a PdfMemDocument from a le

8.66 PoDoFo::PdfMemDocument Class Reference Parameters pszFilename lename of the le which is going to be parsed/opened
259
This might throw a PdfError( ePdfError_InvalidPassword ) exception if a password is required to read this PDF. Call SetPassword with the correct password in this case. See also SetPassword
8.66.3.30
void PoDoFo::PdfMemDocument::SetEncrypted ( const PdfEncrypt & pEncrypt )
Encrypt the document during writing using a PdfEncrypt object Parameters pEncrypt an encryption object that will be owned by PdfMemDocument
8.66.3.31
void PoDoFo::PdfMemDocument::SetEncrypted ( const std::string & userPassword, const std::string & ownerPassword, int protection = PdfEncrypt::ePdfPermissions_Print | PdfEncrypt::ePdfPermissions_Edit | PdfEncrypt::ePdfPermissions_Copy | PdfEncrypt::ePdfPermissions_EditNotes | PdfEncrypt::ePdfPermissions_FillAndSign | PdfEncrypt::ePdfPermissions_Accessible | PdfEncrypt::ePdfPermissions_DocAssembly | PdfEncrypt::ePdfPermissions_HighPrint, PdfEncrypt::EPdfEncryptAlgorithm eAlgorithm = PdfEncrypt::ePdfEncryptAlgorithm_RC4V1, PdfEncrypt::EPdfKeyLength eKeyLength = PdfEncrypt::ePdfKeyLength_40 )
Encrypt the document during writing. Parameters userPassword the user password (if empty the user does not have to enter a password to open the document) ownerPassword the owner password protection several EPdfPermissions values ored together to set the users permissions for this document eAlgorithm the revision of the encryption algorithm to be used eKeyLength the length of the encryption key ranging from 40 to 128 bits (only used if eAlgorithm == ePdfEncryptAlgorithm_RC4V2)
260 See also PdfEncrypt
Class Documentation
8.66.3.32
void PoDoFo::PdfMemDocument::SetPassword ( const std::string & sPassword )
If you try to open an encrypted PDF le, which requires a password to open, PoDoFo will throw a PdfError( ePdfError_InvalidPassword ) exception. If you got such an exception, you have to set a password which should be used for opening the PDF. The usual way will be to ask the user for the password and set the password using this method. PdfParser will immediately continue to read the PDF le. Parameters sPassword a user or owner password which can be used to open an encrypted PDF le If the password is invalid, a PdfError( ePdfError_InvalidPassword ) exception is thrown!
8.66.3.33
void PoDoFo::PdfMemDocument::SetPdfVersion ( EPdfVersion eVersion ) [inline]
Set the PDF Version of the document. Has to be called before Write() to have an effect. Parameters eVersion version of the pdf document
8.66.3.34
void PoDoFo::PdfMemDocument::SetWriteMode ( EPdfWriteMode eWriteMode ) [inline]
Set the write mode to use when writing the PDF. Parameters eWriteMode write mode
8.66.3.35
void PoDoFo::PdfMemDocument::Write ( const char pszFilename )
Writes the complete document to a le Parameters pszFilename lename of the document

8.67 PoDoFo::PdfMemoryInputStream Class Reference See also Write This is an overloaded member function for your convinience.
261
TODO: We will get problems here on linux, if we write to the same lename we read the document from. Because the PdfParserObjects will read there streams data from the le while we are writing it. The problem is that the stream data wont exist at this time as we truncated the le already to zero length by opening it writeable. 8.66.3.36 void PoDoFo::PdfMemDocument::Write ( PdfOutputDevice pDevice )
Writes the complete document to an output device Parameters pDevice write to this output device TODO: We will get problems here on linux, if we write to the same lename we read the document from. Because the PdfParserObjects will read there streams data from the le while we are writing it. The problem is that the stream data wont exist at this time as we truncated the le already to zero length by opening it writeable.
8.67
PoDoFo::PdfMemoryInputStream Class Reference
#include <PdfInputStream.h> Inheritance diagram for PoDoFo::PdfMemoryInputStream:

PoDoFo::PdfInputStream PoDoFo::PdfMemoryInputStream

PdfMemoryInputStream (const char pBuffer, pdf_long lBufferLen) virtual pdf_long Read (char pBuffer, pdf_long lLen)
8.67.1
An input stream that reads data from a memory buffer

262
Class Documentation
8.67.2
8.67.2.1

PoDoFo::PdfMemoryInputStream::PdfMemoryInputStream ( const char pBuffer, pdf_long lBufferLen )
Open a le for reading data Parameters pBuffer buffer to read from lBufferLen length of the buffer
8.67.3
8.67.3.1

pdf_long PoDoFo::PdfMemoryInputStream::Read ( char pBuffer, pdf_long lLen ) [virtual]
Read data from the input stream Parameters pBuffer the data will be stored into this buffer lLen the size of the buffer and number of bytes that will be read Returns the number of bytes read, -1 if an error ocurred and zero if no more bytes are available for reading. Implements PoDoFo::PdfInputStream.
8.68
PoDoFo::PdfMemoryOutputStream Class Reference
#include <PdfOutputStream.h> Inheritance diagram for PoDoFo::PdfMemoryOutputStream:

PoDoFo::PdfOutputStream PoDoFo::PdfMemoryOutputStream

PdfMemoryOutputStream (pdf_long lInitial=INITIAL_SIZE)
8.68 PoDoFo::PdfMemoryOutputStream Class Reference PdfMemoryOutputStream (char pBuffer, pdf_long lLen) virtual pdf_long Write (const char pBuffer, pdf_long lLen) virtual void Close () pdf_long GetLength () const char TakeBuffer ()
263
8.68.1
An output stream that writes data to a memory buffer If the buffer is to small, it will be enlarged automatically. DS: TODO: remove in favour of PdfBufferOutputStream.
8.68.2
8.68.2.1

PoDoFo::PdfMemoryOutputStream::PdfMemoryOutputStream ( pdf_long lInitial = INITIAL_SIZE )
Construct a new PdfMemoryOutputStream Parameters lInitial initial size of the buffer
8.68.2.2
PoDoFo::PdfMemoryOutputStream::PdfMemoryOutputStream ( char pBuffer, pdf_long lLen )
Construct a new PdfMemoryOutputStream that writes to an existing buffer Parameters pBuffer handle to the buffer lLen length of the buffer
8.68.3
8.68.3.1

virtual void PoDoFo::PdfMemoryOutputStream::Close ( [inline, virtual] )
264 8.68.3.2 Returns the length of the written data
Class Documentation pdf_long PoDoFo::PdfMemoryOutputStream::GetLength ( [inline] ) const
8.68.3.3 Returns
char PoDoFo::PdfMemoryOutputStream::TakeBuffer ( [inline]
a handle to the internal buffer. The internal buffer is now owned by the caller and will not be deleted by PdfMemoryOutputStream. Further calls to write are not allowed. The caller has to free the returned malloced buffer!
8.68.3.4
pdf_long PoDoFo::PdfMemoryOutputStream::Write ( const char pBuffer, pdf_long lLen ) [virtual]
8.69
PoDoFo::PdfMemStream Class Reference
#include <PdfMemStream.h> Inheritance diagram for PoDoFo::PdfMemStream:
PoDoFo::PdfStream
PoDoFo::PdfMemStream
8.69 PoDoFo::PdfMemStream Class Reference
265

PdfMemStream (PdfObject pParent) PdfMemStream (const PdfMemStream &rhs) virtual void Write (PdfOutputDevice pDevice, PdfEncrypt pEncrypt=NULL) virtual void GetCopy (char pBuffer, pdf_long lLen) const virtual void GetCopy (PdfOutputStream pStream) const const char Get () const virtual pdf_long GetLength () const void FlateCompress () void Uncompress () void Empty () const PdfStream & operator= (const PdfStream &rhs)

virtual const char GetInternalBuffer () const virtual pdf_long GetInternalBufferSize () const virtual void BeginAppendImpl (const TVecFilters &vecFilters) virtual void AppendImpl (const char pszString, size_t lLen) virtual void EndAppendImpl ()
8.69.1
A PDF stream can be appended to any PdfObject and can contain abitrary data. A PDF memory stream is held completely in memory. Most of the time it will contain either drawing commands to draw onto a page or binary data like a font or an image. A PdfMemStream is implicitly shared and can therefore be copied very quickly.
8.69.2
8.69.2.1

PoDoFo::PdfMemStream::PdfMemStream ( PdfObject pParent )
Create a new PdfStream object which has a parent PdfObject. The stream will be deleted along with the parent. This constructor will be called by PdfObject::Stream() for you. Parameters pParent parent object
266 8.69.2.2
Class Documentation PoDoFo::PdfMemStream::PdfMemStream ( const PdfMemStream & rhs )
Create a shallow copy of a PdfStream object Parameters rhs the object to clone
8.69.3
8.69.3.1

void PoDoFo::PdfMemStream::AppendImpl ( const char pszString, size_t lLen ) [protected, virtual]
Append a binary buffer to the current stream contents. Parameters pszString a buffer lLen length of the buffer See also BeginAppend Append EndAppend Implements PoDoFo::PdfStream. 8.69.3.2 void PoDoFo::PdfMemStream::BeginAppendImpl ( const TVecFilters & vecFilters ) [protected, virtual]
Begin appending data to this stream. Clears the current stream contents. Parameters vecFilters use this lters to encode any data written to the stream. Implements PoDoFo::PdfStream. 8.69.3.3 void PoDoFo::PdfMemStream::Empty ( )
Emptys the stream and set the streams buffer size to 0 8.69.3.4 void PoDoFo::PdfMemStream::EndAppendImpl ( virtual] ) [protected,
Finish appending data to the stream Implements PoDoFo::PdfStream.

8.69 PoDoFo::PdfMemStream Class Reference 8.69.3.5 void PoDoFo::PdfMemStream::FlateCompress ( )
267
This function compresses any currently set stream using the FlateDecode(ZIP) algorithm. JPEG compressed streams will not be compressed again using this function. Entries to the lter dictionary will be added if necessary. 8.69.3.6 const char PoDoFo::PdfMemStream::Get ( ) const [inline]
Get a read-only handle to the current stream data. The data will not be ltered before being returned, so (eg) calling Get() on a Flate compressed stream will return a pointer to the Flate-compressed buffer. Warning Do not retain pointers to the streams internal buffer, as it may be reallocated with any non-const operation. Returns a read-only handle to the streams data
8.69.3.7
void PoDoFo::PdfMemStream::GetCopy ( char pBuffer, pdf_long lLen ) const [virtual]
Get a malloced buffer of the current stream. No lters will be applied to the buffer, so if the stream is Flate compressed the compressed copy will be returned. The caller has to free() the buffer. Parameters pBuffer pointer to the buffer lLen pointer to the buffer length Returns ErrOk on success. Implements PoDoFo::PdfStream. 8.69.3.8 void PoDoFo::PdfMemStream::GetCopy ( PdfOutputStream pStream ) const [virtual]
Get a copy of a the stream and write it to a PdfOutputStream Parameters pStream data is written to this stream. Implements PoDoFo::PdfStream.
268 8.69.3.9
Class Documentation const char PoDoFo::PdfMemStream::GetInternalBuffer ( [inline, protected, virtual] ) const
Required for the GetFilteredCopy implementation Returns a handle to the internal buffer Implements PoDoFo::PdfStream. 8.69.3.10 pdf_long PoDoFo::PdfMemStream::GetInternalBufferSize ( [inline, protected, virtual] ) const
Required for the GetFilteredCopy implementation Returns the size of the internal buffer Implements PoDoFo::PdfStream. 8.69.3.11 pdf_long PoDoFo::PdfMemStream::GetLength ( [virtual] ) const
Get the streams length. The length is that of the internal stream buffer, so (eg) for a Flate-compressed stream it will be the length of the compressed data. Returns the length of the internal buffer See also Get() Implements PoDoFo::PdfStream. 8.69.3.12 const PdfStream & PoDoFo::PdfMemStream::operator= ( const PdfStream & rhs )
Create a copy of a PdfStream object Parameters rhs the object to clone Returns a reference to this object Reimplemented from PoDoFo::PdfStream.
8.70 PoDoFo::Util::PdfMutexImpl Class Reference 8.69.3.13 void PoDoFo::PdfMemStream::Uncompress ( )
269
This method removes all lters from the stream 8.69.3.14 void PoDoFo::PdfMemStream::Write ( PdfOutputDevice pDevice, PdfEncrypt pEncrypt = NULL ) [virtual]
Write the stream to an output device Parameters pDevice write to this outputdevice. pEncrypt encrypt stream data using this object Implements PoDoFo::PdfStream.
8.70
PoDoFo::Util::PdfMutexImpl Class Reference
#include <PdfMutexImpl_win32.h>

PdfMutexImpl () void Lock () bool TryLock () void UnLock () void Lock () bool TryLock () void UnLock () PdfMutexImpl () void Lock () bool TryLock () void UnLock ()
8.70.1
A platform independent non-reentrant mutex, no-op implementation. This version is used if PoDoFo is built without threading support. PdfMutex is NOT part of PoDoFos public API. A platform independent reentrant mutex, pthread implementation. PdfMutex is NOT part of PoDoFos public API. This is the pthread implementation, which is entirely inline. A platform independent reentrant mutex, win32 implementation.
270
Class Documentation
8.70.2
8.70.2.1

PoDoFo::Util::PdfMutexImpl::PdfMutexImpl ( ) [inline]
Construct a new mutex
8.70.2.2
PoDoFo::Util::PdfMutexImpl::PdfMutexImpl (
) [inline]
Construct a new mutex
8.70.3
8.70.3.1

void PoDoFo::Util::PdfMutexImpl::Lock ( ) [inline]
Lock the mutex
8.70.3.2
void PoDoFo::Util::PdfMutexImpl::Lock (
) [inline]
Lock the mutex
8.70.3.3
void PoDoFo::Util::PdfMutexImpl::Lock (
) [inline]
Lock the mutex
8.70.3.4
bool PoDoFo::Util::PdfMutexImpl::TryLock (
) [inline]
Try locking the mutex. Returns true if the mutex was locked false if the mutex is already locked by some other thread
8.70.3.5
bool PoDoFo::Util::PdfMutexImpl::TryLock (
) [inline]
8.71 PoDoFo::Util::PdfMutexWrapper Class Reference 8.70.3.6 bool PoDoFo::Util::PdfMutexImpl::TryLock ( ) [inline]
271
8.70.3.7
void PoDoFo::Util::PdfMutexImpl::UnLock (
) [inline]
Unlock the mutex
8.70.3.8
) [inline]
Unlock the mutex
8.70.3.9
) [inline]
Unlock the mutex
8.71
PoDoFo::Util::PdfMutexWrapper Class Reference
#include <PdfMutexWrapper.h>

PODOFO_NOTHROW PdfMutexWrapper (PdfMutex &rMutex) PdfMutexWrapper ()
8.71.1
A wrapper around PdfMutex. The mutex is locked in the constructor and unlocked in the destructor. In debug builds all exceptions thrown by the mutex implementation are caught and logged before being rethrown. Note that PdfMutexWrapper is not part of PoDoFos public API.
272
Class Documentation
8.71.2
8.71.2.1

PoDoFo::Util::PdfMutexWrapper::PdfMutexWrapper ( PdfMutex & rMutex ) [inline]
Lock a mutex. Parameters rMutex the mutex to be locked.
8.71.2.2
PoDoFo::Util::PdfMutexWrapper::PdfMutexWrapper ( [inline]
Unlocks the mutex on destruction
8.72
PoDoFo::PdfName Class Reference
#include <PdfName.h> Inheritance diagram for PoDoFo::PdfName:
PoDoFo::PdfDataType PoDoFo::PdfName

PdfName () PdfName (const std::string &sName) PdfName (const char pszName) PdfName (const char pszName, long lLen) std::string GetEscapedName () const PdfName (const PdfName &rhs) void Write (PdfOutputDevice pDevice, EPdfWriteMode eWriteMode, const PdfEncrypt pEncrypt=NULL) const PODOFO_NOTHROW const std::string & GetName () const PODOFO_NOTHROW size_t GetLength () const PODOFO_NOTHROW const PdfName & operator= (const PdfName &rhs) PODOFO_NOTHROW bool operator== (const PdfName &rhs) const bool operator== (const char rhs) const PODOFO_NOTHROW bool operator== (const std::string &rhs) const PODOFO_NOTHROW bool operator!= (const PdfName &rhs) const bool operator!= (const char rhs) const PODOFO_NOTHROW bool operator< (const PdfName &rhs) const
8.72 PoDoFo::PdfName Class Reference
273

static PdfName FromEscaped (const std::string &sName) static PdfName FromEscaped (const char pszName, pdf_long ilength=0)
8.72.1
This class represents a PdfName. Whenever a key is required you have to use a PdfName object. PdfName are required as keys in PdfObject and PdfVariant objects. PdfName may have a maximum length of 127 characters. See also PdfObject PdfVariant
8.72.2
8.72.2.1

PoDoFo::PdfName::PdfName ( ) [inline]
Constructor to create NULL strings. use PdfName::KeyNull instead of this constructor
8.72.2.2
PoDoFo::PdfName::PdfName ( const std::string & sName ) [inline]
Create a new PdfName object. Parameters sName the unescaped value of this name. Please specify the name without the leading /.
8.72.2.3
PoDoFo::PdfName::PdfName ( const char pszName ) [inline]
Create a new PdfName object. Parameters pszName the unescaped value of this name. Please specify the name without the leading /. Has to be a zero terminated string.
274 8.72.2.4
Class Documentation PoDoFo::PdfName::PdfName ( const char pszName, long lLen ) [inline]
Create a new PdfName object. Parameters pszName the unescaped value of this name. Please specify the name without the leading /. lLen length of the name
8.72.2.5
PoDoFo::PdfName::PdfName ( const PdfName & rhs ) [inline]
Create a copy of an existing PdfName object. Parameters rhs another PdfName object
8.72.3
8.72.3.1

static PdfName PoDoFo::PdfName::FromEscaped ( const std::string & sName ) [static]
Create a new PdfName object from a string containing an escaped name string without the leading / . Parameters sName A string containing the escaped name Returns A new PdfName
8.72.3.2
PdfName PoDoFo::PdfName::FromEscaped ( const char pszName, pdf_long ilength = 0 ) [static]
Create a new PdfName object from a string containing an escaped name string without the leading / . Parameters pszName A string containing the escaped name ilength length of the escaped string data. If a length of 0 is passed, the string data is expected to be a zero terminated string. Returns A new PdfName
8.72 PoDoFo::PdfName Class Reference 8.72.3.3 Returns an escaped representation of this name without the leading / . string PoDoFo::PdfName::GetEscapedName ( ) const
275
There is no corresponding GetEscapedLength(), since generating the return value is somewhat expensive.
8.72.3.4 Returns
size_t PoDoFo::PdfName::GetLength (
) const [inline]
the unescaped length of this name object
8.72.3.5 Returns
const std::string & PoDoFo::PdfName::GetName ( [inline]
) const
the unescaped value of this name object without the leading slash
8.72.3.6
bool PoDoFo::PdfName::operator!= ( const PdfName & rhs ) const [inline]
compare two PdfName objects. Returns true if both PdfNames have different values.
8.72.3.7
bool PoDoFo::PdfName::operator!= ( const char rhs ) const [inline]
overloaded operator for convinience The string argument is treated as an unescaped name. Parameters rhs a name Returns true if this objects name is not equal to pszName
276 8.72.3.8
Class Documentation bool PoDoFo::PdfName::operator< ( const PdfName & rhs ) const [inline]
compare two PdfName objects. Used for sorting in lists Returns true if this object is smaller than rhs
8.72.3.9
const PdfName & PoDoFo::PdfName::operator= ( const PdfName & rhs ) [inline]
Assign another name to this object Parameters rhs another PdfName object
8.72.3.10
bool PoDoFo::PdfName::operator== ( const std::string & rhs ) const [inline]
overloaded operator for convinience The string argument is treated as an unescaped name. Parameters rhs a name Returns true if this objects name is equal to pszName
8.72.3.11
bool PoDoFo::PdfName::operator== ( const PdfName & rhs ) const [inline]
compare to PdfName objects. Returns true if both PdfNames have the same value.
8.72.3.12
bool PoDoFo::PdfName::operator== ( const char rhs ) const
overloaded operator for convinience The string argument is treated as an unescaped name.
8.73 PoDoFo::PdfNamedColor Class Reference Parameters rhs a name Returns true if this objects name is equal to pszName
277
8.72.3.13
void PoDoFo::PdfName::Write ( PdfOutputDevice pDevice, EPdfWriteMode eWriteMode, const PdfEncrypt pEncrypt = NULL ) const [virtual]
Write the name to an output device in PDF format. This is an overloaded member function. Parameters pDevice write the object to this device eWriteMode additional options for writing this object pEncrypt an encryption object which is used to encrypt this object or NULL to not encrypt this object Implements PoDoFo::PdfDataType.
8.73
PoDoFo::PdfNamedColor Class Reference

PdfNamedColor (const char pszName, const PdfColor &rColor) PdfNamedColor (const char pszName, const char rColorName) PdfNamedColor (const PdfNamedColor &rhs) PdfNamedColor () bool operator< (const char pszName) const bool operator< (const PdfNamedColor &rhs) const bool operator== (const char pszName) const const PdfColor & GetColor () const const char GetName () const
8.73.1
A PdfNamedColor holds a PdfColor object and a name.

278
Class Documentation
8.73.2
8.73.2.1

PoDoFo::PdfNamedColor::PdfNamedColor ( const char pszName, const PdfColor & rColor ) [inline]
Create a PdfNamedColor object. Parameters pszName the name. The string must be allocated as static memory somewhere The string data will not be copied! rColor a PdfColor object
8.73.2.2
PoDoFo::PdfNamedColor::PdfNamedColor ( const char pszName, const char rColorName ) [inline]
Create a PdfNamedColor object. Parameters pszName the name. The string must be allocated as static memory somewhere The string data will not be copied! rColorName RGB hex value (e.g. FFABCD)
8.73.2.3
PoDoFo::PdfNamedColor::PdfNamedColor ( const PdfNamedColor & rhs ) [inline]
Copy constructor
8.73.2.4
PoDoFo::PdfNamedColor::PdfNamedColor (
) [inline]
Class destructor.
8.73.3
8.73.3.1

const PdfColor& PoDoFo::PdfNamedColor::GetColor ( [inline] ) const
Returns a reference to the internal color object
8.74 PoDoFo::PdfObject Class Reference 8.73.3.2 const char PoDoFo::PdfNamedColor::GetName ( [inline] ) const
279
Returns a pointer to the name of the color
8.73.3.3
bool PoDoFo::PdfNamedColor::operator< ( const PdfNamedColor & rhs ) const [inline]
Compare this color object to a PdfNamedColor comparing only the name. The comparison is case insensitive! Returns true if the passed string is smaller than the name of this color object.
8.73.3.4
bool PoDoFo::PdfNamedColor::operator< ( const char pszName ) const [inline]
Compare this color object to a name The comparison is case insensitive! Returns true if the passed string is smaller than the name of this color object.
8.73.3.5
bool PoDoFo::PdfNamedColor::operator== ( const char pszName ) const [inline]
Compare this color object to a name The comparison is case insensitive! Returns true if the passed string is the name of this color object.
8.74
PoDoFo::PdfObject Class Reference
#include <PdfObject.h> Inheritance diagram for PoDoFo::PdfObject:

280
PoDoFo::PdfVariant PoDoFo::PdfObject PoDoFo::PdfParserObject PoDoFo::PdfXRefStreamParserObject
Class Documentation

PdfObject () PdfObject (const PdfReference &rRef, const char pszType) PdfObject (const PdfReference &rRef, const PdfVariant &rVariant) PdfObject (const PdfVariant &var) PdfObject (bool b) PdfObject (pdf_int64 l) PdfObject (double d) PdfObject (const PdfString &rsString) PdfObject (const PdfName &rName) PdfObject (const PdfReference &rRef) PdfObject (const PdfArray &tList) PdfObject (const PdfDictionary &rDict) PdfObject (const PdfObject &rhs) PdfObject GetIndirectKey (const PdfName &key) const PdfObject MustGetIndirectKey (const PdfName &key) const void WriteObject (PdfOutputDevice pDevice, EPdfWriteMode eWriteMode, PdfEncrypt pEncrypt, const PdfName &keyStop=PdfName::KeyNull) const pdf_long GetObjectLength (EPdfWriteMode eWriteMode) const PdfReference & Reference () const PdfStream GetStream () const PdfStream GetStream () const bool HasStream () const PODOFO_NOTHROW bool operator< (const PdfObject &rhs) const PODOFO_NOTHROW bool operator== (const PdfObject &rhs) const void SetOwner (PdfVecObjects pVecObjects) PdfVecObjects GetOwner () const const PdfObject & operator= (const PdfObject &rhs) void FlateCompressStream () pdf_long GetByteOffset (const char pszKey, EPdfWriteMode eWriteMode) void DelayedStreamLoad () const
8.74 PoDoFo::PdfObject Class Reference
281

void EnableDelayedStreamLoading () virtual void DelayedStreamLoadImpl () PdfStream GetStream_NoDL ()
8.74.1
This class represents a PDF indirect Object in memory It is possible to manipulate the stream which can be appended to the object (if the object is of underlying type dictionary). A PdfObject is uniquely identied by an object number and a generation number which has to be passed to the constructor. The object can be written to a le easily using the WriteObject() function. See also WriteObject()
8.74.2
8.74.2.1

PoDoFo::PdfObject::PdfObject ( )
Create a PDF object with object and generation number -1 and the value of being an empty PdfDictionary. 8.74.2.2 PoDoFo::PdfObject::PdfObject ( const PdfReference & rRef, const char pszType )
Construct a new PDF object of type PdfDictionary. Parameters rRef reference of this object pszType if type is not null a key "/Type" will be added to the dictionary with the value of type.
8.74.2.3
PoDoFo::PdfObject::PdfObject ( const PdfReference & rRef, const PdfVariant & rVariant )
Construct a new PDF object. Parameters rRef reference of this object rVariant the value of the PdfObject (which is copied)
282 8.74.2.4
Class Documentation PoDoFo::PdfObject::PdfObject ( const PdfVariant & var )
Create a PDF object with object and generation number -1 and the value of the passed variant. Parameters var the value of the object
8.74.2.5
PoDoFo::PdfObject::PdfObject ( bool b )
Construct a PdfObject with object and generation number -1 and a bool as value. Parameters b the boolean value of this PdfObject
8.74.2.6
PoDoFo::PdfObject::PdfObject ( pdf_int64 l )
Construct a PdfObject with object and generation number -1 and a pdf_int64 as value. Parameters l the pdf_int64 value of this PdfObject
8.74.2.7
PoDoFo::PdfObject::PdfObject ( double d )
Construct a PdfObject with object and generation number -1 and a double as value. Parameters d the double value of this PdfObject
8.74.2.8
PoDoFo::PdfObject::PdfObject ( const PdfString & rsString )
Construct a PdfObject with object and generation number -1 and a PdfString as value. Parameters rsString the string value of this PdfObject
8.74.2.9
PoDoFo::PdfObject::PdfObject ( const PdfName & rName )
Construct a PdfObject with object and generation number -1 and a PdfName as value. Parameters rName the value of this PdfObject
8.74 PoDoFo::PdfObject Class Reference 8.74.2.10 PoDoFo::PdfObject::PdfObject ( const PdfReference & rRef )
283
Construct a PdfObject with object and generation number -1 and a PdfReference as value. Parameters rRef the value of the this PdfObject
8.74.2.11
PoDoFo::PdfObject::PdfObject ( const PdfArray & tList )
Construct a PdfObject with object and generation number -1 and a PdfArray as value. Parameters tList the value of the this PdfObject
8.74.2.12
PoDoFo::PdfObject::PdfObject ( const PdfDictionary & rDict )
Construct a PdfObject with object and generation number -1 and a PdfDictionary as value. Parameters rDict the value of the this PdfObject
8.74.2.13
PoDoFo::PdfObject::PdfObject ( const PdfObject & rhs )
Creates a copy of an existing PdfObject All assosiated objects and streams will be copied along with the PdfObject Parameters rhs PdfObject to clone
8.74.3
8.74.3.1

void PoDoFo::PdfObject::DelayedStreamLoad ( ) const [inline]
Dynamically load this object and any associated stream from a PDF le by calling the virtual method DelayedStreamLoadImpl if the stream is not already loaded. Will call DelayedLoad() rst if it is required. Call graph: DelayedStreamLoad ---> DelayedLoad() --> DelayedLoadImpl() | --> DelayedStreamLoadImpl() For objects complete created in memory this function does nothing.
284 8.74.3.2
Class Documentation void PoDoFo::PdfObject::DelayedStreamLoadImpl ( protected, virtual] ) [inline,
Load the stream of the object if it has one and if delayed loading is enabled. You should override this to control deferred stream loading in your subclass. Never call this method directly; use DelayedStreamLoad() instead.
8.74.3.3
void PoDoFo::PdfObject::EnableDelayedStreamLoading ( [inline, protected]
Flag any stream associated with the object as incompletely loaded, so that DelayedStreamLoad() will be called when needed. All constructors initialize a PdfObject with delayed loading of streams disabled . If you want delayed loading of streams you must ask for it. If you do so, call this method early in your ctor and be sure to override DelayedStreamLoadImpl() Note that it is quite possible to have a PdfObject that requires a delayed-load of its stream but does an immediate load of the PdfVariant base. If you want to delay loading of that too, make sure to call EnableDelayedLoading().
8.74.3.4
void PoDoFo::PdfObject::FlateCompressStream (
This function compresses any currently set stream using the FlateDecode algorithm. JPEG compressed streams will not be compressed again using this function. Entries to the lter dictionary will be added if necessary.
8.74.3.5
pdf_long PoDoFo::PdfObject::GetByteOffset ( const char pszKey, EPdfWriteMode eWriteMode )
Calculate the byte offset of the key pszKey from the start of the object if the object was written to disk at the moment of calling this function. This function is very calculation intensive! Parameters pszKey key to calculate the byte offset eWriteMode additional options for writing the PDF Returns the offset of the key
8.74 PoDoFo::PdfObject Class Reference 8.74.3.6
285
PdfObject PoDoFo::PdfObject::GetIndirectKey ( const PdfName & key ) const
Get the keys value out of the dictionary. If the key is a reference, the reference is resolved and the object pointed to by the reference is returned. Parameters key look for the key named key in the dictionary Returns the found value or NULL if the value is not in the dictionary or if this object is no dictionary
8.74.3.7
pdf_long PoDoFo::PdfObject::GetObjectLength ( EPdfWriteMode eWriteMode )
Get the length of the object in bytes if it was written to disk now. Parameters eWriteMode additional options for writing the object Returns the length of the object
8.74.3.8
PdfVecObjects PoDoFo::PdfObject::GetOwner ( [inline]
) const
Get the owner of this object. Returns the creator of this object
8.74.3.9
PdfStream PoDoFo::PdfObject::GetStream (
Get a handle to a PDF stream object If the PDF object does not have a stream, one will be created. Returns a PdfStream object This will set the dirty ag of this object. See also IsDirty
286 8.74.3.10
Class Documentation const PdfStream PoDoFo::PdfObject::GetStream ( ) const
Get a handle to a const PDF stream object If the PDF object does not have a stream, null is returned Returns a PdfStream object or null
8.74.3.11
PdfStream PoDoFo::PdfObject::GetStream_NoDL ( [protected]
Same as GetStream() but wont trigger a delayed load, so its safe for use while a delayed load is in progress. This will set the dirty ag of this object. See also IsDirty
8.74.3.12
bool PoDoFo::PdfObject::HasStream (
) const [inline]
Check if this object has a PdfStream object appended. Returns true if the object has a stream
8.74.3.13
PdfObject PoDoFo::PdfObject::MustGetIndirectKey ( const PdfName & key ) const [inline]
MustGetIndirectKey() wraps GetIndirectKey to throw on null return. This makes it MUCH more readable to look up deep chains of linked keys with the cost that its not easy to tell at which point a missing key/object was encountered. Returns the found value, which is never null Exceptions PdfError(ePdfError_NoObject) .
8.74.3.14
bool PoDoFo::PdfObject::operator< ( const PdfObject & rhs ) const [inline]
This operator is required for sorting a list of PdfObjects. It compares the objectnumber. If objectnumbers are equal, the generation number is compared.
8.74 PoDoFo::PdfObject Class Reference 8.74.3.15
287
const PdfObject & PoDoFo::PdfObject::operator= ( const PdfObject & rhs )
Creates a copy of an existing PdfObject All assosiated objects and streams will be copied along with the PdfObject Parameters rhs PdfObject to clone Returns a reference to this object
8.74.3.16
bool PoDoFo::PdfObject::operator== ( const PdfObject & rhs ) const [inline]
Comperasion operator. Compares two PDF object only based on their object and generation number 8.74.3.17 const PdfReference & PoDoFo::PdfObject::Reference ( [inline] ) const
Get a indirect reference to this object Returns a PdfReference pointing to this object.
8.74.3.18
void PoDoFo::PdfObject::SetOwner ( PdfVecObjects pVecObjects ) [inline]
Set the owner of this object, i.e. the PdfVecObjects to which this object belongs. Parameters pVecObjects a vector of pdf objects
8.74.3.19
void PoDoFo::PdfObject::WriteObject ( PdfOutputDevice pDevice, EPdfWriteMode eWriteMode, PdfEncrypt pEncrypt, const PdfName & keyStop = PdfName::KeyNull ) const
Write the complete object to a le. Parameters pDevice write the object to this device
288
Class Documentation pEncrypt an encryption object which is used to encrypt this object or NULL to not encrypt this object eWriteMode additional options for writing the object keyStop if not KeyNull and a key == keyStop is found writing will stop right before this key!
8.75
PoDoFo::PdfObjectStreamParserObject Reference
Class
#include <PdfObjectStreamParserObject.h>

PdfObjectStreamParserObject (PdfParserObject pParser, PdfVecObjects pVecObjects, const PdfRefCountedBuffer &rBuffer, PdfEncrypt pEncrypt)
8.75.1
A utility class for PdfParser that can parse an object stream object. It is mainly here to make PdfParser more modular.
8.75.2
8.75.2.1

PoDoFo::PdfObjectStreamParserObject::PdfObjectStreamParserObject ( PdfParserObject pParser, PdfVecObjects pVecObjects, const PdfRefCountedBuffer & rBuffer, PdfEncrypt pEncrypt )
Create a new PdfObjectStreamParserObject from an existing PdfParserObject. The PdfParserObject will be removed and deleted. All objects from the object stream will be read into memory. Parameters pParser PdfParserObject for an object stream pVecObjects add loaded objecs to this vector of objects rBuffer use this allocated buffer for caching pEncrypt encryption object used to decrypt streams
8.76
PoDoFo::PdfOutlineItem Class Reference
#include <PdfOutlines.h>
8.76 PoDoFo::PdfOutlineItem Class Reference Inheritance diagram for PoDoFo::PdfOutlineItem:

PoDoFo::PdfElement
289
PoDoFo::PdfOutlineItem
PoDoFo::PdfOutlines

PdfOutlineItem CreateChild (const PdfString &sTitle, const PdfDestination &rDest) PdfOutlineItem CreateNext (const PdfString &sTitle, const PdfDestination &rDest) PdfOutlineItem CreateNext (const PdfString &sTitle, const PdfAction &rAction) void InsertChild (PdfOutlineItem pItem) PdfOutlineItem Prev () const PdfOutlineItem Next () const PdfOutlineItem First () const PdfOutlineItem Last () const PdfOutlineItem GetParentOutline () const void Erase () void SetDestination (const PdfDestination &rDest) PdfDestination GetDestination (PdfDocument pDoc) void SetAction (const PdfAction &rAction) PdfAction GetAction (void) void SetTitle (const PdfString &sTitle) const PdfString & GetTitle () const void SetTextFormat (EPdfOutlineFormat eFormat) EPdfOutlineFormat GetTextFormat () const void SetTextColor (double r, double g, double b) double GetTextColorRed () const double GetTextColorBlue () const double GetTextColorGreen () const

PdfOutlineItem (PdfVecObjects pParent) PdfOutlineItem (const PdfString &sTitle, const PdfDestination &rDest, PdfOutlineItem pParentOutline, PdfVecObjects pParent) PdfOutlineItem (const PdfString &sTitle, const PdfAction &rAction, PdfOutlineItem pParentOutline, PdfVecObjects pParent) PdfOutlineItem (PdfObject pObject, PdfOutlineItem pParentOutline, PdfOutlineItem pPrevious)
290
Class Documentation
8.76.1
A PDF outline item has an title and a destination. It is an element in the documents outline which shows its hierarchical structure. See also PdfDocument PdfOutlines PdfDestination
8.76.2
8.76.2.1

PoDoFo::PdfOutlineItem::PdfOutlineItem ( PdfVecObjects pParent ) [protected]
Create a new PdfOutlineItem dictionary Parameters pParent parent vector of objects
8.76.2.2
PoDoFo::PdfOutlineItem::PdfOutlineItem ( const PdfString & sTitle, const PdfDestination & rDest, PdfOutlineItem pParentOutline, PdfVecObjects pParent ) [protected]
Create a new PdfOutlineItem from scratch Parameters sTitle title of this item rDest destination of this item pParentOutline parent of this outline item in the outline item hierarchie pParent parent vector of objects which is required to create new objects
8.76.2.3
PoDoFo::PdfOutlineItem::PdfOutlineItem ( const PdfString & sTitle, const PdfAction & rAction, PdfOutlineItem pParentOutline, PdfVecObjects pParent ) [protected]
Create a new PdfOutlineItem from scratch Parameters sTitle title of this item rAction action of this item pParentOutline parent of this outline item in the outline item hierarchie pParent parent vector of objects which is required to create new objects
8.76 PoDoFo::PdfOutlineItem Class Reference 8.76.2.4 PoDoFo::PdfOutlineItem::PdfOutlineItem ( PdfObject pObject, PdfOutlineItem pParentOutline, PdfOutlineItem pPrevious ) [protected]
291
Create a PdfOutlineItem from an existing PdfObject Parameters pObject an existing outline item pParentOutline parent of this outline item in the outline item hierarchie pPrevious previous item of this item
8.76.3
8.76.3.1

PdfOutlineItem PoDoFo::PdfOutlineItem::CreateChild ( const PdfString & sTitle, const PdfDestination & rDest )
Create a PdfOutlineItem that is a child of this item Parameters sTitle title of this item rDest destination of this item
8.76.3.2
PdfOutlineItem PoDoFo::PdfOutlineItem::CreateNext ( const PdfString & sTitle, const PdfDestination & rDest )
Create a PdfOutlineItem that is on the same level and follows the current item. Parameters sTitle title of this item rDest destination of this item
8.76.3.3
PdfOutlineItem PoDoFo::PdfOutlineItem::CreateNext ( const PdfString & sTitle, const PdfAction & rAction )
Create a PdfOutlineItem that is on the same level and follows the current item. Parameters sTitle title of this item rAction action of this item
8.76.3.4
void PoDoFo::PdfOutlineItem::Erase (
Deletes this outline item and all its children from the outline hierarchy and removes all objects from the list of PdfObjects All pointers to this item will be invalid after this function call.
292 8.76.3.5 Returns the rst outline item that is a child of this item
Class Documentation PdfOutlineItem PoDoFo::PdfOutlineItem::First ( [inline] ) const
8.76.3.6
PdfAction PoDoFo::PdfOutlineItem::GetAction ( void )
Get the action of this outline. Returns the action, if there is one, or NULL
8.76.3.7
PdfDestination PoDoFo::PdfOutlineItem::GetDestination ( PdfDocument pDoc )
Get the destination of this outline. Parameters pDoc a PdfDocument owning this annotation. This is required to resolve names and pages. Returns the destination, if there is one, or NULL
8.76.3.8 Returns
PdfOutlineItem PoDoFo::PdfOutlineItem::GetParentOutline ( const [inline]
the parent item of this item or NULL if it is the top level outlines dictionary
8.76.3.9
double PoDoFo::PdfOutlineItem::GetTextColorBlue (
) const
Get the color of the title of this item. Supported since PDF 1.4. Returns the red color component See also SetTextColor
8.76 PoDoFo::PdfOutlineItem Class Reference 8.76.3.10 double PoDoFo::PdfOutlineItem::GetTextColorGreen ( ) const
293
8.76.3.11
double PoDoFo::PdfOutlineItem::GetTextColorRed (
) const
8.76.3.12
EPdfOutlineFormat PoDoFo::PdfOutlineItem::GetTextFormat ( const
Get the text format of the title Returns the text format of the title
8.76.3.13
const PdfString & PoDoFo::PdfOutlineItem::GetTitle (
) const
Get the title of this item Returns the title as PdfString
8.76.3.14
void PoDoFo::PdfOutlineItem::InsertChild ( PdfOutlineItem pItem )
Inserts an existing PdfOutlineItem as a child of this outline item. Parameters pItem an existing outline item
294 8.76.3.15 Returns the last outline item that is a child of this item
Class Documentation PdfOutlineItem PoDoFo::PdfOutlineItem::Last ( [inline] ) const
8.76.3.16 Returns
PdfOutlineItem PoDoFo::PdfOutlineItem::Next ( [inline]
) const
the next item or NULL if this is the last on the current level
8.76.3.17 Returns
PdfOutlineItem PoDoFo::PdfOutlineItem::Prev ( [inline]
) const
the previous item or NULL if this is the rst on the current level
8.76.3.18
void PoDoFo::PdfOutlineItem::SetAction ( const PdfAction & rAction )
Set the action of this outline. Parameters rAction the action
8.76.3.19
void PoDoFo::PdfOutlineItem::SetDestination ( const PdfDestination & rDest )
Set the destination of this outline. Parameters rDest the destination
8.76.3.20
void PoDoFo::PdfOutlineItem::SetTextColor ( double r, double g, double b )
Set the color of the title of this item. This property is supported since PDF 1.4. Parameters r red color component g green color component b blue color component
8.77 PoDoFo::PdfOutlines Class Reference 8.76.3.21
295
void PoDoFo::PdfOutlineItem::SetTextFormat ( EPdfOutlineFormat eFormat )
Set the text format of the title. Supported since PDF 1.4. Parameters eFormat the formatting options for the title
8.76.3.22
void PoDoFo::PdfOutlineItem::SetTitle ( const PdfString & sTitle )
Set the title of this outline item Parameters sTitle the title to use
8.77
PoDoFo::PdfOutlines Class Reference
#include <PdfOutlines.h> Inheritance diagram for PoDoFo::PdfOutlines:

PoDoFo::PdfElement
PoDoFo::PdfOutlineItem
PoDoFo::PdfOutlines

PdfOutlines (PdfVecObjects pParent) PdfOutlines (PdfObject pObject) PdfOutlineItem CreateRoot (const PdfString &sTitle)
8.77.1
The main PDF outlines dictionary. Do not create it by yourself but use PdfDocument::GetOutlines() instead. See also PdfDocument
296
Class Documentation
8.77.2
8.77.2.1

PoDoFo::PdfOutlines::PdfOutlines ( PdfVecObjects pParent )
Create a new PDF outlines dictionary Parameters pParent parent vector of objects
8.77.2.2
PoDoFo::PdfOutlines::PdfOutlines ( PdfObject pObject )
Create a PDF outlines object from an existing dictionary Parameters pObject an existing outlines dictionary
8.77.3
8.77.3.1

PdfOutlineItem PoDoFo::PdfOutlines::CreateRoot ( const PdfString & sTitle )
Create the root node of the outline item tree. Parameters sTitle the title of the root node
8.78
PoDoFo::PdfOutputDevice Class Reference
#include <PdfOutputDevice.h> Inheritance diagram for PoDoFo::PdfOutputDevice:
PoDoFo::PdfOutputDevice PoDoFo::PdfSignOutputDevice

PdfOutputDevice () PdfOutputDevice (const char pszFilename) PdfOutputDevice (char pBuffer, size_t lLen)
8.78 PoDoFo::PdfOutputDevice Class Reference PdfOutputDevice (const std::ostream pOutStream) PdfOutputDevice (PdfRefCountedBuffer pOutBuffer) virtual PdfOutputDevice () virtual size_t GetLength () const virtual void Print (const char pszFormat,...) virtual void PrintV (const char pszFormat, long lBytes, va_list argptr) long PrintVLen (const char pszFormat, va_list args) virtual void Write (const char pBuffer, size_t lLen) virtual size_t Read (char pBuffer, size_t lLen) virtual void Seek (size_t offset) virtual size_t Tell () const virtual void Flush ()
297
8.78.1
This class provides an output device which operates either on a le or on a buffer in memory. Additionally it can count the bytes written to the device. This class is suitable for inheritance to provide output devices of your own for PoDoFo. Just overide the required virtual methods.
8.78.2
8.78.2.1

PoDoFo::PdfOutputDevice::PdfOutputDevice ( )
Construct a new PdfOutputDevice that does not write any data. Only the length of the data is counted. 8.78.2.2 PoDoFo::PdfOutputDevice::PdfOutputDevice ( const char pszFilename )
Construct a new PdfOutputDevice that writes all data to a le. Parameters pszFilename path to a le that will be opened and all data is written to this le.
8.78.2.3
PoDoFo::PdfOutputDevice::PdfOutputDevice ( char pBuffer, size_t lLen )
Construct a new PdfOutputDevice that writes all data to a memory buffer. The buffer will not be owned by this object and has to be allocated before. Parameters pBuffer a buffer in memory lLen the length of the buffer in memory
298 8.78.2.4
Class Documentation PoDoFo::PdfOutputDevice::PdfOutputDevice ( const std::ostream pOutStream )
Construct a new PdfOutputDevice that writes all data to a std::ostream. WARNING: PoDoFo will change the streams locale. It will be restored when the PdfOutputStream controlling the stream is destroyed. Parameters pOutStream write to this std::ostream
8.78.2.5
PoDoFo::PdfOutputDevice::PdfOutputDevice ( PdfRefCountedBuffer pOutBuffer )
Construct a new PdfOutputDevice that writes all data to a PdfRefCountedBuffer. This output device has the advantage that the PdfRefCountedBuffer will resize itself if more memory is needed to hold all data. Parameters pOutBuffer write to this PdfRefCountedBuffer See also PdfRefCountedBuffer
8.78.2.6
PoDoFo::PdfOutputDevice::PdfOutputDevice (
) [virtual]
Destruct the PdfOutputDevice object and close any open les.
8.78.3
8.78.3.1

void PoDoFo::PdfOutputDevice::Flush ( ) [virtual]
Flush the output les buffer to disk if this devices operates on a disk. Reimplemented in PoDoFo::PdfSignOutputDevice. 8.78.3.2 size_t PoDoFo::PdfOutputDevice::GetLength ( virtual] ) const [inline,
The number of bytes written to this object. Returns the number of bytes written to this object.
8.78 PoDoFo::PdfOutputDevice Class Reference See also Init Reimplemented in PoDoFo::PdfSignOutputDevice. void PoDoFo::PdfOutputDevice::Print ( const char pszFormat, ) [virtual]
299
8.78.3.3
...
Write to the PdfOutputDevice. Usage is as the usage of printf. WARNING: Do not use this for doubles or oating point values as the output might depend on the current locale. Parameters pszFormat a format string as you would use it with printf Returns ErrOk on success See also Write Reimplemented in PoDoFo::PdfSignOutputDevice. void PoDoFo::PdfOutputDevice::PrintV ( const char pszFormat, long lBytes, va_list argptr ) [virtual]
8.78.3.4
Write to the PdfOutputDevice. Usage is as the usage of printf. WARNING: Do not use this for doubles or oating point values as the output might depend on the current locale. Parameters pszFormat a format string as you would use it with printf lBytes length of the format string in bytes when written argptr variable argument list Returns ErrOk on success See also Write
300 8.78.3.5
Class Documentation long PoDoFo::PdfOutputDevice::PrintVLen ( const char pszFormat, va_list args )
Determine the length of a format string in bytes when written using PrintV Parameters pszFormat format string args variable argument list Returns length in bytes See also PrintV
8.78.3.6
size_t PoDoFo::PdfOutputDevice::Read ( char pBuffer, size_t lLen ) [virtual]
Read data from the device Parameters pBuffer a pointer to the data buffer lLen length of the output buffer Returns Number of read bytes. Return 0 if EOF Reimplemented in PoDoFo::PdfSignOutputDevice. 8.78.3.7 void PoDoFo::PdfOutputDevice::Seek ( size_t offset ) [virtual]
Seek the device to the position offset from the begining Parameters offset from the beginning of the le Reimplemented in PoDoFo::PdfSignOutputDevice. 8.78.3.8 size_t PoDoFo::PdfOutputDevice::Tell ( virtual] ) const [inline,
Get the current offset from the beginning of the le.

8.79 PoDoFo::PdfOutputStream Class Reference Returns the offset form the beginning of the le. Reimplemented in PoDoFo::PdfSignOutputDevice.
301
8.78.3.9
void PoDoFo::PdfOutputDevice::Write ( const char pBuffer, size_t lLen ) [virtual]
Write data to the buffer. Use this call instead of Print if you want to write binary data to the PdfOutputDevice. Parameters pBuffer a pointer to the data buffer lLen write lLen bytes of pBuffer to the PdfOutputDevice Returns ErrOk on success See also Print Reimplemented in PoDoFo::PdfSignOutputDevice.
8.79
PoDoFo::PdfOutputStream Class Reference
#include <PdfOutputStream.h> Inheritance diagram for PoDoFo::PdfOutputStream:

PoDoFo::PdfOutputStream PoDoFo::PdfBufferOutputStream PoDoFo::PdfDeviceOutputStream PoDoFo::PdfFileOutputStream PoDoFo::PdfFilteredDecodeStream PoDoFo::PdfFilteredEncodeStream PoDoFo::PdfMemoryOutputStream PoDoFo::PdfRC4OutputStream

virtual pdf_long Write (const char pBuffer, pdf_long lLen)=0 pdf_long Write (const std::string &s) virtual void Close ()=0
8.79.1
An interface for writing blocks of data to a data source.

302
Class Documentation
8.79.2
8.79.2.1

virtual void PoDoFo::PdfOutputStream::Close ( virtual] ) [pure
Close the PdfOutputStream. This method may throw exceptions and has to be called before the descructor to end writing. No more data may be written to the output device after calling close. Implemented in PoDoFo::PdfRC4OutputStream, PoDoFo::PdfFilteredEncodeStream, PoDoFo::PdfFilteredDecodeStream, PoDoFo::PdfFileOutputStream, PoDoFo::PdfMemoryOutputStream, PoDoFo::PdfDeviceOutputStream, and PoDoFo::PdfBufferOutputStream.
8.79.2.2
virtual pdf_long PoDoFo::PdfOutputStream::Write ( const char pBuffer, pdf_long lLen ) [pure virtual]
Write data to the output stream Parameters pBuffer the data is read from this buffer lLen the size of the buffer Returns the number of bytes written, -1 if an error ocurred Implemented in PoDoFo::PdfRC4OutputStream, PoDoFo::PdfFilteredEncodeStream, PoDoFo::PdfFilteredDecodeStream, PoDoFo::PdfFileOutputStream, PoDoFo::PdfMemoryOutputStream, PoDoFo::PdfDeviceOutputStream, and PoDoFo::PdfBufferOutputStream.
8.79.2.3
pdf_long PoDoFo::PdfOutputStream::Write ( const std::string & s ) [inline]
Helper that writes a string via Write(const char,long)
8.80
PoDoFo::PdfPage Class Reference
#include <PdfPage.h> Inheritance diagram for PoDoFo::PdfPage:

8.80 PoDoFo::PdfPage Class Reference
303
PoDoFo::PdfElement
PoDoFo::PdfCanvas
PoDoFo::PdfPage

PdfPage (const PdfRect &rSize, PdfDocument pParent) PdfPage (const PdfRect &rSize, PdfVecObjects pParent) PdfPage (PdfObject pObject, const std::deque< PdfObject > &listOfParents) virtual const PdfRect GetPageSize () const bool SetPageWidth (int newWidth) bool SetPageHeight (int newHeight) void SetTrimBox (const PdfRect &rSize) unsigned int GetPageNumber () const virtual PdfObject GetContents () const virtual PdfObject GetContentsForAppending () const virtual PdfObject GetResources () const virtual const PdfRect GetMediaBox () const virtual const PdfRect GetCropBox () const virtual const PdfRect GetTrimBox () const virtual const PdfRect GetBleedBox () const virtual const PdfRect GetArtBox () const virtual int GetRotation () const virtual int GetNumAnnots () const PdfAnnotation CreateAnnotation (EPdfAnnotation eType, const PdfRect &rRect) PdfAnnotation GetAnnotation (int index) void DeleteAnnotation (int index) void DeleteAnnotation (const PdfReference &ref) int GetNumFields () const PdfField GetField (int index) const PdfField GetField (int index) const PdfObject GetFromResources (const PdfName &rType, const PdfName &rKey) const PdfObject GetInheritedKey (const PdfName &rName) const

static PdfRect CreateStandardPageSize (const EPdfPageSize ePageSize, bool bLandscape=false)
304
Class Documentation
8.80.1
PdfPage is one page in the pdf document. It is possible to draw on a page using a PdfPainter object. Every document needs at least one page.
8.80.2
8.80.2.1

PoDoFo::PdfPage::PdfPage ( const PdfRect & rSize, PdfDocument pParent )
Create a new PdfPage object. Parameters rSize a PdfRect specifying the size of the page (i.e the /MediaBox key) in PDF units pParent add the page to this parent
8.80.2.2
PoDoFo::PdfPage::PdfPage ( const PdfRect & rSize, PdfVecObjects pParent )
Create a new PdfPage object. Parameters rSize a PdfRect specifying the size of the page (i.e the /MediaBox key) in PDF units pParent add the page to this parent
8.80.2.3
PoDoFo::PdfPage::PdfPage ( PdfObject pObject, const std::deque< PdfObject > & listOfParents )
Create a PdfPage based on an existing PdfObject Parameters pObject an existing PdfObject listOfParents a list of PdfObjects that are parents of this page and can be queried for inherited attributes. The last object in the list is the most direct parent of this page.
8.80.3
8.80.3.1

PdfAnnotation PoDoFo::PdfPage::CreateAnnotation ( EPdfAnnotation eType, const PdfRect & rRect )
Create a new annotation to this page.

8.80 PoDoFo::PdfPage Class Reference Parameters eType the type of the annotation rRect rectangle of the annotation on the page Returns the annotation object which is owned by the PdfPage
305
8.80.3.2
PdfRect PoDoFo::PdfPage::CreateStandardPageSize ( const EPdfPageSize ePageSize, bool bLandscape = false ) [static]
Creates a PdfRect with the page size as values which is needed to create a PdfPage object from an enum which are dened for a few standard page sizes. Parameters ePageSize the page size you want bLandscape create a landscape pagesize instead of portrait (by exchanging width and height) Returns a PdfRect object which can be passed to the PdfPage constructor
8.80.3.3
void PoDoFo::PdfPage::DeleteAnnotation ( int index )
Delete the annotation with index index from this page. Parameters index the index of the annotation to delete See also GetNumAnnots
8.80.3.4
void PoDoFo::PdfPage::DeleteAnnotation ( const PdfReference & ref )
Delete the annotation object with reference ref from this page. Parameters ref the reference of an annotation object of this page. See also GetNumAnnots
306 8.80.3.5
Class Documentation PdfAnnotation PoDoFo::PdfPage::GetAnnotation ( int index )
Get the annotation with index index of the current page. Parameters index the index of the annotation to retrieve Returns a annotation object. The annotation object is owned by the PdfPage. See also GetNumAnnots
8.80.3.6
virtual const PdfRect PoDoFo::PdfPage::GetArtBox ( [inline, virtual]
) const
Get the current ArtBox in PDF units. Returns PdfRect the page box
8.80.3.7
virtual const PdfRect PoDoFo::PdfPage::GetBleedBox ( [inline, virtual]
) const
Get the current BleedBox (extra area for printing purposes) in PDF units. Returns PdfRect the page box
8.80.3.8
PdfObject PoDoFo::PdfPage::GetContents (
) const [virtual]
Get access to the contents object of this page. If you want to draw onto the page, you have to add drawing commands to the stream of the Contents object. Returns a contents object Implements PoDoFo::PdfCanvas.
8.80 PoDoFo::PdfPage Class Reference 8.80.3.9 PdfObject PoDoFo::PdfPage::GetContentsForAppending ( [virtual]
307 ) const
Get access an object that you can use to ADD drawing to. If you want to draw onto the page, you have to add drawing commands to the stream of the Contents object. Returns a contents object Implements PoDoFo::PdfCanvas. 8.80.3.10 virtual const PdfRect PoDoFo::PdfPage::GetCropBox ( [inline, virtual] ) const
Get the current CropBox (visible page size) in PDF units. Returns PdfRect the page box
8.80.3.11
const PdfField PoDoFo::PdfPage::GetField ( int index ) const
Get a PdfField with a certain index. Parameters index of the PdfField (must be smaller than GetNumFields() ) See also GetNumFields Returns a constP dfField
8.80.3.12
PdfField PoDoFo::PdfPage::GetField ( int index )
Get a PdfField with a certain index. Parameters index of the PdfField (must be smaller than GetNumFields() ) See also GetNumFields Returns a PdfField
308 8.80.3.13
Class Documentation PdfObject PoDoFo::PdfPage::GetFromResources ( const PdfName & rType, const PdfName & rKey )
Get an element from the pages resources dictionary, using a type (category) and a key. Parameters rType the type of resource to fetch (e.g. /Font, or /XObject) rKey the key of the resource Returns the object of the resource or NULL if it was not found
8.80.3.14
const PdfObject PoDoFo::PdfPage::GetInheritedKey ( const PdfName & rName ) const [inline]
Method for getting a value that can be inherited Possible names that can be inherited according to the PDF specication are: Resources, MediaBox, CropBox and Rotate Returns PdfObject - the result of the key fetching or NULL
8.80.3.15
virtual const PdfRect PoDoFo::PdfPage::GetMediaBox ( [inline, virtual]
) const
Get the current MediaBox (physical page size) in PDF units. Returns PdfRect the page box
8.80.3.16
int PoDoFo::PdfPage::GetNumAnnots (
) const [virtual]
Get the number of annotations associated with this page \ returns int number of annotations
8.80.3.17 Returns
int PoDoFo::PdfPage::GetNumFields (
) const
the number of PdfFields on this page.
8.80 PoDoFo::PdfPage Class Reference 8.80.3.18 unsigned int PoDoFo::PdfPage::GetPageNumber ( ) const
309
Page number inside of the document. The rst page has the number 1, the last page has the number PdfPagesTree:GetTotalNumberOfPages() Returns the number of the page inside of the document See also PdfPagesTree:GetTotalNumberOfPages()
8.80.3.19
const PdfRect PoDoFo::PdfPage::GetPageSize ( ) const [inline, virtual]
Get the current page size in PDF Units Returns a PdfRect containing the page size available for drawing Implements PoDoFo::PdfCanvas. 8.80.3.20 PdfObject PoDoFo::PdfPage::GetResources ( virtual] ) const [inline,
Get access to the resources object of this page. This is most likely an internal object. Returns a resources object Implements PoDoFo::PdfCanvas. 8.80.3.21 int PoDoFo::PdfPage::GetRotation ( ) const [virtual]
Get the current page rotation (if any). Returns int 0, 90, 180 or 270
8.80.3.22
virtual const PdfRect PoDoFo::PdfPage::GetTrimBox ( [inline, virtual]
) const
Get the current TrimBox (cut area) in PDF units. Returns PdfRect the page box
310 8.80.3.23
Class Documentation bool PoDoFo::PdfPage::SetPageHeight ( int newHeight )
Set the current page height in PDF Units Returns true if successfull, false otherwise
8.80.3.24
bool PoDoFo::PdfPage::SetPageWidth ( int newWidth )
Set the current page width in PDF Units Returns true if successfull, false otherwise
8.80.3.25
void PoDoFo::PdfPage::SetTrimBox ( const PdfRect & rSize )
Set the trimbox in PDF Units Parameters rSize a PdfRect specifying the trimbox of the page (i.e the /TrimBox key) in PDF units
8.81
PoDoFo::PdfPagesTree Class Reference
#include <PdfPagesTree.h> Inheritance diagram for PoDoFo::PdfPagesTree:
PoDoFo::PdfElement PoDoFo::PdfPagesTree

PdfPagesTree (PdfVecObjects pParent) PdfPagesTree (PdfObject pPagesRoot) virtual PdfPagesTree () int GetTotalNumberOfPages () const PdfPage GetPage (int nIndex) PdfPage GetPage (const PdfReference &ref)
8.81 PoDoFo::PdfPagesTree Class Reference void InsertPage (int nAfterPageNumber, PdfObject pPage) void InsertPage (int nAfterPageNumber, PdfPage pPage) PdfPage CreatePage (const PdfRect &rSize) void DeletePage (int inPageNumber) void ClearCache ()
311
8.81.1
Class for managing the tree of Pages in a PDF document Dont use this class directly. Use PdfDocument instead. See also PdfDocument
8.81.2
8.81.2.1

PoDoFo::PdfPagesTree::PdfPagesTree ( PdfVecObjects pParent )
Construct a new PdfPagesTree
8.81.2.2
PoDoFo::PdfPagesTree::PdfPagesTree ( PdfObject pPagesRoot )
Construct a PdfPagesTree from the root /Pages object Parameters pPagesRoot pointer to page tree dictionary
8.81.2.3
PoDoFo::PdfPagesTree::PdfPagesTree (
) [virtual]
Close/down destruct a PdfPagesTree
8.81.3
8.81.3.1

void PoDoFo::PdfPagesTree::ClearCache ( ) [inline]
Clear internal cache of PdfPage objects. All references to PdfPage object will become invalid when calling this method. All PdfPages will be deleted. You normally will never have to call this method. It is only useful if one modied the page nodes of the pagestree manually.
312 8.81.3.2
Class Documentation PdfPage PoDoFo::PdfPagesTree::CreatePage ( const PdfRect & rSize )
Creates a new page object and inserts it into the internal page tree. The returned page is owned by the pages tree and will get deleted along with it! Parameters rSize a PdfRect specifying the size of the page (i.e the /MediaBox key) in PDF units Returns a pointer to a PdfPage object
8.81.3.3
void PoDoFo::PdfPagesTree::DeletePage ( int inPageNumber )
Delete the specied page object from the internal pages tree. It does NOT remove any PdfObjects from memory - just the reference from the tree Parameters inPageNumber the page number (0-based) to be removed The PdfPage object refering to this page will be deleted by this call! Empty page nodes will also be deleted. See also PdfMemDocument::DeletePages
8.81.3.4
PdfPage PoDoFo::PdfPagesTree::GetPage ( const PdfReference & ref )
Return a PdfPage for the specied Page reference. The returned page is owned by the pages tree and deleted along with it. Parameters ref the reference of the pages object Returns a pointer to the requested page
8.81 PoDoFo::PdfPagesTree Class Reference 8.81.3.5 PdfPage PoDoFo::PdfPagesTree::GetPage ( int nIndex )
313
Return a PdfPage for the specied Page index The returned page is owned by the pages tree and deleted along with it. Parameters nIndex page index, 0-based Returns a pointer to the requested page
8.81.3.6
int PoDoFo::PdfPagesTree::GetTotalNumberOfPages (
) const
Return the number of pages in the entire tree Returns number of pages
8.81.3.7
void PoDoFo::PdfPagesTree::InsertPage ( int nAfterPageNumber, PdfPage pPage )
Inserts an existing page object into the internal page tree. after the specied page number Parameters nAfterPageNumber an integer specifying after what page may be one of the special values from EPdfPageInsertionPoint. Pages are 0 based. pPage a PdfPage to be inserted, the PdfPage will not get owned by the PdfPagesTree
8.81.3.8
void PoDoFo::PdfPagesTree::InsertPage ( int nAfterPageNumber, PdfObject pPage )
Inserts an existing page object into the internal page tree. after the specied page number Parameters nAfterPageNumber an integer specifying after what page may be one of the special values from EPdfPageInsertionPoint. Pages are 0 based. pPage musst be a PdfObject with type /Page
314
Class Documentation
8.82
PoDoFo::PdfPagesTreeCache Class Reference
#include <PdfPagesTreeCache.h>

PdfPagesTreeCache (int nInitialSize) virtual PdfPagesTreeCache () virtual PdfPage GetPage (int nIndex) virtual void AddPageObject (int nIndex, PdfPage pPage) virtual void InsertPage (int nIndex) virtual void DeletePage (int nIndex) virtual void ClearCache ()
8.82.1
This class implements a cache infront of a PdfPagesTree See also PdfCachedPagesTree
8.82.2
8.82.2.1

PoDoFo::PdfPagesTreeCache::PdfPagesTreeCache ( int nInitialSize )
Construct a new PdfCachedPagesTree. Parameters nInitialSize initial size of the pagestree
8.82.2.2
PoDoFo::PdfPagesTreeCache::PdfPagesTreeCache ( [virtual]
Close/down destruct a PdfCachedPagesTree
8.82.3
8.82.3.1

void PoDoFo::PdfPagesTreeCache::AddPageObject ( int nIndex, PdfPage pPage ) [virtual]
Add a PdfPage object to the cache

8.83 PoDoFo::PdfPainter Class Reference Parameters nIndex index of the page pPage page object
315
8.82.3.2
void PoDoFo::PdfPagesTreeCache::ClearCache (
) [virtual]
Clear cache, i.e. remove all elements from the cache. 8.82.3.3 void PoDoFo::PdfPagesTreeCache::DeletePage ( int nIndex ) [virtual]
Delete a PdfPage from the cache Parameters nIndex index of the page
8.82.3.4
PdfPage PoDoFo::PdfPagesTreeCache::GetPage ( int nIndex ) [virtual]
Return a PdfPage for the specied Page index The returned page is owned by the pages tree and deleted along with it. Parameters nIndex page index, 0-based Returns a pointer to the requested page or NULL if it is not cached
8.82.3.5
void PoDoFo::PdfPagesTreeCache::InsertPage ( int nIndex ) [virtual]
A page was inserted into the pagestree, therefore the cache has to be updated Parameters nIndex index where the page was inserted
8.83
PoDoFo::PdfPainter Class Reference
#include <PdfPainter.h> Inheritance diagram for PoDoFo::PdfPainter:

316
Class Documentation
PoDoFo::PdfPainter
PoDoFo::PdfPainterMM

PdfPainter () void SetPage (PdfCanvas pPage) const PdfCanvas GetPage () const void FinishPage () void SetStrokingGray (double g) void SetGray (double g) void SetStrokingColor (double r, double g, double b) void SetColor (double r, double g, double b) void SetStrokingColorCMYK (double c, double m, double y, double k) void SetColorCMYK (double c, double m, double y, double k) void SetStrokingShadingPattern (const PdfShadingPattern &rPattern) void SetShadingPattern (const PdfShadingPattern &rPattern) void SetStrokingColor (const PdfColor &rColor) void SetColor (const PdfColor &rColor) void SetStrokeWidth (double dWidth) void SetStrokeStyle (EPdfStrokeStyle eStyle, const char pszCustom=NULL) void SetLineCapStyle (EPdfLineCapStyle eCapStyle) void SetLineJoinStyle (EPdfLineJoinStyle eJoinStyle) void SetFont (PdfFont pFont) PdfFont GetFont () const void SetClipRect (double dX, double dY, double dWidth, double dHeight) void SetClipRect (const PdfRect &rRect) void DrawLine (double dStartX, double dStartY, double dEndX, double dEndY) void DrawRect (double dX, double dY, double dWidth, double dHeight, double dRoundX=0.0, double dRoundY=0.0) void DrawRect (const PdfRect &rRect, double dRoundX=0.0, double dRoundY=0.0) void FillRect (double dX, double dY, double dWidth, double dHeight, double dRoundX=0.0, double dRoundY=0.0) void FillRect (const PdfRect &rRect, double dRoundX=0.0, double dRoundY=0.0) void DrawEllipse (double dX, double dY, double dWidth, double dHeight) void FillEllipse (double dX, double dY, double dWidth, double dHeight) void DrawCircle (double dX, double dY, double dRadius) void FillCircle (double dX, double dY, double dRadius) void DrawText (double dX, double dY, const PdfString &sText) void DrawText (double dX, double dY, const PdfString &sText, long lLen)
8.83 PoDoFo::PdfPainter Class Reference
317
void DrawMultiLineText (double dX, double dY, double dWidth, double dHeight, const PdfString &rsText, EPdfAlignment eAlignment=ePdfAlignment_Left, EPdfVerticalAlignment eVertical=ePdfVerticalAlignment_Top) void DrawMultiLineText (const PdfRect &rRect, const PdfString &rsText, EPdfAlignment eAlignment=ePdfAlignment_Left, EPdfVerticalAlignment eVertical=ePdfVerticalAlignment_Top) std::vector< TLineElement > GetMultiLineTextAsLines (double dWidth, const PdfString &rsText) void DrawTextAligned (double dX, double dY, double dWidth, const PdfString &rsText, EPdfAlignment eAlignment) void BeginText (double dX, double dY) void AddText (const PdfString &sText) void AddText (const PdfString &sText, pdf_long lStringLen) void MoveTextPos (double dX, double dY) void EndText () void DrawGlyph (PdfMemDocument pDocument, double dX, double dY, const char pszGlyphname) void DrawImage (double dX, double dY, PdfImage pObject, double dScaleX=1.0, double dScaleY=1.0) void DrawXObject (double dX, double dY, PdfXObject pObject, double dScaleX=1.0, double dScaleY=1.0) void ClosePath () void LineTo (double dX, double dY) void MoveTo (double dX, double dY) void CubicBezierTo (double dX1, double dY1, double dX2, double dY2, double dX3, double dY3) void HorizonalLineTo (double dX) void VerticalLineTo (double dY) void SmoothCurveTo (double dX2, double dY2, double dX3, double dY3) void QuadCurveTo (double dX1, double dY1, double dX3, double dY3) void SmoothQuadCurveTo (double dX3, double dY3) void ArcTo (double dX, double dY, double dRadiusX, double dRadiusY, double dRotation, bool bLarge, bool bSweep) void Close () void Stroke () void Fill () void Clip (bool useEvenOddRule=false) void Save () void Restore () void SetTransformationMatrix (double a, double b, double c, double d, double e, double f) void SetExtGState (PdfExtGState inGState) void SetRenderingIntent (char intent) void SetTabWidth (unsigned short nTabWidth) unsigned short GetTabWidth () const void SetPrecision (unsigned short inPrec) unsigned short GetPrecision () const
318
Class Documentation

void SetCurrentStrokingColor () PdfString ExpandTabs (const PdfString &rsString, pdf_long lLen) const
PdfStream m_pCanvas PdfCanvas m_pPage PdfFont m_pFont unsigned short m_nTabWidth PdfColor m_curColor bool m_isTextOpen std::ostringstream m_oss
8.83.1
This class provides an easy to use painter object which allows you to draw on a PDF page object. During all drawing operations, you are still able to access the stream of the object you are drawing on directly. All functions that take coordinates expect these to be in PDF User Units. Keep in mind that PDF has its coordinate system origin at the bottom left corner.
8.83.2
8.83.2.1

PoDoFo::PdfPainter::PdfPainter ( )
Create a new PdfPainter object.
8.83.3
8.83.3.1

void PoDoFo::PdfPainter::AddText ( const PdfString & sText )
Draw a string on a page. You have to call BeginText before the rst call of this function and EndText after the last call. If you want more simpler text output and do not need the advanced text position features of MoveTextPos use DrawText which is easier. Parameters sText the text string which should be printed
8.83 PoDoFo::PdfPainter Class Reference See also SetFont() MoveTextPos() EndText()
319
8.83.3.2
void PoDoFo::PdfPainter::AddText ( const PdfString & sText, pdf_long lStringLen )
Draw a string on a page. You have to call BeginText before the rst call of this function and EndText after the last call. If you want more simpler text output and do not need the advanced text position features of MoveTextPos use DrawText which is easier. Parameters sText the text string which should be printed lStringLen draw only lLen characters of pszText See also SetFont() MoveTextPos() EndText()
8.83.3.3
void PoDoFo::PdfPainter::ArcTo ( double dX, double dY, double dRadiusX, double dRadiusY, double dRotation, bool bLarge, bool bSweep )
Append a Arc to the current path Matches the SVG A operator. Parameters dX x coordinate of the start point dY y coordinate of the start point dRadiusX x coordinate of the end point, which is the new current point dRadiusY y coordinate of the end point, which is the new current point dRotation degree of rotation in radians bLarge large or small portion of the arc bSweep sweep?
320 8.83.3.4
Class Documentation void PoDoFo::PdfPainter::BeginText ( double dX, double dY )
Begin drawing multiple text strings on a page using a given font object. You have to call SetFont before calling this function. If you want more simpler text output and do not need the advanced text position features of MoveTextPos use DrawText which is easier. Parameters dX the x coordinate dY the y coordinate See also SetFont() AddText() MoveTextPos() EndText()
8.83.3.5
void PoDoFo::PdfPainter::Clip ( bool useEvenOddRule = false )
Clip the current path. Matches the PDF W operator. This function is useful to construct an own path for drawing or clipping. Parameters useEvenOddRule select even-odd rule instead of nonzero winding number rule
8.83.3.6
void PoDoFo::PdfPainter::Close (
Close the current path. Matches the PDF h operator. 8.83.3.7 void PoDoFo::PdfPainter::ClosePath ( )
Closes the current path by drawing a line from the current point to the starting point of the path. Matches the PDF h operator. This function is useful to construct an own path for drawing or clipping. 8.83.3.8 void PoDoFo::PdfPainter::CubicBezierTo ( double dX1, double dY1, double dX2, double dY2, double dX3, double dY3 )
Append a cubic bezier curve to the current path Matches the PDF c operator. Parameters dX1 x coordinate of the rst control point
8.83 PoDoFo::PdfPainter Class Reference dY1 y coordinate of the rst control point dX2 x coordinate of the second control point dY2 y coordinate of the second control point dX3 x coordinate of the end point, which is the new current point dY3 y coordinate of the end point, which is the new current point
321
8.83.3.9
void PoDoFo::PdfPainter::DrawCircle ( double dX, double dY, double dRadius )
Draw a circle with the current stroking settings Parameters dX x center coordinate of the circle dY y coordinate of the circle dRadius radius of the circle
8.83.3.10
void PoDoFo::PdfPainter::DrawEllipse ( double dX, double dY, double dWidth, double dHeight )
Draw an ellipse with the current stroking settings Parameters dX x coordinate of the ellipse (left coordinate) dY y coordinate of the ellipse (top coordinate) dWidth width of the ellipse dHeight absolute height of the ellipse
8.83.3.11
void PoDoFo::PdfPainter::DrawGlyph ( PdfMemDocument pDocument, double dX, double dY, const char pszGlyphname )
Draw a single glyph on a page using a given font object. Parameters pDocument pointer to the document, needed to generate a copy of the current font dX the x coordinate dY the y coordinate pszGlyphname the name of the glyph which should be printed See also SetFont()
322 8.83.3.12
Class Documentation void PoDoFo::PdfPainter::DrawImage ( double dX, double dY, PdfImage pObject, double dScaleX = 1.0, double dScaleY = 1.0 )
Draw an image on the current page. Parameters dX the x coordinate (bottom left position of the image) dY the y coordinate (bottom position of the image) pObject an PdfXObject dScaleX option scaling factor in x direction dScaleY option scaling factor in y direction
8.83.3.13
void PoDoFo::PdfPainter::DrawLine ( double dStartX, double dStartY, double dEndX, double dEndY )
Draw a line with the current color and line settings. Parameters dStartX x coordinate of the starting point dStartY y coordinate of the starting point dEndX x coordinate of the ending point dEndY y coordinate of the ending point
8.83.3.14
void PoDoFo::PdfPainter::DrawMultiLineText ( double dX, double dY, double dWidth, double dHeight, const PdfString & rsText, EPdfAlignment eAlignment = ePdfAlignment_Left, EPdfVerticalAlignment eVertical = ePdfVerticalAlignment_Top )
Draw multiline text into a rectangle doing automatic wordwrapping. The current font is used and SetFont has to be called at least once before using this function Parameters dX the x coordinate of the text area (left) dY the y coordinate of the text area (bottom) dWidth width of the text area dHeight height of the text area rsText the text which should be drawn eAlignment alignment of the individual text lines in the given bounding box eVertical vertical alignment of the text in the given bounding box
8.83 PoDoFo::PdfPainter Class Reference 8.83.3.15 void PoDoFo::PdfPainter::DrawMultiLineText ( const PdfRect & rRect, const PdfString & rsText, EPdfAlignment eAlignment = ePdfAlignment_Left, EPdfVerticalAlignment eVertical = ePdfVerticalAlignment_Top ) [inline]
323
Draw multiline text into a rectangle doing automatic wordwrapping. The current font is used and SetFont has to be called at least once before using this function Parameters rRect bounding rectangle of the text rsText the text which should be drawn eAlignment alignment of the individual text lines in the given bounding box eVertical vertical alignment of the text in the given bounding box
8.83.3.16
void PoDoFo::PdfPainter::DrawRect ( double dX, double dY, double dWidth, double dHeight, double dRoundX = 0.0, double dRoundY = 0.0 )
Draw a rectangle with the current stroking settings Parameters dX x coordinate of the rectangle (left coordinate) dY y coordinate of the rectangle (bottom coordinate) dWidth width of the rectangle dHeight absolute height of the rectangle dRoundX rounding factor, x direction dRoundY rounding factor, y direction
8.83.3.17
void PoDoFo::PdfPainter::DrawRect ( const PdfRect & rRect, double dRoundX = 0.0, double dRoundY = 0.0 ) [inline]
Draw a rectangle with the current stroking settings Parameters rRect the rectangle area dRoundX rounding factor, x direction dRoundY rounding factor, y direction See also DrawRect
324 8.83.3.18
Class Documentation void PoDoFo::PdfPainter::DrawText ( double dX, double dY, const PdfString & sText, long lLen )
Draw a single-line text string on a page using a given font object. You have to call SetFont before calling this function. Parameters dX the x coordinate dY the y coordinate sText the text string which should be printed (is not allowed to be NULL!) lLen draw only lLen characters of pszText See also SetFont()
8.83.3.19
void PoDoFo::PdfPainter::DrawText ( double dX, double dY, const PdfString & sText )
Draw a single-line text string on a page using a given font object. You have to call SetFont before calling this function. Parameters dX the x coordinate dY the y coordinate sText the text string which should be printed See also SetFont()
8.83.3.20
void PoDoFo::PdfPainter::DrawTextAligned ( double dX, double dY, double dWidth, const PdfString & rsText, EPdfAlignment eAlignment )
Draw a single line of text horizontally aligned. Parameters dX the x coordinate of the text line dY the y coordinate of the text line dWidth the width of the text line rsText the text to draw eAlignment alignment of the text line
8.83 PoDoFo::PdfPainter Class Reference 8.83.3.21
325
void PoDoFo::PdfPainter::DrawXObject ( double dX, double dY, PdfXObject pObject, double dScaleX = 1.0, double dScaleY = 1.0 )
Draw an XObject on the current page. For PdfImage use DrawImage. Parameters dX the x coordinate (bottom left position of the XObject) dY the y coordinate (bottom position of the XObject) pObject an PdfXObject dScaleX option scaling factor in x direction dScaleY option scaling factor in y direction See also DrawImage
8.83.3.22
void PoDoFo::PdfPainter::EndText (
End drawing multiple text strings on a page If you want more simpler text output and do not need the advanced text position features of MoveTextPos use DrawText which is easier. See also BeginText() AddText() MoveTextPos()
8.83.3.23
PdfString PoDoFo::PdfPainter::ExpandTabs ( const PdfString & rsString, pdf_long lLen ) const [protected]
Expand all tab characters in a string using spaces. Parameters rsString expand all tabs in this string using spaces lLen use only lLen characters of rsString Returns an expanded copy of the passed string See also SetTabWidth
326 8.83.3.24 void PoDoFo::PdfPainter::Fill ( )
Class Documentation
Fill the current path. Matches the PDF f operator. This function is useful to construct an own path for drawing or clipping.
8.83.3.25
void PoDoFo::PdfPainter::FillCircle ( double dX, double dY, double dRadius )
Fill a Circle with the current ll settings Parameters dX x center coordinate of the circle dY y coordinate of the circle dRadius radius of the circle
8.83.3.26
void PoDoFo::PdfPainter::FillEllipse ( double dX, double dY, double dWidth, double dHeight )
Fill an ellipse with the current ll settings Parameters dX x coordinate of the ellipse (left coordinate) dY y coordinate of the ellipse (top coordinate) dWidth width of the ellipse dHeight absolute height of the ellipse
8.83.3.27
void PoDoFo::PdfPainter::FillRect ( const PdfRect & rRect, double dRoundX = 0.0, double dRoundY = 0.0 ) [inline]
Fill a rectangle with the current ll settings Parameters rRect the rectangle area dRoundX rounding factor, x direction dRoundY rounding factor, y direction See also FillRect
8.83 PoDoFo::PdfPainter Class Reference 8.83.3.28
327
void PoDoFo::PdfPainter::FillRect ( double dX, double dY, double dWidth, double dHeight, double dRoundX = 0.0, double dRoundY = 0.0 )
Fill a rectangle with the current ll settings Parameters dX x coordinate of the rectangle (left coordinate) dY y coordinate of the rectangle (bottom coordinate) dWidth width of the rectangle dHeight absolute height of the rectangle dRoundX rounding factor, x direction dRoundY rounding factor, y direction
8.83.3.29
void PoDoFo::PdfPainter::FinishPage (
Finish drawing onto a page. This has to be called whenever a page has been drawn complete. 8.83.3.30 PdfFont PoDoFo::PdfPainter::GetFont ( ) const [inline]
Get the current font: Returns a font object or NULL if no font was set.
8.83.3.31
std::vector< TLineElement > PoDoFo::PdfPainter::GetMultiLineTextAsLines ( double dWidth, const PdfString & rsText )
Gets the text divided into individual lines, using the current font and clipping rectangle. Parameters dWidth width of the text area rsText the text which should be drawn
8.83.3.32
const PdfCanvas PoDoFo::PdfPainter::GetPage ( [inline]
) const
Return the current page that is that on the painter. Returns the current page of the painter or NULL if none is set
328 8.83.3.33
Class Documentation unsigned short PoDoFo::PdfPainter::GetPrecision ( [inline] ) const
Get the currently set oating point precision Returns how many decimal places will be written out for any oating point value
8.83.3.34
unsigned short PoDoFo::PdfPainter::GetTabWidth ( [inline]
) const
Get the currently set tab width Returns by how many spaces a tabulator will be replaced See also DrawText TabWidth
8.83.3.35
void PoDoFo::PdfPainter::HorizonalLineTo ( double dX )
Append a horizontal line to the current path Matches the SVG H operator Parameters dX x coordinate to draw the line to
8.83.3.36
void PoDoFo::PdfPainter::LineTo ( double dX, double dY )
Append a line segment to the current path. Matches the PDF l operator. This function is useful to construct an own path for drawing or clipping. Parameters dX x position dY y position
8.83.3.37
void PoDoFo::PdfPainter::MoveTextPos ( double dX, double dY )
Move position for text drawing on a page. You have to call BeginText before calling this function If you want more simpler text output and do not need the advanced text position features of MoveTextPos use DrawText which is easier.
8.83 PoDoFo::PdfPainter Class Reference Parameters dX the x offset relative to pos of BeginText or last MoveTextPos dY the y offset relative to pos of BeginText or last MoveTextPos See also BeginText() AddText() EndText()
329
8.83.3.38
void PoDoFo::PdfPainter::MoveTo ( double dX, double dY )
Begin a new path. Matches the PDF m operator. This function is useful to construct an own path for drawing or clipping. Parameters dX x position dY y position
8.83.3.39
void PoDoFo::PdfPainter::QuadCurveTo ( double dX1, double dY1, double dX3, double dY3 )
Append a quadratic bezier curve to the current path Matches the SVG Q operator. Parameters dX1 x coordinate of the rst control point dY1 y coordinate of the rst control point dX3 x coordinate of the end point, which is the new current point dY3 y coordinate of the end point, which is the new current point
8.83.3.40
void PoDoFo::PdfPainter::Restore (
Restore the current graphics settings from the graphics stack. Operator Q in PDF. This call has to be balanced with a corresponding call to Save()! See also Save
330 8.83.3.41 void PoDoFo::PdfPainter::Save ( )
Class Documentation
Save the current graphics settings onto the graphics stack. Operator q in PDF. This call has to be balanced with a corresponding call to Restore()! See also Restore
8.83.3.42
void PoDoFo::PdfPainter::SetClipRect ( const PdfRect & rRect ) [inline]
Set a clipping rectangle Parameters rRect rectangle
8.83.3.43
void PoDoFo::PdfPainter::SetClipRect ( double dX, double dY, double dWidth, double dHeight )
Set a clipping rectangle Parameters dX x coordinate of the rectangle (left coordinate) dY y coordinate of the rectangle (bottom coordinate) dWidth width of the rectangle dHeight absolute height of the rectangle
8.83.3.44
void PoDoFo::PdfPainter::SetColor ( double r, double g, double b )
Set the color for all following non-stroking operations in rgb colorspace. This operation used the rg PDF operator. This color is also used when drawing text. Parameters r red value in the range 0.0 - 1.0 g green value in the range 0.0 - 1.0 b blue value in the range 0.0 - 1.0
8.83 PoDoFo::PdfPainter Class Reference 8.83.3.45 void PoDoFo::PdfPainter::SetColor ( const PdfColor & rColor )
331
Set the color for all following non-stroking operations. Parameters rColor a PdfColor object
8.83.3.46
void PoDoFo::PdfPainter::SetColorCMYK ( double c, double m, double y, double k )
Set the color for all following non-stroking operations in cmyk colorspace. This operation used the k PDF operator. Parameters c cyan value in the range 0.0 - 1.0 m magenta value in the range 0.0 - 1.0 y yellow value in the range 0.0 - 1.0 k black value in the range 0.0 - 1.0
8.83.3.47
void PoDoFo::PdfPainter::SetCurrentStrokingColor ( [protected]
Sets the color that was last set by the user as the current stroking color. You should always enclose this function by Save() and Restore() See also Save() Restore()
8.83.3.48
void PoDoFo::PdfPainter::SetExtGState ( PdfExtGState inGState )
Sets a specic PdfExtGState as being active Parameters inGState the specic ExtGState to set
8.83.3.49
void PoDoFo::PdfPainter::SetFont ( PdfFont pFont )
Set the font for all text drawing operations

332 Parameters pFont a handle to a valid PdfFont object See also DrawText
Class Documentation
8.83.3.50
void PoDoFo::PdfPainter::SetGray ( double g )
Set the color for all following non-stroking operations in grayscale colorspace. This operation used the g PDF operator. Parameters g gray scale value in the range 0.0 - 1.0
8.83.3.51
void PoDoFo::PdfPainter::SetLineCapStyle ( EPdfLineCapStyle eCapStyle )
Set the line cap style for all stroking operations. Parameters eCapStyle the cap style. Possible values: ePdfLineCapStyle_Square ePdfLineCapStyle_Butt, ePdfLineCapStyle_Round,
8.83.3.52
void PoDoFo::PdfPainter::SetLineJoinStyle ( EPdfLineJoinStyle eJoinStyle )
Set the line join style for all stroking operations. Parameters eJoinStyle the join style. Possible values: ePdfLineJoinStyle_Bevel ePdfLineJoinStyle_Miter ePdfLineJoinStyle_Round
8.83.3.53
void PoDoFo::PdfPainter::SetPage ( PdfCanvas pPage )
Set the page on which the painter should draw. The painter will draw of course on the pages contents object. Calls FinishPage() on the last page if it was not yet called.
8.83 PoDoFo::PdfPainter Class Reference Parameters pPage a PdfCanvas object (most likely a PdfPage or PdfXObject). See also PdfPage PdfXObject FinishPage() GetPage()
333
8.83.3.54
void PoDoFo::PdfPainter::SetPrecision ( unsigned short inPrec ) [inline]
Set the oating point precision. Parameters inPrec write this many decimal places
8.83.3.55
void PoDoFo::PdfPainter::SetRenderingIntent ( char intent )
Sets a specic rendering intent Parameters intent the specic intent to set
8.83.3.56
void PoDoFo::PdfPainter::SetShadingPattern ( const PdfShadingPattern & rPattern )
Set the shading pattern for all following non-stroking operations. This operation uses the scn PDF operator. Parameters rPattern a shading pattern
8.83.3.57
void PoDoFo::PdfPainter::SetStrokeStyle ( EPdfStrokeStyle eStyle, const char pszCustom = NULL )
Set the stoke style for all stroking operations. Parameters eStyle style of the stroking operations
334
Class Documentation pszCustom a custom stroking style which is used when eStyle == ePdfStrokeStyle_Custom.
Possible values: ePdfStrokeStyle_None ePdfStrokeStyle_Solid ePdfStrokeStyle_Dash ePdfStrokeStyle_Dot ePdfStrokeStyle_DashDot ePdfStrokeStyle_DashDotDot ePdfStrokeStyle_Custom 8.83.3.58 void PoDoFo::PdfPainter::SetStrokeWidth ( double dWidth )
Set the line width for all stroking operations. Parameters dWidth in PDF User Units.
8.83.3.59
void PoDoFo::PdfPainter::SetStrokingColor ( const PdfColor & rColor )
Set the color for all following stroking operations. Parameters rColor a PdfColor object
8.83.3.60
void PoDoFo::PdfPainter::SetStrokingColor ( double r, double g, double b )
Set the color for all following stroking operations in rgb colorspace. This operation used the RG PDF operator. Parameters r red value in the range 0.0 - 1.0 g green value in the range 0.0 - 1.0 b blue value in the range 0.0 - 1.0
8.83.3.61
void PoDoFo::PdfPainter::SetStrokingColorCMYK ( double c, double m, double y, double k )
Set the color for all following stroking operations in cmyk colorspace. This operation used the K PDF operator. Parameters c cyan value in the range 0.0 - 1.0 m magenta value in the range 0.0 - 1.0 y yellow value in the range 0.0 - 1.0 k black value in the range 0.0 - 1.0
8.83 PoDoFo::PdfPainter Class Reference 8.83.3.62 void PoDoFo::PdfPainter::SetStrokingGray ( double g )
335
Set the color for all following stroking operations in grayscale colorspace. This operation used the G PDF operator. Parameters g gray scale value in the range 0.0 - 1.0
8.83.3.63
void PoDoFo::PdfPainter::SetStrokingShadingPattern ( const PdfShadingPattern & rPattern )
Set the shading pattern for all following stroking operations. This operation uses the SCN PDF operator. Parameters rPattern a shading pattern
8.83.3.64
void PoDoFo::PdfPainter::SetTabWidth ( unsigned short nTabWidth ) [inline]
Set the tab width for the DrawText operation. Every tab \t is replaced with nTabWidth spaces before drawing text. Default is a value of 4 Parameters nTabWidth replace every tabulator by this much spaces See also DrawText TabWidth
8.83.3.65
void PoDoFo::PdfPainter::SetTransformationMatrix ( double a, double b, double c, double d, double e, double f )
Set the transformation matrix for the current coordinate system See the operator cm in PDF. The six parameters are a standard 3x3 transformation matrix where the 3 left parameters are 0 0 1. Parameters a scale in x direction b rotation c rotation
336 d scale in y direction e translate in x direction f translate in y direction See also Save() Restore()
Class Documentation
8.83.3.66
void PoDoFo::PdfPainter::SmoothCurveTo ( double dX2, double dY2, double dX3, double dY3 )
Append a smooth bezier curve to the current path Matches the SVG S operator. Parameters dX2 x coordinate of the second control point dY2 y coordinate of the second control point dX3 x coordinate of the end point, which is the new current point dY3 y coordinate of the end point, which is the new current point
8.83.3.67
void PoDoFo::PdfPainter::SmoothQuadCurveTo ( double dX3, double dY3 )
Append a smooth quadratic bezier curve to the current path Matches the SVG T operator. Parameters dX3 x coordinate of the end point, which is the new current point dY3 y coordinate of the end point, which is the new current point
8.83.3.68
void PoDoFo::PdfPainter::Stroke (
Stroke the current path. Matches the PDF S operator. This function is useful to construct an own path for drawing or clipping. 8.83.3.69 void PoDoFo::PdfPainter::VerticalLineTo ( double dY )
Append a vertical line to the current path Matches the SVG V operator Parameters dY y coordinate to draw the line to
8.84 PoDoFo::PdfPainterMM Class Reference
337
8.83.4
8.83.4.1
Member Data Documentation

PdfColor PoDoFo::PdfPainter::m_curColor [protected]
Save the current color for non stroking colors 8.83.4.2 bool PoDoFo::PdfPainter::m_isTextOpen [protected]
Is between BT and ET 8.83.4.3 unsigned short PoDoFo::PdfPainter::m_nTabWidth [protected]
Every tab \t is replaced with m_nTabWidth spaces before drawing text. Default is a value of 4 8.83.4.4 std::ostringstream PoDoFo::PdfPainter::m_oss [protected]
temporary stream buffer 8.83.4.5 PdfStream PoDoFo::PdfPainter::m_pCanvas [protected]
All drawing operations work on this stream. This object may not be NULL. If it is NULL any function accessing it should return ERROR_PDF_INVALID_HANDLE 8.83.4.6 PdfFont PoDoFo::PdfPainter::m_pFont [protected]
Font for all drawing operations 8.83.4.7 PdfCanvas PoDoFo::PdfPainter::m_pPage [protected]
The page object is needed so that fonts etc. can be added to the page resource dictionary as appropriate.
8.84
PoDoFo::PdfPainterMM Class Reference
#include <PdfPainterMM.h> Inheritance diagram for PoDoFo::PdfPainterMM:
PoDoFo::PdfPainter
PoDoFo::PdfPainterMM
338
Class Documentation

PdfPainterMM () void SetStrokeWidthMM (long lWidth) void DrawLineMM (long lStartX, long lStartY, long lEndX, long lEndY) void DrawRectMM (long lX, long lY, long lWidth, long lHeight) void FillRectMM (long lX, long lY, long lWidth, long lHeight) void DrawEllipseMM (long lX, long lY, long lWidth, long lHeight) void FillEllipseMM (long lX, long lY, long lWidth, long lHeight) void DrawTextMM (long lX, long lY, const PdfString &sText) void DrawTextMM (long lX, long lY, const PdfString &sText, long lLen) void DrawImageMM (long lX, long lY, PdfImage pObject, double dScaleX=1.0, double dScaleY=1.0) void DrawXObjectMM (long lX, long lY, PdfXObject pObject, double dScaleX=1.0, double dScaleY=1.0) void LineToMM (long lX, long lY) void MoveToMM (long lX, long lY)
8.84.1
This class provides an easy to use painter object which allows you to draw on a PDF page object. During all drawing operations, you are still able to access the stream of the object you are drawing on directly. This painter takes all coordinates in 1/1000th mm instead of PDF units. Developer note: we use ownership rather than inheritance here, so as to use the same methods names a PdfPainter AND avoid compiler confusion on picking the right one. See also PdfPainter
8.84.2
8.84.2.1

PoDoFo::PdfPainterMM::PdfPainterMM ( ) [inline]
Create a new PdfPainterMM object.
8.84.3
8.84.3.1

void PoDoFo::PdfPainterMM::DrawEllipseMM ( long lX, long lY, long lWidth, long lHeight ) [inline]
Draw an ellipse with the current stroking settings

8.84 PoDoFo::PdfPainterMM Class Reference Parameters lX x coordinate of the ellipse (left coordinate) lY y coordinate of the ellipse (top coordinate) lWidth width of the ellipse lHeight absolute height of the ellipse
339
8.84.3.2
void PoDoFo::PdfPainterMM::DrawImageMM ( long lX, long lY, PdfImage pObject, double dScaleX = 1.0, double dScaleY = 1.0 ) [inline]
Draw an image on the current page. Parameters lX the x coordinate (bottom left position of the image) lY the y coordinate (bottom position of the image) pObject an PdfXObject dScaleX option scaling factor in x direction dScaleY option scaling factor in y direction
8.84.3.3
void PoDoFo::PdfPainterMM::DrawLineMM ( long lStartX, long lStartY, long lEndX, long lEndY ) [inline]
Draw a line with the current color and line settings. Parameters lStartX x coordinate of the starting point lStartY y coordinate of the starting point lEndX x coordinate of the ending point lEndY y coordinate of the ending point
8.84.3.4
void PoDoFo::PdfPainterMM::DrawRectMM ( long lX, long lY, long lWidth, long lHeight ) [inline]
Draw a rectangle with the current stroking settings Parameters lX x coordinate of the rectangle lY y coordinate of the rectangle lWidth width of the rectangle lHeight absolute height of the rectangle
340 8.84.3.5
Class Documentation void PoDoFo::PdfPainterMM::DrawTextMM ( long lX, long lY, const PdfString & sText, long lLen ) [inline]
Draw a text string on a page using a given font object. You have to call SetFont before calling this function. Parameters lX the x coordinate lY the y coordinate sText the text string which should be printed (is not allowed to be NULL!) lLen draw only lLen characters of pszText See also PdfPainter::SetFont()
8.84.3.6
void PoDoFo::PdfPainterMM::DrawTextMM ( long lX, long lY, const PdfString & sText ) [inline]
Draw a text string on a page using a given font object. You have to call SetFont before calling this function. Parameters lX the x coordinate lY the y coordinate sText the text string which should be printed See also PdfPainter::SetFont()
8.84.3.7
void PoDoFo::PdfPainterMM::DrawXObjectMM ( long lX, long lY, PdfXObject pObject, double dScaleX = 1.0, double dScaleY = 1.0 ) [inline]
Draw an XObject on the current page. Parameters lX the x coordinate (bottom left position of the XObject) lY the y coordinate (bottom position of the XObject) pObject an PdfXObject dScaleX option scaling factor in x direction dScaleY option scaling factor in y direction
8.84 PoDoFo::PdfPainterMM Class Reference 8.84.3.8 void PoDoFo::PdfPainterMM::FillEllipseMM ( long lX, long lY, long lWidth, long lHeight ) [inline]
341
Fill an ellipse with the current ll settings Parameters lX x coordinate of the ellipse (left coordinate) lY y coordinate of the ellipse (top coordinate) lWidth width of the ellipse lHeight absolute height of the ellipse
8.84.3.9
void PoDoFo::PdfPainterMM::FillRectMM ( long lX, long lY, long lWidth, long lHeight ) [inline]
Fill a rectangle with the current ll settings Parameters lX x coordinate of the rectangle lY y coordinate of the rectangle lWidth width of the rectangle lHeight absolute height of the rectangle
8.84.3.10
void PoDoFo::PdfPainterMM::LineToMM ( long lX, long lY ) [inline]
Append a line segment to the current path. Matches the PDF l operator. This function is useful to construct an own path for drawing or clipping. Parameters lX x position lY y position
8.84.3.11
void PoDoFo::PdfPainterMM::MoveToMM ( long lX, long lY ) [inline]
Begin a new path. Matches the PDF m operator. This function is useful to construct an own path for drawing or clipping. Parameters lX x position lY y position
342 8.84.3.12
Class Documentation void PoDoFo::PdfPainterMM::SetStrokeWidthMM ( long lWidth ) [inline]
Set the line width for all stroking operations. Parameters lWidth in 1/1000th mm
8.85
PoDoFo::PdfParser Class Reference
#include <PdfParser.h> Inheritance diagram for PoDoFo::PdfParser:
PoDoFo::PdfParser

PdfParser (PdfVecObjects pVecObjects) PdfParser (PdfVecObjects pVecObjects, const char pszFilename, bool bLoadOnDemand=true) PdfParser (PdfVecObjects pVecObjects, const char pBuffer, long lLen, bool bLoadOnDemand=true) PdfParser (PdfVecObjects pVecObjects, const PdfRefCountedInputDevice &rDevice, bool bLoadOnDemand=true) virtual PdfParser () void ParseFile (const char pszFilename, bool bLoadOnDemand=true) void ParseFile (const char pBuffer, long lLen, bool bLoadOnDemand=true) void ParseFile (const PdfRefCountedInputDevice &rDevice, bool bLoadOnDemand=true) bool QuickEncryptedCheck (const char pszFilename) int GetNumberOfIncrementalUpdates () const const PdfVecObjects GetObjects () const EPdfVersion GetPdfVersion () const const char GetPdfVersionString () const const PdfObject GetTrailer () const bool GetLoadOnDemand () const bool IsLinearized () const size_t GetFileSize () const bool GetEncrypted () const const PdfEncrypt GetEncrypt () const
8.85 PoDoFo::PdfParser Class Reference PdfEncrypt TakeEncrypt () void SetPassword (const std::string &sPassword) bool IsStrictParsing () const void SetStrictParsing (bool bStrict) bool GetIgnoreBrokenObjects () void SetIgnoreBrokenObjects (bool bBroken)
343

void FindToken (const char pszToken, const long lRange) void FindToken2 (const char pszToken, const long lRange, size_t searchEnd) void ReadDocumentStructure () void HasLinearizationDict () void MergeTrailer (const PdfObject pTrailer) void ReadTrailer () void ReadXRef (pdf_long pXRefOffset) void ReadXRefContents (pdf_long lOffset, bool bPositionAtEnd=false) void ReadXRefSubsection (long long &nFirstObject, long long &nNumObjects) void ReadXRefStreamContents (pdf_long lOffset, bool bReadOnlyTrailer) void ReadObjects () void ReadObjectsInternal () void ReadObjectFromStream (int nObjNo, int nIndex) bool IsPdfFile () void CheckEOFMarker ()
8.85.1
PdfParser reads a PDF le into memory. The le can be modied in memory and written back using the PdfWriter class. Most PDF features are supported
8.85.2
8.85.2.1

PoDoFo::PdfParser::PdfParser ( PdfVecObjects pVecObjects )
Create a new PdfParser object You have to open a PDF le using ParseFile later. Parameters pVecObjects vector to write the parsed PdfObjects to See also ParseFile
344 8.85.2.2
Class Documentation PoDoFo::PdfParser::PdfParser ( PdfVecObjects pVecObjects, const char pszFilename, bool bLoadOnDemand = true )
Create a new PdfParser object and open a PDF le and parse it into memory. Parameters pVecObjects vector to write the parsed PdfObjects to pszFilename lename of the le which is going to be parsed bLoadOnDemand If true all objects will be read from the le at the time they are accesed rst. If false all objects will be read immediately. This is faster if you do not need the complete PDF le in memory. This might throw a PdfError( ePdfError_InvalidPassword ) exception if a password is required to read this PDF. Call SetPassword with the correct password in this case. See also SetPassword
8.85.2.3
PoDoFo::PdfParser::PdfParser ( PdfVecObjects pVecObjects, const char pBuffer, long lLen, bool bLoadOnDemand = true )
Create a new PdfParser object and open a PDF le and parse it into memory. Parameters pVecObjects vector to write the parsed PdfObjects to pBuffer buffer containing a PDF le in memory lLen length of the buffer containing the PDF le bLoadOnDemand If true all objects will be read from the le at the time they are accesed rst. If false all objects will be read immediately. This is faster if you do not need the complete PDF le in memory. This might throw a PdfError( ePdfError_InvalidPassword ) exception if a password is required to read this PDF. Call SetPassword with the correct password in this case. See also SetPassword
8.85.2.4
PoDoFo::PdfParser::PdfParser ( PdfVecObjects pVecObjects, const PdfRefCountedInputDevice & rDevice, bool bLoadOnDemand = true )
Create a new PdfParser object and open a PDF le and parse it into memory.
8.85 PoDoFo::PdfParser Class Reference Parameters pVecObjects vector to write the parsed PdfObjects to rDevice read from this PdfRefCountedInputDevice
345
bLoadOnDemand If true all objects will be read from the le at the time they are accesed rst. If false all objects will be read immediately. This is faster if you do not need the complete PDF le in memory. This might throw a PdfError( ePdfError_InvalidPassword ) exception if a password is required to read this PDF. Call SetPassword with the correct password in this case. See also SetPassword
8.85.2.5
PoDoFo::PdfParser::PdfParser (
) [virtual]
Delete the PdfParser and all PdfObjects
8.85.3
8.85.3.1

void PoDoFo::PdfParser::CheckEOFMarker ( ) [protected]
Checks for the existence of the %EOF marker at the end of the le When strict mode is off it will also attempt to setup the parser to ignore any garbage after the last %EOF marker Simply raises an error if there is a problem with the marker 8.85.3.2 void PoDoFo::PdfParser::FindToken ( const char pszToken, const long lRange ) [protected]
Searches backwards from the end of the le and tries to nd a token. The current le is positioned right after the token. Parameters pszToken a token to nd lRange range in bytes in which to search begining at the end of the le
8.85.3.3
void PoDoFo::PdfParser::FindToken2 ( const char pszToken, const long lRange, size_t searchEnd ) [protected]
Searches backwards from the specied position of the le and tries to nd a token. The current le is positioned right after the token. Parameters pszToken a token to nd
346
Class Documentation lRange range in bytes in which to search begining at the specied position of the le searchEnd species position
8.85.3.4 Returns
const PdfEncrypt PoDoFo::PdfParser::GetEncrypt ( [inline]
) const
the parsers encryption object or NULL if the read PDF le was not encrypted
8.85.3.5 Returns
bool PoDoFo::PdfParser::GetEncrypted (
) const [inline]
true if this PdfWriter creates an encrypted PDF le
8.85.3.6 Returns
size_t PoDoFo::PdfParser::GetFileSize (
) const [inline]
the length of the le
8.85.3.7 Returns
bool PoDoFo::PdfParser::GetIgnoreBrokenObjects (
) [inline]
if broken objects are ignored while parsing
8.85.3.8 Returns
bool PoDoFo::PdfParser::GetLoadOnDemand (
) const [inline]
true if this PdfParser loads all objects on demand at the time they are accessed for the rst time. The default is to load all object immediately. In this case false is returned.
8.85.3.9
int PoDoFo::PdfParser::GetNumberOfIncrementalUpdates ( [inline]
) const
Retrieve the number of incremental updates that have been applied to the last parsed PDF le. 0 means no update has been applied.
8.85 PoDoFo::PdfParser Class Reference Returns the number of incremental updates to the parsed PDF.
347
8.85.3.10
const PdfVecObjects PoDoFo::PdfParser::GetObjects ( [inline]
) const
Get a reference to the sorted internal objects vector. Returns the internal objects vector.
8.85.3.11
EPdfVersion PoDoFo::PdfParser::GetPdfVersion ( [inline]
) const
Get the le format version of the pdf Returns the le format version as enum
8.85.3.12
const char PoDoFo::PdfParser::GetPdfVersionString (
) const
Get the le format version of the pdf Returns the le format version as string
8.85.3.13
const PdfObject PoDoFo::PdfParser::GetTrailer ( [inline]
) const
Get the trailer dictionary which can be written unmodied to a pdf le. 8.85.3.14 void PoDoFo::PdfParser::HasLinearizationDict ( ) [protected]
Checks wether this pdf is linearized or not. Initializes the linearization directory on sucess. 8.85.3.15 Returns whether the parsed document contains linearization tables bool PoDoFo::PdfParser::IsLinearized ( ) const [inline]
348 8.85.3.16 bool PoDoFo::PdfParser::IsPdfFile (
Class Documentation ) [protected]
Checks the magic number at the start of the pdf le and sets the m_ePdfVersion member to the correct version of the pdf le. Returns true if this is a pdf le, otherwise false
8.85.3.17 Returns
bool PoDoFo::PdfParser::IsStrictParsing (
) const [inline]
true if strict parsing mode is enabled See also SetStringParsing
8.85.3.18
void PoDoFo::PdfParser::MergeTrailer ( const PdfObject pTrailer ) [protected]
Merge the information of this trailer object in the parsers main trailer object. Parameters pTrailer take the keys to merge from this dictionary.
8.85.3.19
void PoDoFo::PdfParser::ParseFile ( const char pszFilename, bool bLoadOnDemand = true )
Open a PDF le and parse it. Parameters pszFilename lename of the le which is going to be parsed bLoadOnDemand If true all objects will be read from the le at the time they are accesed rst. If false all objects will be read immediately. This is faster if you do not need the complete PDF le in memory. This might throw a PdfError( ePdfError_InvalidPassword ) exception if a password is required to read this PDF. Call SetPassword with the correct password in this case. See also SetPassword
8.85 PoDoFo::PdfParser Class Reference 8.85.3.20 void PoDoFo::PdfParser::ParseFile ( const char pBuffer, long lLen, bool bLoadOnDemand = true )
349
Open a PDF le and parse it. Parameters pBuffer buffer containing a PDF le in memory lLen length of the buffer containing the PDF le bLoadOnDemand If true all objects will be read from the le at the time they are accesed rst. If false all objects will be read immediately. This is faster if you do not need the complete PDF le in memory. This might throw a PdfError( ePdfError_InvalidPassword ) exception if a password is required to read this PDF. Call SetPassword with the correct password in this case. See also SetPassword
8.85.3.21
void PoDoFo::PdfParser::ParseFile ( const PdfRefCountedInputDevice & rDevice, bool bLoadOnDemand = true )
Open a PDF le and parse it. Parameters rDevice the input device to read from bLoadOnDemand If true all objects will be read from the le at the time they are accesed rst. If false all objects will be read immediately. This is faster if you do not need the complete PDF le in memory. This might throw a PdfError( ePdfError_InvalidPassword ) exception if a password is required to read this PDF. Call SetPassword with the correct password in this case. See also SetPassword
8.85.3.22
bool PoDoFo::PdfParser::QuickEncryptedCheck ( const char pszFilename )
Quick method to detect secured PDF les, i.e. a PDF with an /Encrypt key in the trailer directory. Returns true if document is secured, false otherwise
350 8.85.3.23
Class Documentation void PoDoFo::PdfParser::ReadDocumentStructure ( [protected] )
Reads the xref sections and the trailers of the le in the correct order in the memory and takes care for linearized pdf les.
8.85.3.24
void PoDoFo::PdfParser::ReadObjectFromStream ( int nObjNo, int nIndex ) [protected]
Read the object with index nIndex from the object stream nObjNo and push it on the objects vector m_vecOffsets. All objects are read from this stream and the stream object is freed from memory. Further calls who try to read from the same stream simply do nothing. Parameters nObjNo object number of the stream object nIndex index of the object which should be parsed
8.85.3.25
void PoDoFo::PdfParser::ReadObjects (
) [protected]
Reads all objects from the pdf into memory from the offsets listed in m_vecOffsets. If required an encryption object is setup rst. The actual reading happens in ReadObjectsInternal() either if no encryption is required or a correct encryption object was initialized from SetPassword.
8.85.3.26
void PoDoFo::PdfParser::ReadObjectsInternal (
) [protected]
Reads all objects from the pdf into memory from the offsets listed in m_vecOffsets. Requires a correctly setup PdfEncrypt object with correct password. This method is called from ReadObjects or SetPassword. See also ReadObjects SetPassword
8.85.3.27
void PoDoFo::PdfParser::ReadTrailer (
) [protected]
Read the trailer directory at the end of the le.

8.85 PoDoFo::PdfParser Class Reference 8.85.3.28 void PoDoFo::PdfParser::ReadXRef ( pdf_long pXRefOffset ) [protected]
351
Looks for a startxref entry at the current le position and saves its byteoffset to pXRefOffset. Parameters pXRefOffset store the byte offset of the xref section into this variable.
8.85.3.29
void PoDoFo::PdfParser::ReadXRefContents ( pdf_long lOffset, bool bPositionAtEnd = false ) [protected]
Reads the xref table from a pdf le. If there is no xref table, ReadXRefStreamContents() is called. Parameters lOffset read the table from this offset bPositionAtEnd if true the xref table is not read, but the le stream is positioned directly after the table, which allows reading a following trailer dictionary.
8.85.3.30
void PoDoFo::PdfParser::ReadXRefStreamContents ( pdf_long lOffset, bool bReadOnlyTrailer ) [protected]
Reads a xref stream contens object Parameters lOffset read the stream from this offset bReadOnlyTrailer only the trailer is skipped over, the contents of the xref stream are not parsed
8.85.3.31
void PoDoFo::PdfParser::ReadXRefSubsection ( long long & nFirstObject, long long & nNumObjects ) [protected]
Read a xref subsection Throws ePdfError_NoXref if the number of objects read was not the number specied by the subsection header (as passed in nNumObjects). Parameters nFirstObject object number of the rst object nNumObjects how many objects should be read from this section
352 8.85.3.32
Class Documentation void PoDoFo::PdfParser::SetIgnoreBrokenObjects ( bool bBroken ) [inline]
Specify if the parser should ignore broken objects, i.e. XRef entries that do not point to valid objects. Default is to not ignore broken objects and throw an exception if one is found. Parameters bBroken if true broken objects will be ignored
8.85.3.33
void PoDoFo::PdfParser::SetPassword ( const std::string & sPassword )
If you try to open an encrypted PDF le, which requires a password to open, PoDoFo will throw a PdfError( ePdfError_InvalidPassword ) exception. If you got such an exception, you have to set a password which should be used for opening the PDF. The usual way will be to ask the user for the password and set the password using this method. PdfParser will immediately continue to read the PDF le. Parameters sPassword a user or owner password which can be used to open an encrypted PDF le If the password is invalid, a PdfError( ePdfError_InvalidPassword ) exception is thrown!
8.85.3.34
void PoDoFo::PdfParser::SetStrictParsing ( bool bStrict ) [inline]
Enable/disable strict parsing mode. Strict parsing is by default disabled. If you enable strict parsing, PoDoFo will fail on a few more common PDF failures. Please not that PoDoFos parser is by default very strict already and does not recover from e.g. wrong XREF tables. Parameters bStrict new setting for strict parsing mode.
8.85.3.35
PdfEncrypt PoDoFo::PdfParser::TakeEncrypt (
) [inline]
Takes the encryption object fro mthe parser. The internal handle will be set to NULL and the ownership of the object is given to the caller. Only call this if you need access to the encryption object before deleting the parser.
8.86 PoDoFo::PdfParserObject Class Reference Returns the parsers encryption object or NULL if the read PDF le was not encrypted
353
8.86
PoDoFo::PdfParserObject Class Reference
#include <PdfParserObject.h> Inheritance diagram for PoDoFo::PdfParserObject:

PoDoFo::PdfVariant PoDoFo::PdfObject PoDoFo::PdfTokenizer
PoDoFo::PdfParserObject PoDoFo::PdfXRefStreamParserObject

PdfParserObject (PdfVecObjects pCreator, const PdfRefCountedInputDevice &rDevice, const PdfRefCountedBuffer &rBuffer, pdf_long lOffset=-1) PdfParserObject (const PdfRefCountedBuffer &rBuffer) void ParseFile (PdfEncrypt pEncrypt, bool bIsTrailer=false) bool HasStreamToParse () const bool IsLoadOnDemand () const void SetLoadOnDemand (bool bDelayed) void SetObjectNumber (unsigned int nObjNo) void FreeObjectMemory (bool bForce=false)

virtual void DelayedLoadImpl () virtual void DelayedStreamLoadImpl () void ParseStream ()
8.86.1
A PdfParserObject constructs a PdfObject from a PDF le. Parsing starts always at the current le position.
354
Class Documentation
8.86.2
8.86.2.1

PoDoFo::PdfParserObject::PdfParserObject ( PdfVecObjects pCreator, const PdfRefCountedInputDevice & rDevice, const PdfRefCountedBuffer & rBuffer, pdf_long lOffset = -1 )
Parse the object data from the given le handle starting at the current position. Parameters pCreator pointer to a PdfVecObjects to resolve object references rDevice an open reference counted input device which is positioned in front of the object which is going to be parsed. rBuffer buffer to use for parsing to avoid reallocations lOffset the position in the device from which the object shall be read if lOffset = -1, the object will be read from the current position in the le.
8.86.2.2
PoDoFo::PdfParserObject::PdfParserObject ( const PdfRefCountedBuffer & rBuffer ) [explicit]
Parse the object data for an internal object. You have to call ParseDictionaryKeys as next function call. The following two parameters are used to avoid allocation of a new buffer in PdfSimpleParser. Warning This constructor is for internal usage only! Parameters rBuffer buffer to use for parsing to avoid reallocations
8.86.3
8.86.3.1

void PoDoFo::PdfParserObject::DelayedLoadImpl ( [protected, virtual] )
Load all data of the object if load object on demand is enabled. Reimplemented from PdfVariant. Do not call this directly, use DelayedLoad(). 8.86.3.2 void PoDoFo::PdfParserObject::DelayedStreamLoadImpl ( [protected, virtual] )
Load the stream of the object if it has one and if loading on demand is enabled. Reimplemented from PdfObject. Do not call this directly, use DelayedStreamLoad().
8.86 PoDoFo::PdfParserObject Class Reference 8.86.3.3
355
void PoDoFo::PdfParserObject::FreeObjectMemory ( bool bForce = false )
Tries to free all memory allocated by this PdfObject (variables and streams) and reads it from disk again if it is requested another time. This will only work if load on demand is used. If the object is dirty if will not be freed. Parameters bForce if true the object will be freed even if IsDirty() returns true. So you will loose any changes made to this object. See also IsLoadOnDemand IsDirty
8.86.3.4
bool PoDoFo::PdfParserObject::HasStreamToParse ( [inline]
) const
Returns if this object has a stream object appended. which has to be parsed. Returns true if there is a stream
8.86.3.5 Returns
bool PoDoFo::PdfParserObject::IsLoadOnDemand ( [inline]
) const
true if this PdfParser loads all objects at the time they are accessed for the rst time. The default is to load all object immediately. In this case false is returned.
8.86.3.6
void PoDoFo::PdfParserObject::ParseFile ( PdfEncrypt pEncrypt, bool bIsTrailer = false )
Parse the object data from the given le handle If delayed loading is enabled, only the object and generation number is read now and everything else is read later. Parameters pEncrypt an encryption dictionary which is used to decrypt strings and streams during parsing or NULL if the PDF le was not encrypted bIsTrailer wether this is a trailer dictionary or not. trailer dictionaries do not have a object number etc.
356 8.86.3.7 void PoDoFo::PdfParserObject::ParseStream (
Class Documentation ) [protected]
Starts reading at the le position m_lStreamOffset and interprets all bytes as contents of the objects stream. It is assumed that the dictionary has a valid /Length key already. Called from DelayedStreamLoadImpl(). Do not call directly. 8.86.3.8 void PoDoFo::PdfParserObject::SetLoadOnDemand ( bool bDelayed ) [inline]
Sets wether this object shall be loaded on demand when its data is accessed for the rst time. Parameters bDelayed if true the object is loaded delayed.
8.86.3.9
void PoDoFo::PdfParserObject::SetObjectNumber ( unsigned int nObjNo ) [inline]
Set the object number of this object. It is almost never necessary to use this call. It is only included for usage in the PdfParser. Parameters nObjNo the new object number of this object
8.87
8.87.1
PoDoFo::PdfPredictorDecoder Class Reference

This structur contains all necessary values for a FlateDecode and LZWDecode Predictor. These values are normally stored in the /DecodeParams key of a PDF dictionary.
8.88
PoDoFo::PdfPushButton Class Reference
#include <PdfField.h> Inherits PoDoFo::PdfButton.

PdfPushButton (PdfAnnotation pWidget, PdfAcroForm pParent) PdfPushButton (PdfPage pPage, const PdfRect &rRect, PdfAcroForm pParent)
8.88 PoDoFo::PdfPushButton Class Reference
357
PdfPushButton (PdfPage pPage, const PdfRect &rRect, PdfDocument pDoc) PdfPushButton (PdfPage pPage, const PdfRect &rRect, PdfStreamedDocument pDoc) PdfPushButton (const PdfField &rhs) void SetRolloverCaption (const PdfString &rsText) const PdfString GetRolloverCaption () const void SetAlternateCaption (const PdfString &rsText) const PdfString GetAlternateCaption () const
8.88.1
A push button is a button which has no state and value but can toggle actions.
8.88.2
8.88.2.1

PoDoFo::PdfPushButton::PdfPushButton ( PdfAnnotation pWidget, PdfAcroForm pParent )
Create a new PdfPushButton 8.88.2.2 PoDoFo::PdfPushButton::PdfPushButton ( PdfPage pPage, const PdfRect & rRect, PdfAcroForm pParent )
Create a new PdfPushButton 8.88.2.3 PoDoFo::PdfPushButton::PdfPushButton ( PdfPage pPage, const PdfRect & rRect, PdfDocument pDoc )
Create a new PdfPushButton 8.88.2.4 PoDoFo::PdfPushButton::PdfPushButton ( PdfPage pPage, const PdfRect & rRect, PdfStreamedDocument pDoc )
Create a new PdfPushButton 8.88.2.5 PoDoFo::PdfPushButton::PdfPushButton ( const PdfField & rhs )
Create a PdfPushButton from a PdfField Parameters rhs a PdfField that is a push button button Raises an error if PdfField::GetType() != ePdfField_PushButton
358
Class Documentation
8.88.3
8.88.3.1 Returns

const PdfString PoDoFo::PdfPushButton::GetAlternateCaption ( const )
the rollover caption of this button
8.88.3.2 Returns
const PdfString PoDoFo::PdfPushButton::GetRolloverCaption ( const
the rollover caption of this button
8.88.3.3
void PoDoFo::PdfPushButton::SetAlternateCaption ( const PdfString & rsText )
Set the alternate caption of this button which is displayed when the button is pressed. Parameters rsText the caption
8.88.3.4
void PoDoFo::PdfPushButton::SetRolloverCaption ( const PdfString & rsText )
Set the rollover caption of this button which is displayed when the cursor enters the eld without the mouse button being pressed Parameters rsText the caption
8.89
PoDoFo::PdfRadialShadingPattern Class Reference
#include <PdfShadingPattern.h> Inheritance diagram for PoDoFo::PdfRadialShadingPattern:

8.89 PoDoFo::PdfRadialShadingPattern Class Reference
359
PoDoFo::PdfElement PoDoFo::PdfShadingPattern PoDoFo::PdfRadialShadingPattern

PdfRadialShadingPattern (double dX0, double dY0, double dR0, double dX1, double dY1, double dR1, const PdfColor &rStart, const PdfColor &rEnd, PdfVecObjects pParent) PdfRadialShadingPattern (double dX0, double dY0, double dR0, double dX1, double dY1, double dR1, const PdfColor &rStart, const PdfColor &rEnd, PdfDocument pParent)
8.89.1
A shading pattern that is a simple radial shading between two colors.
8.89.2
8.89.2.1

PoDoFo::PdfRadialShadingPattern::PdfRadialShadingPattern ( double dX0, double dY0, double dR0, double dX1, double dY1, double dR1, const PdfColor & rStart, const PdfColor & rEnd, PdfVecObjects pParent )
Create an radial shading pattern Parameters dX0 the inner circles x coordinate dY0 the inner circles y coordinate dR0 the inner circles radius dX1 the outer circles x coordinate dY1 the outer circles y coordinate dR1 the outer circles radius rStart the starting color rEnd the ending color pParent the parent
360 8.89.2.2
Class Documentation PoDoFo::PdfRadialShadingPattern::PdfRadialShadingPattern ( double dX0, double dY0, double dR0, double dX1, double dY1, double dR1, const PdfColor & rStart, const PdfColor & rEnd, PdfDocument pParent )
Create an radial shading pattern Parameters dX0 the inner circles x coordinate dY0 the inner circles y coordinate dR0 the inner circles radius dX1 the outer circles x coordinate dY1 the outer circles y coordinate dR1 the outer circles radius rStart the starting color rEnd the ending color pParent the parent
8.90
PoDoFo::PdfRC4InputStream Class Reference
Inheritance diagram for PoDoFo::PdfRC4InputStream:

PoDoFo::PdfInputStream PoDoFo::PdfRC4InputStream

virtual pdf_long Read (char pBuffer, pdf_long lLen)
8.90.1
A PdfInputStream that decrypts all data read using the RC4 encryption algorithm
8.90.2
8.90.2.1

virtual pdf_long PoDoFo::PdfRC4InputStream::Read ( char pBuffer, pdf_long lLen ) [inline, virtual]
Read data from the input stream

8.91 PoDoFo::PdfRC4OutputStream Class Reference Parameters pBuffer the data will be stored into this buffer lLen the size of the buffer and number of bytes that will be read Returns
361
the number of bytes read, -1 if an error ocurred and zero if no more bytes are available for reading. Implements PoDoFo::PdfInputStream.
8.91
PoDoFo::PdfRC4OutputStream Class Reference
Inheritance diagram for PoDoFo::PdfRC4OutputStream:
PoDoFo::PdfOutputStream PoDoFo::PdfRC4OutputStream

virtual pdf_long Write (const char pBuffer, pdf_long lLen) virtual void Close ()
8.91.1
A PdfOutputStream that encrypt all data written using the RC4 encryption algorithm
8.91.2
8.91.2.1

virtual void PoDoFo::PdfRC4OutputStream::Close ( virtual] ) [inline,
362 8.91.2.2
Class Documentation virtual pdf_long PoDoFo::PdfRC4OutputStream::Write ( const char pBuffer, pdf_long lLen ) [inline, virtual]
8.92
PoDoFo::PdfRC4Stream Class Reference

pdf_long Encrypt (char pBuffer, pdf_long lLen)
8.92.1
A class that can encrypt/decrpyt streamed data block wise This is used in the input and output stream encryption implementation. Only the RC4 encryption algorithm is supported
8.92.2
8.92.2.1

pdf_long PoDoFo::PdfRC4Stream::Encrypt ( char pBuffer, pdf_long lLen ) [inline]
Encrypt or decrypt a block Parameters pBuffer the input/output buffer. Data is read from this buffer and also stored here lLen the size of the buffer
8.93
PoDoFo::PdfRect Class Reference
#include <PdfRect.h>

PdfRect () PdfRect (double left, double bottom, double width, double height)
8.93 PoDoFo::PdfRect Class Reference PdfRect (const PdfArray &inArray) PdfRect (const PdfRect &rhs) void ToVariant (PdfVariant &var) const std::string ToString () const void FromArray (const PdfArray &inArray) void Intersect (const PdfRect &rRect) double GetBottom () const void SetBottom (double dBottom) double GetLeft () const void SetLeft (double lLeft) double GetWidth () const void SetWidth (double lWidth) double GetHeight () const void SetHeight (double lHeight)
363
8.93.1
A rectangle as dened by the PDF reference
8.93.2
8.93.2.1

PoDoFo::PdfRect::PdfRect ( )
Create an empty rectangle with bottom=left=with=height=0 8.93.2.2 PoDoFo::PdfRect::PdfRect ( double left, double bottom, double width, double height )
Create a rectangle with a given size and position All values are in PDF units NOTE: since PDF is bottom-left origined, we pass the bottom instead of the top 8.93.2.3 PoDoFo::PdfRect::PdfRect ( const PdfArray & inArray )
Create a rectangle from an array All values are in PDF units 8.93.2.4 PoDoFo::PdfRect::PdfRect ( const PdfRect & rhs )
Copy constructor
8.93.3
8.93.3.1

void PoDoFo::PdfRect::FromArray ( const PdfArray & inArray )
Assigns the values of this PdfRect from the 4 values in the array
364 Parameters inArray the array to load the values from
Class Documentation
8.93.3.2
double PoDoFo::PdfRect::GetBottom (
) const [inline]
Get the bottom coordinate of the rectangle Returns bottom
8.93.3.3
double PoDoFo::PdfRect::GetHeight (
) const [inline]
Get the height of the rectangle Returns height in PDF units
8.93.3.4
double PoDoFo::PdfRect::GetLeft (
) const [inline]
Get the left coordinate of the rectangle Returns left in PDF units
8.93.3.5
double PoDoFo::PdfRect::GetWidth (
) const [inline]
Get the width of the rectangle Returns width in PDF units
8.93.3.6
void PoDoFo::PdfRect::Intersect ( const PdfRect & rRect )
Intersect with another rect Parameters rRect the rect to intersect with
8.93 PoDoFo::PdfRect Class Reference 8.93.3.7
365
void PoDoFo::PdfRect::SetBottom ( double dBottom ) [inline]
Set the bottom coordinate of the rectangle Parameters dBottom
8.93.3.8
void PoDoFo::PdfRect::SetHeight ( double lHeight ) [inline]
Set the height of the rectangle Parameters lHeight in PDF units
8.93.3.9
void PoDoFo::PdfRect::SetLeft ( double lLeft ) [inline]
Set the left coordinate of the rectangle Parameters lLeft in PDF units
8.93.3.10
void PoDoFo::PdfRect::SetWidth ( double lWidth ) [inline]
Set the width of the rectangle Parameters lWidth in PDF units
8.93.3.11
std::string PoDoFo::PdfRect::ToString (
) const
Returns a string representation of the PdfRect Returns std::string representation as [ left bottom right top ]
8.93.3.12
void PoDoFo::PdfRect::ToVariant ( PdfVariant & var ) const
Converts the rectangle into an array based on PDF units and adds the array into an variant. Parameters var the variant to store the Rect
366
Class Documentation
8.94
PoDoFo::PdfRefCountedBuffer Class Reference
#include <PdfRefCountedBuffer.h>

PdfRefCountedBuffer () PdfRefCountedBuffer (char pBuffer, size_t lSize) PdfRefCountedBuffer (size_t lSize) PdfRefCountedBuffer (const PdfRefCountedBuffer &rhs) PdfRefCountedBuffer () char GetBuffer () const size_t GetSize () const void Resize (size_t lSize) const PdfRefCountedBuffer & operator= (const PdfRefCountedBuffer &rhs) void SetTakePossesion (bool bTakePossession) bool TakePossesion () const bool operator== (const PdfRefCountedBuffer &rhs) const bool operator< (const PdfRefCountedBuffer &rhs) const bool operator> (const PdfRefCountedBuffer &rhs) const
8.94.1
A reference counted buffer object which is deleted as soon as the last object having access to it is delteted. The attached memory object can be resized.
8.94.2
8.94.2.1

PoDoFo::PdfRefCountedBuffer::PdfRefCountedBuffer ( [inline] )
Created an empty reference counted buffer The buffer will be initialize to NULL 8.94.2.2 PoDoFo::PdfRefCountedBuffer::PdfRefCountedBuffer ( char pBuffer, size_t lSize )
Created an reference counted buffer and use an exiting buffer The buffer will be owned by this object. Parameters pBuffer a pointer to an allocated buffer lSize size of the allocated buffer
8.94 PoDoFo::PdfRefCountedBuffer Class Reference See also SetTakePossesion
367
8.94.2.3
PoDoFo::PdfRefCountedBuffer::PdfRefCountedBuffer ( size_t lSize ) [inline]
Create a new PdfRefCountedBuffer. Parameters lSize buffer size
8.94.2.4
PoDoFo::PdfRefCountedBuffer::PdfRefCountedBuffer ( const PdfRefCountedBuffer & rhs ) [inline]
Copy an existing PdfRefCountedBuffer and increase the reference count Parameters rhs the PdfRefCountedBuffer to copy
8.94.2.5
PoDoFo::PdfRefCountedBuffer::PdfRefCountedBuffer ( [inline]
Decrease the reference count and delete the buffer if this is the last owner
8.94.3
8.94.3.1

char PoDoFo::PdfRefCountedBuffer::GetBuffer ( [inline] ) const
Get access to the buffer Returns the buffer
8.94.3.2
size_t PoDoFo::PdfRefCountedBuffer::GetSize (
) const [inline]
Return the buffer size. Returns the buffer size
368 8.94.3.3
Class Documentation bool PoDoFo::PdfRefCountedBuffer::operator< ( const PdfRefCountedBuffer & rhs ) const
Compare to buffers. Parameters rhs compare to this buffer Returns true if this buffer is lexically littler than rhs
8.94.3.4
const PdfRefCountedBuffer & PoDoFo::PdfRefCountedBuffer::operator= ( const PdfRefCountedBuffer & rhs )
Copy an existing PdfRefCountedBuffer and increase the reference count Parameters rhs the PdfRefCountedBuffer to copy Returns the copied object
8.94.3.5
bool PoDoFo::PdfRefCountedBuffer::operator== ( const PdfRefCountedBuffer & rhs ) const
Compare to buffers. Parameters rhs compare to this buffer Returns true if both buffers contain the same contents
8.94.3.6
bool PoDoFo::PdfRefCountedBuffer::operator> ( const PdfRefCountedBuffer & rhs ) const
Compare to buffers. Parameters rhs compare to this buffer Returns true if this buffer is lexically greater than rhs
8.95 PoDoFo::PdfRefCountedInputDevice Class Reference 8.94.3.7 void PoDoFo::PdfRefCountedBuffer::Resize ( size_t lSize ) [inline]
369
Resize the buffer to hold at least lSize bytes. Parameters lSize the size of bytes the buffer can at least hold If the buffer is larger no operation is performed. 8.94.3.8 void PoDoFo::PdfRefCountedBuffer::SetTakePossesion ( bool bTakePossession ) [inline]
If the PdfRefCountedBuffer has no possesion on its buffer, it wont delete the buffer. By default the buffer is owned and deleted by the PdfRefCountedBuffer object. Parameters bTakePossession if false the buffer will not be deleted.
8.94.3.9 Returns
bool PoDoFo::PdfRefCountedBuffer::TakePossesion ( [inline]
) const
true if the buffer is owned by the PdfRefCountedBuffer and is deleted along with it.
8.95
PoDoFo::PdfRefCountedInputDevice Class Reference
#include <PdfRefCountedInputDevice.h>

PdfRefCountedInputDevice () PdfRefCountedInputDevice (const char pszFilename, const char pszMode) PdfRefCountedInputDevice (const char pBuffer, size_t lLen) PdfRefCountedInputDevice (PdfInputDevice pDevice) PdfRefCountedInputDevice (const PdfRefCountedInputDevice &rhs) PdfRefCountedInputDevice () PODOFO_NOTHROW PdfInputDevice Device () const const PdfRefCountedInputDevice & operator= (const PdfRefCountedInputDevice &rhs)
370
Class Documentation
8.95.1
A reference counted input device object which is closed as soon as the last object having access to it is deleted.
8.95.2
8.95.2.1

PoDoFo::PdfRefCountedInputDevice::PdfRefCountedInputDevice ( )
Created an empty reference counted input device object The input device will be initialize to NULL
8.95.2.2
PoDoFo::PdfRefCountedInputDevice::PdfRefCountedInputDevice ( const char pszFilename, const char pszMode )
Create a new PdfRefCountedInputDevice which reads from a le. The le is opened using fopen() Parameters pszFilename a lename to be passed to fopen pszMode a mode string that can be passed to fopen
8.95.2.3
PoDoFo::PdfRefCountedInputDevice::PdfRefCountedInputDevice ( const char pBuffer, size_t lLen )
Create a new PdfRefCountedInputDevice which operates on a in memory buffer Parameters pBuffer pointer to the buffer lLen length of the buffer
8.95.2.4
PoDoFo::PdfRefCountedInputDevice::PdfRefCountedInputDevice ( PdfInputDevice pDevice )
Create a new PdfRefCountedInputDevice from an PdfInputDevice Parameters pDevice the input device. It will be owned and deleted by this object.
8.96 PoDoFo::PdfReference Class Reference 8.95.2.5
371
PoDoFo::PdfRefCountedInputDevice::PdfRefCountedInputDevice ( const PdfRefCountedInputDevice & rhs )
Copy an existing PdfRefCountedFile and increase the reference count Parameters rhs the PdfRefCountedFile to copy
8.95.2.6
PoDoFo::PdfRefCountedInputDevice::PdfRefCountedInputDevice ( )
Decrease the reference count and close the le if this is the last owner
8.95.3
8.95.3.1

PdfInputDevice PoDoFo::PdfRefCountedInputDevice::Device ( const [inline] )
Get access to the le handle Returns the le handle
8.95.3.2
const PdfRefCountedInputDevice & PoDoFo::PdfRefCountedInputDevice::operator= ( const PdfRefCountedInputDevice & rhs )
Copy an existing PdfRefCountedFile and increase the reference count Parameters rhs the PdfRefCountedFile to copy Returns the copied object
8.96
PoDoFo::PdfReference Class Reference
#include <PdfReference.h> Inheritance diagram for PoDoFo::PdfReference:

372
Class Documentation
PoDoFo::PdfDataType PoDoFo::PdfReference

PdfReference () PdfReference (const pdf_objnum nObjectNo, const pdf_gennum nGenerationNo) PdfReference (const PdfReference &rhs) const std::string ToString () const PODOFO_NOTHROW const PdfReference & operator= (const PdfReference &rhs) void Write (PdfOutputDevice pDevice, EPdfWriteMode eWriteMode, const PdfEncrypt pEncrypt=NULL) const PODOFO_NOTHROW bool operator== (const PdfReference &rhs) const PODOFO_NOTHROW bool operator!= (const PdfReference &rhs) const PODOFO_NOTHROW bool operator< (const PdfReference &rhs) const PODOFO_NOTHROW void SetObjectNumber (pdf_objnum o) PODOFO_NOTHROW pdf_objnum ObjectNumber () const PODOFO_NOTHROW void SetGenerationNumber (const pdf_gennum g) PODOFO_NOTHROW pdf_gennum GenerationNumber () const PODOFO_NOTHROW bool IsIndirect () const
8.96.1
A reference is a pointer to a object in the PDF le of the form "4 0 R", where 4 is the object number and 0 is the generation number. Every object in the PDF le can be indetied this way. This class is a indirect reference in a PDF le.
8.96.2
8.96.2.1

PoDoFo::PdfReference::PdfReference ( ) [inline]
Create a PdfReference with object number and generation number initialized to 0. 8.96.2.2 PoDoFo::PdfReference::PdfReference ( const pdf_objnum nObjectNo, const pdf_gennum nGenerationNo ) [inline]
Create a PdfReference to an object with a given object and generation number.

8.96 PoDoFo::PdfReference Class Reference Parameters nObjectNo the object number nGenerationNo the generation number
373
8.96.2.3
PoDoFo::PdfReference::PdfReference ( const PdfReference & rhs ) [inline]
Create a copy of an existing PdfReference. Parameters rhs the object to copy
8.96.3
8.96.3.1

pdf_gennum PoDoFo::PdfReference::GenerationNumber ( [inline] ) const
Get the generation number. Returns the generation number of this PdfReference
8.96.3.2
bool PoDoFo::PdfReference::IsIndirect (
) const [inline]
Allows to check if a reference points to an indirect object. A reference is indirect if object number and generation number are both not equal 0. Returns true if this reference is the reference of an indirect object.
8.96.3.3
pdf_objnum PoDoFo::PdfReference::ObjectNumber ( [inline]
) const
Get the object number. Returns the object number of this PdfReference
374 8.96.3.4
Class Documentation bool PoDoFo::PdfReference::operator!= ( const PdfReference & rhs ) const [inline]
Compare to PdfReference objects. Returns false if both reference the same object
8.96.3.5
bool PoDoFo::PdfReference::operator< ( const PdfReference & rhs ) const [inline]
Compare to PdfReference objects. Returns true if this reference has a smaller object and generation number
8.96.3.6
const PdfReference & PoDoFo::PdfReference::operator= ( const PdfReference & rhs ) [inline]
Assign the value of another object to this PdfReference. Parameters rhs the object to copy
8.96.3.7
bool PoDoFo::PdfReference::operator== ( const PdfReference & rhs ) const [inline]
Compare to PdfReference objects. Returns true if both reference the same object
8.96.3.8
void PoDoFo::PdfReference::SetGenerationNumber ( const pdf_gennum g ) [inline]
Set the generation number of this object Parameters g the new generation number
8.97 PoDoFo::PdfRijndael Class Reference 8.96.3.9 void PoDoFo::PdfReference::SetObjectNumber ( pdf_objnum o ) [inline]
375
Set the object number of this object Parameters o the new object number
8.96.3.10
const std::string PoDoFo::PdfReference::ToString (
) const
Convert the reference to a string. Returns a string representation of the object. See also PdfVariant::ToString
8.96.3.11
void PoDoFo::PdfReference::Write ( PdfOutputDevice pDevice, EPdfWriteMode eWriteMode, const PdfEncrypt pEncrypt = NULL ) const [virtual]
Write the complete variant to an output device. This is an overloaded member function. Parameters pDevice write the object to this device eWriteMode additional options for writing this object pEncrypt an encryption object which is used to encrypt this object or NULL to not encrypt this object Implements PoDoFo::PdfDataType.
8.97
PoDoFo::PdfRijndael Class Reference
Class implementing the Rijndael cipher. (For internal use only). #include <PdfRijndael.h>
8.97.1
Class implementing the Rijndael cipher. (For internal use only).

376
Class Documentation
8.98
PoDoFo::PdfRLEFilter Class Reference
#include <PdfFiltersPrivate.h> Inheritance diagram for PoDoFo::PdfRLEFilter:
PoDoFo::PdfFilter
PoDoFo::PdfRLEFilter

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 EPdfFilter GetType () const
8.98.1
The RLE lter.
8.98.2
8.98.2.1

void PoDoFo::PdfRLEFilter::BeginDecodeImpl ( const PdfDictionary ) [virtual]
8.98 PoDoFo::PdfRLEFilter Class Reference 8.98.2.2 void PoDoFo::PdfRLEFilter::BeginEncodeImpl ( ) [virtual]
377
Real implementation of BeginEncode(). NEVER call this method directly. By default this function does nothing. If your lter needs to do setup for encoding, you should override this method. PdfFilter ensures that a valid stream is available when this method is called, and that EndEncode() was called since the last BeginEncode()/EncodeBlock(). See also BeginEncode Reimplemented from PoDoFo::PdfFilter. 8.98.2.3 bool PoDoFo::PdfRLEFilter::CanDecode ( virtual] ) const [inline,
Check wether the decoding is implemented for this lter. Returns true if the lter is able to decode data Implements PoDoFo::PdfFilter. 8.98.2.4 bool PoDoFo::PdfRLEFilter::CanEncode ( virtual] ) const [inline,
Check wether the encoding is implemented for this lter. Returns true if the lter is able to encode data Implements PoDoFo::PdfFilter. 8.98.2.5 void PoDoFo::PdfRLEFilter::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 youre going to store it, as ownership is not transferred to the lter and the caller may free the buffer at any time.
378
Class Documentation
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. 8.98.2.6 void PoDoFo::PdfRLEFilter::EncodeBlockImpl ( const char pBuffer, pdf_long lLen ) [virtual]
Encode a block of data and write it to the PdfOutputStream specied 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. 8.98.2.7 void PoDoFo::PdfRLEFilter::EndEncodeImpl ( ) [virtual]
Finish encoding of data. See also BeginEncodeImpl EncodeBlockImpl Reimplemented from PoDoFo::PdfFilter. 8.98.2.8 EPdfFilter PoDoFo::PdfRLEFilter::GetType ( virtual] ) const [inline,
GetType of this lter.

8.99 PoDoFo::PdfSampledFunction Class Reference Returns the GetType of this lter Implements PoDoFo::PdfFilter.
379
8.99
PoDoFo::PdfSampledFunction Class Reference
#include <PdfFunction.h> Inheritance diagram for PoDoFo::PdfSampledFunction:
PoDoFo::PdfElement PoDoFo::PdfFunction PoDoFo::PdfSampledFunction

PdfSampledFunction (const PdfArray &rDomain, const PdfArray &rRange, const PdfFunction::Sample &rlstSamples, PdfVecObjects pParent) PdfSampledFunction (const PdfArray &rDomain, const PdfArray &rRange, const PdfFunction::Sample &rlstSamples, PdfDocument pParent)
8.99.1
This class is a PdfSampledFunction.
8.99.2
8.99.2.1

PoDoFo::PdfSampledFunction::PdfSampledFunction ( const PdfArray & rDomain, const PdfArray & rRange, const PdfFunction::Sample & rlstSamples, PdfVecObjects pParent )
Create a new PdfSampledFunction object. Parameters rDomain this array describes the input parameters of this PdfFunction. If this function has m input parameters, this array has to contain 2m numbers where each number describes either the lower or upper boundary of the input range.
380
Class Documentation rRange this array describes the output parameters of this PdfFunction. If this function has n input parameters, this array has to contain 2n numbers where each number describes either the lower or upper boundary of the output range. rlstSamples a list of bytes which are used to build up this function sample data pParent parent vector of objects
8.99.2.2
PoDoFo::PdfSampledFunction::PdfSampledFunction ( const PdfArray & rDomain, const PdfArray & rRange, const PdfFunction::Sample & rlstSamples, PdfDocument pParent )
Create a new PdfSampledFunction object. Parameters rDomain this array describes the input parameters of this PdfFunction. If this function has m input parameters, this array has to contain 2m numbers where each number describes either the lower or upper boundary of the input range. rRange this array describes the output parameters of this PdfFunction. If this function has n input parameters, this array has to contain 2n numbers where each number describes either the lower or upper boundary of the output range. rlstSamples a list of bytes which are used to build up this function sample data pParent parent document
8.100
PoDoFo::PdfShadingPattern Class Reference
#include <PdfShadingPattern.h> Inheritance diagram for PoDoFo::PdfShadingPattern:

PoDoFo::PdfElement PoDoFo::PdfShadingPattern PoDoFo::PdfAxialShadingPattern PoDoFo::PdfFunctionBaseShadingPattern PoDoFo::PdfRadialShadingPattern

const PdfName & GetIdentier () const
8.100 PoDoFo::PdfShadingPattern Class Reference
381

PdfShadingPattern (EPdfShadingPatternType eShadingType, PdfVecObjects pParent) PdfShadingPattern (EPdfShadingPatternType eShadingType, PdfDocument pParent)
8.100.1
This class dened a shading pattern which can be used to ll abitrary shapes with a pattern using PdfPainter.
8.100.2
8.100.2.1

PoDoFo::PdfShadingPattern::PdfShadingPattern ( EPdfShadingPatternType eShadingType, PdfVecObjects pParent ) [protected]
Create a new PdfShadingPattern object which will introduce itself automatically to every page object it is used on. Parameters pParent parent vector of objects eShadingType the type of this shading pattern
8.100.2.2
PoDoFo::PdfShadingPattern::PdfShadingPattern ( EPdfShadingPatternType eShadingType, PdfDocument pParent ) [protected]
Create a new PdfShadingPattern object which will introduce itself automatically to every page object it is used on. Parameters pParent parent document eShadingType the type of this shading pattern
8.100.3
8.100.3.1

const PdfName & PoDoFo::PdfShadingPattern::GetIdentier ( const [inline] )
Returns the identier of this ShadingPattern how it is known in the pages resource dictionary.
382 Returns PdfName containing the identier (e.g. /Sh13)
Class Documentation
8.101
PoDoFo::PdfSignatureField Class Reference
#include <PdfSignatureField.h> Inherits PoDoFo::PdfField.

PdfSignatureField (PdfPage pPage, const PdfRect &rRect, PdfDocument pDoc) void SetSignature (const PdfData &signatureData) void SetSignatureReason (const PdfString &rsText) void SetSignatureDate (const PdfDate &sigDate)
8.101.1
Signature eld
8.101.2
8.101.2.1

PoDoFo::PdfSignatureField::PdfSignatureField ( PdfPage pPage, const PdfRect & rRect, PdfDocument pDoc )
Create a new PdfSignatureField
8.101.3
8.101.3.1

void PoDoFo::PdfSignatureField::SetSignature ( const PdfData & signatureData )
Create space for signature Parameters signatureData String used to locate reserved space for signature. This string will be replaiced with signature. Structure of the PDF le - before signing: <</ByteRange[ 0 1234567890 1234567890 1234567890]/Contents<signatureData> Have to be replaiced with the following structure: <</ByteRange[ 0 count pos count]/Contents<real signature ...0-padding>
8.102 PoDoFo::PdfSignOutputDevice Class Reference 8.101.3.2
383
void PoDoFo::PdfSignatureField::SetSignatureDate ( const PdfDate & sigDate )
Date of signature
8.101.3.3
void PoDoFo::PdfSignatureField::SetSignatureReason ( const PdfString & rsText )
Set reason of the signature Parameters rsText the reason of signature
8.102
PoDoFo::PdfSignOutputDevice Class Reference
#include <PdfSignOutputDevice.h> Inheritance diagram for PoDoFo::PdfSignOutputDevice:
PoDoFo::PdfOutputDevice PoDoFo::PdfSignOutputDevice

virtual void SetSignatureSize (size_t lSignatureSize) virtual size_t GetSignatureSize () const virtual const PdfData GetSignatureBeacon () const virtual void AdjustByteRange () virtual size_t ReadForSignature (char pBuffer, size_t lLen) virtual void SetSignature (const PdfData &sigData) virtual size_t GetLength () const virtual void Print (const char pszFormat,...) virtual void Write (const char pBuffer, size_t lLen) virtual size_t Read (char pBuffer, size_t lLen) virtual void Seek (size_t offset) virtual size_t Tell () const virtual void Flush ()
384
Class Documentation
8.102.1
Signer class Class is used to locate place for signature in the stream. Usage: 1. Locate signature and adjust ByteRange 2. Generate signature 3. Insert new signature
8.102.2
8.102.2.1

void PoDoFo::PdfSignOutputDevice::AdjustByteRange ( [virtual] )
Modify ByteRange entry according to signature position 8.102.2.2 virtual void PoDoFo::PdfSignOutputDevice::Flush ( virtual] ) [inline,
Flush the output les buffer to disk if this devices operates on a disk. Reimplemented from PoDoFo::PdfOutputDevice. 8.102.2.3 virtual size_t PoDoFo::PdfSignOutputDevice::GetLength ( [inline, virtual] ) const
The number of bytes written to this object. Returns the number of bytes written to this object. See also Init Reimplemented from PoDoFo::PdfOutputDevice. 8.102.2.4 virtual const PdfData PoDoFo::PdfSignOutputDevice::GetSignatureBeacon ( ) const [inline, virtual]
Return signature beacon 8.102.2.5 size_t PoDoFo::PdfSignOutputDevice::GetSignatureSize ( [virtual] ) const
Get expected size of signature. If reserved size if zero no signatures will be added.
8.102 PoDoFo::PdfSignOutputDevice Class Reference Returns Total space reserved for signature.
385
8.102.2.6
virtual void PoDoFo::PdfSignOutputDevice::Print ( const char pszFormat, ... ) [inline, virtual]
Write to the PdfOutputDevice. Usage is as the usage of printf. WARNING: Do not use this for doubles or oating point values as the output might depend on the current locale. Parameters pszFormat a format string as you would use it with printf Returns ErrOk on success See also Write Reimplemented from PoDoFo::PdfOutputDevice.
8.102.2.7
virtual size_t PoDoFo::PdfSignOutputDevice::Read ( char pBuffer, size_t lLen ) [inline, virtual]
Read data from the device Parameters pBuffer a pointer to the data buffer lLen length of the output buffer Returns Number of read bytes. Return 0 if EOF Reimplemented from PoDoFo::PdfOutputDevice.
8.102.2.8
size_t PoDoFo::PdfSignOutputDevice::ReadForSignature ( char pBuffer, size_t lLen ) [virtual]
Read data for signature

386 8.102.2.9
Class Documentation virtual void PoDoFo::PdfSignOutputDevice::Seek ( size_t offset ) [inline, virtual]
Seek the device to the position offset from the begining Parameters offset from the beginning of the le Reimplemented from PoDoFo::PdfOutputDevice. 8.102.2.10 void PoDoFo::PdfSignOutputDevice::SetSignature ( const PdfData & sigData ) [virtual]
Embed real signature in the PDF 8.102.2.11 void PoDoFo::PdfSignOutputDevice::SetSignatureSize ( size_t lSignatureSize ) [virtual]
Set string to lookup for Parameters lSignatureSize Total space reserved for signature
8.102.2.12
virtual size_t PoDoFo::PdfSignOutputDevice::Tell ( [inline, virtual]
) const
Get the current offset from the beginning of the le. Returns the offset form the beginning of the le. Reimplemented from PoDoFo::PdfOutputDevice. 8.102.2.13 void PoDoFo::PdfSignOutputDevice::Write ( const char pBuffer, size_t lLen ) [virtual]
Write data to the buffer. Use this call instead of Print if you want to write binary data to the PdfOutputDevice. Parameters pBuffer a pointer to the data buffer lLen write lLen bytes of pBuffer to the PdfOutputDevice
8.103 PoDoFo::PdfSimpleEncoding Class Reference Returns ErrOk on success See also Print Reimplemented from PoDoFo::PdfOutputDevice.
387
8.103
PoDoFo::PdfSimpleEncoding Class Reference
#include <PdfEncoding.h> Inheritance diagram for PoDoFo::PdfSimpleEncoding:

PoDoFo::PdfEncoding PoDoFo::PdfSimpleEncoding PoDoFo::PdfDocEncoding PoDoFo::PdfMacRomanEncoding PoDoFo::PdfStandardEncoding PoDoFo::PdfSymbolEncoding PoDoFo::PdfWinAnsiEncoding PoDoFo::PdfZapfDingbatsEncoding

virtual void AddToDictionary (PdfDictionary &rDictionary) const virtual PdfString ConvertToUnicode (const PdfString &rEncodedString, const PdfFont pFont) const virtual PdfRefCountedBuffer ConvertToEncoding (const PdfString &rString, const PdfFont pFont) const virtual bool IsAutoDelete () const virtual bool IsSingleByteEncoding () const const PdfName & GetName () const virtual pdf_utf16be GetCharCode (int nIndex) const

virtual const PdfName & GetID () const virtual const pdf_utf16be GetToUnicodeTable () const =0
Util::PdfMutex m_mutex
Mutex for the creation of the encoding table.
388
Class Documentation
8.103.1
A common base class for standard PdfEncoding which are known by name. PdfDocEncoding (only use this for strings which are not printed in the document. This is for meta data in the PDF). MacRomanEncoding WinAnsiEncoding MacExpertEncoding StandardEncoding SymbolEncoding ZapfDingbatsEncoding See also PdfWinAnsiEncoding PdfMacRomanEncoding PdfMacExportEncoding .. PdfStandardEncoding PdfSymbolEncoding PdfZapfDingbatsEncoding
8.103.2
8.103.2.1

void PoDoFo::PdfSimpleEncoding::AddToDictionary ( PdfDictionary & rDictionary ) const [virtual]
Add this encoding object to a dictionary usually be adding an /Encoding key in font dictionaries. Parameters rDictionary add the encoding to this dictionary Implements PoDoFo::PdfEncoding. 8.103.2.2 PdfRefCountedBuffer PoDoFo::PdfSimpleEncoding::ConvertToEncoding ( const PdfString & rString, const PdfFont pFont ) const [virtual]
Convert a unicode PdfString to a string encoded with this encoding. Parameters rString an unicode PdfString.
8.103 PoDoFo::PdfSimpleEncoding Class Reference pFont the font for which this string is converted Returns
389
an encoded PdfRefCountedBuffer. The PdfRefCountedBuffer is treated as a series of bytes and is allowed to have 0 bytes. The returned buffer must not be a unicode string. Implements PoDoFo::PdfEncoding. 8.103.2.3 PdfString PoDoFo::PdfSimpleEncoding::ConvertToUnicode ( const PdfString & rEncodedString, const PdfFont pFont ) const [virtual]
Convert a string that is encoded with this encoding to an unicode PdfString. Parameters rEncodedString a string encoded by this encoding. Usually this string was read from a content stream. pFont the font for which this string is converted Returns an unicode PdfString. Implements PoDoFo::PdfEncoding. 8.103.2.4 pdf_utf16be PoDoFo::PdfSimpleEncoding::GetCharCode ( int nIndex ) const [virtual]
Get the unicode character code for this encoding at the position nIndex. nIndex is a position between GetFirstChar() and GetLastChar() Parameters nIndex character code at position index Returns unicode character code See also GetFirstChar GetLastChar Will throw an exception if nIndex is out of range. Implements PoDoFo::PdfEncoding.
390 8.103.2.5
Class Documentation const PdfName & PoDoFo::PdfSimpleEncoding::GetID ( [inline, protected, virtual] ) const
Get a unique ID for this encoding which can used for comparisons! Returns a unique id for this encoding! Implements PoDoFo::PdfEncoding. 8.103.2.6 const PdfName & PoDoFo::PdfSimpleEncoding::GetName ( [inline] ) const
Get the name of this encoding. Returns the name of this encoding.
8.103.2.7
virtual const pdf_utf16be PoDoFo::PdfSimpleEncoding::GetToUnicodeTable ( const [protected, pure virtual]
Gets a table of 256 short values which are the big endian unicode code points that are assigned to the 256 values of this encoding. This table is used internally to convert an encoded string of this encoding to and from unicode. Returns an array of 256 big endian unicode code points Implemented in PoDoFo::PdfDocEncoding, PoDoFo::PdfWinAnsiEncoding, PoDoFo::PdfMacRomanEncoding, PoDoFo::PdfStandardEncoding, PoDoFo::PdfSymbolEncoding, and PoDoFo::PdfZapfDingbatsEncoding. 8.103.2.8 bool PoDoFo::PdfSimpleEncoding::IsAutoDelete ( [inline, virtual] ) const
PdfSimpleEncoding subclasses are usuylla not auto-deleted, as they are allocated statically only once. Returns true if this encoding should be deleted automatically with the font.
8.104 PoDoFo::PdfSimpleTableModel Class Reference See also PdfFont::WinAnsiEncoding PdfFont::MacRomanEncoding Implements PoDoFo::PdfEncoding. 8.103.2.9 Returns true if this is a single byte encoding with a maximum of 256 values. Implements PoDoFo::PdfEncoding. bool PoDoFo::PdfSimpleEncoding::IsSingleByteEncoding ( [inline, virtual]
391
) const
8.104
PoDoFo::PdfSimpleTableModel Class Reference
#include <PdfTable.h> Inheritance diagram for PoDoFo::PdfSimpleTableModel:

PoDoFo::PdfTableModel PoDoFo::PdfSimpleTableModel

PdfSimpleTableModel () PdfSimpleTableModel (int nCols, int nRows) void SetFont (PdfFont pFont) void SetAlignment (EPdfAlignment eAlignment) void SetAlignment (EPdfVerticalAlignment eAlignment) void SetBackgroundColor (const PdfColor &rColor) void SetForegroundColor (const PdfColor &rColor) void SetBackgroundEnabled (bool bEnable) void SetWordWrapEnabled (bool bEnable) void SetBorderEnabled (bool bEnable) void SetBorderWidth (double dWidth) void SetText (int col, int row, const PdfString &rsString) virtual PdfString GetText (int col, int row) const virtual EPdfAlignment GetAlignment (int col, int row) const virtual EPdfVerticalAlignment GetVerticalAlignment (int col, int row) const virtual PdfFont GetFont (int col, int row) const
392
Class Documentation virtual bool HasBackgroundColor (int col, int row) const virtual PdfColor GetBackgroundColor (int col, int row) const virtual PdfColor GetForegroundColor (int col, int row) const virtual bool HasWordWrap (int col, int row) const virtual bool HasBorders () const virtual double GetBorderWidth () const virtual PdfColor GetBorderColor (int col, int row) const virtual bool HasImage (int col, int row) const virtual PdfImage GetImage (int col, int row) const
8.104.1
An implementation of a simple PdfTableModel.
8.104.2
8.104.2.1

PoDoFo::PdfSimpleTableModel::PdfSimpleTableModel ( )
Creates an empty PdfSimpleTableModel that does not contain any data. Using this model will result in drawing an empty table! 8.104.2.2 PoDoFo::PdfSimpleTableModel::PdfSimpleTableModel ( int nCols, int nRows )
Creates an empty PdfSimpleTableModel that does not contain any data. Using this model will result in drawing an empty table! Parameters nCols number of columns of the data in this table model (must match the PdfTable object) nRows number of rows of the data in this table model (must match the PdfTable object) You can set the tables data using SetText. See also SetText
8.104.3
8.104.3.1

EPdfAlignment PoDoFo::PdfSimpleTableModel::GetAlignment ( int col, int row ) const [inline, virtual]
Parameters col the column of the table cell

8.104 PoDoFo::PdfSimpleTableModel Class Reference row the row of the table cell Returns the horizontal alignment of the contents in the cell Implements PoDoFo::PdfTableModel. 8.104.3.2
393
PdfColor PoDoFo::PdfSimpleTableModel::GetBackgroundColor ( int col, int row ) const [inline, virtual]
Parameters col the column of the table cell row the row of the table cell Returns the background color of the specied cell Implements PoDoFo::PdfTableModel. 8.104.3.3 PdfColor PoDoFo::PdfSimpleTableModel::GetBorderColor ( int col, int row ) const [inline, virtual]
Parameters col the column of the table cell row the row of the table cell Returns the border color Implements PoDoFo::PdfTableModel. 8.104.3.4 Returns the stroke witdth of the border line Implements PoDoFo::PdfTableModel. 8.104.3.5 PdfFont PoDoFo::PdfSimpleTableModel::GetFont ( int col, int row ) const [inline, virtual] double PoDoFo::PdfSimpleTableModel::GetBorderWidth ( [inline, virtual] ) const
Parameters col the column of the table cell

394 row the row of the table cell Returns the font of this table cell or NULL to use the default font Implements PoDoFo::PdfTableModel. 8.104.3.6
Class Documentation
PdfColor PoDoFo::PdfSimpleTableModel::GetForegroundColor ( int col, int row ) const [inline, virtual]
Parameters col the column of the table cell row the row of the table cell Returns the foreground (text) color of the specied cell Implements PoDoFo::PdfTableModel. 8.104.3.7 PdfImage PoDoFo::PdfSimpleTableModel::GetImage ( int col, int row ) const [inline, virtual]
Parameters col the column of the table cell row the row of the table cell Returns the image for the specied cell or NULL if the cell has no image Implements PoDoFo::PdfTableModel. 8.104.3.8 PdfString PoDoFo::PdfSimpleTableModel::GetText ( int col, int row ) const [inline, virtual]
Parameters col the column of the table cell row the row of the table cell Returns the contents string of this table cell Implements PoDoFo::PdfTableModel.
8.104 PoDoFo::PdfSimpleTableModel Class Reference 8.104.3.9 EPdfVerticalAlignment PoDoFo::PdfSimpleTableModel::GetVerticalAlignment ( int col, int row ) const [inline, virtual]
395
Parameters col the column of the table cell row the row of the table cell Returns the vertical alignment of the contents in the cell Implements PoDoFo::PdfTableModel. 8.104.3.10 bool PoDoFo::PdfSimpleTableModel::HasBackgroundColor ( int col, int row ) const [inline, virtual]
Parameters col the column of the table cell row the row of the table cell Returns true if this cell has a background color Implements PoDoFo::PdfTableModel. 8.104.3.11 Returns true if the table should have a border around all cells. false if no cell border should be visible Cell borders are always drawn using the current PdfPainter settings. Implements PoDoFo::PdfTableModel. 8.104.3.12 bool PoDoFo::PdfSimpleTableModel::HasImage ( int col, int row ) const [inline, virtual] bool PoDoFo::PdfSimpleTableModel::HasBorders ( [inline, virtual] ) const
Parameters col the column of the table cell row the row of the table cell Returns true if the table cell contains an image Implements PoDoFo::PdfTableModel.
396 8.104.3.13
Class Documentation bool PoDoFo::PdfSimpleTableModel::HasWordWrap ( int col, int row ) const [inline, virtual]
Parameters col the column of the table cell row the row of the table cell Returns true if the specied cell should use wordwrapping Implements PoDoFo::PdfTableModel. 8.104.3.14 void PoDoFo::PdfSimpleTableModel::SetAlignment ( EPdfAlignment eAlignment ) [inline]
Set the horizontal alignment of the contents in all table cells Parameters eAlignment the horizontal alignment of text in a table cell
8.104.3.15
void PoDoFo::PdfSimpleTableModel::SetAlignment ( EPdfVerticalAlignment eAlignment ) [inline]
Set the vertical alignment of the contents in all table cells Parameters eAlignment the vertiical alignment of text in a table cell
8.104.3.16
void PoDoFo::PdfSimpleTableModel::SetBackgroundColor ( const PdfColor & rColor ) [inline]
Set the background color of the table cells Parameters rColor the background color
8.104.3.17
void PoDoFo::PdfSimpleTableModel::SetBackgroundEnabled ( bool bEnable ) [inline]
Sets wether all cells have a background color or not Parameters bEnable if true all cells have a background color
8.104 PoDoFo::PdfSimpleTableModel Class Reference 8.104.3.18 void PoDoFo::PdfSimpleTableModel::SetBorderEnabled ( bool bEnable ) [inline]
397
Sets wether all cells have a border or not. Parameters bEnable if true a border will be drawn using the current PdfPainter settings
8.104.3.19
void PoDoFo::PdfSimpleTableModel::SetBorderWidth ( double dWidth ) [inline]
Sets the stroke width of the border around the table. Parameters dWidth the stroke width of the border
8.104.3.20
void PoDoFo::PdfSimpleTableModel::SetFont ( PdfFont pFont ) [inline]
Set the font that will be used to draw all table contents. Parameters pFont the font for the table contents
8.104.3.21
void PoDoFo::PdfSimpleTableModel::SetForegroundColor ( const PdfColor & rColor ) [inline]
Set the foreground color of the table cells Parameters rColor the foreground color
8.104.3.22
void PoDoFo::PdfSimpleTableModel::SetText ( int col, int row, const PdfString & rsString ) [inline]
Sets the contents of a specic cell Parameters col the column of the table cell row the row of the table cell rsString the contents of this cell
398 8.104.3.23
Class Documentation void PoDoFo::PdfSimpleTableModel::SetWordWrapEnabled ( bool bEnable ) [inline]
Sets wether all cells have wordwrapping or not Parameters bEnable if true all cells have wordwrapping
8.105
PoDoFo::PdfStandardEncoding Class Reference
#include <PdfEncoding.h> Inheritance diagram for PoDoFo::PdfStandardEncoding:
PoDoFo::PdfEncoding PoDoFo::PdfSimpleEncoding PoDoFo::PdfStandardEncoding

PdfStandardEncoding ()

8.105.1
Do not allocate this class yourself, as allocations might be expensive. Try using PdfFont::StandardEncoding. See also PdfFont::StandardEncoding
8.105.2
8.105.2.1

PoDoFo::PdfStandardEncoding::PdfStandardEncoding ( [inline] )
Create a new PdfStandardEncoding

8.106 PoDoFo::PdfStitchingFunction Class Reference
399
8.105.3
8.105.3.1

const pdf_utf16be PoDoFo::PdfStandardEncoding::GetToUnicodeTable ( ) const [protected, virtual]
8.106
PoDoFo::PdfStitchingFunction Class Reference
#include <PdfFunction.h> Inheritance diagram for PoDoFo::PdfStitchingFunction:
PoDoFo::PdfElement PoDoFo::PdfFunction PoDoFo::PdfStitchingFunction

PdfStitchingFunction (const PdfFunction::List &rlstFunctions, const PdfArray &rDomain, const PdfArray &rBounds, const PdfArray &rEncode, PdfVecObjects pParent) PdfStitchingFunction (const PdfFunction::List &rlstFunctions, const PdfArray &rDomain, const PdfArray &rBounds, const PdfArray &rEncode, PdfDocument pParent)
8.106.1
This class is a PdfStitchingFunction, i.e. a PdfFunction that combines more than one PdfFunction into one. It combines several PdfFunctions that take 1 input parameter to a new PdfFunction taking again only 1 input parameter.
400
Class Documentation
8.106.2
8.106.2.1

PoDoFo::PdfStitchingFunction::PdfStitchingFunction ( const PdfFunction::List & rlstFunctions, const PdfArray & rDomain, const PdfArray & rBounds, const PdfArray & rEncode, PdfVecObjects pParent )
Create a new PdfStitchingFunction object. Parameters rlstFunctions a list of functions which are used to built up this function object rDomain this array describes the input parameters of this PdfFunction. If this function has m input parameters, this array has to contain 2m numbers where each number describes either the lower or upper boundary of the input range. rBounds the bounds array rEncode the encode array pParent parent vector of objects
8.106.2.2
PoDoFo::PdfStitchingFunction::PdfStitchingFunction ( const PdfFunction::List & rlstFunctions, const PdfArray & rDomain, const PdfArray & rBounds, const PdfArray & rEncode, PdfDocument pParent )
Create a new PdfStitchingFunction object. Parameters rlstFunctions a list of functions which are used to built up this function object rDomain this array describes the input parameters of this PdfFunction. If this function has m input parameters, this array has to contain 2m numbers where each number describes either the lower or upper boundary of the input range. rBounds the bounds array rEncode the encode array pParent parent document
8.107
PoDoFo::PdfStream Class Reference
#include <PdfStream.h> Inheritance diagram for PoDoFo::PdfStream:

8.107 PoDoFo::PdfStream Class Reference
401
PoDoFo::PdfStream
PoDoFo::PdfFileStream
PoDoFo::PdfMemStream

PdfStream (PdfObject pParent) virtual void Write pEncrypt=NULL)=0 (PdfOutputDevice pDevice, PdfEncrypt
void Set (const char szBuffer, pdf_long lLen, const TVecFilters &vecFilters) void Set (const char szBuffer, pdf_long lLen) void Set (PdfInputStream pStream) void Set (PdfInputStream pStream, const TVecFilters &vecFilters) void Set (const char pszString) void SetRawData (PdfInputStream pStream, pdf_long lLen=-1) void BeginAppend (bool bClearExisting=true) void BeginAppend (const TVecFilters &vecFilters, bool bClearExisting=true, bool bDeleteFilters=true) void Append (const char pszString, size_t lLen) void Append (const char pszString) void Append (const std::string &sString) void EndAppend () bool IsAppending () const virtual pdf_long GetLength () const =0 virtual void GetCopy (char pBuffer, pdf_long lLen) const =0 virtual void GetCopy (PdfOutputStream pStream) const =0 void GetFilteredCopy (char pBuffer, pdf_long lLen) const void GetFilteredCopy (PdfOutputStream pStream) const const PdfStream & operator= (const PdfStream &rhs)

virtual const char GetInternalBuffer () const =0 virtual pdf_long GetInternalBufferSize () const =0 virtual void BeginAppendImpl (const TVecFilters &vecFilters)=0 virtual void AppendImpl (const char pszString, size_t lLen)=0 virtual void EndAppendImpl ()=0
402
Class Documentation
8.107.1
A PDF stream can be appended to any PdfObject and can contain arbitrary data. Most of the time it will contain either drawing commands to draw onto a page or binary data like a font or an image. You have to use a concrete implementation of a stream, which can be retrieved from a StreamFactory. See also PdfVecObjects PdfMemoryStream PdfFileStream
8.107.2
8.107.2.1

PoDoFo::PdfStream::PdfStream ( PdfObject pParent )
Create a new PdfStream object which has a parent PdfObject. The stream will be deleted along with the parent. This constructor will be called by PdfObject::Stream() for you. Parameters pParent parent object
8.107.3
8.107.3.1

void PoDoFo::PdfStream::Append ( const char pszString, size_t lLen ) [inline]
Append a binary buffer to the current stream contents. Make sure BeginAppend has been called before. Parameters pszString a buffer lLen length of the buffer See also BeginAppend EndAppend
8.107.3.2
void PoDoFo::PdfStream::Append ( const char pszString ) [inline]
Append a null-terminated string to the current stream contents.

8.107 PoDoFo::PdfStream Class Reference Make sure BeginAppend has been called before. Parameters pszString a zero terminated string buffer containing only ASCII text data See also BeginAppend EndAppend
403
8.107.3.3
void PoDoFo::PdfStream::Append ( const std::string & sString ) [inline]
Append to the current stream contents. Make sure BeginAppend has been called before. Parameters sString a std::string containing ASCII text data See also BeginAppend EndAppend
8.107.3.4
virtual void PoDoFo::PdfStream::AppendImpl ( const char pszString, size_t lLen ) [protected, pure virtual]
Append a binary buffer to the current stream contents. Parameters pszString a buffer lLen length of the buffer See also BeginAppend Append EndAppend Implemented in PoDoFo::PdfFileStream, and PoDoFo::PdfMemStream. 8.107.3.5 void PoDoFo::PdfStream::BeginAppend ( bool bClearExisting = true )
Start appending data to this stream.

404
Class Documentation
This method has to be called before any of the append methods. All appended data will be ate decoded! Parameters bClearExisting if true any existing stream contents will be cleared. See also Append EndAppend
8.107.3.6
void PoDoFo::PdfStream::BeginAppend ( const TVecFilters & vecFilters, bool bClearExisting = true, bool bDeleteFilters = true )
Start appending data to this stream. This method has to be called before any of the append methods. Use PdfFilterFactory::CreateFilterList if you want to use the contents of the stream dictionarys existing lter key. Parameters vecFilters a list of lters to use when appending data bClearExisting if true any existing stream contents will be cleared. bDeleteFilters if true existing lter keys are deleted if an empty list of lters is passed (required for SetRawData) See also Append EndAppend
8.107.3.7
virtual void PoDoFo::PdfStream::BeginAppendImpl ( const TVecFilters & vecFilters ) [protected, pure virtual]
Begin appending data to this stream. Clears the current stream contents. Use PdfFilterFactory::CreateFilterList if you want to use the contents of the stream dictionarys existing lter key. Parameters vecFilters use this lters to encode any data written to the stream. Implemented in PoDoFo::PdfFileStream, and PoDoFo::PdfMemStream.
8.107 PoDoFo::PdfStream Class Reference 8.107.3.8 void PoDoFo::PdfStream::EndAppend ( )
405
Finish appending data to this stream. BeginAppend() has to be called before this method. See also BeginAppend Append
8.107.3.9
virtual void PoDoFo::PdfStream::EndAppendImpl ( [protected, pure virtual]
Finish appending data to the stream Implemented in PoDoFo::PdfFileStream, and PoDoFo::PdfMemStream. 8.107.3.10 virtual void PoDoFo::PdfStream::GetCopy ( char pBuffer, pdf_long lLen ) const [pure virtual]
Get a malloced buffer of the current stream. No lters will be applied to the buffer, so if the stream is Flate compressed the compressed copy will be returned. The caller has to free() the buffer. Parameters pBuffer pointer to the buffer lLen pointer to the buffer length Implemented in PoDoFo::PdfFileStream, and PoDoFo::PdfMemStream. 8.107.3.11 virtual void PoDoFo::PdfStream::GetCopy ( PdfOutputStream pStream ) const [pure virtual]
Get a copy of a the stream and write it to a PdfOutputStream Parameters pStream data is written to this stream. Implemented in PoDoFo::PdfFileStream, and PoDoFo::PdfMemStream. 8.107.3.12 void PoDoFo::PdfStream::GetFilteredCopy ( char pBuffer, pdf_long lLen ) const
Get a malloced buffer of the current stream which has been ltered by all lters as specied in the dictionarys /Filter key. For example, if the stream is Flate compressed, the buffer returned from this method will have been decompressed.
406 The caller has to free() the buffer. Parameters pBuffer pointer to the buffer lLen pointer to the buffer length
Class Documentation
8.107.3.13
void PoDoFo::PdfStream::GetFilteredCopy ( PdfOutputStream pStream ) const
Get a ltered copy of a the stream and write it to a PdfOutputStream Parameters pStream ltered data is written to this stream.
8.107.3.14
virtual const char PoDoFo::PdfStream::GetInternalBuffer ( const [protected, pure virtual]
Required for the GetFilteredCopy implementation Returns a handle to the internal buffer Implemented in PoDoFo::PdfFileStream, and PoDoFo::PdfMemStream. 8.107.3.15 virtual pdf_long PoDoFo::PdfStream::GetInternalBufferSize ( const [protected, pure virtual] )
Required for the GetFilteredCopy implementation Returns the size of the internal buffer Implemented in PoDoFo::PdfFileStream, and PoDoFo::PdfMemStream. 8.107.3.16 virtual pdf_long PoDoFo::PdfStream::GetLength ( ) const [pure virtual]
Get the streams length with all lters applied (eg if the stream is Flate compressed, the length of the compressed data stream). Returns the length of the internal buffer Implemented in PoDoFo::PdfFileStream, and PoDoFo::PdfMemStream.
8.107 PoDoFo::PdfStream Class Reference 8.107.3.17 Returns bool PoDoFo::PdfStream::IsAppending ( ) const [inline]
407
true if code is between BeginAppend() and EndAppend() at the moment. I.e. it is save to call EndAppend now. See also BeginAppend Append
8.107.3.18
const PdfStream & PoDoFo::PdfStream::operator= ( const PdfStream & rhs )
Create a copy of a PdfStream object Parameters rhs the object to clone Returns a reference to this object Reimplemented in PoDoFo::PdfMemStream. 8.107.3.19 void PoDoFo::PdfStream::Set ( const char szBuffer, pdf_long lLen, const TVecFilters & vecFilters )
Set a binary buffer as stream data. Use PdfFilterFactory::CreateFilterList if you want to use the contents of the stream dictionarys existing lter key. Parameters szBuffer buffer containing the stream data lLen length of the buffer vecFilters a list of lters to use when appending data
8.107.3.20
void PoDoFo::PdfStream::Set ( PdfInputStream pStream, const TVecFilters & vecFilters )
Set a binary buffer whose contents are read from a PdfInputStream Use PdfFilterFactory::CreateFilterList if you want to use the contents of the stream dictionarys existing lter key.
408 Parameters pStream read stream contents from this PdfInputStream vecFilters a list of lters to use when appending data
Class Documentation
8.107.3.21
void PoDoFo::PdfStream::Set ( PdfInputStream pStream )
Set a binary buffer whose contents are read from a PdfInputStream All data will be ate encoded. Parameters pStream read stream contents from this PdfInputStream
8.107.3.22
void PoDoFo::PdfStream::Set ( const char pszString ) [inline]
Set a null-terminated char buffer as the streams contents. The string will be copied into a newly allocated buffer. Parameters pszString a zero terminated string buffer containing only ASCII text data
8.107.3.23
void PoDoFo::PdfStream::Set ( const char szBuffer, pdf_long lLen )
Set a binary buffer as stream data. All data will be ate encoded. Parameters szBuffer buffer containing the stream data lLen length of the buffer
8.107.3.24
void PoDoFo::PdfStream::SetRawData ( PdfInputStream pStream, pdf_long lLen = -1 )
Sets raw data for this lter which is read from an input stream. This method does neither encode nor decode the read data. The lters of the object are not modied and the data is expected to be encoded as stated by the /Filters key in the streams object. Parameters pStream read data from this input stream lLen read excactly lLen bytes from the input stream if lLen = -1 read until the end of the input stream was reached.
8.108 PoDoFo::PdfStreamedDocument Class Reference 8.107.3.25 virtual void PoDoFo::PdfStream::Write ( PdfOutputDevice pDevice, PdfEncrypt pEncrypt = NULL ) [pure virtual]
409
Write the stream to an output device Parameters pDevice write to this outputdevice. pEncrypt encrypt stream data using this object Implemented in PoDoFo::PdfFileStream, and PoDoFo::PdfMemStream.
8.108
PoDoFo::PdfStreamedDocument Class Reference
#include <PdfStreamedDocument.h> Inheritance diagram for PoDoFo::PdfStreamedDocument:
PoDoFo::PdfDocument
PoDoFo::PdfStreamedDocument

PdfStreamedDocument (PdfOutputDevice pDevice, EPdfVersion eVersion=ePdfVersion_Default, PdfEncrypt pEncrypt=NULL, EPdfWriteMode eWriteMode=ePdfWriteMode_Default) PdfStreamedDocument (const char pszFilename, EPdfVersion eVersion=ePdfVersion_Default, PdfEncrypt pEncrypt=NULL, EPdfWriteMode eWriteMode=ePdfWriteMode_Default) void Close () virtual EPdfWriteMode GetWriteMode () const virtual EPdfVersion GetPdfVersion () const virtual bool IsLinearized () const virtual bool IsPrintAllowed () const virtual bool IsEditAllowed () const virtual bool IsCopyAllowed () const virtual bool IsEditNotesAllowed () const virtual bool IsFillAndSignAllowed () const virtual bool IsAccessibilityAllowed () const virtual bool IsDocAssemblyAllowed () const virtual bool IsHighPrintAllowed () const
410
Class Documentation
8.108.1
PdfStreamedDocument is the preferred class for creating new PDF documents. Page contents, fonts and images are written to disk as soon as possible and are not kept in memory. This results in faster document generation and less memory being used. Please use PdfMemDocument if you intend to work on the object structure of a PDF le. One of the design goals of PdfStreamedDocument was to hide the underlying object structure of a PDF le as far as possible. See also PdfDocument PdfMemDocument Example of using PdfStreamedDocument: PdfStreamedDocument document( "outputle.pdf" ); PdfPage pPage = document.CreatePage( PdfPage::CreateStandardPageSize( ePdfPageSize_A4 ) ); PdfFont pFont = document.CreateFont( "Arial" ); PdfPainter painter; painter.SetPage( pPage ); painter.SetFont( pFont ); painter.DrawText( 56.69, pPage->GetPageSize().GetHeight() - 56.69, "Hello World!" ); painter.FinishPage(); document.Close();
8.108.2
8.108.2.1

PoDoFo::PdfStreamedDocument::PdfStreamedDocument ( PdfOutputDevice pDevice, EPdfVersion eVersion = ePdfVersion_Default, PdfEncrypt pEncrypt = NULL, EPdfWriteMode eWriteMode = ePdfWriteMode_Default )
Create a new PdfStreamedDocument. All data is written to an output device immediately. Parameters pDevice an output device eVersion the PDF version of the document to write. The PDF version can only be set in the constructor as it is the rst item written to the document on disk. pEncrypt pointer to an encryption object or NULL. If not NULL the PdfEncrypt object will be copied and used to encrypt the created document. eWriteMode additional options for writing the pdf
8.108 PoDoFo::PdfStreamedDocument Class Reference 8.108.2.2
411
PoDoFo::PdfStreamedDocument::PdfStreamedDocument ( const char pszFilename, EPdfVersion eVersion = ePdfVersion_Default, PdfEncrypt pEncrypt = NULL, EPdfWriteMode eWriteMode = ePdfWriteMode_Default )
Create a new PdfStreamedDocument. All data is written to a le immediately. Parameters pszFilename resulting PDF le eVersion the PDF version of the document to write. The PDF version can only be set in the constructor as it is the rst item written to the document on disk. pEncrypt pointer to an encryption object or NULL. If not NULL the PdfEncrypt object will be copied and used to encrypt the created document. eWriteMode additional options for writing the pdf
8.108.3
8.108.3.1

void PoDoFo::PdfStreamedDocument::Close ( )
Close the document. The PDF le on disk is nished. No other member function of this class maybe called after calling this function.
8.108.3.2
EPdfVersion PoDoFo::PdfStreamedDocument::GetPdfVersion ( const [inline, virtual]
Get the PDF version of the document Returns EPdfVersion version of the pdf document Implements PoDoFo::PdfDocument.
8.108.3.3
EPdfWriteMode PoDoFo::PdfStreamedDocument::GetWriteMode ( ) const [inline, virtual]
Get the write mode used for wirting the PDF Returns the write mode Implements PoDoFo::PdfDocument.
412 8.108.3.4
Class Documentation bool PoDoFo::PdfStreamedDocument::IsAccessibilityAllowed ( const [inline, virtual] )
Checks if it is allowed to extract text and graphics to support users with disabillities Every PDF consuming applications has to adhere this value! Returns true if you are allowed to extract text and graphics to support users with disabillities See also PdfEncrypt to set own document permissions. Implements PoDoFo::PdfDocument.
8.108.3.5
bool PoDoFo::PdfStreamedDocument::IsCopyAllowed ( [inline, virtual]
) const
Checks if text and graphics extraction is allowed. Every PDF consuming applications has to adhere this value! Returns true if you are allowed to extract text and graphics from this document See also PdfEncrypt to set own document permissions. Implements PoDoFo::PdfDocument.
8.108.3.6
bool PoDoFo::PdfStreamedDocument::IsDocAssemblyAllowed ( const [inline, virtual]
Checks if it is allowed to insert, create, rotate, delete pages or add bookmarks Every PDF consuming applications has to adhere this value! Returns true if you are allowed to insert, create, rotate, delete pages or add bookmarks See also PdfEncrypt to set own document permissions. Implements PoDoFo::PdfDocument.
8.108 PoDoFo::PdfStreamedDocument Class Reference 8.108.3.7 bool PoDoFo::PdfStreamedDocument::IsEditAllowed ( [inline, virtual] ) const
413
Checks if modiying this document (besides annotations, form elds or changing pages) is allowed. Every PDF consuming applications has to adhere this value! Returns true if you are allowed to mody this document See also PdfEncrypt to set own document permissions. Implements PoDoFo::PdfDocument.
8.108.3.8
bool PoDoFo::PdfStreamedDocument::IsEditNotesAllowed ( [inline, virtual]
) const
Checks if it is allowed to add or modify annotations or form elds Every PDF consuming applications has to adhere this value! Returns true if you are allowed to add or modify annotations or form elds See also PdfEncrypt to set own document permissions. Implements PoDoFo::PdfDocument.
8.108.3.9
bool PoDoFo::PdfStreamedDocument::IsFillAndSignAllowed ( const [inline, virtual]
Checks if it is allowed to ll in existing form or signature elds Every PDF consuming applications has to adhere this value! Returns true if you are allowed to ll in existing form or signature elds See also PdfEncrypt to set own document permissions. Implements PoDoFo::PdfDocument.
414 8.108.3.10
Class Documentation bool PoDoFo::PdfStreamedDocument::IsHighPrintAllowed ( const [inline, virtual] )
Checks if it is allowed to print a high quality version of this document Every PDF consuming applications has to adhere this value! Returns true if you are allowed to print a high quality version of this document See also PdfEncrypt to set own document permissions. Implements PoDoFo::PdfDocument. 8.108.3.11 bool PoDoFo::PdfStreamedDocument::IsLinearized ( [inline, virtual] ) const
Returns wether this PDF document is linearized, aka weboptimized Returns true if the PDF document is linearized Implements PoDoFo::PdfDocument. 8.108.3.12 bool PoDoFo::PdfStreamedDocument::IsPrintAllowed ( [inline, virtual] ) const
Checks if printing this document is allowed. Every PDF consuming applications has to adhere this value! Returns true if you are allowed to print this document See also PdfEncrypt to set own document permissions. Implements PoDoFo::PdfDocument.
8.109
PoDoFo::PdfString Class Reference
#include <PdfString.h> Inheritance diagram for PoDoFo::PdfString:

8.109 PoDoFo::PdfString Class Reference
415
PoDoFo::PdfDataType PoDoFo::PdfString

PdfString () PdfString (const std::string &sString, const PdfEncoding const pEncoding=NULL) PdfString (const char pszString, const PdfEncoding const pEncoding=NULL) PdfString (const wchar_t pszString) PdfString (const char pszString, pdf_long lLen, bool bHex=false, const PdfEncoding const pEncoding=NULL) PdfString (const pdf_utf8 pszStringUtf8) PdfString (const pdf_utf16be pszStringUtf16) PdfString (const pdf_utf8 pszStringUtf8, pdf_long lLen) PdfString (const pdf_utf16be pszStringUtf16, pdf_long lLen) PdfString (const PdfString &rhs) void SetHexData (const char pszHex, pdf_long lLen=-1, PdfEncrypt pEncrypt=NULL) bool IsValid () const bool IsHex () const bool IsUnicode () const const char GetString () const const pdf_utf16be GetUnicode () const const std::string & GetStringUtf8 () const pdf_long GetLength () const pdf_long GetUnicodeLength () const pdf_long GetCharacterLength () const void Write (PdfOutputDevice pDevice, EPdfWriteMode eWriteMode, const PdfEncrypt pEncrypt=NULL) const const PdfString & operator= (const PdfString &rhs) bool operator> (const PdfString &rhs) const bool operator< (const PdfString &rhs) const bool operator== (const PdfString &rhs) const bool operator!= (const PdfString &rhs) const PdfString ToUnicode () const
8.109.1
A string that can be written to a PDF document. If it contains binary data it is automatically converted into a hex string, otherwise a normal PDF string is written to the document.
416
Class Documentation
PdfStrings representing text are either in PDFDocEncoding (ISO Latin1) encoded or UTF-16BE encoded. PoDoFo contains methods to convert between these encodings. For convinience conversion to UTF-8 is possible to. Please not that strings are always stored as UTF-16BE or ISO Latin1 (PdfDocEncoding) in the PDF le. UTF-16BE strings have to start with the byts 0xFE 0xFF to be recognized by PoDoFo as unicode strings. PdfStrings is an implicitly shared class. As a reason it is very fast to copy PdfString objects. The internal string buffer is guaranteed to be always terminated by 2 zeros.
8.109.2
8.109.2.1

PoDoFo::PdfString::PdfString ( )
Create an empty and invalid string 8.109.2.2 PoDoFo::PdfString::PdfString ( const std::string & sString, const PdfEncoding const pEncoding = NULL )
Construct a new PdfString from a std::string. The input string will be copied. If the rst to bytes of the string are 0xFE and 0xFF this string is treated as UTF-16BE encoded unicode string. Parameters sString the string to copy pEncoding the encoding of this string, if it is no unicode string. This is ignored for unicode strings. If NULL PdfDocEncoding will be used as a default.
8.109.2.3
PoDoFo::PdfString::PdfString ( const char pszString, const PdfEncoding const pEncoding = NULL )
Construct a new PdfString from a 0 terminated string. The input string will be copied. Parameters pszString the string to copy pEncoding the encoding of this string, if it is no unicode string. This is ignored for unicode strings. If NULL PdfDocEncoding will be used as a default.
8.109.2.4
PoDoFo::PdfString::PdfString ( const wchar_t pszString )
Construct a new PdfString from a 0 terminated string. The input string will be copied.
8.109 PoDoFo::PdfString Class Reference Parameters pszString the string to copy
417
8.109.2.5
PoDoFo::PdfString::PdfString ( const char pszString, pdf_long lLen, bool bHex = false, const PdfEncoding const pEncoding = NULL )
Construct a new PdfString from a string. The input string will be copied. If the rst to bytes of the string are 0xFE and 0xFF this string is treated as UTF-16BE encoded unicode string. Parameters pszString the string to copy lLen length of the string data to encode bHex if true the data will be hex encoded during writeout of the string and IsHex() will return true. pEncoding the encoding of this string, if it is no unicode string. This is ignored for unicode strings. If NULL PdfDocEncoding will be used as a default.
8.109.2.6
PoDoFo::PdfString::PdfString ( const pdf_utf8 pszStringUtf8 )
Construct a new PdfString from an UTF-8 encoded string. The string is converted to UTF-16BE internally. Parameters pszStringUtf8 a UTF-8 encoded string.
8.109.2.7
PoDoFo::PdfString::PdfString ( const pdf_utf16be pszStringUtf16 )
Construct a new PdfString from an UTF-16be encoded zero terminated string. Parameters pszStringUtf16 a UTF-16BE encoded string.
8.109.2.8
PoDoFo::PdfString::PdfString ( const pdf_utf8 pszStringUtf8, pdf_long lLen )
Construct a new PdfString from an UTF-8 encoded string. The string is converted to UTF-16BE internally.
418 Parameters pszStringUtf8 a UTF-8 encoded string. lLen number of bytes to convert
Class Documentation
8.109.2.9
PoDoFo::PdfString::PdfString ( const pdf_utf16be pszStringUtf16, pdf_long lLen )
Construct a new PdfString from an UTF-16be encoded zero terminated string. Parameters pszStringUtf16 a UTF-16BE encoded string. lLen number of words to convert
8.109.2.10
PoDoFo::PdfString::PdfString ( const PdfString & rhs )
Copy an existing PdfString Parameters rhs another PdfString to copy
8.109.3
8.109.3.1

pdf_long PoDoFo::PdfString::GetCharacterLength ( [inline] ) const
Get the number of characters in the string. This function returns the correct number of characters in the string for unicode and ansi strings. Always use this method if you want to know the number of characters in the string as GetLength() will returns the number of bytes used for unicode strings! Returns the number of characters in the string
8.109.3.2
pdf_long PoDoFo::PdfString::GetLength (
) const [inline]
The length of the string data returned by GetString() in bytes not including terminating zeros. Returns the length of the string. See also GetCharacterLength to determine the number of characters in the string
8.109 PoDoFo::PdfString Class Reference 8.109.3.3 const char PoDoFo::PdfString::GetString (
419 ) const [inline]
The contents of the strings can be read by this function. The returned data is never hex encoded may contain 0 bytes. if IsUnicode() returns true, the return value points to a UTF-16BE string buffer with Length() characters. Better use GetUnicode() in this case. Returns the strings contents which is guaranteed to be zero terminated but might also contain 0 bytes in the string. See also IsHex IsUnicode Length
8.109.3.4
const std::string & PoDoFo::PdfString::GetStringUtf8 ( [inline]
) const
The contents of the string as UTF8 string. The strings contents are always returned as UTF8 by this function. Works for unicode strings and for non unicode strings. This is the prefered way to access the strings contents. Returns the string contents always as UTF8.
8.109.3.5
const pdf_utf16be PoDoFo::PdfString::GetUnicode ( [inline]
) const
The contents of the strings can be read by this function. The returned data is never hex encoded any maycontain 0 bytes. if IsUnicode() returns true, the return value points to a UTF-16BE string buffer with Length() characters. Better use GetUnicode() in this case. Returns the strings contents which is guaranteed to be zero terminated but might also contain 0 bytes in the string. See also IsHex IsUnicode Length
420 8.109.3.6
Class Documentation pdf_long PoDoFo::PdfString::GetUnicodeLength ( [inline] ) const
The length of the string data returned by GetUnicode() in characters not including the terminating zero Returns the length of the string. See also GetCharacterLength to determine the number of characters in the string
8.109.3.7
bool PoDoFo::PdfString::IsHex (
) const [inline]
Check if this is a hex string. If true the data will be hex encoded when the string is written to a PDF le. Returns true if this is a hex string. See also GetString() will return the raw string contents (not hex encoded)
8.109.3.8
bool PoDoFo::PdfString::IsUnicode (
) const [inline]
PdfStrings are either Latin1 encoded or UTF-16BE encoded unicode strings. This functions returns true if this is a unicode string object. Returns true if this is a unicode string.
8.109.3.9
bool PoDoFo::PdfString::IsValid (
) const [inline]
The string is valid if no error in the constructor has occurred. If it is valid it is safe to call all the other member functions. Returns true if this is a valid initialized PdfString
8.109 PoDoFo::PdfString Class Reference 8.109.3.10 bool PoDoFo::PdfString::operator!= ( const PdfString & rhs ) const [inline]
421
Comparison operator Parameters rhs compare to this string object Returns true if strings have different contents
8.109.3.11
bool PoDoFo::PdfString::operator< ( const PdfString & rhs ) const
Compare two PdfString objects Parameters rhs another PdfString to compare Returns this object
8.109.3.12
const PdfString & PoDoFo::PdfString::operator= ( const PdfString & rhs )
Copy an existing PdfString Parameters rhs another PdfString to copy Returns this object
8.109.3.13
bool PoDoFo::PdfString::operator== ( const PdfString & rhs ) const
Comparison operator UTF-8 and UTF-16BE encoded strings of the same data compare equal. Whether the string will be written out as hex is not considered - only the real "text" is tested for equality. Parameters rhs compare to this string object
422 Returns true if both strings have the same contents
Class Documentation
8.109.3.14
bool PoDoFo::PdfString::operator> ( const PdfString & rhs ) const
Compare two PdfString objects Parameters rhs another PdfString to compare Returns this object
8.109.3.15
void PoDoFo::PdfString::SetHexData ( const char pszHex, pdf_long lLen = -1, PdfEncrypt pEncrypt = NULL )
Set hex encoded data as the strings data. Parameters pszHex must be hex encoded data. lLen length of the hex encoded data. if lLen == -1 then strlen( pszHex ) will be used as length of the hex data. pszHex has to be zero terminated in this case. pEncrypt if !NULL assume the hex data is encrypted and should be decrypted after hexdecoding
8.109.3.16
PdfString PoDoFo::PdfString::ToUnicode (
) const
Converts this string to a hex encoded string. If IsHex returns true, a copy of this string is returned otherwise the strings data is hex encoded and returned. Returns a hex encoded version of this string or this string if it is already hex ecoded. See also IsHex Converts this string to a ascii string (not hex encoded) If IsHex returns false, a copy of this string is returned otherwise the strings data is hex decoded and returned.
8.110 PoDoFo::PdfSymbolEncoding Class Reference Returns
423
a plain version of this string which is not hex encoded or this string if it is already a plain not hex encoded string. See also IsHex Converts this string to a unicode string If IsUnicode() returns true a copy of this string is returned otherwise the string data is converted to UTF-16be and returned. Returns a unicode version of this string
8.109.3.17
void PoDoFo::PdfString::Write ( PdfOutputDevice pDevice, EPdfWriteMode eWriteMode, const PdfEncrypt pEncrypt = NULL ) const [virtual]
Write this PdfString in PDF format to a PdfOutputDevice Parameters pDevice the output device. eWriteMode additional options for writing this object pEncrypt an encryption object which is used to encrypt this object or NULL to not encrypt this object Implements PoDoFo::PdfDataType.
8.110
PoDoFo::PdfSymbolEncoding Class Reference
#include <PdfEncoding.h> Inheritance diagram for PoDoFo::PdfSymbolEncoding:
PoDoFo::PdfEncoding PoDoFo::PdfSimpleEncoding PoDoFo::PdfSymbolEncoding

PdfSymbolEncoding ()
424
Class Documentation

8.110.1
Do not allocate this class yourself, as allocations might be expensive. Try using PdfFont::SymbolEncoding. See also PdfFont::SymbolEncoding
8.110.2
8.110.2.1

PoDoFo::PdfSymbolEncoding::PdfSymbolEncoding ( ) [inline]
Create a new PdfSymbolEncoding
8.110.3
8.110.3.1

const pdf_utf16be PoDoFo::PdfSymbolEncoding::GetToUnicodeTable ( const [protected, virtual] )
8.111
PoDoFo::PdfTable Class Reference
#include <PdfTable.h>
Public Types
typedef PdfPage ( CreatePageCallback )(PdfRect &rClipRect, pCustom) void
8.111 PoDoFo::PdfTable Class Reference
425

PdfTable (int nCols, int nRows) virtual void Draw (double dX, double dY, PdfPainter pPainter, const PdfRect &rClipRect=PdfRect(), double pdLastX=NULL, double pdLastY=NULL) virtual double GetWidth (double dX, double dY, PdfCanvas pPage) const virtual double GetHeight (double dX, double dY, PdfCanvas pPage) const void SetModel (PdfTableModel pModel) const PdfTableModel GetModel () const void SetColumnWidths (double pdWidths) void SetRowHeights (double pdHeights) void SetColumnWidth (double dWidth) void SetRowHeight (double dHeight) void SetTableWidth (double dWidth) void SetTableHeight (double dHeight) void SetAutoPageBreak (bool bPageBreak, CreatePageCallback callback, void pCustomData=NULL) bool GetAutoPageBreak () const int GetCols () const int GetRows () const

void CalculateTableSize (const double dX, const double dY, const PdfCanvas pCanvas, double pdWidths, double pdHeights, double pdWidth, double pdHeight) const void DrawHorizontalBorders (int nRow, double dX, double dY, PdfPainter pPainter, double pdColWidths) bool CheckForNewPage (double pdY, double pdCurY, double dRowHeight, PdfPainter pPainter)
8.111.1
This is a high level class of a table which can be drawn to a PdfPainter. Use this class if you have to include data into your PDF as an table.
8.111.2
8.111.2.1
Member Typedef Documentation

typedef PdfPage( PoDoFo::PdfTable::CreatePageCallback)(PdfRect &rClipRect, void pCustom)
Callback to create a new page for PdfTable. See also SetAutoPageBreak

426 Parameters
Class Documentation
rClipRect this is an output parameter which has to be set to the clipping rectangle of the new page. If the new page has no clipping rectangle set it to PdfRect( 0, 0, PdfPage::GetPageSize().GetWidth(), PdfPage::GetPageSize().GetHeight() ) pCustom pointer to user dened data
8.111.3
8.111.3.1

PoDoFo::PdfTable::PdfTable ( int nCols, int nRows )
Create a new PdfTable object. Parameters nCols number of columns in the table. nRows number of rows in the table.
8.111.4
8.111.4.1

void PoDoFo::PdfTable::CalculateTableSize ( const double dX, const double dY, const PdfCanvas pCanvas, double pdWidths, double pdHeights, double pdWidth, double pdHeight ) const [protected]
Internal functions that calculates the total table size for a table with the current settings when drawn on a certain page. Parameters dX the X coordinate of top left at which is drawn dY the Y coordinate of top left at which is drawn pCanvas the canvas object (usually a page) on which the table will be drawn. pdWidths pointer to an array with GetCols() doubles where the width for each column will be stored pdHeights pointer to an array with GetRows() doublesd where the height for each row will be stored pdWidth pointer to a double where the total width of the table will be stored pdHeight pointer to a double where the total height of the table will be stored
8.111.4.2
bool PoDoFo::PdfTable::CheckForNewPage ( double pdY, double pdCurY, double dRowHeight, PdfPainter pPainter ) [protected]
Checks if there is enough space on the current page for one row! If necessary a new page is created.
8.111 PoDoFo::PdfTable Class Reference If GetAutoPageBreak is false, this method does nothing. Parameters pdY top of the table
427
pdCurY pointer to the current y position on the page. Might be reset to a new y position. dRowHeight height of the next row. pPainter painter used for drawing Returns true if a new page was created, otherwise false
8.111.4.3
void PoDoFo::PdfTable::Draw ( double dX, double dY, PdfPainter pPainter, const PdfRect & rClipRect = PdfRect(), double pdLastX = NULL, double pdLastY = NULL ) [virtual]
Draw the table with its current settings on a PdfPainter. Parameters dX x coordinate of top left of the table dY y coordinate of top left of the table pPainter the painter to draw on. The painter has to have a page set currently. rClipRect the clipping rectangle on the current page pdLastX the last used X position by the table on the current page will be written to this value (usually bottom right) pdLastY the last used Y positon by the table on the current page will be written to this value (usually bottom right)
8.111.4.4
void PoDoFo::PdfTable::DrawHorizontalBorders ( int nRow, double dX, double dY, PdfPainter pPainter, double pdColWidths ) [protected]
Draw one row of horizontal cell borders using the correct color for each cell. Parameters nRow the current row dX left x coordinate dY y coordinate pPainter use this painter object pdColWidths an array containing all colomun widths
428 8.111.4.5 Returns bool PoDoFo::PdfTable::GetAutoPageBreak (
true if a new page is created automatically if more space is required to draw the table. See also SetAutoPageBreak
8.111.4.6 Returns
int PoDoFo::PdfTable::GetCols (
) const [inline]
the number of columns in the table.
8.111.4.7
double PoDoFo::PdfTable::GetHeight ( double dX, double dY, PdfCanvas pPage ) const [virtual]
Get the width of the table when drawn with the current settings at a certain position. Parameters dX x coordinate of top left of the table dY y coordinate of top left of the table pPage the page on which the table will be drawn Returns the width of the table
8.111.4.8
const PdfTableModel PoDoFo::PdfTable::GetModel ( [inline]
) const
Get the current PdfTableModel Returns the currently set PdfTableModel or NULL if none was set
8.111.4.9 Returns
int PoDoFo::PdfTable::GetRows (
) const [inline]
the number of rows in the table.
8.111 PoDoFo::PdfTable Class Reference 8.111.4.10 double PoDoFo::PdfTable::GetWidth ( double dX, double dY, PdfCanvas pPage ) const [virtual]
429
Get the width of the table when drawn with the current settings at a certain position. Parameters dX x coordinate of top left of the table dY y coordinate of top left of the table pPage the page on which the table will be drawn Returns the width of the table
8.111.4.11
void PoDoFo::PdfTable::SetAutoPageBreak ( bool bPageBreak, CreatePageCallback callback, void pCustomData = NULL ) [inline]
Automatically create a new page and continue drawing the table on the new page, if there is not enough space on the current page. The newly created page will be set as the current page on the painter used to draw and will be created using the same size as the old page. Parameters bPageBreak if true automatically create new pages if required. callback a callback function that is called to create a new page. Please note: PdfTable cannot create new pages on its own. You always have to implement a callback which does the new page creation for the PdfTable. pCustomData custom data that is passed to the callback By default this feature is turned off and contents are clipped that do not t on the current page. See also GetAutoPageBreak
8.111.4.12
void PoDoFo::PdfTable::SetColumnWidth ( double dWidth ) [inline]
Set all columns to have the same width. Parameters dWidth the width of every column By default the column with is calculated automatically from either the table width or if no table width is set from the width of the page on which the table is drawn.
430 8.111.4.13
Class Documentation void PoDoFo::PdfTable::SetColumnWidths ( double pdWidths )
Set the width of all columns. Parameters pdWidths a pointer to an array of GetCols() doubles which are the individual width of a column. See also GetCols()
8.111.4.14
void PoDoFo::PdfTable::SetModel ( PdfTableModel pModel ) [inline]
Set the PdfTableModel that will supply all contents and formatting informations to the table. Parameters pModel a PdfTableModel The model will not be owned by the PdfTable and has to be deleted by the caller. See also GetModel
8.111.4.15
void PoDoFo::PdfTable::SetRowHeight ( double dHeight ) [inline]
Set all rows to have the same height. Parameters dHeight the height of every row By default the row height is calculated automatically from either the table height or if no table height is set from the height of the page on which the table is drawn. 8.111.4.16 void PoDoFo::PdfTable::SetRowHeights ( double pdHeights )
Set the height of all rows. Parameters pdHeights a pointer to an array of GetRows() doubles which are the individual heights of a row.
8.112 PoDoFo::PdfTableModel Class Reference See also GetRows()
431
8.111.4.17
void PoDoFo::PdfTable::SetTableHeight ( double dHeight ) [inline]
Set the height of the table. Parameters dHeight the height of the whole table. This height is used if no row height is set to calculate the height of every row. If this height is not set, the height of the page on which this table is drawn is used. 8.111.4.18 void PoDoFo::PdfTable::SetTableWidth ( double dWidth ) [inline]
Set the width of the table. Parameters dWidth the width of the whole table. This width is used if no column width is set to calculate the width of every column. If this width is not set, the width of the page on which this table is drawn is used.
8.112
PoDoFo::PdfTableModel Class Reference
#include <PdfTable.h> Inheritance diagram for PoDoFo::PdfTableModel:

PoDoFo::PdfTableModel PoDoFo::PdfSimpleTableModel

virtual PdfString GetText (int col, int row) const =0 virtual EPdfAlignment GetAlignment (int col, int row) const =0 virtual EPdfVerticalAlignment GetVerticalAlignment (int col, int row) const =0 virtual PdfFont GetFont (int col, int row) const =0
432
Class Documentation virtual bool HasBackgroundColor (int col, int row) const =0 virtual PdfColor GetBackgroundColor (int col, int row) const =0 virtual PdfColor GetForegroundColor (int col, int row) const =0 virtual bool HasWordWrap (int col, int row) const =0 virtual bool HasBorders () const =0 virtual double GetBorderWidth () const =0 virtual PdfColor GetBorderColor (int col, int row) const =0 virtual bool HasImage (int col, int row) const =0 virtual PdfImage GetImage (int col, int row) const =0
8.112.1
This is an abstract interface of a model that can provide data and formatting informations to a PdfTable. You can implement your own PdfTableModel to supply data to a PdfTable. PdfSimpleTableModel is an example of a simple model. See also PdfTable PdfSimpleTableModel
8.112.2
8.112.2.1

virtual EPdfAlignment PoDoFo::PdfTableModel::GetAlignment ( int col, int row ) const [pure virtual]
Parameters col the column of the table cell row the row of the table cell Returns the horizontal alignment of the contents in the cell Implemented in PoDoFo::PdfSimpleTableModel. 8.112.2.2 virtual PdfColor PoDoFo::PdfTableModel::GetBackgroundColor ( int col, int row ) const [pure virtual]
Parameters col the column of the table cell row the row of the table cell Returns the background color of the specied cell Implemented in PoDoFo::PdfSimpleTableModel.
8.112 PoDoFo::PdfTableModel Class Reference 8.112.2.3 virtual PdfColor PoDoFo::PdfTableModel::GetBorderColor ( int col, int row ) const [pure virtual]
433
Parameters col the column of the table cell row the row of the table cell Returns the border color Implemented in PoDoFo::PdfSimpleTableModel. 8.112.2.4 Returns the stroke witdth of the border line Implemented in PoDoFo::PdfSimpleTableModel. 8.112.2.5 virtual PdfFont PoDoFo::PdfTableModel::GetFont ( int col, int row ) const [pure virtual] virtual double PoDoFo::PdfTableModel::GetBorderWidth ( [pure virtual] ) const
Parameters col the column of the table cell row the row of the table cell Returns the font of this table cell or NULL to use the default font Implemented in PoDoFo::PdfSimpleTableModel. 8.112.2.6 virtual PdfColor PoDoFo::PdfTableModel::GetForegroundColor ( int col, int row ) const [pure virtual]
Parameters col the column of the table cell row the row of the table cell Returns the foreground (text) color of the specied cell Implemented in PoDoFo::PdfSimpleTableModel.
434 8.112.2.7
Class Documentation virtual PdfImage PoDoFo::PdfTableModel::GetImage ( int col, int row ) const [pure virtual]
Parameters col the column of the table cell row the row of the table cell Returns the image for the specied cell or NULL if the cell has no image Implemented in PoDoFo::PdfSimpleTableModel. 8.112.2.8 virtual PdfString PoDoFo::PdfTableModel::GetText ( int col, int row ) const [pure virtual]
Parameters col the column of the table cell row the row of the table cell Returns the contents string of this table cell Implemented in PoDoFo::PdfSimpleTableModel. 8.112.2.9 virtual EPdfVerticalAlignment PoDoFo::PdfTableModel::GetVerticalAlignment ( int col, int row ) const [pure virtual]
Parameters col the column of the table cell row the row of the table cell Returns the vertical alignment of the contents in the cell Implemented in PoDoFo::PdfSimpleTableModel. 8.112.2.10 virtual bool PoDoFo::PdfTableModel::HasBackgroundColor ( int col, int row ) const [pure virtual]
Parameters col the column of the table cell row the row of the table cell
8.113 PoDoFo::PdfTextField Class Reference Returns true if this cell has a background color Implemented in PoDoFo::PdfSimpleTableModel. 8.112.2.11 Returns true if the table should have a border around all cells. false if no cell border should be visible Cell borders are always drawn using the current PdfPainter settings. Implemented in PoDoFo::PdfSimpleTableModel. 8.112.2.12 virtual bool PoDoFo::PdfTableModel::HasBorders ( [pure virtual] ) const
435
virtual bool PoDoFo::PdfTableModel::HasImage ( int col, int row ) const [pure virtual]
Parameters col the column of the table cell row the row of the table cell Returns true if the table cell contains an image Implemented in PoDoFo::PdfSimpleTableModel. 8.112.2.13 virtual bool PoDoFo::PdfTableModel::HasWordWrap ( int col, int row ) const [pure virtual]
Parameters col the column of the table cell row the row of the table cell Returns true if the specied cell should use wordwrapping Implemented in PoDoFo::PdfSimpleTableModel.
8.113
PoDoFo::PdfTextField Class Reference
#include <PdfField.h> Inherits PoDoFo::PdfField.

436
Class Documentation

PdfTextField (PdfAnnotation pWidget, PdfAcroForm pParent) PdfTextField (PdfPage pPage, const PdfRect &rRect, PdfAcroForm pParent) PdfTextField (PdfPage pPage, const PdfRect &rRect, PdfDocument pDoc) PdfTextField (PdfPage pPage, const PdfRect &rRect, PdfStreamedDocument pDoc) PdfTextField (const PdfField &rhs) void SetText (const PdfString &rsText) PdfString GetText () const void SetMaxLen (pdf_long nMaxLen) pdf_long GetMaxLen () const void SetMultiLine (bool bMultiLine) bool IsMultiLine () const void SetPasswordField (bool bPassword) bool IsPasswordField () const void SetFileField (bool bFile) bool IsFileField () const void SetSpellcheckingEnabled (bool bSpellcheck) bool IsSpellcheckingEnabled () const void SetScrollBarsEnabled (bool bScroll) bool IsScrollBarsEnabled () const void SetCombs (bool bCombs) bool IsCombs () const void SetRichText (bool bRichText) bool IsRichText () const
8.113.1
A texteld in a PDF le. Users can enter text into a text eld. Single and multi line text is possible, as well as richtext. The text can be interpreted as path to a le which is going to be submitted.
8.113.2
8.113.2.1

PoDoFo::PdfTextField::PdfTextField ( PdfAnnotation pWidget, PdfAcroForm pParent )
Create a new PdfTextField 8.113.2.2 PoDoFo::PdfTextField::PdfTextField ( PdfPage pPage, const PdfRect & rRect, PdfAcroForm pParent )

8.113 PoDoFo::PdfTextField Class Reference 8.113.2.3 PoDoFo::PdfTextField::PdfTextField ( PdfPage pPage, const PdfRect & rRect, PdfDocument pDoc )
437
Create a new PdfTextField 8.113.2.4 PoDoFo::PdfTextField::PdfTextField ( PdfPage pPage, const PdfRect & rRect, PdfStreamedDocument pDoc )
Create a new PdfTextField 8.113.2.5 PoDoFo::PdfTextField::PdfTextField ( const PdfField & rhs )
Create a PdfTextField from a PdfField Parameters rhs a PdfField that is a PdfTextField Raises an error if PdfField::GetType() != ePdfField_TextField
8.113.3
8.113.3.1 Returns

pdf_long PoDoFo::PdfTextField::GetMaxLen ( ) const
the max length of this texteld in characters or -1 if no max length was specied
8.113.3.2 Returns
PdfString PoDoFo::PdfTextField::GetText (
) const
the text contents of this text eld
8.113.3.3 Returns
bool PoDoFo::PdfTextField::IsCombs (
) const [inline]
true if the text eld is divided in to equal combs
8.113.3.4 Returns
bool PoDoFo::PdfTextField::IsFileField (
) const [inline]
true if the contents are treated as lename
438 8.113.3.5 Returns true if this text eld can contain multiple lines of text bool PoDoFo::PdfTextField::IsMultiLine (
8.113.3.6 Returns
bool PoDoFo::PdfTextField::IsPasswordField (
) const [inline]
true if this eld is a password eld that does not echo entered characters on the screen
8.113.3.7 Returns
bool PoDoFo::PdfTextField::IsRichText (
) const [inline]
true if this is a richtext text eld
8.113.3.8 Returns
bool PoDoFo::PdfTextField::IsScrollBarsEnabled ( [inline]
) const
true if scrollbars are enabled for this text eld
8.113.3.9 Returns
bool PoDoFo::PdfTextField::IsSpellcheckingEnabled ( [inline]
) const
true if spellchecking is enabled for this text eld
8.113.3.10
void PoDoFo::PdfTextField::SetCombs ( bool bCombs ) [inline]
Divide the text eld into max-len equal combs. Parameters bCombs if true enable division into combs By default coms are disabled. Requires the max len property to be set. See also SetMaxLen
8.113 PoDoFo::PdfTextField Class Reference 8.113.3.11 void PoDoFo::PdfTextField::SetFileField ( bool bFile ) [inline]
439
Create a le selection eld. The entered contents are treated as lename to a le whose contents are submitted as the value of the eld. Parameters bFile if true the contents are treated as a pathname to a le to submit
8.113.3.12
void PoDoFo::PdfTextField::SetMaxLen ( pdf_long nMaxLen )
Sets the max length in characters of this texteld Parameters nMaxLen the max length of this textelds in characters
8.113.3.13
void PoDoFo::PdfTextField::SetMultiLine ( bool bMultiLine ) [inline]
Create a multi-line text eld that can contains multiple lines of text. Parameters bMultiLine if true a multi line eld is generated, otherwise the text eld can contain only a single line of text. The default is to create a single line text eld. 8.113.3.14 void PoDoFo::PdfTextField::SetPasswordField ( bool bPassword ) [inline]
Create a password text eld that should not echo entered characters visibly to the screen. Parameters bPassword if true a password eld is created The default is to create no password eld 8.113.3.15 void PoDoFo::PdfTextField::SetRichText ( bool bRichText ) [inline]
Creates a richtext eld.

440 Parameters bRichText if true creates a richtext eld By default richtext is disabled. 8.113.3.16
Class Documentation
void PoDoFo::PdfTextField::SetScrollBarsEnabled ( bool bScroll ) [inline]
Enable/disable scrollbars for this text eld Parameters bScroll if true scrollbars will be enabled Text elds have scrollbars by default 8.113.3.17 void PoDoFo::PdfTextField::SetSpellcheckingEnabled ( bool bSpellcheck ) [inline]
Enable/disable spellchecking for this text eld Parameters bSpellcheck if true spellchecking will be enabled Text elds are spellchecked by default 8.113.3.18 void PoDoFo::PdfTextField::SetText ( const PdfString & rsText )
Sets the text contents of this text eld. Parameters rsText the text of this eld
8.114
PoDoFo::PdfTokenizer Class Reference
#include <PdfTokenizer.h> Inheritance diagram for PoDoFo::PdfTokenizer:

PoDoFo::PdfTokenizer PoDoFo::PdfContentsTokenizer PoDoFo::PdfParser PoDoFo::PdfParserObject PoDoFo::PdfXRefStreamParserObject
8.114 PoDoFo::PdfTokenizer Class Reference
441

virtual bool GetNextToken (const char &pszToken, EPdfTokenType peType=NULL) bool IsNextToken (const char pszToken) pdf_long GetNextNumber () void GetNextVariant (PdfVariant &rVariant, PdfEncrypt pEncrypt)

static PODOFO_NOTHROW bool IsWhitespace (const unsigned char ch) static PODOFO_NOTHROW bool IsDelimiter (const unsigned char ch) static PODOFO_NOTHROW bool IsRegular (const unsigned char ch) static PODOFO_NOTHROW bool IsPrintable (const unsigned char ch) static PODOFO_NOTHROW int GetHexValue (const unsigned char ch)
Static Public Attributes

static const unsigned int HEX_NOT_FOUND = std::numeric_limits<unsigned int>::max()

void GetNextVariant (const char pszToken, EPdfTokenType eType, PdfVariant &rVariant, PdfEncrypt pEncrypt) EPdfDataType DetermineDataType (const char pszToken, EPdfTokenType eType, PdfVariant &rVariant) void ReadDictionary (PdfVariant &rVariant, PdfEncrypt pEncrypt) void ReadArray (PdfVariant &rVariant, PdfEncrypt pEncrypt) void ReadString (PdfVariant &rVariant, PdfEncrypt pEncrypt) void ReadHexString (PdfVariant &rVariant, PdfEncrypt pEncrypt) void ReadName (PdfVariant &rVariant) void QuequeToken (const char pszToken, EPdfTokenType eType)
8.114.1
A simple tokenizer for PDF les and PDF content streams
8.114.2
8.114.2.1

EPdfDataType PoDoFo::PdfTokenizer::DetermineDataType ( const char pszToken, EPdfTokenType eType, PdfVariant & rVariant ) [protected]
Determine the possible datatype of a token. Numbers, reals, bools or NULL values are parsed directly by this function and saved to a variant.
442 Returns the expected datatype
Class Documentation
8.114.2.2
int PoDoFo::PdfTokenizer::GetHexValue ( const unsigned char ch ) [inline, static]
Get the hex value from a static map of a given hex character (0-9, A-F, a-f). Parameters ch hex character Returns hex value or HEX_NOT_FOUND if invalid See also HEX_NOT_FOUND
8.114.2.3
pdf_long PoDoFo::PdfTokenizer::GetNextNumber (
Read the next number from the current le position ignoring all comments. Raises NoNumber exception if the next token is no number, and UnexpectedEOF if no token could be read. No token is consumed if NoNumber is thrown. Returns a number read from the input device.
8.114.2.4
bool PoDoFo::PdfTokenizer::GetNextToken ( const char & pszToken, EPdfTokenType peType = NULL ) [virtual]
Reads the next token from the current le position ignoring all comments. Parameters [out] pszToken On true return, set to a pointer to the read token (a NULLterminated C string). The pointer is to memory owned by PdfTokenizer and must NOT be freed. The contents are invalidated on the next call to GetNextToken(..) and by the destruction of the PdfTokenizer. Undened on false return. [out] peType On true return, if not NULL the type of the read token will be stored into this parameter. Undened on false return. Returns True if a token was read, false if there are no more tokens to read.
8.114 PoDoFo::PdfTokenizer Class Reference See also GetBuffer Reimplemented in PoDoFo::PdfContentsTokenizer. 8.114.2.5 void PoDoFo::PdfTokenizer::GetNextVariant ( PdfVariant & rVariant, PdfEncrypt pEncrypt )
443
Read the next variant from the current le position ignoring all comments. Raises an UnexpectedEOF exception if there is no variant left in the le. Parameters rVariant write the read variant to this value pEncrypt an encryption object which is used to decrypt strings during parsing
8.114.2.6
void PoDoFo::PdfTokenizer::GetNextVariant ( const char pszToken, EPdfTokenType eType, PdfVariant & rVariant, PdfEncrypt pEncrypt ) [protected]
Read the next variant from the current le position ignoring all comments. Raises an exception if there is no variant left in the le. Parameters pszToken a token that has already been read eType type of the passed token rVariant write the read variant to this value pEncrypt an encryption object which is used to decrypt strings during parsing
8.114.2.7
bool PoDoFo::PdfTokenizer::IsDelimiter ( const unsigned char ch ) [inline, static]
Returns true if the given character is a delimiter according to the pdf reference Returns true if it is a delimiter character otherwise false
8.114.2.8
bool PoDoFo::PdfTokenizer::IsNextToken ( const char pszToken )
Reads the next token from the current le position ignoring all comments and compare the passed token to the read token. If there is no next token available, throws UnexpectedEOF.
444 Parameters pszToken a token that is compared to the read token Returns true if the read token equals the passed token.
Class Documentation
8.114.2.9
bool PoDoFo::PdfTokenizer::IsPrintable ( const unsigned char ch ) [inline, static]
True if the passed character is within the generally accepted "printable" ASCII range.
8.114.2.10
bool PoDoFo::PdfTokenizer::IsRegular ( const unsigned char ch ) [inline, static]
True if the passed character is a regular character according to the PDF reference (Section 3.1.1, Character Set); ie it is neither a white-space nor a delimeter character.
8.114.2.11
bool PoDoFo::PdfTokenizer::IsWhitespace ( const unsigned char ch ) [inline, static]
Returns true if the given character is a whitespace according to the pdf reference Returns true if it is a whitespace character otherwise false
8.114.2.12
void PoDoFo::PdfTokenizer::QuequeToken ( const char pszToken, EPdfTokenType eType ) [protected]
Add a token to the queque of tokens. GetNextToken() will return all quequed tokens rst before reading new tokens from the input device. Parameters pszToken string of the token eType type of the token See also GetNextToken
8.114 PoDoFo::PdfTokenizer Class Reference 8.114.2.13
445
void PoDoFo::PdfTokenizer::ReadArray ( PdfVariant & rVariant, PdfEncrypt pEncrypt ) [protected]
Read an array from the input device and store it into a variant. Parameters rVariant store the array into this variable pEncrypt an encryption object which is used to decrypt strings during parsing
8.114.2.14
void PoDoFo::PdfTokenizer::ReadDictionary ( PdfVariant & rVariant, PdfEncrypt pEncrypt ) [protected]
Read a dictionary from the input device and store it into a variant. Parameters rVariant store the dictionary into this variable pEncrypt an encryption object which is used to decrypt strings during parsing
8.114.2.15
void PoDoFo::PdfTokenizer::ReadHexString ( PdfVariant & rVariant, PdfEncrypt pEncrypt ) [protected]
Read a hex string from the input device and store it into a variant. Parameters rVariant store the hex string into this variable pEncrypt an encryption object which is used to decrypt strings during parsing
8.114.2.16
void PoDoFo::PdfTokenizer::ReadName ( PdfVariant & rVariant ) [protected]
Read a name from the input device and store it into a variant. Throws UnexpectedEOF if there is nothing to read. Parameters rVariant store the name into this variable
8.114.2.17
void PoDoFo::PdfTokenizer::ReadString ( PdfVariant & rVariant, PdfEncrypt pEncrypt ) [protected]
Read a string from the input device and store it into a variant.
446 Parameters rVariant store the string into this variable
Class Documentation
pEncrypt an encryption object which is used to decrypt strings during parsing
8.114.3
8.114.3.1

const unsigned int PoDoFo::PdfTokenizer::HEX_NOT_FOUND = std::numeric_limits<unsigned int>::max() [static]
Constant which is returned for invalid hex values.
8.115
PoDoFo::NonPublic::PdfTTFWriter Class Reference
#include <PdfTTFWriter.h>

PdfTTFWriter () void Read (PdfInputDevice pDevice) void Subset () void Write (PdfOutputDevice pDevice)
8.115.1
An internal class which can parse a TrueType font le and write a subset of this TrueType font back to an output device. This class is used internally to do font subsetting. The usual way to use this class is: PdfTTFWriter writer; writer.Read ( [an input device] ); // read the font from a device writer.Subset ( ); // do the subsetting writer.Write ( [an output device] ); // write the font back to a device
8.115.2
8.115.2.1

PoDoFo::NonPublic::PdfTTFWriter::PdfTTFWriter ( )
Create a PdfTTFWriter object. For testing purposes. TODO: Remove The TTF format.
8.116 PoDoFo::PdfType1Encrypt Class Reference Big endian
447
Required tables: cmap character to glyph mapping CHK glyf glyph data CHK head font header CHK hhea horizontal header CHK hmtx horizontal metrics CHK loca index to location CHK maxp maximum prole CHK name naming table CHK post PostScript information OS/2 OS/2 and Windows specic metrics CHK
8.115.3
8.115.3.1

void PoDoFo::NonPublic::PdfTTFWriter::Read ( PdfInputDevice pDevice )
Fills the internal data structures using an existing TrueType font. Parameters pDevice the TTF is read from this device
8.115.3.2
void PoDoFo::NonPublic::PdfTTFWriter::Subset (
Do the actual subsetting of the font data TODO 8.115.3.3 void PoDoFo::NonPublic::PdfTTFWriter::Write ( PdfOutputDevice pDevice )
Write a TTF font from the current internal structures to an output device. Parameters pDevice write the font to this device
8.116
PoDoFo::PdfType1Encrypt Class Reference
#include <PdfFontType1.h> Inherited by PoDoFo::PdfType1EncryptCharstring, oFo::PdfType1EncryptEexec. and PoD-

PdfType1Encrypt () unsigned char Encrypt (unsigned char plain) unsigned char Decrypt (unsigned char cipher)
448
Class Documentation
8.116.1
Helper Class needed for parsing type1-font for subsetting
8.116.2
8.116.2.1

PoDoFo::PdfType1Encrypt::PdfType1Encrypt ( )
Create a new PdfTypeEncrypt object.
8.116.3
8.116.3.1

unsigned char PoDoFo::PdfType1Encrypt::Decrypt ( unsigned char cipher )
Decrypts a character Parameters cipher the cipher to decrypt. Returns decrypted character
8.116.3.2
unsigned char PoDoFo::PdfType1Encrypt::Encrypt ( unsigned char plain )
Encrypts a character Parameters plain the character to encrypt. Returns encrypted cipher
8.117
PoDoFo::PdfVariant Class Reference
#include <PdfVariant.h> Inheritance diagram for PoDoFo::PdfVariant:

8.117 PoDoFo::PdfVariant Class Reference

PoDoFo::PdfVariant PoDoFo::PdfObject PoDoFo::PdfParserObject PoDoFo::PdfXRefStreamParserObject
449

PdfVariant () PdfVariant (bool b) PdfVariant (pdf_int64 l) PdfVariant (double d) PdfVariant (const PdfString &rsString) PdfVariant (const PdfName &rName) PdfVariant (const PdfReference &rRef) PdfVariant (const PdfArray &tList) PdfVariant (const PdfDictionary &rDict) PdfVariant (const PdfData &rData) PdfVariant (const PdfVariant &rhs) bool IsEmpty () const void Clear () EPdfDataType GetDataType () const const char GetDataTypeString () const bool IsBool () const bool IsNumber () const bool IsReal () const bool IsString () const bool IsHexString () const bool IsName () const bool IsArray () const bool IsDictionary () const bool IsRawData () const bool IsNull () const bool IsReference () const void Write (PdfOutputDevice pDevice, EPdfWriteMode eWriteMode, const PdfEncrypt pEncrypt=NULL) const virtual void Write (PdfOutputDevice pDevice, EPdfWriteMode eWriteMode, const PdfEncrypt pEncrypt, const PdfName &keyStop) const void ToString (std::string &rsData, EPdfWriteMode eWriteMode=ePdfWriteMode_Clean) const void SetBool (bool b)
450 bool GetBool () const void SetNumber (long l) pdf_int64 GetNumber () const void SetReal (double d) double GetReal () const const PdfString & GetString () const const PdfName & GetName () const const PdfArray & GetArray () const PdfArray & GetArray () const PdfDictionary & GetDictionary () const PdfDictionary & GetDictionary () const PdfReference & GetReference () const const PdfData & GetRawData () const PdfData & GetRawData () const PdfVariant & operator= (const PdfVariant &rhs) bool operator== (const PdfVariant &rhs) const bool operator!= (const PdfVariant &rhs) const bool IsDirty () const void SetImmutable (bool bImmutable) bool GetImmutable () const
Class Documentation

void AssertMutable () const void SetDirty (bool bDirty) void DelayedLoad () const void EnableDelayedLoading () virtual void DelayedLoadImpl () PODOFO_NOTHROW bool DelayedLoadDone () const const PdfDictionary & GetDictionary_NoDL () const PdfDictionary & GetDictionary_NoDL () const PdfArray & GetArray_NoDL () const PdfArray & GetArray_NoDL ()
8.117.1
A variant data type which supports all data types supported by the PDF standard. The data can be parsed directly from a string or set by one of the members. One can also convert the variant back to a string after setting the values. Warning All methods not marked otherwise may trigger a deferred load. This means that they are unsafe to call while a deferred load is already in progress (as recursion will occurr). TODO: domseichter: Make this class implicitly shared
451
8.117.2
8.117.2.1

PoDoFo::PdfVariant::PdfVariant ( )
Construct an empty variant type IsNull() will return true. 8.117.2.2 PoDoFo::PdfVariant::PdfVariant ( bool b )
Construct a PdfVariant that is a bool. Parameters b the boolean value of this PdfVariant
8.117.2.3
PoDoFo::PdfVariant::PdfVariant ( pdf_int64 l )
Construct a PdfVariant that is a number. Parameters l the value of the number.
8.117.2.4
PoDoFo::PdfVariant::PdfVariant ( double d )
Construct a PdfVariant that is a real number. Parameters d the value of the real number.
8.117.2.5
PoDoFo::PdfVariant::PdfVariant ( const PdfString & rsString )
Construct a PdfVariant that is a string. The argument string will be escaped where necessary, so it should be passed in unescaped form. Parameters rsString the value of the string
8.117.2.6
PoDoFo::PdfVariant::PdfVariant ( const PdfName & rName )
Construct a PdfVariant that is a name. Parameters rName the value of the name
452 8.117.2.7
Class Documentation PoDoFo::PdfVariant::PdfVariant ( const PdfReference & rRef )
Construct a PdfVariant that is a name. Parameters rRef the value of the name
8.117.2.8
PoDoFo::PdfVariant::PdfVariant ( const PdfArray & tList )
Initalize a PdfVariant object with array data. The variant will automatically get the datatype ePdfDataType_Array. This Init call is the fastest way to create a new PdfVariant that is an array. Parameters tList a list of variants Returns ErrOk on sucess
8.117.2.9
PoDoFo::PdfVariant::PdfVariant ( const PdfDictionary & rDict )
Construct a PdfVariant that is a dictionary. Parameters rDict the value of the dictionary.
8.117.2.10
PoDoFo::PdfVariant::PdfVariant ( const PdfData & rData )
Construct a PdfVariant that contains raw PDF data. Parameters rData raw and valid PDF data.
8.117.2.11
PoDoFo::PdfVariant::PdfVariant ( const PdfVariant & rhs )
Constructs a new PdfVariant which has the same contents as rhs. Parameters rhs an existing variant which is copied.
453
8.117.3
8.117.3.1

void PoDoFo::PdfVariant::AssertMutable ( protected] ) const [inline,
Will throw an exception if called on an immutable object, so this should be called before actually changing a value!
8.117.3.2
void PoDoFo::PdfVariant::Clear (
Clear all internal member variables and free the memory they have allocated. Sets the datatype to ePdfDataType_Null This will reset the dirty ag of this object to be clean. See also IsDirty
8.117.3.3
void PoDoFo::PdfVariant::DelayedLoad ( protected]
) const [inline,
Dynamically load the contents of this object from a PDF le by calling the virtual method DelayedLoadImpl() if the object is not already loaded. For objects complete created in memory and those that do not support deferred loading this function does nothing, since deferred loading will not be enabled.
8.117.3.4
bool PoDoFo::PdfVariant::DelayedLoadDone ( protected]
) const [inline,
Returns true if delayed loading is disabled, or if it is enabled and loading has completed. External callers should never need to see this, its an internal state ag only.
8.117.3.5
void PoDoFo::PdfVariant::DelayedLoadImpl ( protected, virtual]
) [inline,
Load all data of the object if delayed loading is enabled. Never call this method directly; use DelayedLoad() instead. You should override this to control deferred loading in your subclass. Note that this method should not load any associated streams, just the base object. The default implementation throws. It should never be called, since objects that do not support delayed loading should not enable it. While this method is not const it may be called from a const context, so be careful what you mess with.
454 8.117.3.6
Class Documentation void PoDoFo::PdfVariant::EnableDelayedLoading ( protected] ) [inline,
Flag the object incompletely loaded. DelayedLoad() will be called when any method that requires more information than is currently available is loaded. All constructors initialize a PdfVariant with delayed loading disabled . If you want delayed loading you must ask for it. If you do so, call this method early in your ctor and be sure to override DelayedLoadImpl().
8.117.3.7
const PdfArray & PoDoFo::PdfVariant::GetArray ( [inline]
) const
Returns the value of the object as array Returns a array
8.117.3.8
PdfArray & PoDoFo::PdfVariant::GetArray (
) [inline]
Returns the value of the object as array Returns a array
8.117.3.9
const PdfArray & PoDoFo::PdfVariant::GetArray_NoDL ( [inline, protected]
) const
Version of GetArray() that doesnt trigger a delayed load Returns a array
8.117.3.10
PdfArray & PoDoFo::PdfVariant::GetArray_NoDL ( [inline, protected]
Version of GetArray() that doesnt trigger a delayed load. Returns a array
8.117 PoDoFo::PdfVariant Class Reference 8.117.3.11 bool PoDoFo::PdfVariant::GetBool ( ) const [inline]
455
Get the value if this object is a bool. Returns the bool value.
8.117.3.12 Returns
EPdfDataType PoDoFo::PdfVariant::GetDataType ( [inline]
) const
the datatype of this object or ePdfDataType_Unknown if it does not have a value.
8.117.3.13 Returns
const char PoDoFo::PdfVariant::GetDataTypeString (
) const
a human readable string representation of GetDataType() The returned string must not be freed.
8.117.3.14
const PdfDictionary & PoDoFo::PdfVariant::GetDictionary ( const [inline]
Returns the dictionary value of this object Returns a PdfDictionary
8.117.3.15
PdfDictionary & PoDoFo::PdfVariant::GetDictionary ( [inline]
Returns the dictionary value of this object Returns a PdfDictionary
8.117.3.16
const PdfDictionary & PoDoFo::PdfVariant::GetDictionary_NoDL ( ) const [inline, protected]
Version of GetDictionary() that doesnt trigger a delayed load Returns a PdfDictionary
456 8.117.3.17
Class Documentation PdfDictionary & PoDoFo::PdfVariant::GetDictionary_NoDL ( [inline, protected] )
Version of GetDictionary() that doesnt trigger a delayed load Returns a PdfDictionary
8.117.3.18
bool PoDoFo::PdfVariant::GetImmutable (
) const [inline]
Retrieve if an object is immutable. This is used by PdfImmediateWriter and PdfStreamedDocument so that no keys can be added to an object after setting stream data on it. Returns true if the object is immutable
8.117.3.19
const PdfName & PoDoFo::PdfVariant::GetName ( [inline]
) const
Returns the value of the object as name
8.117.3.20
pdf_int64 PoDoFo::PdfVariant::GetNumber (
) const [inline]
Get the value of the object as long. Returns the value of the number
8.117.3.21
PdfData & PoDoFo::PdfVariant::GetRawData (
) [inline]
Get the reference values of this object. Returns a reference to the PdfData instance.
8.117 PoDoFo::PdfVariant Class Reference 8.117.3.22 const PdfData & PoDoFo::PdfVariant::GetRawData ( [inline] ) const
457
Get the reference values of this object. Returns a reference to the PdfData instance.
8.117.3.23
double PoDoFo::PdfVariant::GetReal (
) const [inline]
Get the value of the object as double. Returns the value of the number
8.117.3.24
const PdfReference & PoDoFo::PdfVariant::GetReference ( [inline]
) const
Get the reference values of this object. Returns a PdfReference
8.117.3.25 Returns
const PdfString & PoDoFo::PdfVariant::GetString ( [inline]
) const
the value of the object as string.
8.117.3.26 Returns
bool PoDoFo::PdfVariant::IsArray (
) const [inline]
true if this variant is an array (i.e. GetDataType() == ePdfDataType_Array)
8.117.3.27 Returns
bool PoDoFo::PdfVariant::IsBool (
) const [inline]
true if this variant is a bool (i.e. GetDataType() == ePdfDataType_Bool)
458 8.117.3.28 Returns true if this variant is a dictionary (i.e. Dictionary) bool PoDoFo::PdfVariant::IsDictionary (
GetDataType() == ePdfDataType_-
8.117.3.29
bool PoDoFo::PdfVariant::IsDirty (
) const [inline]
The dirty ag is set if this variant has been modied after construction. Usually the dirty ag is also set if you call any non-const member function (e.g. GetDictionary()) as PdfVariant cannot determine if you actually changed the dictionary or not. Returns true if the value is dirty and has been modied since construction
8.117.3.30 Returns
bool PoDoFo::PdfVariant::IsEmpty (
) const [inline]
true if this PdfVariant is empty. i.e. m_eDataType == ePdfDataType_Null
8.117.3.31 Returns
bool PoDoFo::PdfVariant::IsHexString (
) const [inline]
true if this variant is a hex-string (i.e. HexString)
GetDataType() == ePdfDataType_-
8.117.3.32 Returns
bool PoDoFo::PdfVariant::IsName (
) const [inline]
true if this variant is a name (i.e. GetDataType() == ePdfDataType_Name)
8.117.3.33 Returns
bool PoDoFo::PdfVariant::IsNull (
) const [inline]
true if this variant is null (i.e. GetDataType() == ePdfDataType_Null)
8.117 PoDoFo::PdfVariant Class Reference 8.117.3.34 Returns bool PoDoFo::PdfVariant::IsNumber ( ) const [inline]
459
true if this variant is a number (i.e. GetDataType() == ePdfDataType_Number)
8.117.3.35 Returns
bool PoDoFo::PdfVariant::IsRawData (
) const [inline]
true if this variant is raw data (i.e. GetDataType() == ePdfDataType_RawData
8.117.3.36 Returns
bool PoDoFo::PdfVariant::IsReal (
) const [inline]
true if this variant is a real (i.e. GetDataType() == ePdfDataType_Real)
8.117.3.37 Returns
bool PoDoFo::PdfVariant::IsReference (
) const [inline]
true if this variant is a reference (i.e. GetDataType() == ePdfDataType_Reference)
8.117.3.38 Returns
bool PoDoFo::PdfVariant::IsString (
) const [inline]
true if this variant is a string (i.e. GetDataType() == ePdfDataType_String)
8.117.3.39 See also
bool PoDoFo::PdfVariant::operator!= ( const PdfVariant & rhs ) const [inline]
operator==
8.117.3.40
const PdfVariant & PoDoFo::PdfVariant::operator= ( const PdfVariant & rhs )
Assign the values of another PdfVariant to this one. Parameters rhs an existing variant which is copied.
460 This will set the dirty ag of this object. See also IsDirty
Class Documentation
8.117.3.41
bool PoDoFo::PdfVariant::operator== ( const PdfVariant & rhs ) const
Test to see if the value contained by this variant is the same as the value of the other variant. 8.117.3.42 void PoDoFo::PdfVariant::SetBool ( bool b ) [inline]
Set the value of this object as bool Parameters b the value as bool. This will set the dirty ag of this object. See also IsDirty
8.117.3.43
void PoDoFo::PdfVariant::SetDirty ( bool bDirty ) [inline, protected]
Sets the dirty ag of this PdfVariant Parameters bDirty true if this PdfVariant has been modied from the outside See also IsDirty
8.117.3.44
void PoDoFo::PdfVariant::SetImmutable ( bool bImmutable ) [inline]
Sets this object to immutable, so that no keys can be edited or changed. Parameters bImmutable if true set the object to be immutable This is used by PdfImmediateWriter and PdfStreamedDocument so that no keys can be added to an object after setting stream data on it.
8.117 PoDoFo::PdfVariant Class Reference 8.117.3.45 void PoDoFo::PdfVariant::SetNumber ( long l ) [inline]
461
Set the value of this object as long Parameters l the value as long. This will set the dirty ag of this object. See also IsDirty
8.117.3.46
void PoDoFo::PdfVariant::SetReal ( double d ) [inline]
Set the value of this object as double Parameters d the value as double. This will set the dirty ag of this object. See also IsDirty
8.117.3.47
void PoDoFo::PdfVariant::ToString ( std::string & rsData, EPdfWriteMode eWriteMode = ePdfWriteMode_Clean ) const
Converts the current object into a string representation which can be written directly to a PDF le on disc. Parameters rsData the object string is returned in this object. eWriteMode additional options for writing to a string
8.117.3.48
void PoDoFo::PdfVariant::Write ( PdfOutputDevice pDevice, EPdfWriteMode eWriteMode, const PdfEncrypt pEncrypt = NULL ) const
Write the complete variant to an output device. This is an overloaded member function. Parameters pDevice write the object to this device eWriteMode additional options for writing this object pEncrypt an encryption object which is used to encrypt this object or NULL to not encrypt this object
462 8.117.3.49
Class Documentation void PoDoFo::PdfVariant::Write ( PdfOutputDevice pDevice, EPdfWriteMode eWriteMode, const PdfEncrypt pEncrypt, const PdfName & keyStop ) const [virtual]
Write the complete variant to an output device. Parameters pDevice write the object to this device eWriteMode additional options for writing this object pEncrypt an encryption object which is used to encrypt this object or NULL to not encrypt this object keyStop if not KeyNull and a key == keyStop is found writing will stop right before this key! if IsDictionary returns true.
8.118
PoDoFo::PdfVecObjects Class Reference
#include <PdfVecObjects.h>
Classes
class Observer class StreamFactory

PdfVecObjects () PdfDocument GetParentDocument () const void SetParentDocument (PdfDocument pDocument) void SetAutoDelete (bool bAutoDelete) bool AutoDelete () const void Clear () size_t GetSize () const size_t GetObjectCount () const PdfObject GetObject (const PdfReference &ref) const size_t GetIndex (const PdfReference &ref) const PdfObject RemoveObject (const PdfReference &ref, bool bMarkAsFree=true) PdfObject RemoveObject (const TIVecObjects &it) PdfObject CreateObject (const char pszType=NULL) PdfObject CreateObject (const PdfVariant &rVariant) void AddFreeObject (const PdfReference &rReference) const TPdfReferenceList & GetFreeObjects () const void RenumberObjects (PdfObject pTrailer, TPdfReferenceSet pNotDelete=NULL, bool bDoGarbageCollection=false) void push_back (PdfObject pObj)
8.118 PoDoFo::PdfVecObjects Class Reference
463
void Sort () void Reserve (size_t size) void GetObjectDependencies (const PdfObject pObj, TPdfReferenceList pList) const void Attach (Observer pObserver) void Detach (Observer pObserver) void SetStreamFactory (StreamFactory pFactory) PdfStream CreateStream (PdfObject pParent) PdfStream CreateStream (const PdfStream &rhs) void WriteObject (PdfObject pObject) void Finish () void BeginAppendStream (const PdfStream pStream) void EndAppendStream (const PdfStream pStream) TIVecObjects begin () TCIVecObjects begin () const TIVecObjects end () TCIVecObjects end () const PdfObject GetBack () void CollectGarbage (PdfObject pTrailer)
8.118.1
A STL vector of PdfObjects. I.e. a list of PdfObject classes. The PdfParser will read the PdfFile into memory and create a PdfVecObjects of all dictionaries found in the PDF le. The PdfWriter class contrary creates a PdfVecObjects internally and writes it to a PDF le later with an appropriate table of contents. These class contains also advanced funtions for searching of PdfObjects in a PdfVecObject.
8.118.2
8.118.2.1

PoDoFo::PdfVecObjects::PdfVecObjects ( )
Default constuctor
8.118.3
8.118.3.1

void PoDoFo::PdfVecObjects::AddFreeObject ( const PdfReference & rReference )
Mark a reference as unused so that it can be reused for new objects. Parameters rReference the reference to reuse
464 8.118.3.2
Class Documentation void PoDoFo::PdfVecObjects::Attach ( Observer pObserver ) [inline]
Attach a new observer Parameters pObserver to attach
8.118.3.3 Returns
bool PoDoFo::PdfVecObjects::AutoDelete (
) const [inline]
if autodeletion is enabled and all objects will be deleted when the PdfVecObjects is deleted.
8.118.3.4
TIVecObjects PoDoFo::PdfVecObjects::begin (
) [inline]
Iterator pointing at the begining of the vector Returns beginning iterator
8.118.3.5
TCIVecObjects PoDoFo::PdfVecObjects::begin ( [inline]
) const
Iterator pointing at the begining of the vector Returns beginning iterator
8.118.3.6
void PoDoFo::PdfVecObjects::BeginAppendStream ( const PdfStream pStream )
Every stream implementation has to call this in BeginAppend Parameters pStream the stream object that is calling
8.118.3.7
void PoDoFo::PdfVecObjects::Clear (
Removes all objects from the vector and resets it to the default state. If SetAutoDelete is true all objects are deleted. All observers are removed from the vector.
8.118 PoDoFo::PdfVecObjects Class Reference See also SetAutoDelete AutoDelete
465
8.118.3.8
void PoDoFo::PdfVecObjects::CollectGarbage ( PdfObject pTrailer )
Deletes all objects that are not references by other objects besides the trailer (which references the root dictionary, which in turn should reference all other objects). Parameters pTrailer trailer object of the PDF Warning this might be slow!
8.118.3.9
PdfObject PoDoFo::PdfVecObjects::CreateObject ( const PdfVariant & rVariant )
Creates a new object (of type rVariants) and inserts it into the vector. This function assigns the next free object number to the PdfObject. Parameters rVariant value of the PdfObject Returns PdfObject pointer to the new PdfObject
8.118.3.10
PdfObject PoDoFo::PdfVecObjects::CreateObject ( const char pszType = NULL )
Creates a new object and inserts it into the vector. This function assigns the next free object number to the PdfObject. Parameters pszType optionall value of the /Type key of the object Returns PdfObject pointer to the new PdfObject
466 8.118.3.11
Class Documentation PdfStream PoDoFo::PdfVecObjects::CreateStream ( PdfObject pParent )
Creates a stream object This method is a factory for PdfStream objects. Parameters pParent parent object Returns a new stream object
8.118.3.12
PdfStream PoDoFo::PdfVecObjects::CreateStream ( const PdfStream & rhs )
Creates a stream object by copying an existing stream Parameters rhs copy this stream Returns a new stream object
8.118.3.13
void PoDoFo::PdfVecObjects::Detach ( Observer pObserver )
Detach an observer. Parameters pObserver observer to detach
8.118.3.14
TCIVecObjects PoDoFo::PdfVecObjects::end ( ) const [inline]
Iterator pointing at the end of the vector Returns ending iterator
8.118.3.15
TIVecObjects PoDoFo::PdfVecObjects::end (
) [inline]
Iterator pointing at the end of the vector Returns ending iterator
8.118 PoDoFo::PdfVecObjects Class Reference 8.118.3.16 void PoDoFo::PdfVecObjects::EndAppendStream ( const PdfStream pStream )
467
Every stream implementation has to call this in EndAppend Parameters pStream the stream object that is calling
8.118.3.17
void PoDoFo::PdfVecObjects::Finish (
Call whenever a document is nished 8.118.3.18 PdfObject PoDoFo::PdfVecObjects::GetBack ( ) [inline]
Get the last object in the vector Returns the last object in the vector or NULL if the vector is emtpy.
8.118.3.19
const TPdfReferenceList & PoDoFo::PdfVecObjects::GetFreeObjects ( [inline]
) const
Returns a list of free references in this vector
8.118.3.20
size_t PoDoFo::PdfVecObjects::GetIndex ( const PdfReference & ref ) const
Finds the object with the given reference in m_vecOffsets and returns the index to it. Parameters ref the object to be found Returns the found object or NULL if no object was found.
8.118.3.21
PdfObject PoDoFo::PdfVecObjects::GetObject ( const PdfReference & ref ) const
Finds the object with the given reference in m_vecOffsets and returns a pointer to it if it is found.
468 Parameters ref the object to be found Returns the found object or NULL if no object was found.
Class Documentation
8.118.3.22 Returns
size_t PoDoFo::PdfVecObjects::GetObjectCount ( [inline]
) const
the highest object number in the vector
8.118.3.23
void PoDoFo::PdfVecObjects::GetObjectDependencies ( const PdfObject pObj, TPdfReferenceList pList ) const
Get a set with all references of objects that the passed object depends on. Parameters pObj the object to calculate all dependencies for pList write the list of dependencies to this list
8.118.3.24 Returns
PdfDocument PoDoFo::PdfVecObjects::GetParentDocument ( const [inline]
a pointer to a PdfDocument that is the parent of this vector. Might be NULL if the vector has no parent.
8.118.3.25 Returns
size_t PoDoFo::PdfVecObjects::GetSize (
) const [inline]
the size of the internal vector
8.118.3.26
void PoDoFo::PdfVecObjects::push_back ( PdfObject pObj )
Insert a object into this vector. Overwritten from std::vector so that m_bObjectCount can be increased for each object. Parameters pObj pointer to the object you want to insert
8.118 PoDoFo::PdfVecObjects Class Reference 8.118.3.27 PdfObject PoDoFo::PdfVecObjects::RemoveObject ( const PdfReference & ref, bool bMarkAsFree = true )
469
Remove the object with the given object and generation number from the list of objects. The object is returned if it was found. Otherwise NULL is returned. The caller has to delete the object by hisself. Parameters ref the object to be found bMarkAsFree if true the removed object reference is marked as free object you will always want to have this true as invalid PDF les can be generated otherwise Returns The removed object.
8.118.3.28
PdfObject PoDoFo::PdfVecObjects::RemoveObject ( const TIVecObjects & it )
Remove the object with the iterator it from the vector and return it Parameters it the object to remove Returns the removed object
8.118.3.29
void PoDoFo::PdfVecObjects::RenumberObjects ( PdfObject pTrailer, TPdfReferenceSet pNotDelete = NULL, bool bDoGarbageCollection = false )
Renumbers all objects according to there current position in the vector. All references remain intact. Warning! This function is _very_ calculation intensive. Parameters pTrailer the trailer object pNotDelete a list of object which must not be deleted bDoGarbageCollection enable garbage collection, which deletes all objects that are not reachable from the trailer. This might be slow! See also CollectGarbage
470 8.118.3.30
Class Documentation void PoDoFo::PdfVecObjects::Reserve ( size_t size ) [inline]
Causes the internal vector to reserve space for size elements. Parameters size reserve space for that much elements in the internal vector
8.118.3.31
void PoDoFo::PdfVecObjects::SetAutoDelete ( bool bAutoDelete ) [inline]
Enable/disable auto deletion. By default auto deletion is disabled. Parameters bAutoDelete if true all objects will be deleted when the PdfVecObjects is deleted.
8.118.3.32
void PoDoFo::PdfVecObjects::SetParentDocument ( PdfDocument pDocument ) [inline]
Sets a parent document of this vector Parameters pDocument the parent of this vector
8.118.3.33
void PoDoFo::PdfVecObjects::SetStreamFactory ( StreamFactory pFactory ) [inline]
Sets a StreamFactory which is used whenever CreateStream is called. Parameters pFactory a stream factory or NULL to reset to the default factory
8.118.3.34
void PoDoFo::PdfVecObjects::Sort (
Sort the objects in the vector based on their object and generation numbers 8.118.3.35 void PoDoFo::PdfVecObjects::WriteObject ( PdfObject pObject )
Can be called to force objects to be written to disk. Parameters pObject a PdfObject that should be written to disk.
8.119 PoDoFo::PdfWinAnsiEncoding Class Reference
471
8.119
PoDoFo::PdfWinAnsiEncoding Class Reference
#include <PdfEncoding.h> Inheritance diagram for PoDoFo::PdfWinAnsiEncoding:

PoDoFo::PdfEncoding PoDoFo::PdfSimpleEncoding PoDoFo::PdfWinAnsiEncoding

PdfWinAnsiEncoding ()

8.119.1
The WinAnsi Encoding is the default encoding in PoDoFo for contents on PDF pages. It is also called CP-1252 encoding. Do not allocate this class yourself, as allocations might be expensive. Try using PdfFont::WinAnsiEncoding. See also PdfFont::WinAnsiEncoding
8.119.2
8.119.2.1

PoDoFo::PdfWinAnsiEncoding::PdfWinAnsiEncoding ( [inline] )
Create a new PdfWinAnsiEncoding

472
Class Documentation
8.119.3
8.119.3.1

const pdf_utf16be PoDoFo::PdfWinAnsiEncoding::GetToUnicodeTable ( ) const [protected, virtual]
8.120
PoDoFo::PdfWriter Class Reference
#include <PdfWriter.h> Inherited by PoDoFo::PdfImmediateWriter[private].

PdfWriter (PdfParser pParser) PdfWriter (PdfVecObjects pVecObjects, const PdfObject pTrailer) void Write (const char pszFilename) void Write (PdfOutputDevice pDevice) void SetWriteMode (EPdfWriteMode eWriteMode) EPdfWriteMode GetWriteMode () const void SetPdfVersion (EPdfVersion eVersion) EPdfVersion GetPdfVersion () const void SetLinearized (bool bLinearize) bool GetLinearized () const void SetUseXRefStream (bool bStream) bool GetUseXRefStream () const const char GetPdfVersionString () const void SetEncrypted (const PdfEncrypt &rEncrypt) bool GetEncrypted () const void GetByteOffset (PdfObject pObject, pdf_long pulOffset) void WriteToBuffer (char ppBuffer, pdf_long pulLen) void FillTrailerObject (PdfObject pTrailer, pdf_long lSize, bool bPrevEntry, bool bOnlySizeKey) const
8.120 PoDoFo::PdfWriter Class Reference
473

PdfWriter (PdfVecObjects pVecObjects) void PODOFO_LOCAL WritePdfHeader (PdfOutputDevice pDevice) void WritePdfObjects (PdfOutputDevice pDevice, const PdfVecObjects &vecObjects, PdfXRef pXref) PODOFO_LOCAL void CreateFileIdentier (PdfString &identier, const PdfObject pTrailer) const PODOFO_LOCAL
PdfVecObjects m_vecObjects PdfEncrypt m_pEncrypt
If not NULL encrypt all strings and streams and create an encryption dictionary in the trailer.
PdfObject m_pEncryptObj
Used to temporarly store the encryption dictionary.
8.120.1
The PdfWriter class writes a list of PdfObjects as PDF le. The XRef section (which is the required table of contents for any PDF le) is created automatically. It does not know about pages but only about PdfObjects. Most users will want to use PdfDocument.
8.120.2
8.120.2.1

PoDoFo::PdfWriter::PdfWriter ( PdfParser pParser )
Create a PdfWriter object from a PdfParser object Parameters pParser a pdf parser object
8.120.2.2
PoDoFo::PdfWriter::PdfWriter ( PdfVecObjects pVecObjects, const PdfObject pTrailer )
Create a new pdf le, from an vector of PdfObjects and a trailer object. Parameters pVecObjects the vector of objects pTrailer a valid trailer object
474 8.120.2.3
Class Documentation PoDoFo::PdfWriter::PdfWriter ( PdfVecObjects pVecObjects ) [protected]
Create a PdfWriter from a PdfVecObjects
8.120.3
8.120.3.1

void PoDoFo::PdfWriter::CreateFileIdentier ( PdfString & identier, const PdfObject pTrailer ) const [protected]
Creates a le identier which is required in several PDF workows. All values from the les document information dictionary are used to create a unique MD5 key which is added to the trailer dictionary. Parameters identier write the identier to this string pTrailer trailer object
8.120.3.2
void PoDoFo::PdfWriter::FillTrailerObject ( PdfObject pTrailer, pdf_long lSize, bool bPrevEntry, bool bOnlySizeKey ) const
Add required keys to a trailer object Parameters pTrailer add keys to this object lSize number of objects in the PDF le bPrevEntry if true a prev entry is added to the trailer object with a value of 0 bOnlySizeKey write only the size key
8.120.3.3
void PoDoFo::PdfWriter::GetByteOffset ( PdfObject pObject, pdf_long pulOffset )
Calculate the byte offset of the object pObject in the PDF le if the le was written to disk at the moment of calling this function. This function is very calculation intensive! Parameters pObject object to calculate the byte offset (has to be a child of this PdfWriter) pulOffset pointer to an unsigned long to save the offset
8.120 PoDoFo::PdfWriter Class Reference 8.120.3.4 Returns true if this PdfWriter creates an encrypted PDF le bool PoDoFo::PdfWriter::GetEncrypted ( ) const [inline]
475
8.120.3.5 Returns
bool PoDoFo::PdfWriter::GetLinearized (
) const [inline]
true if this PDF le is web optimized.
8.120.3.6
EPdfVersion PoDoFo::PdfWriter::GetPdfVersion ( [inline]
) const
Get the PDF version of the document Returns EPdfVersion version of the pdf document
8.120.3.7
const char PoDoFo::PdfWriter::GetPdfVersionString ( [inline]
) const
Get the le format version of the pdf Returns the le format version as string
8.120.3.8 Returns
bool PoDoFo::PdfWriter::GetUseXRefStream (
) const [inline]
wether a XRef stream is used or not
8.120.3.9
EPdfWriteMode PoDoFo::PdfWriter::GetWriteMode ( [inline]
) const
Get the write mode used for wirting the PDF Returns the write mode
476 8.120.3.10
Class Documentation void PoDoFo::PdfWriter::SetEncrypted ( const PdfEncrypt & rEncrypt )
Set the written document to be encrypted using a PdfEncrypt object Parameters rEncrypt an encryption object which is used to encrypt the written PDF le
8.120.3.11
void PoDoFo::PdfWriter::SetLinearized ( bool bLinearize ) [inline]
Enabled linearization for this document. I.e. optimize it for web usage. Default is false. Parameters bLinearize if true create a web optimized PDF le
8.120.3.12
void PoDoFo::PdfWriter::SetPdfVersion ( EPdfVersion eVersion ) [inline]
Set the PDF Version of the document. Has to be called before Write() to have an effect. Parameters eVersion version of the pdf document
8.120.3.13
void PoDoFo::PdfWriter::SetUseXRefStream ( bool bStream ) [inline]
Create a XRef stream which is in some case more compact but requires at least PDF 1.5 Default is false. Parameters bStream if true a XRef stream object will be created
8.120.3.14
void PoDoFo::PdfWriter::SetWriteMode ( EPdfWriteMode eWriteMode ) [inline]
Set the write mode to use when writing the PDF. Parameters eWriteMode write mode
8.120 PoDoFo::PdfWriter Class Reference 8.120.3.15 void PoDoFo::PdfWriter::Write ( PdfOutputDevice pDevice )
477
Writes the complete document to a PdfOutputDevice Parameters pDevice write to the specied device
8.120.3.16
void PoDoFo::PdfWriter::Write ( const char pszFilename )
Writes the complete document to a PDF le. Parameters pszFilename lename of a PDF le.
8.120.3.17
void PoDoFo::PdfWriter::WritePdfHeader ( PdfOutputDevice pDevice ) [protected]
Writes the pdf header to the current le. Parameters pDevice write to this output device
8.120.3.18
void PoDoFo::PdfWriter::WritePdfObjects ( PdfOutputDevice pDevice, const PdfVecObjects & vecObjects, PdfXRef pXref ) [protected]
Write pdf objects to le Parameters pDevice write to this output device vecObjects write all objects in this vector to the le pXref add all written objects to this XRefTable
8.120.3.19
void PoDoFo::PdfWriter::WriteToBuffer ( char ppBuffer, pdf_long pulLen )
Write the whole document to a buffer in memory. Better use a PdfOutputDevice that writes to a PdfRefCountedBuffer. Parameters ppBuffer will be malloced and the document will be written to this buffer.
478
Class Documentation pulLen the length of the buffer will be returned in this parameter
Returns ErrOk on success See also Write
8.120.4
8.120.4.1

PdfVecObjects PoDoFo::PdfWriter::m_vecObjects [protected]
Reorder and renumber all object as required for linearized PDF les. This function is very slow. Parameters pLinearize linearization dictionary pHint primary hint stream dictionary pPage rst page to display in the document ppLast the pointer will be initialized to the last object belonging to the rst page Initialize m_pPagesTree with its correct value Always call this function befre accessing the pages tree. Find dependencies required for creating a linearized PDF of the catalog dictionary. Fill all keys in the linearization dictionary with their values pLinearize a linearization dictionary pHint the hint stream pPage the rst page in the linerarized PDF le pLast pointer of the last object belonging to the rst page pVecXRefOffset xref table entries for previous entry
8.121
PoDoFo::PdfXObject Class Reference
#include <PdfXObject.h> Inheritance diagram for PoDoFo::PdfXObject:

PoDoFo::PdfElement PoDoFo::PdfCanvas
PoDoFo::PdfXObject PoDoFo::PdfImage
8.121 PoDoFo::PdfXObject Class Reference
479

PdfXObject (const PdfRect &rRect, PdfDocument pParent, const char pszPrex=NULL) PdfXObject (const PdfRect &rRect, PdfVecObjects pParent, const char pszPrex=NULL) PdfXObject (const PdfMemDocument &rSourceDoc, int nPage, PdfDocument pParent, const char pszPrex=NULL, bool bUseTrimBox=false) PdfXObject (PdfObject pObject) virtual PdfObject GetContents () const virtual PdfObject GetContentsForAppending () const virtual PdfObject GetResources () const virtual const PdfRect GetPageSize () const const PdfName & GetIdentier () const const PdfReference & GetObjectReference () const
8.121.1
A XObject is a content stream with several drawing commands and data which can be used throughout a PDF document. You can draw on a XObject like you would draw onto a page and can draw this XObject later again using a PdfPainter. See also PdfPainter
8.121.2
8.121.2.1

PoDoFo::PdfXObject::PdfXObject ( const PdfRect & rRect, PdfDocument pParent, const char pszPrex = NULL )
Create a new XObject with a specied dimension in a given document Parameters rRect the size of the XObject pParent the parent document of the XObject pszPrex optional prex for XObject-name
8.121.2.2
PoDoFo::PdfXObject::PdfXObject ( const PdfRect & rRect, PdfVecObjects pParent, const char pszPrex = NULL )
Create a new XObject with a specied dimension in a given vector of PdfObjects

480 Parameters rRect the size of the XObject pParent the parent vector of the XObject pszPrex optional prex for XObject-name
Class Documentation
8.121.2.3
PoDoFo::PdfXObject::PdfXObject ( const PdfMemDocument & rSourceDoc, int nPage, PdfDocument pParent, const char pszPrex = NULL, bool bUseTrimBox = false )
Create a new XObject from a page of another document in a given document Parameters rSourceDoc the document to create the XObject from nPage the page-number in rDoc to create the XObject from pParent the parent document of the XObject pszPrex optional prex for XObject-name bUseTrimBox if true try to use trimbox for size of xobject
8.121.2.4
PoDoFo::PdfXObject::PdfXObject ( PdfObject pObject )
Create a XObject from an existing PdfObject Parameters pObject an existing object which has to be a XObject
8.121.3
8.121.3.1

PdfObject PoDoFo::PdfXObject::GetContents ( [inline, virtual] ) const
Get access to the contents object of this page. If you want to draw onto the page, you have to add drawing commands to the stream of the Contents object. The contents object is a this pointer in this case. Returns a contents object Implements PoDoFo::PdfCanvas.
8.121 PoDoFo::PdfXObject Class Reference 8.121.3.2
481
virtual PdfObject PoDoFo::PdfXObject::GetContentsForAppending ( ) const [inline, virtual]
Get access to the contents object of this page. If you want to draw onto the page, you have to add drawing commands to the stream of the Contents object. The contents object is a this pointer in this case. Returns a contents object Implements PoDoFo::PdfCanvas. 8.121.3.3 const PdfName & PoDoFo::PdfXObject::GetIdentier ( [inline] ) const
Get the identier used for drawig this object Returns identier
8.121.3.4
const PdfReference & PoDoFo::PdfXObject::GetObjectReference ( ) const [inline]
Get the reference to the XObject in the PDF le without having to access the PdfObject. This allows to work with XObjects which have been written to disk already. Returns the reference of the PdfObject for this XObject
8.121.3.5
const PdfRect PoDoFo::PdfXObject::GetPageSize ( [inline, virtual]
) const
Get the current page size in PDF Units Returns a PdfRect containing the page size available for drawing Implements PoDoFo::PdfCanvas. 8.121.3.6 PdfObject PoDoFo::PdfXObject::GetResources ( [inline, virtual] ) const
Get access to the resources object of this page. This is most likely an internal object.
482 Returns a resources object Implements PoDoFo::PdfCanvas.
Class Documentation
8.122
PoDoFo::PdfXRef Class Reference
#include <PdfXRef.h> Inheritance diagram for PoDoFo::PdfXRef:
PoDoFo::PdfXRef
PoDoFo::PdfXRefStream

PdfXRef () virtual PdfXRef () void AddObject (const PdfReference &rRef, pdf_uint64 offset, bool bUsed) void Write (PdfOutputDevice pDevice) pdf_uint32 GetSize () const virtual pdf_uint64 GetOffset () const

virtual void BeginWrite (PdfOutputDevice pDevice) virtual void WriteSubSection (PdfOutputDevice pDevice, pdf_objnum nFirst, pdf_uint32 nCount) virtual void WriteXRefEntry (PdfOutputDevice pDevice, pdf_uint64 offset, pdf_gennum generation, char cMode, pdf_objnum objectNumber=0) virtual void EndWrite (PdfOutputDevice pDevice)
8.122.1
Creates an XRef table. This is an internal class of PoDoFo used by PdfWriter.

8.122 PoDoFo::PdfXRef Class Reference
483
8.122.2
8.122.2.1

PoDoFo::PdfXRef::PdfXRef ( )
Create a new XRef table 8.122.2.2 PoDoFo::PdfXRef::PdfXRef ( ) [virtual]
Destruct the XRef table
8.122.3
8.122.3.1

void PoDoFo::PdfXRef::AddObject ( const PdfReference & rRef, pdf_uint64 offset, bool bUsed )
Add an object to the XRef table. The object should have been written to an output device already. Parameters rRef reference of this object offset the offset where on the device the object was written bUsed species wether this is an used or free object. Set this value to true for all normal objects and to false for free object references.
8.122.3.2
void PoDoFo::PdfXRef::BeginWrite ( PdfOutputDevice pDevice ) [protected, virtual]
Called at the start of writing the XRef table. This method can be overwritten in subclasses to write a general header for the XRef table. Parameters pDevice the output device to which the XRef table should be written. Reimplemented in PoDoFo::PdfXRefStream. 8.122.3.3 void PoDoFo::PdfXRef::EndWrite ( PdfOutputDevice pDevice ) [protected, virtual]
Called at the end of writing the XRef table. Sub classes can overload this method to nish a XRef table. Parameters pDevice the output device to which the XRef table should be written. Reimplemented in PoDoFo::PdfXRefStream.
484 8.122.3.4 Returns pdf_uint64 PoDoFo::PdfXRef::GetOffset ( virtual]
the offset in the le at which the XRef table starts after it was written Reimplemented in PoDoFo::PdfXRefStream. 8.122.3.5 pdf_uint32 PoDoFo::PdfXRef::GetSize ( ) const
Get the size of the XRef table. I.e. the highest object number + 1. Returns the size of the xref table
8.122.3.6
void PoDoFo::PdfXRef::Write ( PdfOutputDevice pDevice )
Write the XRef table to an output device. Parameters pDevice an output device (usually a PDF le)
8.122.3.7
void PoDoFo::PdfXRef::WriteSubSection ( PdfOutputDevice pDevice, pdf_objnum nFirst, pdf_uint32 nCount ) [protected, virtual]
Begin an XRef subsection. All following calls of WriteXRefEntry belong to this XRef subsection. Parameters pDevice the output device to which the XRef table should be written. nFirst the object number of the rst object in this subsection nCount the number of entries in this subsection Reimplemented in PoDoFo::PdfXRefStream. 8.122.3.8 void PoDoFo::PdfXRef::WriteXRefEntry ( PdfOutputDevice pDevice, pdf_uint64 offset, pdf_gennum generation, char cMode, pdf_objnum objectNumber = 0 ) [protected, virtual]
Write a single entry to the XRef table

8.123 PoDoFo::PdfXRefStream Class Reference Parameters pDevice the output device to which the XRef table should be written. offset the offset of the object generation the generation number cMode the mode n for object and f for free objects
485
objectNumber the object number of the currently written object if cMode = n otherwise undened Reimplemented in PoDoFo::PdfXRefStream.
8.123
PoDoFo::PdfXRefStream Class Reference
#include <PdfXRefStream.h> Inheritance diagram for PoDoFo::PdfXRefStream:
PoDoFo::PdfXRef
PoDoFo::PdfXRefStream

PdfXRefStream (PdfVecObjects pParent, PdfWriter pWriter) virtual PdfXRefStream () virtual pdf_uint64 GetOffset () const

virtual void BeginWrite (PdfOutputDevice pDevice) virtual void WriteSubSection (PdfOutputDevice pDevice, pdf_objnum nFirst, pdf_uint32 nCount) virtual void WriteXRefEntry (PdfOutputDevice pDevice, pdf_uint64 offset, pdf_gennum generation, char cMode, pdf_objnum objectNumber=0) virtual void EndWrite (PdfOutputDevice pDevice)
8.123.1
Creates an XRef table that is a stream object. Requires at least PDF 1.5. XRef streams are more compact than normal XRef tables. This is an internal class of PoDoFo used by PdfWriter.
486
Class Documentation
8.123.2
8.123.2.1

PoDoFo::PdfXRefStream::PdfXRefStream ( PdfVecObjects pParent, PdfWriter pWriter )
Create a new XRef table Parameters pParent a vector of PdfObject is required to create a PdfObject for the XRef pWriter is needed to ll the trailer directory correctly which is included into the XRef
8.123.2.2
PoDoFo::PdfXRefStream::PdfXRefStream (
) [virtual]
Destruct the XRef table
8.123.3
8.123.3.1

void PoDoFo::PdfXRefStream::BeginWrite ( PdfOutputDevice pDevice ) [protected, virtual]
Called at the start of writing the XRef table. This method can be overwritten in subclasses to write a general header for the XRef table. Parameters pDevice the output device to which the XRef table should be written. Reimplemented from PoDoFo::PdfXRef. 8.123.3.2 void PoDoFo::PdfXRefStream::EndWrite ( PdfOutputDevice pDevice ) [protected, virtual]
Called at the end of writing the XRef table. Sub classes can overload this method to nish a XRef table. Parameters pDevice the output device to which the XRef table should be written. Reimplemented from PoDoFo::PdfXRef. 8.123.3.3 Returns the offset in the le at which the XRef table starts after it was written
pdf_uint64 PoDoFo::PdfXRefStream::GetOffset ( [inline, virtual]
) const
8.124 PoDoFo::PdfXRefStreamParserObject Class Reference Reimplemented from PoDoFo::PdfXRef.
487
8.123.3.4
void PoDoFo::PdfXRefStream::WriteSubSection ( PdfOutputDevice pDevice, pdf_objnum nFirst, pdf_uint32 nCount ) [protected, virtual]
Begin an XRef subsection. All following calls of WriteXRefEntry belong to this XRef subsection. Parameters pDevice the output device to which the XRef table should be written. nFirst the object number of the rst object in this subsection nCount the number of entries in this subsection Reimplemented from PoDoFo::PdfXRef.
8.123.3.5
void PoDoFo::PdfXRefStream::WriteXRefEntry ( PdfOutputDevice pDevice, pdf_uint64 offset, pdf_gennum generation, char cMode, pdf_objnum objectNumber = 0 ) [protected, virtual]
Write a single entry to the XRef table Parameters pDevice the output device to which the XRef table should be written. offset the offset of the object generation the generation number cMode the mode n for object and f for free objects objectNumber the object number of the currently written object if cMode = n otherwise undened Reimplemented from PoDoFo::PdfXRef.
8.124
PoDoFo::PdfXRefStreamParserObject Reference
Class
#include <PdfXRefStreamParserObject.h> Inheritance diagram for PoDoFo::PdfXRefStreamParserObject:

488
PoDoFo::PdfVariant PoDoFo::PdfObject
Class Documentation
PoDoFo::PdfParserObject PoDoFo::PdfXRefStreamParserObject

PdfXRefStreamParserObject (PdfVecObjects pCreator, const PdfRefCountedInputDevice &rDevice, const PdfRefCountedBuffer &rBuffer, PdfParser::TVecOffsets pOffsets) bool HasPrevious () pdf_long GetPreviousOffset ()
8.124.1
A utility class for PdfParser that can parse an XRef stream object. It is mainly here to make PdfParser more modular.
8.124.2
8.124.2.1

PoDoFo::PdfXRefStreamParserObject::PdfXRefStreamParserObject ( PdfVecObjects pCreator, const PdfRefCountedInputDevice & rDevice, const PdfRefCountedBuffer & rBuffer, PdfParser::TVecOffsets pOffsets )
Parse the object data from the given le handle starting at the current position. Parameters pCreator pointer to a PdfVecObjects to resolve object references rDevice an open reference counted input device which is positioned in front of the object which is going to be parsed. rBuffer buffer to use for parsing to avoid reallocations pOffsets XRef entries are stored into this array
8.125 PoDoFo::PdfZapfDingbatsEncoding Class Reference
489
8.124.3
8.124.3.1

pdf_long PoDoFo::PdfXRefStreamParserObject::GetPreviousOffset ( ) [inline]
Returns the offset of the previous XRef table
8.124.3.2 Returns
bool PoDoFo::PdfXRefStreamParserObject::HasPrevious ( [inline]
true if there is a previous XRefStream
8.125
PoDoFo::PdfZapfDingbatsEncoding Class Reference
#include <PdfEncoding.h> Inheritance diagram for PoDoFo::PdfZapfDingbatsEncoding:
PoDoFo::PdfEncoding PoDoFo::PdfSimpleEncoding PoDoFo::PdfZapfDingbatsEncoding

PdfZapfDingbatsEncoding ()

8.125.1
Do not allocate this class yourself, as allocations might be expensive. Try using PdfFont::ZapfDingbats.
490 See also PdfFont::ZapfDingbatsEncoding
Class Documentation
8.125.2
8.125.2.1

PoDoFo::PdfZapfDingbatsEncoding::PdfZapfDingbatsEncoding ( [inline] )
Create a new PdfZapfDingbatsEncoding
8.125.3
8.125.3.1

const pdf_utf16be PoDoFo::PdfZapfDingbatsEncoding::GetToUnicodeTable ( [protected, virtual] ) const
8.126
PoDoFo::PdfVecObjects::StreamFactory Reference
Class
#include <PdfVecObjects.h> Inherited by PoDoFo::PdfImmediateWriter[private].

virtual PdfStream CreateStream (PdfObject pParent)=0
8.126.1
This class is used to implement stream factories in PoDoFo.

8.127 PoDoFo::TFontCacheElement Struct Reference
491
8.126.2
8.126.2.1

virtual PdfStream PoDoFo::PdfVecObjects::StreamFactory::CreateStream ( PdfObject pParent ) [pure virtual]
Creates a stream object Parameters pParent parent object Returns a new stream object
8.127
PoDoFo::TFontCacheElement Struct Reference
#include <PdfFontCache.h>
Public Attributes
PdfString m_sFontName
We use PdfString here as it can easily handle unicode on windows.
8.127.1
A private structure, which represents a font in the cache.
492
Class Documentation
Chapter 9
File Documentation
9.1 PdfDenes.h File Reference
#include "PdfCompilerCompat.h" #include <wchar.h> #include <map> #include <string> #include <vector> #include <set> #include "PdfError.h" #include "PdfMemoryManagement.h" #include "podofoapi.h"
Namespaces
namespace PoDoFo
Denes
#dene PODOFO_MAKE_VERSION_REAL(M, (M<<16)+(m<<8)+(p) ) m, p) (
#dene PODOFO_MAKE_VERSION_STR_REAL(M, m, p) ("\"" #M "." #m "." #p "\"") #dene ePdfRenderingIntent_AbsoluteColorimetric "AbsoluteColorimetric" #dene ePdfBlendMode_Normal "Normal"
494
File Documentation
Enumerations
enum PoDoFo::EPdfVersion { PoDoFo::ePdfVersion_1_0 = 0, PoDoFo::ePdfVersion_1_1, PoDoFo::ePdfVersion_1_2, PoDoFo::ePdfVersion_1_3, PoDoFo::ePdfVersion_1_4, PoDoFo::ePdfVersion_1_5, PoDoFo::ePdfVersion_1_6, PoDoFo::ePdfVersion_1_7 } enum PoDoFo::EPdfWriteMode { PoDoFo::ePdfWriteMode_Compact = 0x01, PoDoFo::ePdfWriteMode_Clean = 0x02 } enum PoDoFo::EPdfDataType { PoDoFo::ePdfDataType_Bool, PoDoFo::ePdfDataType_Number, PoDoFo::ePdfDataType_Real, PoDoFo::ePdfDataType_String, PoDoFo::ePdfDataType_HexString, PoDoFo::ePdfDataType_Name, PoDoFo::ePdfDataType_Array, PoDoFo::ePdfDataType_Dictionary, PoDoFo::ePdfDataType_Null, PoDoFo::ePdfDataType_Reference, PoDoFo::ePdfDataType_RawData, PoDoFo::ePdfDataType_Unknown } enum PoDoFo::EPdfFilter { PoDoFo::ePdfFilter_ASCIIHexDecode, PoDoFo::ePdfFilter_ASCII85Decode , PoDoFo::ePdfFilter_FlateDecode, PoDoFo::ePdfFilter_RunLengthDecode } enum PoDoFo::EPdfFontType enum PoDoFo::EPdfColorSpace { PoDoFo::ePdfColorSpace_DeviceGray, PoDoFo::ePdfColorSpace_DeviceRGB, PoDoFo::ePdfColorSpace_DeviceCMYK, PoDoFo::ePdfColorSpace_Separation, PoDoFo::ePdfColorSpace_CieLab } enum PoDoFo::EPdfStrokeStyle enum PoDoFo::EPdfLineCapStyle enum PoDoFo::EPdfLineJoinStyle enum PoDoFo::EPdfVerticalAlignment enum PoDoFo::EPdfAlignment enum PoDoFo::EPdfPageSize { PoDoFo::ePdfPageSize_A0, PoDoFo::ePdfPageSize_A1, PoDoFo::ePdfPageSize_A2, PoDoFo::ePdfPageSize_A3, PoDoFo::ePdfPageSize_A4, PoDoFo::ePdfPageSize_A5, PoDoFo::ePdfPageSize_A6, PoDoFo::ePdfPageSize_Letter, PoDoFo::ePdfPageSize_Legal, PoDoFo::ePdfPageSize_Tabloid } enum PoDoFo::EPdfPageMode enum PoDoFo::EPdfPageLayout
Functions
template<typename T > const T PoDoFo::PDF_MAX (const T a, const T b) template<typename T > const T PoDoFo::PDF_MIN (const T a, const T b)
9.2 PdfError.h File Reference
495
Variables
const EPdfVersion PoDoFo::ePdfVersion_Default = ePdfVersion_1_3 const int PoDoFo::s_nNumWhiteSpaces = 6
PDF Reference, Section 3.1.1, Table 3.1, White-space characters.
9.1.1
This le should be included as the FIRST le in every header of PoDoFo lib. It includes all standard les, denes some useful macros, some datatypes and all important enumeration types. On supporting platforms it will be precompiled to speed compilation.
9.1.2
9.1.2.1
Dene Documentation
#dene ePdfBlendMode_Normal "Normal"
List of dened transparency blending modes 9.1.2.2 #dene ePdfRenderingIntent_AbsoluteColorimetric "AbsoluteColorimetric"
List of dened Rendering intents 9.1.2.3 #dene PODOFO_MAKE_VERSION_REAL( M, m, p ) ( (M<<16)+(m<<8)+(p) )
PoDoFo version - 24-bit integer representation. Version is 0xMMmmpp where M is major, m is minor and p is patch eg 0.7.0 is represented as 0x000700 eg 0.7.99 is represented as 0x000763 Note that the PoDoFo version is available in parts as individual 8-bit integer literals in PODOFO_VERSION_MAJOR, PODOFO_VERSION_MINOR and PODOFO_VERSION_PATCH . 9.1.2.4 #dene PODOFO_MAKE_VERSION_STR_REAL( M, m, p ) ("\"" #M "." #m "." #p "\"")
PoDoFo version represented as a string literal, eg 0.7.99
9.2
PdfError.h File Reference
#include "podofoapi.h" #include <string>

496 #include <queue> #include <cstdarg>
File Documentation
Classes
class PoDoFo::PdfError
Namespaces
namespace PoDoFo
Denes
#dene PODOFO_RAISE_ERROR(x) throw ::PoDoFo::PdfError( x, __FILE__, __LINE__ ); #dene PODOFO_RAISE_ERROR_INFO(x, y) throw ::PoDoFo::PdfError( x, __FILE__, __LINE__, y ); #dene PODOFO_RAISE_LOGIC_IF(x, y) { if (x) throw ::PoDoFo::PdfError( ePdfError_InternalLogic, __FILE__, __LINE__, y ); };
Enumerations
enum PoDoFo::EPdfError { PoDoFo::ePdfError_ErrOk = 0, PoDoFo::ePdfError_TestFailed, PoDoFo::ePdfError_InvalidHandle, PoDoFo::ePdfError_FileNotFound, PoDoFo::ePdfError_InvalidDeviceOperation, UnexpectedEOF, PoDoFo::ePdfError_OutOfMemory, ValueOutOfRange, PoDoFo::ePdfError_PoDoFo::ePdfError_-
PoDoFo::ePdfError_InternalLogic, PoDoFo::ePdfError_InvalidEnumValue, PoDoFo::ePdfError_PageNotFound, PoDoFo::ePdfError_NoPdfFile, PoDoFo::ePdfError_NoXRef, PoDoFo::ePdfError_NoTrailer, PoDoFo::ePdfError_NoNumber, PoDoFo::ePdfError_NoObject, PoDoFo::ePdfError_NoEOFToken, PoDoFo::ePdfError_InvalidTrailerSize, PoDoFo::ePdfError_InvalidLinearization, PoDoFo::ePdfError_InvalidDataType, PoDoFo::ePdfError_InvalidXRef, PoDoFo::ePdfError_InvalidXRefStream, PoDoFo::ePdfError_InvalidXRefType, PoDoFo::ePdfError_InvalidPredictor, PoDoFo::ePdfError_InvalidStrokeStyle, PoDoFo::ePdfError_InvalidHexString, PoDoFo::ePdfError_InvalidStream, PoDoFo::ePdfError_InvalidStreamLength, PoDoFo::ePdfError_InvalidKey, PoDoFo::ePdfError_InvalidName, PoDoFo::ePdfError_InvalidEncryptionDict, PoDoFo::ePdfError_InvalidPassword,
9.2 PdfError.h File Reference
497
PoDoFo::ePdfError_InvalidFontFile, PoDoFo::ePdfError_InvalidContentStream, PoDoFo::ePdfError_UnsupportedFilter, PoDoFo::ePdfError_UnsupportedFontFormat, PoDoFo::ePdfError_ActionAlreadyPresent, PoDoFo::ePdfError_WrongDestinationType, PoDoFo::ePdfError_MissingEndStream, PoDoFo::ePdfError_Date, PoDoFo::ePdfError_Flate, PoDoFo::ePdfError_FreeType, PoDoFo::ePdfError_SignatureError, PoDoFo::ePdfError_MutexError, PoDoFo::ePdfError_UnsupportedImageFormat, PoDoFo::ePdfError_CannotConvertColor, PoDoFo::ePdfError_NotImplemented, PoDoFo::ePdfError_DestinationAlreadyPresent, PoDoFo::ePdfError_ChangeOnImmutable, 0xffff } enum PoDoFo::ELogSeverity { PoDoFo::ePdfError_Unknown =
PoDoFo::eLogSeverity_Critical, PoDoFo::eLogSeverity_Error, PoDoFo::eLogSeverity_Warning, PoDoFo::eLogSeverity_Information, PoDoFo::eLogSeverity_Debug, PoDoFo::eLogSeverity_Unknown = 0xffff } PoDoFo::eLogSeverity_None,
9.2.1
Error information and logging is implemented in this le.
9.2.2
9.2.2.1
Dene Documentation
#dene PODOFO_RAISE_ERROR( x ) throw ::PoDoFo::PdfError( x, __FILE__, __LINE__ );
Set the value of the variable eCode (which has to exist in the current function) to x and return the eCode. 9.2.2.2 #dene PODOFO_RAISE_ERROR_INFO( x, y ) throw ::PoDoFo::PdfError( x, __FILE__, __LINE__, y );
Set the value of the variable eCode (which has to exist in the current function) to x and return the eCode. Additionally additional information on the error y is set. y has to be an c-string. 9.2.2.3 #dene PODOFO_RAISE_LOGIC_IF( x, y ) { if (x) throw ::PoDoFo::PdfError( ePdfError_InternalLogic, __FILE__, __LINE__, y ); };
Evaluate x as a binary predicate and if it is true, raise a logic error with the info string y .
498
File Documentation
This macro will be undened when NDEBUG is set, so its compiled out for release builds. Use it for expensive or extremely frequent sanity checking. We dene it then UNDEF it to help out doxygen.
9.3
PdfFiltersPrivate.h File Reference
#include "PdfDefines.h" #include "PdfDefinesPrivate.h" #include "PdfFilter.h" #include "PdfRefCountedBuffer.h" #include <zlib.h>
Classes
class PoDoFo::PdfHexFilter class PoDoFo::PdfAscii85Filter class PoDoFo::PdfFlateFilter class PoDoFo::PdfRLEFilter class PoDoFo::PdfLZWFilter
Namespaces
namespace PoDoFo
9.3.1
Provides implementations of various PDF stream lters. This is an internal header. It should not be included in podofo.h, and should not be included directly by client applications. These lters should only be accessed through the factory interface in PdfFilters.h .
Index
PdfCanvas PdfXRef PoDoFo::PdfCanvas, 56 PoDoFo::PdfXRef, 483 PdfColor PdfXRefStream PoDoFo::PdfColor, 62 PoDoFo::PdfXRefStream, 486 PdfContents AddCharacter PoDoFo::PdfContents, 74 PoDoFo::PdfFontTTFSubset, 211 PdfDate AddColorResource PoDoFo::PdfDate, 82 PoDoFo::PdfCanvas, 57 PdfDocument AddDifference PoDoFo::PdfDocument, 100 PoDoFo::PdfEncodingDifference, PdfEncrypt 124 PoDoFo::PdfEncrypt, 133 AddFreeObject PdfFilter PoDoFo::PdfVecObjects, 463 PoDoFo::PdfFilter, 164 AddGlyph PdfFontCache PoDoFo::PdfFontTTFSubset, 211 PoDoFo::PdfFontCache, 188 AddNamedDestination PdfInfo PoDoFo::PdfDocument, 100 PoDoFo::PdfInfo, 231 AddObject PdfInputDevice PoDoFo::PdfXRef, 483 PoDoFo::PdfInputDevice, 235 AddPageObject PdfMemDocument PoDoFo::PdfPagesTreeCache, 314 PoDoFo::PdfMemDocument, 251 AddResource PdfMutexWrapper PoDoFo::PdfCanvas, 57 PoDoFo::Util::PdfMutexWrapper, AddText 272 PoDoFo::PdfPainter, 318, 319 PdfNamedColor AddToCallstack PoDoFo::PdfNamedColor, 278 PoDoFo::PdfError, 145 PdfOutputDevice AddToDictionary PoDoFo::PdfOutputDevice, 298 PoDoFo::PdfAction, 40 PdfPagesTree PoDoFo::PdfDestination, 86 PoDoFo::PdfPagesTree, 311 PoDoFo::PdfDifferenceEncoding, PdfPagesTreeCache 94 PoDoFo::PdfPagesTreeCache, 314 PoDoFo::PdfEncoding, 120 PdfParser PoDoFo::PdfIdentityEncoding, 223 PoDoFo::PdfParser, 345 PoDoFo::PdfSimpleEncoding, 388 PdfRefCountedBuffer PoDoFo::PdfRefCountedBuffer, 367 AddUsedGlyphname PoDoFo::PdfFont, 182 PdfRefCountedInputDevice PoDoFo::PdfFontType1, 213 PoDoFo::PdfRefCountedInputDevice, AddUsedSubsettingGlyphs PoDoFo::PdfFont, 182 371
500 PoDoFo::PdfFontType1, 213 AdjustByteRange PoDoFo::PdfSignOutputDevice, 384 Append PoDoFo::PdfDocument, 101 PoDoFo::PdfStream, 402, 403 AppendImpl PoDoFo::PdfFileStream, 160 PoDoFo::PdfMemStream, 266 PoDoFo::PdfStream, 403 ArcTo PoDoFo::PdfPainter, 319 AssertMutable PoDoFo::PdfDataType, 80 PoDoFo::PdfVariant, 453 Attach PoDoFo::PdfVecObjects, 463 AttachFile PoDoFo::PdfDocument, 101 Authenticate PoDoFo::PdfEncrypt, 133 AutoDelete PoDoFo::PdfVecObjects, 464 Bad PoDoFo::PdfInputDevice, 235 begin PoDoFo::PdfEncoding, 120 PoDoFo::PdfVecObjects, 464 BeginAppend PoDoFo::PdfStream, 403, 404 BeginAppendImpl PoDoFo::PdfFileStream, 161 PoDoFo::PdfMemStream, 266 PoDoFo::PdfStream, 404 BeginAppendStream PoDoFo::PdfVecObjects, 464 PoDoFo::PdfVecObjects::Observer, 38 BeginDecode PoDoFo::PdfFilter, 164 BeginDecodeImpl PoDoFo::PdfAscii85Filter, 50 PoDoFo::PdfFilter, 164 PoDoFo::PdfFlateFilter, 177 PoDoFo::PdfHexFilter, 219 PoDoFo::PdfLZWFilter, 244 PoDoFo::PdfRLEFilter, 376 BeginEncode PoDoFo::PdfFilter, 165
INDEX BeginEncodeImpl PoDoFo::PdfAscii85Filter, 50 PoDoFo::PdfFilter, 165 PoDoFo::PdfFlateFilter, 177 PoDoFo::PdfLZWFilter, 245 PoDoFo::PdfRLEFilter, 376 BeginText PoDoFo::PdfPainter, 319 BeginWrite PoDoFo::PdfXRef, 483 PoDoFo::PdfXRefStream, 486 BuildColorSpace PoDoFo::PdfColor, 63 BuildFont PoDoFo::PdfFontTTFSubset, 211 CalculateTableSize PoDoFo::PdfTable, 426 CanDecode PoDoFo::PdfAscii85Filter, 50 PoDoFo::PdfFilter, 166 PoDoFo::PdfFlateFilter, 177 PoDoFo::PdfHexFilter, 219 PoDoFo::PdfLZWFilter, 245 PoDoFo::PdfRLEFilter, 377 CanEncode PoDoFo::PdfAscii85Filter, 51 PoDoFo::PdfFilter, 166 PoDoFo::PdfFlateFilter, 178 PoDoFo::PdfHexFilter, 220 PoDoFo::PdfLZWFilter, 245 PoDoFo::PdfRLEFilter, 377 CharWidth PoDoFo::PdfFontMetrics, 195 CharWidthMM PoDoFo::PdfFontMetrics, 195 CheckEOFMarker PoDoFo::PdfParser, 345 CheckForNewPage PoDoFo::PdfTable, 426 Clear PoDoFo::PdfDocument, 101 PoDoFo::PdfInputDevice, 236 PoDoFo::PdfVariant, 453 PoDoFo::PdfVecObjects, 464 ClearCache PoDoFo::PdfPagesTree, 311 PoDoFo::PdfPagesTreeCache, 315 Clip PoDoFo::PdfPainter, 320
INDEX Close PoDoFo::PdfBufferOutputStream, 55 PoDoFo::PdfDeviceOutputStream, 90 PoDoFo::PdfFileOutputStream, 158 PoDoFo::PdfFilteredDecodeStream, 172 PoDoFo::PdfFilteredEncodeStream, 173 PoDoFo::PdfInputDevice, 236 PoDoFo::PdfMemoryOutputStream, 263 PoDoFo::PdfOutputStream, 302 PoDoFo::PdfPainter, 320 PoDoFo::PdfRC4OutputStream, 361 PoDoFo::PdfStreamedDocument, 411 ClosePath PoDoFo::PdfPainter, 320 CollectGarbage PoDoFo::PdfVecObjects, 465 Contains PoDoFo::PdfEncodingDifference, 124 ConvertToCMYK PoDoFo::PdfColor, 63 ConvertToEncoding PoDoFo::PdfDifferenceEncoding, 94 PoDoFo::PdfEncoding, 120 PoDoFo::PdfIdentityEncoding, 223 PoDoFo::PdfSimpleEncoding, 388 ConvertToGrayScale PoDoFo::PdfColor, 63 ConvertToRGB PoDoFo::PdfColor, 63 ConvertToUnicode PoDoFo::PdfDifferenceEncoding, 94 PoDoFo::PdfEncoding, 121 PoDoFo::PdfIdentityEncoding, 223 PoDoFo::PdfSimpleEncoding, 389 Create PoDoFo::PdfFilterFactory, 174 CreateAnnotation PoDoFo::PdfPage, 304 CreateChild PoDoFo::PdfOutlineItem, 291 CreateDecodeStream
501 PoDoFo::PdfFilterFactory, 174 CreateDuplicateFontType1 PoDoFo::PdfDocument, 101 CreateEncodeStream PoDoFo::PdfFilterFactory, 175 CreateEncoding PoDoFo::PdfEncodingObjectFactory, 128 CreateEncryptionDictionary PoDoFo::PdfEncrypt, 133 PoDoFo::PdfEncryptAES, 141 PoDoFo::PdfEncryptRC4, 143 CreateEncryptionInputStream PoDoFo::PdfEncrypt, 134 PoDoFo::PdfEncryptAES, 141 PoDoFo::PdfEncryptRC4, 143 CreateEncryptionOutputStream PoDoFo::PdfEncrypt, 134 PoDoFo::PdfEncryptAES, 141 PoDoFo::PdfEncryptRC4, 143 CreateFileIdentier PoDoFo::PdfWriter, 474 CreateFilterList PoDoFo::PdfFilterFactory, 175 CreateFont PoDoFo::PdfDocument, 101, 102 PoDoFo::PdfFontFactory, 193 CreateFontObject PoDoFo::PdfFontFactory, 193 CreateFontSubset PoDoFo::PdfDocument, 103 CreateNext PoDoFo::PdfOutlineItem, 291 CreateObject PoDoFo::PdfElement, 117 PoDoFo::PdfVecObjects, 465 CreateObjKey PoDoFo::PdfEncrypt, 134 CreatePage PoDoFo::PdfDocument, 103 PoDoFo::PdfPagesTree, 311 CreatePageCallback PoDoFo::PdfTable, 425 CreatePdfEncrypt PoDoFo::PdfEncrypt, 134, 135 CreateRoot PoDoFo::PdfOutlines, 296 CreateStandardPageSize PoDoFo::PdfPage, 305
502
INDEX
CreateStream Device PoDoFo::PdfVecObjects, 465, 466 PoDoFo::PdfRefCountedInputDevice, PoD371 oFo::PdfVecObjects::StreamFactory, 491 Draw CubicBezierTo PoDoFo::PdfTable, 427 PoDoFo::PdfPainter, 320 DrawCircle PoDoFo::PdfPainter, 321 data DrawEllipse PoDoFo::PdfData, 78 PoDoFo::PdfPainter, 321 DebugEnabled DrawEllipseMM PoDoFo::PdfError, 146 PoDoFo::PdfPainterMM, 338 DebugMessage DrawGlyph PoDoFo::PdfError, 146 PoDoFo::PdfPainter, 321 Decode DrawHorizontalBorders PoDoFo::PdfFilter, 166 PoDoFo::PdfTable, 427 DecodeBlock DrawImage PoDoFo::PdfFilter, 166 PoDoFo::PdfPainter, 321 DecodeBlockImpl DrawImageMM PoDoFo::PdfAscii85Filter, 51 PoDoFo::PdfPainterMM, 339 PoDoFo::PdfFilter, 167 DrawLine PoDoFo::PdfFlateFilter, 178 PoDoFo::PdfPainter, 322 PoDoFo::PdfHexFilter, 220 DrawLineMM PoDoFo::PdfLZWFilter, 245 PoDoFo::PdfPainterMM, 339 PoDoFo::PdfRLEFilter, 377 DrawMultiLineText Decrypt PoDoFo::PdfPainter, 322 PoDoFo::PdfType1Encrypt, 448 DrawRect DelayedLoad PoDoFo::PdfPainter, 323 PoDoFo::PdfVariant, 453 DrawRectMM DelayedLoadDone PoDoFo::PdfPainterMM, 339 PoDoFo::PdfVariant, 453 DrawText DelayedLoadImpl PoDoFo::PdfPainter, 323, 324 PoDoFo::PdfParserObject, 354 DrawTextAligned PoDoFo::PdfVariant, 453 PoDoFo::PdfPainter, 324 DelayedStreamLoad DrawTextMM PoDoFo::PdfObject, 283 PoDoFo::PdfPainterMM, 339, 340 DelayedStreamLoadImpl DrawXObject PoDoFo::PdfObject, 283 PoDoFo::PdfPainter, 324 PoDoFo::PdfParserObject, 354 DrawXObjectMM DeleteAnnotation PoDoFo::PdfPainterMM, 340 PoDoFo::PdfPage, 305 DeletePage EBaseEncoding PoDoFo::PdfPagesTree, 312 PoDoFo::PdfDifferenceEncoding, PoDoFo::PdfPagesTreeCache, 315 92 DeletePages eBaseEncoding_Font PoDoFo::PdfMemDocument, 251 PoDoFo::PdfDifferenceEncoding, Detach 92 PoDoFo::PdfVecObjects, 466 eBaseEncoding_MacExpert DetermineDataType PoDoFo::PdfDifferenceEncoding, PoDoFo::PdfTokenizer, 441 92
INDEX eBaseEncoding_MacRoman PoDoFo::PdfDifferenceEncoding, 92 eBaseEncoding_WinAnsi PoDoFo::PdfDifferenceEncoding, 92 EFontCreationFlags PoDoFo::PdfFontCache, 187 eFontCreationFlags_AutoSelectBase14 PoDoFo::PdfFontCache, 187 eFontCreationFlags_None PoDoFo::PdfFontCache, 187 eFontCreationFlags_Type1Subsetting PoDoFo::PdfFontCache, 187 EFontFileType PoDoFo::PdfFontTTFSubset, 210 eFontFileType_OTF PoDoFo::PdfFontTTFSubset, 210 eFontFileType_TTC PoDoFo::PdfFontTTFSubset, 210 eFontFileType_TTF PoDoFo::PdfFontTTFSubset, 210 eFontFileType_Unknown PoDoFo::PdfFontTTFSubset, 210 ELogSeverity PoDoFo, 27 eLogSeverity_Critical PoDoFo, 27 eLogSeverity_Debug PoDoFo, 27 eLogSeverity_Error PoDoFo, 27 eLogSeverity_Information PoDoFo, 27 eLogSeverity_None PoDoFo, 27 eLogSeverity_Unknown PoDoFo, 27 eLogSeverity_Warning PoDoFo, 27 EmbedFont PoDoFo::PdfFont, 182 PoDoFo::PdfFontCID, 192 PoDoFo::PdfFontSimple, 207 EmbedFontFile PoDoFo::PdfFontSimple, 207 PoDoFo::PdfFontType1, 214 PoDoFo::PdfFontType1Base14, 216 EmbedSubsetFont PoDoFo::PdfFont, 182
503 PoDoFo::PdfFontType1, 214 EmbedSubsetFonts PoDoFo::PdfDocument, 104 PoDoFo::PdfFontCache, 188 Empty PoDoFo::PdfMemStream, 266 EmptyCache PoDoFo::PdfFontCache, 188 EnableDebug PoDoFo::PdfError, 146 EnableDelayedLoading PoDoFo::PdfVariant, 453 EnableDelayedStreamLoading PoDoFo::PdfObject, 284 EnableLogging PoDoFo::PdfError, 146 Encode PoDoFo::PdfFilter, 167 EncodeBlock PoDoFo::PdfFilter, 168 EncodeBlockImpl PoDoFo::PdfAscii85Filter, 51 PoDoFo::PdfFilter, 168 PoDoFo::PdfFlateFilter, 178 PoDoFo::PdfHexFilter, 220 PoDoFo::PdfLZWFilter, 246 PoDoFo::PdfRLEFilter, 378 Encrypt PoDoFo::PdfRC4Stream, 362 PoDoFo::PdfType1Encrypt, 448 end PoDoFo::PdfEncoding, 121 PoDoFo::PdfVecObjects, 466 EndAppend PoDoFo::PdfStream, 404 EndAppendImpl PoDoFo::PdfFileStream, 161 PoDoFo::PdfMemStream, 266 PoDoFo::PdfStream, 405 EndAppendStream PoDoFo::PdfVecObjects, 466 PoDoFo::PdfVecObjects::Observer, 38 EndDecode PoDoFo::PdfFilter, 169 EndDecodeImpl PoDoFo::PdfAscii85Filter, 52 PoDoFo::PdfFilter, 169 PoDoFo::PdfFlateFilter, 179 PoDoFo::PdfHexFilter, 221
504 PoDoFo::PdfLZWFilter, 246 EndEncode PoDoFo::PdfFilter, 169 EndEncodeImpl PoDoFo::PdfAscii85Filter, 52 PoDoFo::PdfFilter, 169 PoDoFo::PdfFlateFilter, 179 PoDoFo::PdfLZWFilter, 247 PoDoFo::PdfRLEFilter, 378 EndText PoDoFo::PdfPainter, 325 EndWrite PoDoFo::PdfXRef, 483 PoDoFo::PdfXRefStream, 486 Eof PoDoFo::PdfInputDevice, 236 EPdfAction PoDoFo, 27 EPdfAlignment PoDoFo, 27 EPdfAnnotation PoDoFo, 27 EPdfAnnotationFlags PoDoFo, 28 ePdfBlendMode_Normal PdfDenes.h, 495 EPdfColorSpace PoDoFo, 28 ePdfColorSpace_CieLab PoDoFo, 28 ePdfColorSpace_DeviceCMYK PoDoFo, 28 ePdfColorSpace_DeviceGray PoDoFo, 28 ePdfColorSpace_DeviceRGB PoDoFo, 28 ePdfColorSpace_Separation PoDoFo, 28 EPdfContentsType PoDoFo, 28 ePdfContentsType_ImageData PoDoFo, 28 ePdfContentsType_Keyword PoDoFo, 28 ePdfContentsType_Variant PoDoFo, 28 EPdfDataType PoDoFo, 28 ePdfDataType_Array PoDoFo, 29
INDEX ePdfDataType_Bool PoDoFo, 29 ePdfDataType_Dictionary PoDoFo, 29 ePdfDataType_HexString PoDoFo, 29 ePdfDataType_Name PoDoFo, 29 ePdfDataType_Null PoDoFo, 29 ePdfDataType_Number PoDoFo, 29 ePdfDataType_RawData PoDoFo, 29 ePdfDataType_Real PoDoFo, 29 ePdfDataType_Reference PoDoFo, 29 ePdfDataType_String PoDoFo, 29 ePdfDataType_Unknown PoDoFo, 29 EPdfDestinationType PoDoFo, 29 EPdfEncryptAlgorithm PoDoFo::PdfEncrypt, 132 ePdfEncryptAlgorithm_AESV2 PoDoFo::PdfEncrypt, 132 ePdfEncryptAlgorithm_RC4V1 PoDoFo::PdfEncrypt, 132 ePdfEncryptAlgorithm_RC4V2 PoDoFo::PdfEncrypt, 132 EPdfError PoDoFo, 29 ePdfError_ActionAlreadyPresent PoDoFo, 31 ePdfError_CannotConvertColor PoDoFo, 31 ePdfError_ChangeOnImmutable PoDoFo, 31 ePdfError_Date PoDoFo, 31 ePdfError_DestinationAlreadyPresent PoDoFo, 31 ePdfError_ErrOk PoDoFo, 30 ePdfError_FileNotFound PoDoFo, 30 ePdfError_Flate PoDoFo, 31
INDEX ePdfError_FreeType PoDoFo, 31 ePdfError_InternalLogic PoDoFo, 30 ePdfError_InvalidContentStream PoDoFo, 31 ePdfError_InvalidDataType PoDoFo, 30 ePdfError_InvalidDeviceOperation PoDoFo, 30 ePdfError_InvalidEncryptionDict PoDoFo, 31 ePdfError_InvalidEnumValue PoDoFo, 30 ePdfError_InvalidFontFile PoDoFo, 31 ePdfError_InvalidHandle PoDoFo, 30 ePdfError_InvalidHexString PoDoFo, 30 ePdfError_InvalidKey PoDoFo, 30 ePdfError_InvalidLinearization PoDoFo, 30 ePdfError_InvalidName PoDoFo, 30 ePdfError_InvalidPassword PoDoFo, 31 ePdfError_InvalidPredictor PoDoFo, 30 ePdfError_InvalidStream PoDoFo, 30 ePdfError_InvalidStreamLength PoDoFo, 30 ePdfError_InvalidStrokeStyle PoDoFo, 30 ePdfError_InvalidTrailerSize PoDoFo, 30 ePdfError_InvalidXRef PoDoFo, 30 ePdfError_InvalidXRefStream PoDoFo, 30 ePdfError_InvalidXRefType PoDoFo, 30 ePdfError_MissingEndStream PoDoFo, 31 ePdfError_MutexError PoDoFo, 31 ePdfError_NoEOFToken PoDoFo, 30 ePdfError_NoNumber PoDoFo, 30 ePdfError_NoObject PoDoFo, 30 ePdfError_NoPdfFile PoDoFo, 30 ePdfError_NotImplemented PoDoFo, 31 ePdfError_NoTrailer PoDoFo, 30 ePdfError_NoXRef PoDoFo, 30 ePdfError_OutOfMemory PoDoFo, 30 ePdfError_PageNotFound PoDoFo, 30 ePdfError_SignatureError PoDoFo, 31 ePdfError_TestFailed PoDoFo, 30 ePdfError_UnexpectedEOF PoDoFo, 30 ePdfError_Unknown PoDoFo, 31 ePdfError_UnsupportedFilter PoDoFo, 31 ePdfError_UnsupportedFontFormat PoDoFo, 31 ePdfError_UnsupportedImageFormat PoDoFo, 31 ePdfError_ValueOutOfRange PoDoFo, 30 ePdfError_WrongDestinationType PoDoFo, 31 EPdfField PoDoFo, 31 EPdfFilter PoDoFo, 31 ePdfFilter_ASCII85Decode PoDoFo, 32 ePdfFilter_ASCIIHexDecode PoDoFo, 32 ePdfFilter_FlateDecode PoDoFo, 32 ePdfFilter_RunLengthDecode PoDoFo, 32 EPdfFontType PoDoFo, 32 EPdfFunctionType PoDoFo, 32
505
506 ePdfFunctionType_Exponential PoDoFo, 32 ePdfFunctionType_PostScript PoDoFo, 32 ePdfFunctionType_Sampled PoDoFo, 32 ePdfFunctionType_Stitching PoDoFo, 32 EPdfHighlightingMode PoDoFo, 32 ePdfHighlightingMode_Invert PoDoFo, 32 ePdfHighlightingMode_InvertOutline PoDoFo, 33 ePdfHighlightingMode_None PoDoFo, 32 ePdfHighlightingMode_Push PoDoFo, 33 EPdfInfoInitial PoDoFo::PdfInfo, 230 ePdfInfoInitial_WriteCreationTime PoDoFo::PdfInfo, 230 ePdfInfoInitial_WriteModicationTime PoDoFo::PdfInfo, 230 ePdfInfoInitial_WriteProducer PoDoFo::PdfInfo, 230 EPdfKeyLength PoDoFo::PdfEncrypt, 132 EPdfLineCapStyle PoDoFo, 33 EPdfLineJoinStyle PoDoFo, 33 EPdfOutlineFormat PoDoFo, 33 ePdfOutlineFormat_Bold PoDoFo, 33 ePdfOutlineFormat_BoldItalic PoDoFo, 33 ePdfOutlineFormat_Default PoDoFo, 33 ePdfOutlineFormat_Italic PoDoFo, 33 EPdfPageLayout PoDoFo, 33 EPdfPageMode PoDoFo, 33 EPdfPageSize PoDoFo, 33 ePdfPageSize_A0 PoDoFo, 34 ePdfPageSize_A1 PoDoFo, 34 ePdfPageSize_A2 PoDoFo, 34 ePdfPageSize_A3 PoDoFo, 34 ePdfPageSize_A4 PoDoFo, 34 ePdfPageSize_A5 PoDoFo, 34 ePdfPageSize_A6 PoDoFo, 34 ePdfPageSize_Legal PoDoFo, 34 ePdfPageSize_Letter PoDoFo, 34 ePdfPageSize_Tabloid PoDoFo, 34 EPdfPermissions PoDoFo::PdfEncrypt, 132 ePdfPermissions_Accessible PoDoFo::PdfEncrypt, 133 ePdfPermissions_Copy PoDoFo::PdfEncrypt, 133 ePdfPermissions_DocAssembly PoDoFo::PdfEncrypt, 133 ePdfPermissions_Edit PoDoFo::PdfEncrypt, 133 ePdfPermissions_EditNotes PoDoFo::PdfEncrypt, 133 ePdfPermissions_FillAndSign PoDoFo::PdfEncrypt, 133 ePdfPermissions_HighPrint PoDoFo::PdfEncrypt, 133 ePdfPermissions_Print PoDoFo::PdfEncrypt, 133 ePdfRenderingIntent_AbsoluteColorimetric PdfDenes.h, 495 EPdfStrokeStyle PoDoFo, 34 EPdfVersion PoDoFo, 34 ePdfVersion_1_0 PoDoFo, 34 ePdfVersion_1_1 PoDoFo, 34 ePdfVersion_1_2 PoDoFo, 34 ePdfVersion_1_3
INDEX
INDEX PoDoFo, 34 ePdfVersion_1_4 PoDoFo, 34 ePdfVersion_1_5 PoDoFo, 34 ePdfVersion_1_6 PoDoFo, 34 ePdfVersion_1_7 PoDoFo, 34 ePdfVersion_Default PoDoFo, 36 EPdfVerticalAlignment PoDoFo, 34 EPdfWriteMode PoDoFo, 35 ePdfWriteMode_Clean PoDoFo, 35 ePdfWriteMode_Compact PoDoFo, 35 Erase PoDoFo::PdfOutlineItem, 291 ErrorMessage PoDoFo::PdfError, 146 ErrorName PoDoFo::PdfError, 147 ExpandTabs PoDoFo::PdfPainter, 325 FailEncodeDecode PoDoFo::PdfFilter, 170 Fill PoDoFo::PdfPainter, 325 FillCircle PoDoFo::PdfPainter, 326 FillEllipse PoDoFo::PdfPainter, 326 FillEllipseMM PoDoFo::PdfPainterMM, 340 FillRect PoDoFo::PdfPainter, 326 FillRectMM PoDoFo::PdfPainterMM, 341 FillTrailerObject PoDoFo::PdfWriter, 474 FillXObjectFromDocumentPage PoDoFo::PdfDocument, 104 FilterNameToType PoDoFo::PdfFilterFactory, 175 FilterTypeToName PoDoFo::PdfFilterFactory, 176
507 FindToken PoDoFo::PdfParser, 345 FindToken2 PoDoFo::PdfParser, 345 Finish PoDoFo::PdfVecObjects, 467 FinishPage PoDoFo::PdfPainter, 327 First PoDoFo::PdfOutlineItem, 291 FixObjectReferences PoDoFo::PdfDocument, 104 FlateCompress PoDoFo::PdfMemStream, 266 FlateCompressStream PoDoFo::PdfObject, 284 Flush PoDoFo::PdfOutputDevice, 298 PoDoFo::PdfSignOutputDevice, 384 FontTypeFromFilename PoDoFo::PdfFontMetrics, 196 FreeGlobalEncodingInstances PoDoFo::PdfEncodingFactory, 126 FreeObjectMemory PoDoFo::PdfMemDocument, 251 PoDoFo::PdfParserObject, 354 FromArray PoDoFo::PdfColor, 64 PoDoFo::PdfRect, 363 FromEscaped PoDoFo::PdfName, 274 FromString PoDoFo::PdfColor, 64 GenerateEncryptionKey PoDoFo::PdfEncrypt, 136 GenerationNumber PoDoFo::PdfReference, 373 Get PoDoFo::PdfMemStream, 267 GetAcroForm PoDoFo::PdfDocument, 104 GetAction PoDoFo::PdfAnnotation, 42 PoDoFo::PdfOutlineItem, 292 GetAlignment PoDoFo::PdfSimpleTableModel, 392 PoDoFo::PdfTableModel, 432 GetAlternateCaption
508 PoDoFo::PdfPushButton, 358 GetAlternateColorSpace PoDoFo::PdfColor, 64 GetAnnotation PoDoFo::PdfPage, 305 GetArray PoDoFo::PdfDestination, 86 PoDoFo::PdfVariant, 454 GetArray_NoDL PoDoFo::PdfVariant, 454 GetArtBox PoDoFo::PdfPage, 306 GetAscent PoDoFo::PdfFontMetrics, 196 GetAuthor PoDoFo::PdfInfo, 231 GetAutoPageBreak PoDoFo::PdfTable, 427 GetBack PoDoFo::PdfVecObjects, 467 GetBackgroundColor PoDoFo::PdfSimpleTableModel, 393 PoDoFo::PdfTableModel, 432 GetBaseFont PoDoFo::PdfFont, 182 GetBlack PoDoFo::PdfColor, 65 GetBleedBox PoDoFo::PdfPage, 306 GetBlue PoDoFo::PdfColor, 65 GetBool PoDoFo::PdfVariant, 454 GetBorderColor PoDoFo::PdfSimpleTableModel, 393 PoDoFo::PdfTableModel, 432 GetBorderWidth PoDoFo::PdfSimpleTableModel, 393 PoDoFo::PdfTableModel, 433 GetBottom PoDoFo::PdfRect, 364 GetBoundingBox PoDoFo::PdfFontMetrics, 196 GetBuffer PoDoFo::PdfRefCountedBuffer, 367 GetByteOffset PoDoFo::PdfObject, 284
INDEX PoDoFo::PdfWriter, 474 GetCallstack PoDoFo::PdfError, 147 GetCatalog PoDoFo::PdfDocument, 105 PoDoFo::PdfMemDocument, 252 GetChar PoDoFo::PdfInputDevice, 236 GetCharacterLength PoDoFo::PdfString, 418 GetCharCode PoDoFo::PdfDifferenceEncoding, 95 PoDoFo::PdfEncoding, 121 PoDoFo::PdfIdentityEncoding, 223 PoDoFo::PdfSimpleEncoding, 389 GetCieA PoDoFo::PdfColor, 65 GetCieB PoDoFo::PdfColor, 65 GetCieL PoDoFo::PdfColor, 66 GetColor PoDoFo::PdfAnnotation, 43 PoDoFo::PdfNamedColor, 278 GetColorSpace PoDoFo::PdfColor, 66 GetColorSpaceForName PoDoFo::PdfColor, 66 GetCols PoDoFo::PdfTable, 428 GetContents PoDoFo::PdfAnnotation, 43 PoDoFo::PdfCanvas, 57 PoDoFo::PdfContents, 74 PoDoFo::PdfPage, 306 PoDoFo::PdfXObject, 480 GetContentsForAppending PoDoFo::PdfCanvas, 57 PoDoFo::PdfContents, 74 PoDoFo::PdfPage, 306 PoDoFo::PdfXObject, 480 GetCopy PoDoFo::PdfFileStream, 161 PoDoFo::PdfMemStream, 267 PoDoFo::PdfStream, 405 GetCount PoDoFo::PdfEncodingDifference, 125 GetCreator
INDEX PoDoFo::PdfInfo, 231 GetCropBox PoDoFo::PdfPage, 307 GetCyan PoDoFo::PdfColor, 66 GetDataType PoDoFo::PdfVariant, 455 GetDataTypeString PoDoFo::PdfVariant, 455 GetDensity PoDoFo::PdfColor, 67 GetDescent PoDoFo::PdfFontMetrics, 196 GetDestination PoDoFo::PdfAnnotation, 43 PoDoFo::PdfOutlineItem, 292 GetDictionary PoDoFo::PdfVariant, 455 GetDictionary_NoDL PoDoFo::PdfVariant, 455 GetDifferences PoDoFo::PdfDifferenceEncoding, 95 GetDuplicateFontType1 PoDoFo::PdfFontCache, 188 GetDValue PoDoFo::PdfDestination, 86 GetEnabledEncryptionAlgorithms PoDoFo::PdfEncrypt, 136 GetEncoding PoDoFo::PdfFont, 183 GetEncrypt PoDoFo::PdfMemDocument, 252 PoDoFo::PdfParser, 346 GetEncryptAlgorithm PoDoFo::PdfEncrypt, 136 GetEncrypted PoDoFo::PdfMemDocument, 252 PoDoFo::PdfParser, 346 PoDoFo::PdfWriter, 474 GetError PoDoFo::PdfError, 147 GetEscapedName PoDoFo::PdfName, 274 GetField PoDoFo::PdfPage, 307 GetFileAttachement PoDoFo::PdfAnnotation, 43 GetFileLength PoDoFo::PdfFileInputStream, 156
509 GetFilename PoDoFo::PdfFileSpec, 159 PoDoFo::PdfFontMetrics, 197 GetFileSize PoDoFo::PdfParser, 346 GetFilteredCopy PoDoFo::PdfStream, 405, 406 GetFirstChar PoDoFo::PdfEncoding, 122 GetFlags PoDoFo::PdfAnnotation, 44 GetFont PoDoFo::PdfFontCache, 188, 189 PoDoFo::PdfMemDocument, 253 PoDoFo::PdfPainter, 327 PoDoFo::PdfSimpleTableModel, 393 PoDoFo::PdfTableModel, 433 GetFontCharSpace PoDoFo::PdfFont, 183 PoDoFo::PdfFontMetrics, 197 GetFontData PoDoFo::PdfFontMetrics, 197 GetFontDataLen PoDoFo::PdfFontMetrics, 197 GetFontLibrary PoDoFo::PdfDocument, 105 PoDoFo::PdfFontCache, 189 GetFontMetrics PoDoFo::PdfFont, 183 GetFontMetrics2 PoDoFo::PdfFont, 183 GetFontname PoDoFo::PdfFontMetrics, 197 GetFontScale PoDoFo::PdfFont, 183 PoDoFo::PdfFontMetrics, 198 GetFontSize PoDoFo::PdfFont, 184 PoDoFo::PdfFontMetrics, 198 GetFontSubset PoDoFo::PdfFontCache, 190 GetFontType PoDoFo::PdfFontFactory, 193 PoDoFo::PdfFontMetrics, 198 GetForegroundColor PoDoFo::PdfSimpleTableModel, 394 PoDoFo::PdfTableModel, 433 GetFreeObjects
510 PoDoFo::PdfVecObjects, 467 GetFromResources PoDoFo::PdfPage, 307 GetGlyphId PoDoFo::PdfFontMetrics, 198 GetGlyphWidth PoDoFo::PdfFontMetrics, 198, 199 GetGrayScale PoDoFo::PdfColor, 67 GetGreen PoDoFo::PdfColor, 67 GetHeight PoDoFo::PdfImage, 226 PoDoFo::PdfRect, 364 PoDoFo::PdfTable, 428 GetHexValue PoDoFo::PdfTokenizer, 442 GetID PoDoFo::PdfDifferenceEncoding, 95 PoDoFo::PdfEncoding, 122 PoDoFo::PdfIdentityEncoding, 224 PoDoFo::PdfSimpleEncoding, 389 GetIdentier PoDoFo::PdfExtGState, 154 PoDoFo::PdfFont, 184 PoDoFo::PdfShadingPattern, 381 PoDoFo::PdfXObject, 481 GetIgnoreBrokenObjects PoDoFo::PdfParser, 346 GetImage PoDoFo::PdfSimpleTableModel, 394 PoDoFo::PdfTableModel, 433 GetImmutable PoDoFo::PdfDataType, 80 PoDoFo::PdfVariant, 456 GetIndex PoDoFo::PdfVecObjects, 467 GetIndirectKey PoDoFo::PdfObject, 284 GetInfo PoDoFo::PdfDocument, 105 GetInheritedKey PoDoFo::PdfPage, 308 GetInternalBuffer PoDoFo::PdfFileStream, 162 PoDoFo::PdfMemStream, 267 PoDoFo::PdfStream, 406 GetInternalBufferSize
INDEX PoDoFo::PdfFileStream, 162 PoDoFo::PdfMemStream, 268 PoDoFo::PdfStream, 406 GetItalicAngle PoDoFo::PdfFontMetrics, 199 GetItem PoDoFo::PdfListField, 241 GetItemCount PoDoFo::PdfListField, 241 GetItemDisplayText PoDoFo::PdfListField, 241 GetKeywords PoDoFo::PdfInfo, 231 GetLastChar PoDoFo::PdfEncoding, 122 GetLeft PoDoFo::PdfDestination, 86 PoDoFo::PdfRect, 364 GetLength PoDoFo::PdfBufferOutputStream, 55 PoDoFo::PdfFileStream, 162 PoDoFo::PdfMemoryOutputStream, 263 PoDoFo::PdfMemStream, 268 PoDoFo::PdfName, 275 PoDoFo::PdfOutputDevice, 298 PoDoFo::PdfSignOutputDevice, 384 PoDoFo::PdfStream, 406 PoDoFo::PdfString, 418 GetLinearized PoDoFo::PdfWriter, 475 GetLineSpacing PoDoFo::PdfFontMetrics, 199 GetLineSpacingMM PoDoFo::PdfFontMetrics, 199 GetLoadOnDemand PoDoFo::PdfParser, 346 GetMagenta PoDoFo::PdfColor, 68 GetMarkInfo PoDoFo::PdfMemDocument, 253 GetMaxLen PoDoFo::PdfTextField, 437 GetMD5String PoDoFo::PdfEncrypt, 136 GetMediaBox PoDoFo::PdfPage, 308 GetMetadata PoDoFo::PdfMemDocument, 253
INDEX GetModel PoDoFo::PdfTable, 428 GetMultiLineTextAsLines PoDoFo::PdfPainter, 327 GetName PoDoFo::PdfColor, 68 PoDoFo::PdfName, 275 PoDoFo::PdfNamedColor, 278 PoDoFo::PdfSimpleEncoding, 390 PoDoFo::PdfVariant, 456 GetNamedObjectFromCatalog PoDoFo::PdfDocument, 106 GetNameForColorSpace PoDoFo::PdfColor, 68 GetNamesTree PoDoFo::PdfDocument, 106 GetNextNumber PoDoFo::PdfTokenizer, 442 GetNextToken PoDoFo::PdfContentsTokenizer, 75 PoDoFo::PdfTokenizer, 442 GetNextVariant PoDoFo::PdfTokenizer, 443 GetNonConstObject PoDoFo::PdfElement, 117 GetNumAnnots PoDoFo::PdfPage, 308 GetNumber PoDoFo::PdfVariant, 456 GetNumberOfIncrementalUpdates PoDoFo::PdfParser, 346 GetNumFields PoDoFo::PdfPage, 308 GetObject PoDoFo::PdfDestination, 86, 87 PoDoFo::PdfElement, 117, 118 PoDoFo::PdfVecObjects, 467 GetObjectCount PoDoFo::PdfVecObjects, 468 GetObjectDependencies PoDoFo::PdfVecObjects, 468 GetObjectLength PoDoFo::PdfObject, 285 GetObjectReference PoDoFo::PdfXObject, 481 GetObjects PoDoFo::PdfDocument, 106 PoDoFo::PdfMemDocument, 253 PoDoFo::PdfParser, 347 GetOffset
511 PoDoFo::PdfXRef, 483 PoDoFo::PdfXRefStream, 486 GetOpen PoDoFo::PdfAnnotation, 44 GetOutlines PoDoFo::PdfDocument, 107 GetOwner PoDoFo::PdfObject, 285 GetPage PoDoFo::PdfAnnotation, 44 PoDoFo::PdfDestination, 87 PoDoFo::PdfDocument, 107 PoDoFo::PdfPagesTree, 312 PoDoFo::PdfPagesTreeCache, 315 PoDoFo::PdfPainter, 327 GetPageCount PoDoFo::PdfDocument, 107 GetPageMode PoDoFo::PdfDocument, 107 GetPageNumber PoDoFo::PdfPage, 308 GetPageSize PoDoFo::PdfCanvas, 57 PoDoFo::PdfPage, 309 PoDoFo::PdfXObject, 481 GetPagesTree PoDoFo::PdfDocument, 108 GetParentDocument PoDoFo::PdfVecObjects, 468 GetParentOutline PoDoFo::PdfOutlineItem, 292 GetPdfAscent PoDoFo::PdfFontMetrics, 200 GetPdfDescent PoDoFo::PdfFontMetrics, 200 GetPdfVersion PoDoFo::PdfDocument, 108 PoDoFo::PdfMemDocument, 254 PoDoFo::PdfParser, 347 PoDoFo::PdfStreamedDocument, 411 PoDoFo::PdfWriter, 475 GetPdfVersionString PoDoFo::PdfParser, 347 PoDoFo::PdfWriter, 475 GetPrecision PoDoFo::PdfPainter, 327 GetPreviousOffset PoDoFo::PdfXRefStreamParserObject,
512 489 GetProcSet PoDoFo::PdfCanvas, 58 GetProducer PoDoFo::PdfInfo, 232 GetQuadPoints PoDoFo::PdfAnnotation, 44 GetRawData PoDoFo::PdfVariant, 456 GetReal PoDoFo::PdfVariant, 457 GetRect PoDoFo::PdfAnnotation, 44 PoDoFo::PdfDestination, 87 GetRed PoDoFo::PdfColor, 68 GetReference PoDoFo::PdfVariant, 457 GetResources PoDoFo::PdfCanvas, 58 PoDoFo::PdfPage, 309 PoDoFo::PdfXObject, 481 GetRolloverCaption PoDoFo::PdfPushButton, 358 GetRotation PoDoFo::PdfPage, 309 GetRows PoDoFo::PdfTable, 428 GetSelectedItem PoDoFo::PdfListField, 242 GetSignatureBeacon PoDoFo::PdfSignOutputDevice, 384 GetSignatureSize PoDoFo::PdfSignOutputDevice, 384 GetSize PoDoFo::PdfFontTTFSubset, 211 PoDoFo::PdfRefCountedBuffer, 367 PoDoFo::PdfVecObjects, 468 PoDoFo::PdfXRef, 484 GetStream PoDoFo::PdfObject, 285 GetStream_NoDL PoDoFo::PdfObject, 286 GetStrikeOutPosition PoDoFo::PdfFontMetrics, 200 GetStrikeOutPositionMM PoDoFo::PdfFontMetrics, 200 GetStrikeoutThickness PoDoFo::PdfFontMetrics, 201 GetStrikeoutThicknessMM
INDEX PoDoFo::PdfFontMetrics, 201 GetString PoDoFo::PdfString, 418 PoDoFo::PdfVariant, 457 GetStringUtf8 PoDoFo::PdfString, 419 GetStructTreeRoot PoDoFo::PdfMemDocument, 254 GetSubject PoDoFo::PdfInfo, 232 GetSubsetFontnamePrex PoDoFo::PdfFontMetrics, 201 GetSupportedFormats PoDoFo::PdfImage, 226 GetTabWidth PoDoFo::PdfPainter, 328 GetText PoDoFo::PdfSimpleTableModel, 394 PoDoFo::PdfTableModel, 434 PoDoFo::PdfTextField, 437 GetTextColorBlue PoDoFo::PdfOutlineItem, 292 GetTextColorGreen PoDoFo::PdfOutlineItem, 292 GetTextColorRed PoDoFo::PdfOutlineItem, 293 GetTextFormat PoDoFo::PdfOutlineItem, 293 GetTime PoDoFo::PdfDate, 82 GetTitle PoDoFo::PdfAnnotation, 45 PoDoFo::PdfInfo, 232 PoDoFo::PdfOutlineItem, 293 GetTop PoDoFo::PdfDestination, 88 GetTotalNumberOfPages PoDoFo::PdfPagesTree, 313 GetToUnicodeTable PoDoFo::PdfDocEncoding, 97 PoDoFo::PdfMacRomanEncoding, 248 PoDoFo::PdfSimpleEncoding, 390 PoDoFo::PdfStandardEncoding, 399 PoDoFo::PdfSymbolEncoding, 424 PoDoFo::PdfWinAnsiEncoding, 472 PoDoFo::PdfZapfDingbatsEncoding, 490
INDEX GetTrailer PoDoFo::PdfDocument, 108 PoDoFo::PdfMemDocument, 254 PoDoFo::PdfParser, 347 GetTrapped PoDoFo::PdfInfo, 232 GetTrimBox PoDoFo::PdfPage, 309 GetType PoDoFo::PdfAction, 40 PoDoFo::PdfAnnotation, 45 PoDoFo::PdfAscii85Filter, 52 PoDoFo::PdfDestination, 88 PoDoFo::PdfFilter, 170 PoDoFo::PdfFlateFilter, 179 PoDoFo::PdfHexFilter, 221 PoDoFo::PdfLZWFilter, 247 PoDoFo::PdfRLEFilter, 378 GetUnderlinePosition PoDoFo::PdfFontMetrics, 201 GetUnderlinePositionMM PoDoFo::PdfFontMetrics, 201 GetUnderlineThickness PoDoFo::PdfFontMetrics, 201 GetUnderlineThicknessMM PoDoFo::PdfFontMetrics, 202 GetUnicode PoDoFo::PdfString, 419 GetUnicodeLength PoDoFo::PdfString, 419 GetURI PoDoFo::PdfAction, 40 GetUseXRefStream PoDoFo::PdfWriter, 475 GetVerticalAlignment PoDoFo::PdfSimpleTableModel, 394 PoDoFo::PdfTableModel, 434 GetWeight PoDoFo::PdfFontMetrics, 202 GetWidth PoDoFo::PdfImage, 227 PoDoFo::PdfRect, 364 PoDoFo::PdfTable, 428 GetWidthArray PoDoFo::PdfFontMetrics, 202 GetWriteMode PoDoFo::PdfDocument, 108 PoDoFo::PdfMemDocument, 254
513 PoDoFo::PdfStreamedDocument, 411 PoDoFo::PdfWriter, 475 GetYellow PoDoFo::PdfColor, 69 GetZoom PoDoFo::PdfDestination, 88 GlobalMacExpertEncodingInstance PoDoFo::PdfEncodingFactory, 126 GlobalMacRomanEncodingInstance PoDoFo::PdfEncodingFactory, 126 GlobalPdfDocEncodingInstance PoDoFo::PdfEncodingFactory, 126 GlobalStandardEncodingInstance PoDoFo::PdfEncodingFactory, 127 GlobalSymbolEncodingInstance PoDoFo::PdfEncodingFactory, 127 GlobalWinAnsiEncodingInstance PoDoFo::PdfEncodingFactory, 127 GlobalZapfDingbatsEncodingInstance PoDoFo::PdfEncodingFactory, 127 HasAction PoDoFo::PdfAnnotation, 45 HasAppearanceStream PoDoFo::PdfAnnotation, 45 HasBackgroundColor PoDoFo::PdfSimpleTableModel, 395 PoDoFo::PdfTableModel, 434 HasBorders PoDoFo::PdfSimpleTableModel, 395 PoDoFo::PdfTableModel, 435 HasDestination PoDoFo::PdfAnnotation, 45 HasFileAttachement PoDoFo::PdfAnnotation, 45 HasImage PoDoFo::PdfSimpleTableModel, 395 PoDoFo::PdfTableModel, 435 HasLinearizationDict PoDoFo::PdfParser, 347 HasPrevious PoDoFo::PdfXRefStreamParserObject, 489 HasStream PoDoFo::PdfObject, 286
514 HasStreamToParse PoDoFo::PdfParserObject, 355 HasURI PoDoFo::PdfAction, 40 HasWordWrap PoDoFo::PdfSimpleTableModel, 395 PoDoFo::PdfTableModel, 435 HEX_NOT_FOUND PoDoFo::PdfTokenizer, 446 HorizonalLineTo PoDoFo::PdfPainter, 328 Init PoDoFo::PdfFontCID, 192 PoDoFo::PdfFontSimple, 208 InitPagesTree PoDoFo::PdfDocument, 109 InsertChild PoDoFo::PdfOutlineItem, 293 InsertItem PoDoFo::PdfListField, 242 InsertPage PoDoFo::PdfPagesTree, 313 PoDoFo::PdfPagesTreeCache, 315 InsertPages PoDoFo::PdfMemDocument, 254 Intersect PoDoFo::PdfRect, 364 IsAccessibilityAllowed PoDoFo::PdfDocument, 109 PoDoFo::PdfEncrypt, 137 PoDoFo::PdfMemDocument, 255 PoDoFo::PdfStreamedDocument, 411 IsAppending PoDoFo::PdfStream, 406 IsArray PoDoFo::PdfVariant, 457 IsAutoDelete PoDoFo::PdfDifferenceEncoding, 95 PoDoFo::PdfEncoding, 122 PoDoFo::PdfIdentityEncoding, 224 PoDoFo::PdfSimpleEncoding, 390 IsBold PoDoFo::PdfFont, 184 IsBool PoDoFo::PdfVariant, 457 IsChecked
INDEX PoDoFo::PdfCheckBox, 59 IsCieLab PoDoFo::PdfColor, 69 IsCMYK PoDoFo::PdfColor, 69 IsComboBox PoDoFo::PdfListField, 242 IsCombs PoDoFo::PdfTextField, 437 IsCopyAllowed PoDoFo::PdfDocument, 109 PoDoFo::PdfEncrypt, 137 PoDoFo::PdfMemDocument, 255 PoDoFo::PdfStreamedDocument, 412 IsDelimiter PoDoFo::PdfTokenizer, 443 IsDictionary PoDoFo::PdfVariant, 457 IsDirty PoDoFo::PdfDataType, 80 PoDoFo::PdfVariant, 458 IsDocAssemblyAllowed PoDoFo::PdfDocument, 109 PoDoFo::PdfEncrypt, 137 PoDoFo::PdfMemDocument, 255 PoDoFo::PdfStreamedDocument, 412 IsEditable PoDoFo::PdfComboBox, 72 IsEditAllowed PoDoFo::PdfDocument, 110 PoDoFo::PdfEncrypt, 137 PoDoFo::PdfMemDocument, 256 PoDoFo::PdfStreamedDocument, 412 IsEditNotesAllowed PoDoFo::PdfDocument, 110 PoDoFo::PdfEncrypt, 138 PoDoFo::PdfMemDocument, 256 PoDoFo::PdfStreamedDocument, 413 IsEmpty PoDoFo::PdfVariant, 458 IsEncryptionEnabled PoDoFo::PdfEncrypt, 138 IsError PoDoFo::PdfError, 147 IsFileField PoDoFo::PdfTextField, 437
INDEX IsFillAndSignAllowed PoDoFo::PdfDocument, 110 PoDoFo::PdfEncrypt, 138 PoDoFo::PdfMemDocument, 256 PoDoFo::PdfStreamedDocument, 413 IsGrayScale PoDoFo::PdfColor, 69 IsHex PoDoFo::PdfString, 420 IsHexString PoDoFo::PdfVariant, 458 IsHighPrintAllowed PoDoFo::PdfDocument, 111 PoDoFo::PdfEncrypt, 139 PoDoFo::PdfMemDocument, 257 PoDoFo::PdfStreamedDocument, 413 IsIndirect PoDoFo::PdfReference, 373 IsItalic PoDoFo::PdfFont, 184 IsLinearized PoDoFo::PdfDocument, 111 PoDoFo::PdfMemDocument, 257 PoDoFo::PdfParser, 347 PoDoFo::PdfStreamedDocument, 414 IsLoadOnDemand PoDoFo::PdfParserObject, 355 IsMultiLine PoDoFo::PdfTextField, 437 IsMultiSelect PoDoFo::PdfListField, 242 IsName PoDoFo::PdfVariant, 458 IsNextToken PoDoFo::PdfTokenizer, 443 IsNull PoDoFo::PdfVariant, 458 IsNumber PoDoFo::PdfVariant, 458 IsPasswordField PoDoFo::PdfTextField, 438 IsPdfFile PoDoFo::PdfParser, 347 IsPrintable PoDoFo::PdfTokenizer, 444 IsPrintAllowed PoDoFo::PdfDocument, 111
515 PoDoFo::PdfEncrypt, 139 PoDoFo::PdfMemDocument, 257 PoDoFo::PdfStreamedDocument, 414 IsRawData PoDoFo::PdfVariant, 459 IsReal PoDoFo::PdfVariant, 459 IsReference PoDoFo::PdfVariant, 459 IsRegular PoDoFo::PdfTokenizer, 444 IsRGB PoDoFo::PdfColor, 69 IsRichText PoDoFo::PdfTextField, 438 IsScrollBarsEnabled PoDoFo::PdfTextField, 438 IsSeekable PoDoFo::PdfInputDevice, 236 IsSeparation PoDoFo::PdfColor, 70 IsSingleByteEncoding PoDoFo::PdfDifferenceEncoding, 96 PoDoFo::PdfEncoding, 122 PoDoFo::PdfIdentityEncoding, 224 PoDoFo::PdfSimpleEncoding, 391 IsSorted PoDoFo::PdfListField, 242 IsSpellcheckingEnabled PoDoFo::PdfListField, 243 PoDoFo::PdfTextField, 438 IsStrictParsing PoDoFo::PdfParser, 348 IsStrikeOut PoDoFo::PdfFont, 184 IsString PoDoFo::PdfVariant, 459 IsSubsetting PoDoFo::PdfFont, 185 IsSymbol PoDoFo::PdfFontMetrics, 202 IsUnderlined PoDoFo::PdfFont, 185 IsUnicode PoDoFo::PdfString, 420 IsValid PoDoFo::PdfDate, 82 PoDoFo::PdfString, 420
516 IsWhitespace PoDoFo::PdfTokenizer, 444 Next Last PoDoFo::PdfOutlineItem, 293 LineTo PoDoFo::PdfPainter, 328 LineToMM PoDoFo::PdfPainterMM, 341 Load PoDoFo::PdfMemDocument, 258 LoadFromFile PoDoFo::PdfImage, 227 Lock PoDoFo::Util::PdfMutexImpl, 270 LoggingEnabled PoDoFo::PdfError, 147 LogMessage PoDoFo::PdfError, 147, 148 Look PoDoFo::PdfInputDevice, 236 m_curColor PoDoFo::PdfPainter, 337 m_isTextOpen PoDoFo::PdfPainter, 337 m_nTabWidth PoDoFo::PdfPainter, 337 m_oss PoDoFo::PdfPainter, 337 m_pCanvas PoDoFo::PdfPainter, 337 m_pFont PoDoFo::PdfPainter, 337 m_pPage PoDoFo::PdfPainter, 337 m_vecObjects PoDoFo::PdfWriter, 478 MergeTrailer PoDoFo::PdfParser, 348 MoveTextPos PoDoFo::PdfPainter, 328 MoveTo PoDoFo::PdfPainter, 329 MoveToMM PoDoFo::PdfPainterMM, 341 MustGetIndirectKey PoDoFo::PdfObject, 286 NameToUnicodeID
INDEX PoDoFo::PdfDifferenceEncoding, 96 PoDoFo::PdfOutlineItem, 294 ObjectNumber PoDoFo::PdfReference, 373 operator< PoDoFo::PdfEncoding, 123 PoDoFo::PdfName, 275 PoDoFo::PdfNamedColor, 279 PoDoFo::PdfObject, 286 PoDoFo::PdfRefCountedBuffer, 367 PoDoFo::PdfReference, 374 PoDoFo::PdfString, 421 operator> PoDoFo::PdfRefCountedBuffer, 368 PoDoFo::PdfString, 422 operator= PoDoFo::PdfColor, 70 PoDoFo::PdfData, 78 PoDoFo::PdfDestination, 88 PoDoFo::PdfEncodingDifference, 125 PoDoFo::PdfEncrypt, 139 PoDoFo::PdfError, 148, 149 PoDoFo::PdfMemStream, 268 PoDoFo::PdfName, 276 PoDoFo::PdfObject, 286 PoDoFo::PdfRefCountedBuffer, 368 PoDoFo::PdfRefCountedInputDevice, 371 PoDoFo::PdfReference, 374 PoDoFo::PdfStream, 407 PoDoFo::PdfString, 421 PoDoFo::PdfVariant, 459 operator== PoDoFo::PdfColor, 70 PoDoFo::PdfEncoding, 123 PoDoFo::PdfError, 149 PoDoFo::PdfName, 276 PoDoFo::PdfNamedColor, 279 PoDoFo::PdfObject, 287 PoDoFo::PdfRefCountedBuffer, 368 PoDoFo::PdfReference, 374 PoDoFo::PdfString, 421 PoDoFo::PdfVariant, 460 ParentDestructed
INDEX PoDoFo::PdfVecObjects::Observer, 38 ParseFile PoDoFo::PdfParser, 348, 349 PoDoFo::PdfParserObject, 355 ParseStream PoDoFo::PdfParserObject, 355 PDF_MAX PoDoFo, 35 PDF_MIN PoDoFo, 35 PdfAction PoDoFo::PdfAction, 39 PdfAnnotation PoDoFo::PdfAnnotation, 42 PdfArrayBaseClass PoDoFo, 27 PdfAxialShadingPattern PoDoFo::PdfAxialShadingPattern, 53 PdfBufferOutputStream PoDoFo::PdfBufferOutputStream, 55 PdfCheckBox PoDoFo::PdfCheckBox, 59 PdfColor PoDoFo::PdfColor, 62 PdfComboBox PoDoFo::PdfComboBox, 72 PdfContents PoDoFo::PdfContents, 73 PdfContentsTokenizer PoDoFo::PdfContentsTokenizer, 75 PdfData PoDoFo::PdfData, 77, 78 PdfDataType PoDoFo::PdfDataType, 80 PdfDate PoDoFo::PdfDate, 82 PdfDenes.h, 493 ePdfBlendMode_Normal, 495 ePdfRenderingIntent_AbsoluteColorimetric, 495 PODOFO_MAKE_VERSION_REAL, 495 PODOFO_MAKE_VERSION_STR_REAL, 495 PdfDestination PoDoFo::PdfDestination, 84, 85 PdfDeviceInputStream
517 PoDoFo::PdfDeviceInputStream, 89 PdfDeviceOutputStream PoDoFo::PdfDeviceOutputStream, 90 PdfDifferenceEncoding PoDoFo::PdfDifferenceEncoding, 92, 93 PdfDocEncoding PoDoFo::PdfDocEncoding, 97 PdfDocument PoDoFo::PdfDocument, 100 PdfElement PoDoFo::PdfElement, 116, 117 PdfEncoding PoDoFo::PdfEncoding, 120 PdfEncodingDifference PoDoFo::PdfEncodingDifference, 124 PdfError PoDoFo::PdfError, 145 PdfError.h, 495 PODOFO_RAISE_ERROR, 497 PODOFO_RAISE_ERROR_INFO, 497 PODOFO_RAISE_LOGIC_IF, 497 PdfExponentialFunction PoDoFo::PdfExponentialFunction, 152 PdfExtGState PoDoFo::PdfExtGState, 153 PdfFileInputStream PoDoFo::PdfFileInputStream, 156 PdfFileOutputStream PoDoFo::PdfFileOutputStream, 157 PdfFileSpec PoDoFo::PdfFileSpec, 159 PdfFileStream PoDoFo::PdfFileStream, 160 PdfFilter PoDoFo::PdfFilter, 164 PdfFilteredDecodeStream PoDoFo::PdfFilteredDecodeStream, 171 PdfFilteredEncodeStream PoDoFo::PdfFilteredEncodeStream, 173 PdfFiltersPrivate.h, 498 PdfFont PoDoFo::PdfFont, 181 PdfFontCache
518
INDEX
PoDoFo::Util::PdfMutexWrapper, PoDoFo::PdfFontCache, 187 272 PdfFontCID PdfName PoDoFo::PdfFontCID, 191 PoDoFo::PdfName, 273, 274 PdfFontSimple PdfNamedColor PoDoFo::PdfFontSimple, 207 PoDoFo::PdfNamedColor, 278 PdfFontTrueType PdfObject PoDoFo::PdfFontTrueType, 209 PoDoFo::PdfObject, 281283 PdfFontTTFSubset PdfObjectStreamParserObject PoDoFo::PdfFontTTFSubset, 210 PoDPdfFontType1 oFo::PdfObjectStreamParserObject, PoDoFo::PdfFontType1, 212, 213 288 PdfFontType1Base14 PdfOutlineItem PoDoFo::PdfFontType1Base14, 215 PoDoFo::PdfOutlineItem, 290 PdfFunction PdfOutlines PoDoFo::PdfFunction, 216, 217 PoDoFo::PdfOutlines, 296 PdfFunctionBaseShadingPattern PdfOutputDevice PoD297, oFo::PdfFunctionBaseShadingPattern, PoDoFo::PdfOutputDevice, 298 218 PdfPage PdfIdentityEncoding PoDoFo::PdfPage, 304 PoDoFo::PdfIdentityEncoding, 222 PdfPagesTree PdfImage PoDoFo::PdfPagesTree, 311 PoDoFo::PdfImage, 226 PdfPagesTreeCache PdfInfo PoDoFo::PdfPagesTreeCache, 314 PoDoFo::PdfInfo, 231 PdfPainter PdfInputDevice PoDoFo::PdfPainter, 318 PoDoFo::PdfInputDevice, 235 PdfPainterMM PdfListBox PoDoFo::PdfPainterMM, 338 PoDoFo::PdfListBox, 239 PdfParser PdfListField PoDoFo::PdfParser, 343, 344 PoDoFo::PdfListField, 240, 241 PdfParserObject PdfLocaleImbue PoDoFo::PdfParserObject, 354 PoDoFo, 35 PdfPushButton PdfMacRomanEncoding PoDoFo::PdfPushButton, 357 PoDoFo::PdfMacRomanEncoding, PdfRadialShadingPattern 248 PoDoFo::PdfRadialShadingPattern, PdfMemDocument 359 PoDoFo::PdfMemDocument, 250 PdfRect PdfMemoryInputStream PoDoFo::PdfRect, 363 PoDoFo::PdfMemoryInputStream, PdfRefCountedBuffer 262 PoDoFo::PdfRefCountedBuffer, PdfMemoryOutputStream 366, 367 PoDoFo::PdfMemoryOutputStream, PdfRefCountedInputDevice 263 PoDPdfMemStream oFo::PdfRefCountedInputDevice, PoDoFo::PdfMemStream, 265 370 PdfMutexImpl PdfReference PoDoFo::Util::PdfMutexImpl, 270 PoDoFo::PdfReference, 372, 373 PdfMutexWrapper PdfSampledFunction
INDEX
519
PoDoFo::PdfSampledFunction, 379, PoD380 oFo::PdfZapfDingbatsEncoding, PdfShadingPattern 490 PoDoFo::PdfShadingPattern, 381 PoDoFo, 21 PdfSignatureField ELogSeverity, 27 PoDoFo::PdfSignatureField, 382 eLogSeverity_Critical, 27 PdfSimpleTableModel eLogSeverity_Debug, 27 PoDoFo::PdfSimpleTableModel, eLogSeverity_Error, 27 392 eLogSeverity_Information, 27 PdfStandardEncoding eLogSeverity_None, 27 PoDoFo::PdfStandardEncoding, 398 eLogSeverity_Unknown, 27 PdfStitchingFunction eLogSeverity_Warning, 27 PoDoFo::PdfStitchingFunction, 400 EPdfAction, 27 PdfStream EPdfAlignment, 27 PoDoFo::PdfStream, 402 EPdfAnnotation, 27 PdfStreamedDocument EPdfAnnotationFlags, 28 PoDoFo::PdfStreamedDocument, EPdfColorSpace, 28 410 ePdfColorSpace_CieLab, 28 PdfString ePdfColorSpace_DeviceCMYK, 28 PoDoFo::PdfString, 416418 ePdfColorSpace_DeviceGray, 28 PdfSymbolEncoding ePdfColorSpace_DeviceRGB, 28 PoDoFo::PdfSymbolEncoding, 424 ePdfColorSpace_Separation, 28 PdfTable EPdfContentsType, 28 PoDoFo::PdfTable, 426 ePdfContentsType_ImageData, 28 PdfTextField ePdfContentsType_Keyword, 28 PoDoFo::PdfTextField, 436, 437 ePdfContentsType_Variant, 28 PdfTTFWriter EPdfDataType, 28 PoDoFo::NonPublic::PdfTTFWriter, ePdfDataType_Array, 29 446 ePdfDataType_Bool, 29 PdfType1Encrypt ePdfDataType_Dictionary, 29 PoDoFo::PdfType1Encrypt, 448 ePdfDataType_HexString, 29 PdfVariant ePdfDataType_Name, 29 PoDoFo::PdfVariant, 451, 452 ePdfDataType_Null, 29 PdfVecObjects ePdfDataType_Number, 29 PoDoFo::PdfVecObjects, 463 ePdfDataType_RawData, 29 PdfWinAnsiEncoding ePdfDataType_Real, 29 PoDoFo::PdfWinAnsiEncoding, 471 ePdfDataType_Reference, 29 PdfWriter ePdfDataType_String, 29 PoDoFo::PdfWriter, 473 ePdfDataType_Unknown, 29 PdfXObject EPdfDestinationType, 29 PoDoFo::PdfXObject, 479, 480 EPdfError, 29 PdfXRef ePdfError_ActionAlreadyPresent, PoDoFo::PdfXRef, 483 31 PdfXRefStream ePdfError_CannotConvertColor, 31 PoDoFo::PdfXRefStream, 486 ePdfError_ChangeOnImmutable, 31 PdfXRefStreamParserObject ePdfError_Date, 31 PoDePdfError_oFo::PdfXRefStreamParserObject, DestinationAlreadyPresent, 488 31 PdfZapfDingbatsEncoding ePdfError_ErrOk, 30
520 ePdfError_FileNotFound, 30 ePdfError_Flate, 31 ePdfError_FreeType, 31 ePdfError_InternalLogic, 30 ePdfError_InvalidContentStream, 31 ePdfError_InvalidDataType, 30 ePdfError_InvalidDeviceOperation, 30 ePdfError_InvalidEncryptionDict, 31 ePdfError_InvalidEnumValue, 30 ePdfError_InvalidFontFile, 31 ePdfError_InvalidHandle, 30 ePdfError_InvalidHexString, 30 ePdfError_InvalidKey, 30 ePdfError_InvalidLinearization, 30 ePdfError_InvalidName, 30 ePdfError_InvalidPassword, 31 ePdfError_InvalidPredictor, 30 ePdfError_InvalidStream, 30 ePdfError_InvalidStreamLength, 30 ePdfError_InvalidStrokeStyle, 30 ePdfError_InvalidTrailerSize, 30 ePdfError_InvalidXRef, 30 ePdfError_InvalidXRefStream, 30 ePdfError_InvalidXRefType, 30 ePdfError_MissingEndStream, 31 ePdfError_MutexError, 31 ePdfError_NoEOFToken, 30 ePdfError_NoNumber, 30 ePdfError_NoObject, 30 ePdfError_NoPdfFile, 30 ePdfError_NotImplemented, 31 ePdfError_NoTrailer, 30 ePdfError_NoXRef, 30 ePdfError_OutOfMemory, 30 ePdfError_PageNotFound, 30 ePdfError_SignatureError, 31 ePdfError_TestFailed, 30 ePdfError_UnexpectedEOF, 30 ePdfError_Unknown, 31 ePdfError_UnsupportedFilter, 31 ePdfError_UnsupportedFontFormat, 31 ePdfError_UnsupportedImageFormat, 31 ePdfError_ValueOutOfRange, 30 ePdfError_WrongDestinationType, 31
INDEX EPdfField, 31 EPdfFilter, 31 ePdfFilter_ASCII85Decode, 32 ePdfFilter_ASCIIHexDecode, 32 ePdfFilter_FlateDecode, 32 ePdfFilter_RunLengthDecode, 32 EPdfFontType, 32 EPdfFunctionType, 32 ePdfFunctionType_Exponential, 32 ePdfFunctionType_PostScript, 32 ePdfFunctionType_Sampled, 32 ePdfFunctionType_Stitching, 32 EPdfHighlightingMode, 32 ePdfHighlightingMode_Invert, 32 ePdfHighlightingMode_InvertOutline, 33 ePdfHighlightingMode_None, 32 ePdfHighlightingMode_Push, 33 EPdfLineCapStyle, 33 EPdfLineJoinStyle, 33 EPdfOutlineFormat, 33 ePdfOutlineFormat_Bold, 33 ePdfOutlineFormat_BoldItalic, 33 ePdfOutlineFormat_Default, 33 ePdfOutlineFormat_Italic, 33 EPdfPageLayout, 33 EPdfPageMode, 33 EPdfPageSize, 33 ePdfPageSize_A0, 34 ePdfPageSize_A1, 34 ePdfPageSize_A2, 34 ePdfPageSize_A3, 34 ePdfPageSize_A4, 34 ePdfPageSize_A5, 34 ePdfPageSize_A6, 34 ePdfPageSize_Legal, 34 ePdfPageSize_Letter, 34 ePdfPageSize_Tabloid, 34 EPdfStrokeStyle, 34 EPdfVersion, 34 ePdfVersion_1_0, 34 ePdfVersion_1_1, 34 ePdfVersion_1_2, 34 ePdfVersion_1_3, 34 ePdfVersion_1_4, 34 ePdfVersion_1_5, 34 ePdfVersion_1_6, 34 ePdfVersion_1_7, 34 ePdfVersion_Default, 36 EPdfVerticalAlignment, 34
INDEX EPdfWriteMode, 35 SetFileAttachement, 48 ePdfWriteMode_Clean, 35 SetFlags, 48 ePdfWriteMode_Compact, 35 SetOpen, 48 PDF_MAX, 35 SetQuadPoints, 49 PDF_MIN, 35 SetTitle, 49 PdfArrayBaseClass, 27 PoDoFo::PdfAscii85Filter, 49 PdfLocaleImbue, 35 BeginDecodeImpl, 50 podofo_free, 36 BeginEncodeImpl, 50 podofo_is_little_endian, 36 CanDecode, 50 podofo_malloc, 36 CanEncode, 51 podofo_realloc, 36 DecodeBlockImpl, 51 PoDoFo::MD5Context, 37 EncodeBlockImpl, 51 PoDoFo::NamedColorComparatorPredicate, EndDecodeImpl, 52 37 EndEncodeImpl, 52 PoDoFo::NonPublic::PdfTTFWriter, 446 GetType, 52 PdfTTFWriter, 446 PoDoFo::PdfAxialShadingPattern, 53 Read, 447 PdfAxialShadingPattern, 53 Subset, 447 PoDoFo::PdfBufferOutputStream, 54 Write, 447 Close, 55 PoDoFo::PdfAction, 38 GetLength, 55 AddToDictionary, 40 PdfBufferOutputStream, 55 GetType, 40 Write, 55 GetURI, 40 PoDoFo::PdfCanvas, 56 HasURI, 40 PdfCanvas, 56 PdfAction, 39 AddColorResource, 57 SetURI, 40 AddResource, 57 PoDoFo::PdfAnnotation, 41 GetContents, 57 GetAction, 42 GetContentsForAppending, 57 GetColor, 43 GetPageSize, 57 GetContents, 43 GetProcSet, 58 GetDestination, 43 GetResources, 58 GetFileAttachement, 43 PoDoFo::PdfCheckBox, 58 GetFlags, 44 IsChecked, 59 GetOpen, 44 PdfCheckBox, 59 GetPage, 44 SetAppearanceChecked, 59 GetQuadPoints, 44 SetAppearanceUnchecked, 60 GetRect, 44 SetChecked, 60 GetTitle, 45 PoDoFo::PdfColor, 60 GetType, 45 PdfColor, 62 HasAction, 45 BuildColorSpace, 63 HasAppearanceStream, 45 ConvertToCMYK, 63 HasDestination, 45 ConvertToGrayScale, 63 HasFileAttachement, 45 ConvertToRGB, 63 PdfAnnotation, 42 FromArray, 64 SetAction, 46 FromString, 64 SetAppearanceStream, 46 GetAlternateColorSpace, 64 SetBorderStyle, 46 GetBlack, 65 SetColor, 47 GetBlue, 65 SetContents, 47 GetCieA, 65 SetDestination, 48 GetCieB, 65
521
522 GetCieL, 66 GetColorSpace, 66 GetColorSpaceForName, 66 GetCyan, 66 GetDensity, 67 GetGrayScale, 67 GetGreen, 67 GetMagenta, 68 GetName, 68 GetNameForColorSpace, 68 GetRed, 68 GetYellow, 69 IsCieLab, 69 IsCMYK, 69 IsGrayScale, 69 IsRGB, 69 IsSeparation, 70 operator=, 70 operator==, 70 PdfColor, 62 ToArray, 71 PoDoFo::PdfComboBox, 71 IsEditable, 72 PdfComboBox, 72 SetEditable, 72 PoDoFo::PdfContents, 73 PdfContents, 74 GetContents, 74 GetContentsForAppending, 74 PdfContents, 73 PoDoFo::PdfContentsTokenizer, 74 GetNextToken, 75 PdfContentsTokenizer, 75 ReadNext, 76 PoDoFo::PdfData, 77 data, 78 operator=, 78 PdfData, 77, 78 Write, 78 PoDoFo::PdfDataType, 79 AssertMutable, 80 GetImmutable, 80 IsDirty, 80 PdfDataType, 80 SetDirty, 80 SetImmutable, 80 Write, 81 PoDoFo::PdfDate, 81 PdfDate, 82 GetTime, 82
INDEX IsValid, 82 PdfDate, 82 ToString, 82 PoDoFo::PdfDestination, 83 AddToDictionary, 86 GetArray, 86 GetDValue, 86 GetLeft, 86 GetObject, 86, 87 GetPage, 87 GetRect, 87 GetTop, 88 GetType, 88 GetZoom, 88 operator=, 88 PdfDestination, 84, 85 PoDoFo::PdfDeviceInputStream, 89 PdfDeviceInputStream, 89 Read, 89 PoDoFo::PdfDeviceOutputStream, 90 Close, 90 PdfDeviceOutputStream, 90 Write, 91 PoDoFo::PdfDifferenceEncoding, 91 AddToDictionary, 94 ConvertToEncoding, 94 ConvertToUnicode, 94 EBaseEncoding, 92 eBaseEncoding_Font, 92 eBaseEncoding_MacExpert, 92 eBaseEncoding_MacRoman, 92 eBaseEncoding_WinAnsi, 92 GetCharCode, 95 GetDifferences, 95 GetID, 95 IsAutoDelete, 95 IsSingleByteEncoding, 96 NameToUnicodeID, 96 PdfDifferenceEncoding, 92, 93 UnicodeIDToName, 96 PoDoFo::PdfDocEncoding, 96 GetToUnicodeTable, 97 PdfDocEncoding, 97 PoDoFo::PdfDocument, 98 PdfDocument, 100 AddNamedDestination, 100 Append, 101 AttachFile, 101 Clear, 101 CreateDuplicateFontType1, 101
INDEX CreateFont, 101, 102 CreateFontSubset, 103 CreatePage, 103 EmbedSubsetFonts, 104 FillXObjectFromDocumentPage, 104 FixObjectReferences, 104 GetAcroForm, 104 GetCatalog, 105 GetFontLibrary, 105 GetInfo, 105 GetNamedObjectFromCatalog, 106 GetNamesTree, 106 GetObjects, 106 GetOutlines, 107 GetPage, 107 GetPageCount, 107 GetPageMode, 107 GetPagesTree, 108 GetPdfVersion, 108 GetTrailer, 108 GetWriteMode, 108 InitPagesTree, 109 IsAccessibilityAllowed, 109 IsCopyAllowed, 109 IsDocAssemblyAllowed, 109 IsEditAllowed, 110 IsEditNotesAllowed, 110 IsFillAndSignAllowed, 110 IsHighPrintAllowed, 111 IsLinearized, 111 IsPrintAllowed, 111 PdfDocument, 100 SetBaseURI, 112 SetBindingDirection, 112 SetCatalog, 112 SetCenterWindow, 112 SetDisplayDocTitle, 112 SetFitWindow, 112 SetHideMenubar, 112 SetHideToolbar, 113 SetHideWindowUI, 113 SetInfo, 113 SetLanguage, 113 SetPageLayout, 113 SetPageMode, 113 SetPrintScaling, 113 SetTrailer, 114 SetUseFullScreen, 114 SetViewerPreference, 114
523 PoDoFo::PdfElement, 114 CreateObject, 117 GetNonConstObject, 117 GetObject, 117, 118 PdfElement, 116, 117 TypeNameForIndex, 118 TypeNameToIndex, 118 PoDoFo::PdfEncoding, 119 AddToDictionary, 120 begin, 120 ConvertToEncoding, 120 ConvertToUnicode, 121 end, 121 GetCharCode, 121 GetFirstChar, 122 GetID, 122 GetLastChar, 122 IsAutoDelete, 122 IsSingleByteEncoding, 122 operator<, 123 operator==, 123 PdfEncoding, 120 PoDoFo::PdfEncodingDifference, 123 AddDifference, 124 Contains, 124 GetCount, 125 operator=, 125 PdfEncodingDifference, 124 ToArray, 125 PoDoFo::PdfEncodingFactory, 125 FreeGlobalEncodingInstances, 126 GlobalMacExpertEncodingInstance, 126 GlobalMacRomanEncodingInstance, 126 GlobalPdfDocEncodingInstance, 126 GlobalStandardEncodingInstance, 127 GlobalSymbolEncodingInstance, 127 GlobalWinAnsiEncodingInstance, 127 GlobalZapfDingbatsEncodingInstance, 127 PoDoFo::PdfEncodingObjectFactory, 128 CreateEncoding, 128 PoDoFo::PdfEncrypt, 128 PdfEncrypt, 133
524 Authenticate, 133 CreateEncryptionDictionary, 133 CreateEncryptionInputStream, 134 CreateEncryptionOutputStream, 134 CreateObjKey, 134 CreatePdfEncrypt, 134, 135 EPdfEncryptAlgorithm, 132 ePdfEncryptAlgorithm_AESV2, 132 ePdfEncryptAlgorithm_RC4V1, 132 ePdfEncryptAlgorithm_RC4V2, 132 EPdfKeyLength, 132 EPdfPermissions, 132 ePdfPermissions_Accessible, 133 ePdfPermissions_Copy, 133 ePdfPermissions_DocAssembly, 133 ePdfPermissions_Edit, 133 ePdfPermissions_EditNotes, 133 ePdfPermissions_FillAndSign, 133 ePdfPermissions_HighPrint, 133 ePdfPermissions_Print, 133 GenerateEncryptionKey, 136 GetEnabledEncryptionAlgorithms, 136 GetEncryptAlgorithm, 136 GetMD5String, 136 IsAccessibilityAllowed, 137 IsCopyAllowed, 137 IsDocAssemblyAllowed, 137 IsEditAllowed, 137 IsEditNotesAllowed, 138 IsEncryptionEnabled, 138 IsFillAndSignAllowed, 138 IsHighPrintAllowed, 139 IsPrintAllowed, 139 operator=, 139 RC4, 139 SetCurrentReference, 139 SetEnabledEncryptionAlgorithms, 140 PoDoFo::PdfEncryptAES, 140 CreateEncryptionDictionary, 141 CreateEncryptionInputStream, 141 CreateEncryptionOutputStream, 141 PoDoFo::PdfEncryptRC4, 142 CreateEncryptionDictionary, 143 CreateEncryptionInputStream, 143 CreateEncryptionOutputStream, 143 PoDoFo::PdfError, 144 AddToCallstack, 145
INDEX DebugEnabled, 146 DebugMessage, 146 EnableDebug, 146 EnableLogging, 146 ErrorMessage, 146 ErrorName, 147 GetCallstack, 147 GetError, 147 IsError, 147 LoggingEnabled, 147 LogMessage, 147, 148 operator=, 148, 149 operator==, 149 PdfError, 145 PrintErrorMsg, 149 SetError, 150 SetErrorInformation, 150 SetLogMessageCallback, 150 what, 151 PoDoFo::PdfExponentialFunction, 151 PdfExponentialFunction, 152 PoDoFo::PdfExtGState, 152 GetIdentier, 154 PdfExtGState, 153 SetBlendMode, 154 SetFillOpacity, 154 SetFillOverprint, 154 SetFrequency, 154 SetNonZeroOverprint, 154 SetOverprint, 155 SetRenderingIntent, 155 SetStrokeOpacity, 155 SetStrokeOverprint, 155 PoDoFo::PdfFileInputStream, 155 GetFileLength, 156 PdfFileInputStream, 156 Read, 156 PoDoFo::PdfFileOutputStream, 157 Close, 158 PdfFileOutputStream, 157 Write, 158 PoDoFo::PdfFileSpec, 158 GetFilename, 159 PdfFileSpec, 159 PoDoFo::PdfFileStream, 159 AppendImpl, 160 BeginAppendImpl, 161 EndAppendImpl, 161 GetCopy, 161 GetInternalBuffer, 162
INDEX GetInternalBufferSize, 162 GetLength, 162 PdfFileStream, 160 SetEncrypted, 162 Write, 162 PoDoFo::PdfFilter, 163 PdfFilter, 164 BeginDecode, 164 BeginDecodeImpl, 164 BeginEncode, 165 BeginEncodeImpl, 165 CanDecode, 166 CanEncode, 166 Decode, 166 DecodeBlock, 166 DecodeBlockImpl, 167 Encode, 167 EncodeBlock, 168 EncodeBlockImpl, 168 EndDecode, 169 EndDecodeImpl, 169 EndEncode, 169 EndEncodeImpl, 169 FailEncodeDecode, 170 GetType, 170 PdfFilter, 164 PoDoFo::PdfFilteredDecodeStream, 170 Close, 172 PdfFilteredDecodeStream, 171 Write, 172 PoDoFo::PdfFilteredEncodeStream, 172 Close, 173 PdfFilteredEncodeStream, 173 Write, 173 PoDoFo::PdfFilterFactory, 173 Create, 174 CreateDecodeStream, 174 CreateEncodeStream, 175 CreateFilterList, 175 FilterNameToType, 175 FilterTypeToName, 176 PoDoFo::PdfFlateFilter, 176 BeginDecodeImpl, 177 BeginEncodeImpl, 177 CanDecode, 177 CanEncode, 178 DecodeBlockImpl, 178 EncodeBlockImpl, 178 EndDecodeImpl, 179 EndEncodeImpl, 179 GetType, 179 PoDoFo::PdfFont, 180 AddUsedGlyphname, 182 AddUsedSubsettingGlyphs, 182 EmbedFont, 182 EmbedSubsetFont, 182 GetBaseFont, 182 GetEncoding, 183 GetFontCharSpace, 183 GetFontMetrics, 183 GetFontMetrics2, 183 GetFontScale, 183 GetFontSize, 184 GetIdentier, 184 IsBold, 184 IsItalic, 184 IsStrikeOut, 184 IsSubsetting, 185 IsUnderlined, 185 PdfFont, 181 SetFontCharSpace, 185 SetFontScale, 185 SetFontSize, 185 SetStrikeOut, 185 SetUnderlined, 186 WriteStringToStream, 186 PoDoFo::PdfFontCache, 186 PdfFontCache, 188 EFontCreationFlags, 187 eFontCreationFlags_AutoSelectBase14, 187 eFontCreationFlags_None, 187 eFontCreationFlags_Type1Subsetting, 187 EmbedSubsetFonts, 188 EmptyCache, 188 GetDuplicateFontType1, 188 GetFont, 188, 189 GetFontLibrary, 189 GetFontSubset, 190 PdfFontCache, 187 PoDoFo::PdfFontCID, 190 EmbedFont, 192 Init, 192 PdfFontCID, 191 PoDoFo::PdfFontFactory, 192 CreateFont, 193 CreateFontObject, 193 GetFontType, 193 PoDoFo::PdfFontMetrics, 194
525
526 CharWidth, 195 CharWidthMM, 195 FontTypeFromFilename, 196 GetAscent, 196 GetBoundingBox, 196 GetDescent, 196 GetFilename, 197 GetFontCharSpace, 197 GetFontData, 197 GetFontDataLen, 197 GetFontname, 197 GetFontScale, 198 GetFontSize, 198 GetFontType, 198 GetGlyphId, 198 GetGlyphWidth, 198, 199 GetItalicAngle, 199 GetLineSpacing, 199 GetLineSpacingMM, 199 GetPdfAscent, 200 GetPdfDescent, 200 GetStrikeOutPosition, 200 GetStrikeOutPositionMM, 200 GetStrikeoutThickness, 201 GetStrikeoutThicknessMM, 201 GetSubsetFontnamePrex, 201 GetUnderlinePosition, 201 GetUnderlinePositionMM, 201 GetUnderlineThickness, 201 GetUnderlineThicknessMM, 202 GetWeight, 202 GetWidthArray, 202 IsSymbol, 202 SetFontCharSpace, 202 SetFontScale, 203 SetFontSize, 203 SetFontType, 203 StringWidth, 203, 204 StringWidthMM, 204, 205 UnicodeCharWidth, 205 PoDoFo::PdfFontSimple, 206 EmbedFont, 207 EmbedFontFile, 207 Init, 208 PdfFontSimple, 207 PoDoFo::PdfFontTrueType, 208 PdfFontTrueType, 209 PoDoFo::PdfFontTTFSubset, 209 AddCharacter, 211 AddGlyph, 211
INDEX BuildFont, 211 EFontFileType, 210 eFontFileType_OTF, 210 eFontFileType_TTC, 210 eFontFileType_TTF, 210 eFontFileType_Unknown, 210 GetSize, 211 PdfFontTTFSubset, 210 PoDoFo::PdfFontType1, 212 AddUsedGlyphname, 213 AddUsedSubsettingGlyphs, 213 EmbedFontFile, 214 EmbedSubsetFont, 214 PdfFontType1, 212, 213 PoDoFo::PdfFontType1Base14, 214 EmbedFontFile, 216 PdfFontType1Base14, 215 PoDoFo::PdfFunction, 216 PdfFunction, 216, 217 PoDoFo::PdfFunctionBaseShadingPattern, 217 PdfFunctionBaseShadingPattern, 218 PoDoFo::PdfHexFilter, 219 BeginDecodeImpl, 219 CanDecode, 219 CanEncode, 220 DecodeBlockImpl, 220 EncodeBlockImpl, 220 EndDecodeImpl, 221 GetType, 221 PoDoFo::PdfIdentityEncoding, 221 AddToDictionary, 223 ConvertToEncoding, 223 ConvertToUnicode, 223 GetCharCode, 223 GetID, 224 IsAutoDelete, 224 IsSingleByteEncoding, 224 PdfIdentityEncoding, 222 PoDoFo::PdfImage, 225 GetHeight, 226 GetSupportedFormats, 226 GetWidth, 227 LoadFromFile, 227 PdfImage, 226 SetImageChromaKeyMask, 227 SetImageColorSpace, 227 SetImageData, 228 SetImageICCProle, 228
INDEX SetImageSoftmask, 229 SetInterpolate, 229 PoDoFo::PdfInfo, 229 PdfInfo, 231 EPdfInfoInitial, 230 ePdfInfoInitial_WriteCreationTime, 230 ePdfInfoInitial_WriteModicationTime, 230 ePdfInfoInitial_WriteProducer, 230 GetAuthor, 231 GetCreator, 231 GetKeywords, 231 GetProducer, 232 GetSubject, 232 GetTitle, 232 GetTrapped, 232 PdfInfo, 231 SetAuthor, 232 SetCreator, 233 SetKeywords, 233 SetProducer, 233 SetSubject, 233 SetTitle, 233 SetTrapped, 233 PoDoFo::PdfInputDevice, 234 PdfInputDevice, 235 Bad, 235 Clear, 236 Close, 236 Eof, 236 GetChar, 236 IsSeekable, 236 Look, 236 PdfInputDevice, 235 Read, 236 Seek, 237 SetSeekable, 237 Tell, 237 PoDoFo::PdfInputStream, 237 Read, 238 PoDoFo::PdfListBox, 238 PdfListBox, 239 PoDoFo::PdfListField, 239 GetItem, 241 GetItemCount, 241 GetItemDisplayText, 241 GetSelectedItem, 242 InsertItem, 242
527 IsComboBox, 242 IsMultiSelect, 242 IsSorted, 242 IsSpellcheckingEnabled, 243 PdfListField, 240, 241 RemoveItem, 243 SetMultiSelect, 243 SetSelectedItem, 243 SetSorted, 243 SetSpellcheckingEnabled, 243 PoDoFo::PdfLZWFilter, 244 BeginDecodeImpl, 244 BeginEncodeImpl, 245 CanDecode, 245 CanEncode, 245 DecodeBlockImpl, 245 EncodeBlockImpl, 246 EndDecodeImpl, 246 EndEncodeImpl, 247 GetType, 247 PoDoFo::PdfMacRomanEncoding, 247 GetToUnicodeTable, 248 PdfMacRomanEncoding, 248 PoDoFo::PdfMemDocument, 248 PdfMemDocument, 251 DeletePages, 251 FreeObjectMemory, 251 GetCatalog, 252 GetEncrypt, 252 GetEncrypted, 252 GetFont, 253 GetMarkInfo, 253 GetMetadata, 253 GetObjects, 253 GetPdfVersion, 254 GetStructTreeRoot, 254 GetTrailer, 254 GetWriteMode, 254 InsertPages, 254 IsAccessibilityAllowed, 255 IsCopyAllowed, 255 IsDocAssemblyAllowed, 255 IsEditAllowed, 256 IsEditNotesAllowed, 256 IsFillAndSignAllowed, 256 IsHighPrintAllowed, 257 IsLinearized, 257 IsPrintAllowed, 257 Load, 258 PdfMemDocument, 250
528 SetEncrypted, 259 SetPassword, 260 SetPdfVersion, 260 SetWriteMode, 260 Write, 260, 261 PoDoFo::PdfMemoryInputStream, 261 PdfMemoryInputStream, 262 Read, 262 PoDoFo::PdfMemoryOutputStream, 262 Close, 263 GetLength, 263 PdfMemoryOutputStream, 263 TakeBuffer, 264 Write, 264 PoDoFo::PdfMemStream, 264 AppendImpl, 266 BeginAppendImpl, 266 Empty, 266 EndAppendImpl, 266 FlateCompress, 266 Get, 267 GetCopy, 267 GetInternalBuffer, 267 GetInternalBufferSize, 268 GetLength, 268 operator=, 268 PdfMemStream, 265 Uncompress, 268 Write, 269 PoDoFo::PdfName, 272 FromEscaped, 274 GetEscapedName, 274 GetLength, 275 GetName, 275 operator<, 275 operator=, 276 operator==, 276 PdfName, 273, 274 Write, 277 PoDoFo::PdfNamedColor, 277 PdfNamedColor, 278 GetColor, 278 GetName, 278 operator<, 279 operator==, 279 PdfNamedColor, 278 PoDoFo::PdfObject, 279 DelayedStreamLoad, 283 DelayedStreamLoadImpl, 283 EnableDelayedStreamLoading, 284
INDEX FlateCompressStream, 284 GetByteOffset, 284 GetIndirectKey, 284 GetObjectLength, 285 GetOwner, 285 GetStream, 285 GetStream_NoDL, 286 HasStream, 286 MustGetIndirectKey, 286 operator<, 286 operator=, 286 operator==, 287 PdfObject, 281283 Reference, 287 SetOwner, 287 WriteObject, 287 PoDoFo::PdfObjectStreamParserObject, 288 PdfObjectStreamParserObject, 288 PoDoFo::PdfOutlineItem, 288 CreateChild, 291 CreateNext, 291 Erase, 291 First, 291 GetAction, 292 GetDestination, 292 GetParentOutline, 292 GetTextColorBlue, 292 GetTextColorGreen, 292 GetTextColorRed, 293 GetTextFormat, 293 GetTitle, 293 InsertChild, 293 Last, 293 Next, 294 PdfOutlineItem, 290 Prev, 294 SetAction, 294 SetDestination, 294 SetTextColor, 294 SetTextFormat, 294 SetTitle, 295 PoDoFo::PdfOutlines, 295 CreateRoot, 296 PdfOutlines, 296 PoDoFo::PdfOutputDevice, 296 PdfOutputDevice, 298 Flush, 298 GetLength, 298 PdfOutputDevice, 297, 298
INDEX Print, 299 PrintV, 299 PrintVLen, 299 Read, 300 Seek, 300 Tell, 300 Write, 301 PoDoFo::PdfOutputStream, 301 Close, 302 Write, 302 PoDoFo::PdfPage, 302 CreateAnnotation, 304 CreateStandardPageSize, 305 DeleteAnnotation, 305 GetAnnotation, 305 GetArtBox, 306 GetBleedBox, 306 GetContents, 306 GetContentsForAppending, 306 GetCropBox, 307 GetField, 307 GetFromResources, 307 GetInheritedKey, 308 GetMediaBox, 308 GetNumAnnots, 308 GetNumFields, 308 GetPageNumber, 308 GetPageSize, 309 GetResources, 309 GetRotation, 309 GetTrimBox, 309 PdfPage, 304 SetPageHeight, 309 SetPageWidth, 310 SetTrimBox, 310 PoDoFo::PdfPagesTree, 310 PdfPagesTree, 311 ClearCache, 311 CreatePage, 311 DeletePage, 312 GetPage, 312 GetTotalNumberOfPages, 313 InsertPage, 313 PdfPagesTree, 311 PoDoFo::PdfPagesTreeCache, 314 PdfPagesTreeCache, 314 AddPageObject, 314 ClearCache, 315 DeletePage, 315 GetPage, 315 InsertPage, 315 PdfPagesTreeCache, 314 PoDoFo::PdfPainter, 315 AddText, 318, 319 ArcTo, 319 BeginText, 319 Clip, 320 Close, 320 ClosePath, 320 CubicBezierTo, 320 DrawCircle, 321 DrawEllipse, 321 DrawGlyph, 321 DrawImage, 321 DrawLine, 322 DrawMultiLineText, 322 DrawRect, 323 DrawText, 323, 324 DrawTextAligned, 324 DrawXObject, 324 EndText, 325 ExpandTabs, 325 Fill, 325 FillCircle, 326 FillEllipse, 326 FillRect, 326 FinishPage, 327 GetFont, 327 GetMultiLineTextAsLines, 327 GetPage, 327 GetPrecision, 327 GetTabWidth, 328 HorizonalLineTo, 328 LineTo, 328 m_curColor, 337 m_isTextOpen, 337 m_nTabWidth, 337 m_oss, 337 m_pCanvas, 337 m_pFont, 337 m_pPage, 337 MoveTextPos, 328 MoveTo, 329 PdfPainter, 318 QuadCurveTo, 329 Restore, 329 Save, 329 SetClipRect, 330 SetColor, 330 SetColorCMYK, 331
529
530 SetCurrentStrokingColor, 331 SetExtGState, 331 SetFont, 331 SetGray, 332 SetLineCapStyle, 332 SetLineJoinStyle, 332 SetPage, 332 SetPrecision, 333 SetRenderingIntent, 333 SetShadingPattern, 333 SetStrokeStyle, 333 SetStrokeWidth, 334 SetStrokingColor, 334 SetStrokingColorCMYK, 334 SetStrokingGray, 334 SetStrokingShadingPattern, 335 SetTabWidth, 335 SetTransformationMatrix, 335 SmoothCurveTo, 336 SmoothQuadCurveTo, 336 Stroke, 336 VerticalLineTo, 336 PoDoFo::PdfPainterMM, 337 DrawEllipseMM, 338 DrawImageMM, 339 DrawLineMM, 339 DrawRectMM, 339 DrawTextMM, 339, 340 DrawXObjectMM, 340 FillEllipseMM, 340 FillRectMM, 341 LineToMM, 341 MoveToMM, 341 PdfPainterMM, 338 SetStrokeWidthMM, 341 PoDoFo::PdfParser, 342 PdfParser, 345 CheckEOFMarker, 345 FindToken, 345 FindToken2, 345 GetEncrypt, 346 GetEncrypted, 346 GetFileSize, 346 GetIgnoreBrokenObjects, 346 GetLoadOnDemand, 346 GetNumberOfIncrementalUpdates, 346 GetObjects, 347 GetPdfVersion, 347 GetPdfVersionString, 347
INDEX GetTrailer, 347 HasLinearizationDict, 347 IsLinearized, 347 IsPdfFile, 347 IsStrictParsing, 348 MergeTrailer, 348 ParseFile, 348, 349 PdfParser, 343, 344 QuickEncryptedCheck, 349 ReadDocumentStructure, 349 ReadObjectFromStream, 350 ReadObjects, 350 ReadObjectsInternal, 350 ReadTrailer, 350 ReadXRef, 350 ReadXRefContents, 351 ReadXRefStreamContents, 351 ReadXRefSubsection, 351 SetIgnoreBrokenObjects, 351 SetPassword, 352 SetStrictParsing, 352 TakeEncrypt, 352 PoDoFo::PdfParserObject, 353 DelayedLoadImpl, 354 DelayedStreamLoadImpl, 354 FreeObjectMemory, 354 HasStreamToParse, 355 IsLoadOnDemand, 355 ParseFile, 355 ParseStream, 355 PdfParserObject, 354 SetLoadOnDemand, 356 SetObjectNumber, 356 PoDoFo::PdfPredictorDecoder, 356 PoDoFo::PdfPushButton, 356 GetAlternateCaption, 358 GetRolloverCaption, 358 PdfPushButton, 357 SetAlternateCaption, 358 SetRolloverCaption, 358 PoDoFo::PdfRadialShadingPattern, 358 PdfRadialShadingPattern, 359 PoDoFo::PdfRC4InputStream, 360 Read, 360 PoDoFo::PdfRC4OutputStream, 361 Close, 361 Write, 361 PoDoFo::PdfRC4Stream, 362 Encrypt, 362 PoDoFo::PdfRect, 362
INDEX FromArray, 363 GetBottom, 364 GetHeight, 364 GetLeft, 364 GetWidth, 364 Intersect, 364 PdfRect, 363 SetBottom, 364 SetHeight, 365 SetLeft, 365 SetWidth, 365 ToString, 365 ToVariant, 365 PoDoFo::PdfRefCountedBuffer, 366 PdfRefCountedBuffer, 367 GetBuffer, 367 GetSize, 367 operator<, 367 operator>, 368 operator=, 368 operator==, 368 PdfRefCountedBuffer, 366, 367 Resize, 368 SetTakePossesion, 369 TakePossesion, 369 PoDoFo::PdfRefCountedInputDevice, 369 PdfRefCountedInputDevice, 371 Device, 371 operator=, 371 PdfRefCountedInputDevice, 370 PoDoFo::PdfReference, 371 GenerationNumber, 373 IsIndirect, 373 ObjectNumber, 373 operator<, 374 operator=, 374 operator==, 374 PdfReference, 372, 373 SetGenerationNumber, 374 SetObjectNumber, 374 ToString, 375 Write, 375 PoDoFo::PdfRijndael, 375 PoDoFo::PdfRLEFilter, 376 BeginDecodeImpl, 376 BeginEncodeImpl, 376 CanDecode, 377 CanEncode, 377 DecodeBlockImpl, 377 EncodeBlockImpl, 378 EndEncodeImpl, 378 GetType, 378 PoDoFo::PdfSampledFunction, 379 PdfSampledFunction, 379, 380 PoDoFo::PdfShadingPattern, 380 GetIdentier, 381 PdfShadingPattern, 381 PoDoFo::PdfSignatureField, 382 PdfSignatureField, 382 SetSignature, 382 SetSignatureDate, 382 SetSignatureReason, 383 PoDoFo::PdfSignOutputDevice, 383 AdjustByteRange, 384 Flush, 384 GetLength, 384 GetSignatureBeacon, 384 GetSignatureSize, 384 Print, 385 Read, 385 ReadForSignature, 385 Seek, 385 SetSignature, 386 SetSignatureSize, 386 Tell, 386 Write, 386 PoDoFo::PdfSimpleEncoding, 387 AddToDictionary, 388 ConvertToEncoding, 388 ConvertToUnicode, 389 GetCharCode, 389 GetID, 389 GetName, 390 GetToUnicodeTable, 390 IsAutoDelete, 390 IsSingleByteEncoding, 391 PoDoFo::PdfSimpleTableModel, 391 GetAlignment, 392 GetBackgroundColor, 393 GetBorderColor, 393 GetBorderWidth, 393 GetFont, 393 GetForegroundColor, 394 GetImage, 394 GetText, 394 GetVerticalAlignment, 394 HasBackgroundColor, 395 HasBorders, 395 HasImage, 395
531
532 HasWordWrap, 395 PdfSimpleTableModel, 392 SetAlignment, 396 SetBackgroundColor, 396 SetBackgroundEnabled, 396 SetBorderEnabled, 396 SetBorderWidth, 397 SetFont, 397 SetForegroundColor, 397 SetText, 397 SetWordWrapEnabled, 397 PoDoFo::PdfStandardEncoding, 398 GetToUnicodeTable, 399 PdfStandardEncoding, 398 PoDoFo::PdfStitchingFunction, 399 PdfStitchingFunction, 400 PoDoFo::PdfStream, 400 Append, 402, 403 AppendImpl, 403 BeginAppend, 403, 404 BeginAppendImpl, 404 EndAppend, 404 EndAppendImpl, 405 GetCopy, 405 GetFilteredCopy, 405, 406 GetInternalBuffer, 406 GetInternalBufferSize, 406 GetLength, 406 IsAppending, 406 operator=, 407 PdfStream, 402 Set, 407, 408 SetRawData, 408 Write, 408 PoDoFo::PdfStreamedDocument, 409 Close, 411 GetPdfVersion, 411 GetWriteMode, 411 IsAccessibilityAllowed, 411 IsCopyAllowed, 412 IsDocAssemblyAllowed, 412 IsEditAllowed, 412 IsEditNotesAllowed, 413 IsFillAndSignAllowed, 413 IsHighPrintAllowed, 413 IsLinearized, 414 IsPrintAllowed, 414 PdfStreamedDocument, 410 PoDoFo::PdfString, 414 GetCharacterLength, 418
INDEX GetLength, 418 GetString, 418 GetStringUtf8, 419 GetUnicode, 419 GetUnicodeLength, 419 IsHex, 420 IsUnicode, 420 IsValid, 420 operator<, 421 operator>, 422 operator=, 421 operator==, 421 PdfString, 416418 SetHexData, 422 ToUnicode, 422 Write, 423 PoDoFo::PdfSymbolEncoding, 423 GetToUnicodeTable, 424 PdfSymbolEncoding, 424 PoDoFo::PdfTable, 424 CalculateTableSize, 426 CheckForNewPage, 426 CreatePageCallback, 425 Draw, 427 DrawHorizontalBorders, 427 GetAutoPageBreak, 427 GetCols, 428 GetHeight, 428 GetModel, 428 GetRows, 428 GetWidth, 428 PdfTable, 426 SetAutoPageBreak, 429 SetColumnWidth, 429 SetColumnWidths, 429 SetModel, 430 SetRowHeight, 430 SetRowHeights, 430 SetTableHeight, 431 SetTableWidth, 431 PoDoFo::PdfTableModel, 431 GetAlignment, 432 GetBackgroundColor, 432 GetBorderColor, 432 GetBorderWidth, 433 GetFont, 433 GetForegroundColor, 433 GetImage, 433 GetText, 434 GetVerticalAlignment, 434
INDEX HasBackgroundColor, 434 HasBorders, 435 HasImage, 435 HasWordWrap, 435 PoDoFo::PdfTextField, 435 GetMaxLen, 437 GetText, 437 IsCombs, 437 IsFileField, 437 IsMultiLine, 437 IsPasswordField, 438 IsRichText, 438 IsScrollBarsEnabled, 438 IsSpellcheckingEnabled, 438 PdfTextField, 436, 437 SetCombs, 438 SetFileField, 438 SetMaxLen, 439 SetMultiLine, 439 SetPasswordField, 439 SetRichText, 439 SetScrollBarsEnabled, 440 SetSpellcheckingEnabled, 440 SetText, 440 PoDoFo::PdfTokenizer, 440 DetermineDataType, 441 GetHexValue, 442 GetNextNumber, 442 GetNextToken, 442 GetNextVariant, 443 HEX_NOT_FOUND, 446 IsDelimiter, 443 IsNextToken, 443 IsPrintable, 444 IsRegular, 444 IsWhitespace, 444 QuequeToken, 444 ReadArray, 444 ReadDictionary, 445 ReadHexString, 445 ReadName, 445 ReadString, 445 PoDoFo::PdfType1Encrypt, 447 Decrypt, 448 Encrypt, 448 PdfType1Encrypt, 448 PoDoFo::PdfVariant, 448 AssertMutable, 453 Clear, 453 DelayedLoad, 453 DelayedLoadDone, 453 DelayedLoadImpl, 453 EnableDelayedLoading, 453 GetArray, 454 GetArray_NoDL, 454 GetBool, 454 GetDataType, 455 GetDataTypeString, 455 GetDictionary, 455 GetDictionary_NoDL, 455 GetImmutable, 456 GetName, 456 GetNumber, 456 GetRawData, 456 GetReal, 457 GetReference, 457 GetString, 457 IsArray, 457 IsBool, 457 IsDictionary, 457 IsDirty, 458 IsEmpty, 458 IsHexString, 458 IsName, 458 IsNull, 458 IsNumber, 458 IsRawData, 459 IsReal, 459 IsReference, 459 IsString, 459 operator=, 459 operator==, 460 PdfVariant, 451, 452 SetBool, 460 SetDirty, 460 SetImmutable, 460 SetNumber, 460 SetReal, 461 ToString, 461 Write, 461 PoDoFo::PdfVecObjects, 462 AddFreeObject, 463 Attach, 463 AutoDelete, 464 begin, 464 BeginAppendStream, 464 Clear, 464 CollectGarbage, 465 CreateObject, 465 CreateStream, 465, 466
533
534 Detach, 466 end, 466 EndAppendStream, 466 Finish, 467 GetBack, 467 GetFreeObjects, 467 GetIndex, 467 GetObject, 467 GetObjectCount, 468 GetObjectDependencies, 468 GetParentDocument, 468 GetSize, 468 PdfVecObjects, 463 push_back, 468 RemoveObject, 468, 469 RenumberObjects, 469 Reserve, 469 SetAutoDelete, 470 SetParentDocument, 470 SetStreamFactory, 470 Sort, 470 WriteObject, 470 PoDoFo::PdfVecObjects::Observer, 37 BeginAppendStream, 38 EndAppendStream, 38 ParentDestructed, 38 PoDoFo::PdfVecObjects::StreamFactory, 490 CreateStream, 491 PoDoFo::PdfWinAnsiEncoding, 471 GetToUnicodeTable, 472 PdfWinAnsiEncoding, 471 PoDoFo::PdfWriter, 472 CreateFileIdentier, 474 FillTrailerObject, 474 GetByteOffset, 474 GetEncrypted, 474 GetLinearized, 475 GetPdfVersion, 475 GetPdfVersionString, 475 GetUseXRefStream, 475 GetWriteMode, 475 m_vecObjects, 478 PdfWriter, 473 SetEncrypted, 475 SetLinearized, 476 SetPdfVersion, 476 SetUseXRefStream, 476 SetWriteMode, 476 Write, 476, 477
INDEX WritePdfHeader, 477 WritePdfObjects, 477 WriteToBuffer, 477 PoDoFo::PdfXObject, 478 GetContents, 480 GetContentsForAppending, 480 GetIdentier, 481 GetObjectReference, 481 GetPageSize, 481 GetResources, 481 PdfXObject, 479, 480 PoDoFo::PdfXRef, 482 PdfXRef, 483 AddObject, 483 BeginWrite, 483 EndWrite, 483 GetOffset, 483 GetSize, 484 PdfXRef, 483 Write, 484 WriteSubSection, 484 WriteXRefEntry, 484 PoDoFo::PdfXRefStream, 485 PdfXRefStream, 486 BeginWrite, 486 EndWrite, 486 GetOffset, 486 PdfXRefStream, 486 WriteSubSection, 487 WriteXRefEntry, 487 PoDoFo::PdfXRefStreamParserObject, 487 GetPreviousOffset, 489 HasPrevious, 489 PdfXRefStreamParserObject, 488 PoDoFo::PdfZapfDingbatsEncoding, 489 GetToUnicodeTable, 490 PdfZapfDingbatsEncoding, 490 PoDoFo::TFontCacheElement, 491 PoDoFo::Util::PdfMutexImpl, 269 Lock, 270 PdfMutexImpl, 270 TryLock, 270 UnLock, 271 PoDoFo::Util::PdfMutexWrapper, 271 PdfMutexWrapper, 272 PdfMutexWrapper, 272 podofo_free PoDoFo, 36 podofo_is_little_endian
INDEX PoDoFo, 36 PODOFO_MAKE_VERSION_REAL PdfDenes.h, 495 PODOFO_MAKE_VERSION_STR_REAL PdfDenes.h, 495 podofo_malloc PoDoFo, 36 PODOFO_RAISE_ERROR PdfError.h, 497 PODOFO_RAISE_ERROR_INFO PdfError.h, 497 PODOFO_RAISE_LOGIC_IF PdfError.h, 497 podofo_realloc PoDoFo, 36 Prev PoDoFo::PdfOutlineItem, 294 Print PoDoFo::PdfOutputDevice, 299 PoDoFo::PdfSignOutputDevice, 385 PrintErrorMsg PoDoFo::PdfError, 149 PrintV PoDoFo::PdfOutputDevice, 299 PrintVLen PoDoFo::PdfOutputDevice, 299 push_back PoDoFo::PdfVecObjects, 468 QuadCurveTo PoDoFo::PdfPainter, 329 QuequeToken PoDoFo::PdfTokenizer, 444 QuickEncryptedCheck PoDoFo::PdfParser, 349 RC4 PoDoFo::PdfEncrypt, 139 Read PoDoFo::NonPublic::PdfTTFWriter, 447 PoDoFo::PdfDeviceInputStream, 89 PoDoFo::PdfFileInputStream, 156 PoDoFo::PdfInputDevice, 236 PoDoFo::PdfInputStream, 238 PoDoFo::PdfMemoryInputStream, 262 PoDoFo::PdfOutputDevice, 300 PoDoFo::PdfRC4InputStream, 360
535 PoDoFo::PdfSignOutputDevice, 385 ReadArray PoDoFo::PdfTokenizer, 444 ReadDictionary PoDoFo::PdfTokenizer, 445 ReadDocumentStructure PoDoFo::PdfParser, 349 ReadForSignature PoDoFo::PdfSignOutputDevice, 385 ReadHexString PoDoFo::PdfTokenizer, 445 ReadName PoDoFo::PdfTokenizer, 445 ReadNext PoDoFo::PdfContentsTokenizer, 76 ReadObjectFromStream PoDoFo::PdfParser, 350 ReadObjects PoDoFo::PdfParser, 350 ReadObjectsInternal PoDoFo::PdfParser, 350 ReadString PoDoFo::PdfTokenizer, 445 ReadTrailer PoDoFo::PdfParser, 350 ReadXRef PoDoFo::PdfParser, 350 ReadXRefContents PoDoFo::PdfParser, 351 ReadXRefStreamContents PoDoFo::PdfParser, 351 ReadXRefSubsection PoDoFo::PdfParser, 351 Reference PoDoFo::PdfObject, 287 RemoveItem PoDoFo::PdfListField, 243 RemoveObject PoDoFo::PdfVecObjects, 468, 469 RenumberObjects PoDoFo::PdfVecObjects, 469 Reserve PoDoFo::PdfVecObjects, 469 Resize PoDoFo::PdfRefCountedBuffer, 368 Restore PoDoFo::PdfPainter, 329 Save PoDoFo::PdfPainter, 329
536 Seek PoDoFo::PdfInputDevice, 237 PoDoFo::PdfOutputDevice, 300 PoDoFo::PdfSignOutputDevice, 385 Set PoDoFo::PdfStream, 407, 408 SetAction PoDoFo::PdfAnnotation, 46 PoDoFo::PdfOutlineItem, 294 SetAlignment PoDoFo::PdfSimpleTableModel, 396 SetAlternateCaption PoDoFo::PdfPushButton, 358 SetAppearanceChecked PoDoFo::PdfCheckBox, 59 SetAppearanceStream PoDoFo::PdfAnnotation, 46 SetAppearanceUnchecked PoDoFo::PdfCheckBox, 60 SetAuthor PoDoFo::PdfInfo, 232 SetAutoDelete PoDoFo::PdfVecObjects, 470 SetAutoPageBreak PoDoFo::PdfTable, 429 SetBackgroundColor PoDoFo::PdfSimpleTableModel, 396 SetBackgroundEnabled PoDoFo::PdfSimpleTableModel, 396 SetBaseURI PoDoFo::PdfDocument, 112 SetBindingDirection PoDoFo::PdfDocument, 112 SetBlendMode PoDoFo::PdfExtGState, 154 SetBool PoDoFo::PdfVariant, 460 SetBorderEnabled PoDoFo::PdfSimpleTableModel, 396 SetBorderStyle PoDoFo::PdfAnnotation, 46 SetBorderWidth PoDoFo::PdfSimpleTableModel, 397 SetBottom PoDoFo::PdfRect, 364
INDEX SetCatalog PoDoFo::PdfDocument, 112 SetCenterWindow PoDoFo::PdfDocument, 112 SetChecked PoDoFo::PdfCheckBox, 60 SetClipRect PoDoFo::PdfPainter, 330 SetColor PoDoFo::PdfAnnotation, 47 PoDoFo::PdfPainter, 330 SetColorCMYK PoDoFo::PdfPainter, 331 SetColumnWidth PoDoFo::PdfTable, 429 SetColumnWidths PoDoFo::PdfTable, 429 SetCombs PoDoFo::PdfTextField, 438 SetContents PoDoFo::PdfAnnotation, 47 SetCreator PoDoFo::PdfInfo, 233 SetCurrentReference PoDoFo::PdfEncrypt, 139 SetCurrentStrokingColor PoDoFo::PdfPainter, 331 SetDestination PoDoFo::PdfAnnotation, 48 PoDoFo::PdfOutlineItem, 294 SetDirty PoDoFo::PdfDataType, 80 PoDoFo::PdfVariant, 460 SetDisplayDocTitle PoDoFo::PdfDocument, 112 SetEditable PoDoFo::PdfComboBox, 72 SetEnabledEncryptionAlgorithms PoDoFo::PdfEncrypt, 140 SetEncrypted PoDoFo::PdfFileStream, 162 PoDoFo::PdfMemDocument, 259 PoDoFo::PdfWriter, 475 SetError PoDoFo::PdfError, 150 SetErrorInformation PoDoFo::PdfError, 150 SetExtGState PoDoFo::PdfPainter, 331 SetFileAttachement
INDEX PoDoFo::PdfAnnotation, 48 SetFileField PoDoFo::PdfTextField, 438 SetFillOpacity PoDoFo::PdfExtGState, 154 SetFillOverprint PoDoFo::PdfExtGState, 154 SetFitWindow PoDoFo::PdfDocument, 112 SetFlags PoDoFo::PdfAnnotation, 48 SetFont PoDoFo::PdfPainter, 331 PoDoFo::PdfSimpleTableModel, 397 SetFontCharSpace PoDoFo::PdfFont, 185 PoDoFo::PdfFontMetrics, 202 SetFontScale PoDoFo::PdfFont, 185 PoDoFo::PdfFontMetrics, 203 SetFontSize PoDoFo::PdfFont, 185 PoDoFo::PdfFontMetrics, 203 SetFontType PoDoFo::PdfFontMetrics, 203 SetForegroundColor PoDoFo::PdfSimpleTableModel, 397 SetFrequency PoDoFo::PdfExtGState, 154 SetGenerationNumber PoDoFo::PdfReference, 374 SetGray PoDoFo::PdfPainter, 332 SetHeight PoDoFo::PdfRect, 365 SetHexData PoDoFo::PdfString, 422 SetHideMenubar PoDoFo::PdfDocument, 112 SetHideToolbar PoDoFo::PdfDocument, 113 SetHideWindowUI PoDoFo::PdfDocument, 113 SetIgnoreBrokenObjects PoDoFo::PdfParser, 351 SetImageChromaKeyMask PoDoFo::PdfImage, 227 SetImageColorSpace PoDoFo::PdfImage, 227 SetImageData PoDoFo::PdfImage, 228 SetImageICCProle PoDoFo::PdfImage, 228 SetImageSoftmask PoDoFo::PdfImage, 229 SetImmutable PoDoFo::PdfDataType, 80 PoDoFo::PdfVariant, 460 SetInfo PoDoFo::PdfDocument, 113 SetInterpolate PoDoFo::PdfImage, 229 SetKeywords PoDoFo::PdfInfo, 233 SetLanguage PoDoFo::PdfDocument, 113 SetLeft PoDoFo::PdfRect, 365 SetLinearized PoDoFo::PdfWriter, 476 SetLineCapStyle PoDoFo::PdfPainter, 332 SetLineJoinStyle PoDoFo::PdfPainter, 332 SetLoadOnDemand PoDoFo::PdfParserObject, 356 SetLogMessageCallback PoDoFo::PdfError, 150 SetMaxLen PoDoFo::PdfTextField, 439 SetModel PoDoFo::PdfTable, 430 SetMultiLine PoDoFo::PdfTextField, 439 SetMultiSelect PoDoFo::PdfListField, 243 SetNonZeroOverprint PoDoFo::PdfExtGState, 154 SetNumber PoDoFo::PdfVariant, 460 SetObjectNumber PoDoFo::PdfParserObject, 356 PoDoFo::PdfReference, 374 SetOpen PoDoFo::PdfAnnotation, 48 SetOverprint PoDoFo::PdfExtGState, 155 SetOwner
537
538 PoDoFo::PdfObject, 287 SetPage PoDoFo::PdfPainter, 332 SetPageHeight PoDoFo::PdfPage, 309 SetPageLayout PoDoFo::PdfDocument, 113 SetPageMode PoDoFo::PdfDocument, 113 SetPageWidth PoDoFo::PdfPage, 310 SetParentDocument PoDoFo::PdfVecObjects, 470 SetPassword PoDoFo::PdfMemDocument, 260 PoDoFo::PdfParser, 352 SetPasswordField PoDoFo::PdfTextField, 439 SetPdfVersion PoDoFo::PdfMemDocument, 260 PoDoFo::PdfWriter, 476 SetPrecision PoDoFo::PdfPainter, 333 SetPrintScaling PoDoFo::PdfDocument, 113 SetProducer PoDoFo::PdfInfo, 233 SetQuadPoints PoDoFo::PdfAnnotation, 49 SetRawData PoDoFo::PdfStream, 408 SetReal PoDoFo::PdfVariant, 461 SetRenderingIntent PoDoFo::PdfExtGState, 155 PoDoFo::PdfPainter, 333 SetRichText PoDoFo::PdfTextField, 439 SetRolloverCaption PoDoFo::PdfPushButton, 358 SetRowHeight PoDoFo::PdfTable, 430 SetRowHeights PoDoFo::PdfTable, 430 SetScrollBarsEnabled PoDoFo::PdfTextField, 440 SetSeekable PoDoFo::PdfInputDevice, 237 SetSelectedItem PoDoFo::PdfListField, 243
INDEX SetShadingPattern PoDoFo::PdfPainter, 333 SetSignature PoDoFo::PdfSignatureField, 382 PoDoFo::PdfSignOutputDevice, 386 SetSignatureDate PoDoFo::PdfSignatureField, 382 SetSignatureReason PoDoFo::PdfSignatureField, 383 SetSignatureSize PoDoFo::PdfSignOutputDevice, 386 SetSorted PoDoFo::PdfListField, 243 SetSpellcheckingEnabled PoDoFo::PdfListField, 243 PoDoFo::PdfTextField, 440 SetStreamFactory PoDoFo::PdfVecObjects, 470 SetStrictParsing PoDoFo::PdfParser, 352 SetStrikeOut PoDoFo::PdfFont, 185 SetStrokeOpacity PoDoFo::PdfExtGState, 155 SetStrokeOverprint PoDoFo::PdfExtGState, 155 SetStrokeStyle PoDoFo::PdfPainter, 333 SetStrokeWidth PoDoFo::PdfPainter, 334 SetStrokeWidthMM PoDoFo::PdfPainterMM, 341 SetStrokingColor PoDoFo::PdfPainter, 334 SetStrokingColorCMYK PoDoFo::PdfPainter, 334 SetStrokingGray PoDoFo::PdfPainter, 334 SetStrokingShadingPattern PoDoFo::PdfPainter, 335 SetSubject PoDoFo::PdfInfo, 233 SetTableHeight PoDoFo::PdfTable, 431 SetTableWidth PoDoFo::PdfTable, 431 SetTabWidth PoDoFo::PdfPainter, 335 SetTakePossesion PoDoFo::PdfRefCountedBuffer, 369
INDEX SetText PoDoFo::PdfSimpleTableModel, 397 PoDoFo::PdfTextField, 440 SetTextColor PoDoFo::PdfOutlineItem, 294 SetTextFormat PoDoFo::PdfOutlineItem, 294 SetTitle PoDoFo::PdfAnnotation, 49 PoDoFo::PdfInfo, 233 PoDoFo::PdfOutlineItem, 295 SetTrailer PoDoFo::PdfDocument, 114 SetTransformationMatrix PoDoFo::PdfPainter, 335 SetTrapped PoDoFo::PdfInfo, 233 SetTrimBox PoDoFo::PdfPage, 310 SetUnderlined PoDoFo::PdfFont, 186 SetURI PoDoFo::PdfAction, 40 SetUseFullScreen PoDoFo::PdfDocument, 114 SetUseXRefStream PoDoFo::PdfWriter, 476 SetViewerPreference PoDoFo::PdfDocument, 114 SetWidth PoDoFo::PdfRect, 365 SetWordWrapEnabled PoDoFo::PdfSimpleTableModel, 397 SetWriteMode PoDoFo::PdfMemDocument, 260 PoDoFo::PdfWriter, 476 SmoothCurveTo PoDoFo::PdfPainter, 336 SmoothQuadCurveTo PoDoFo::PdfPainter, 336 Sort PoDoFo::PdfVecObjects, 470 StringWidth PoDoFo::PdfFontMetrics, 203, 204 StringWidthMM PoDoFo::PdfFontMetrics, 204, 205 Stroke PoDoFo::PdfPainter, 336
539 Subset PoDoFo::NonPublic::PdfTTFWriter, 447 TakeBuffer PoDoFo::PdfMemoryOutputStream, 264 TakeEncrypt PoDoFo::PdfParser, 352 TakePossesion PoDoFo::PdfRefCountedBuffer, 369 Tell PoDoFo::PdfInputDevice, 237 PoDoFo::PdfOutputDevice, 300 PoDoFo::PdfSignOutputDevice, 386 ToArray PoDoFo::PdfColor, 71 PoDoFo::PdfEncodingDifference, 125 ToString PoDoFo::PdfDate, 82 PoDoFo::PdfRect, 365 PoDoFo::PdfReference, 375 PoDoFo::PdfVariant, 461 ToUnicode PoDoFo::PdfString, 422 ToVariant PoDoFo::PdfRect, 365 TryLock PoDoFo::Util::PdfMutexImpl, 270 TypeNameForIndex PoDoFo::PdfElement, 118 TypeNameToIndex PoDoFo::PdfElement, 118 Uncompress PoDoFo::PdfMemStream, 268 UnicodeCharWidth PoDoFo::PdfFontMetrics, 205 UnicodeIDToName PoDoFo::PdfDifferenceEncoding, 96 UnLock PoDoFo::Util::PdfMutexImpl, 271 VerticalLineTo PoDoFo::PdfPainter, 336 what PoDoFo::PdfError, 151
540 Write PoDoFo::NonPublic::PdfTTFWriter, 447 PoDoFo::PdfBufferOutputStream, 55 PoDoFo::PdfData, 78 PoDoFo::PdfDataType, 81 PoDoFo::PdfDeviceOutputStream, 91 PoDoFo::PdfFileOutputStream, 158 PoDoFo::PdfFileStream, 162 PoDoFo::PdfFilteredDecodeStream, 172 PoDoFo::PdfFilteredEncodeStream, 173 PoDoFo::PdfMemDocument, 260, 261 PoDoFo::PdfMemoryOutputStream, 264 PoDoFo::PdfMemStream, 269 PoDoFo::PdfName, 277 PoDoFo::PdfOutputDevice, 301 PoDoFo::PdfOutputStream, 302 PoDoFo::PdfRC4OutputStream, 361 PoDoFo::PdfReference, 375 PoDoFo::PdfSignOutputDevice, 386 PoDoFo::PdfStream, 408 PoDoFo::PdfString, 423 PoDoFo::PdfVariant, 461 PoDoFo::PdfWriter, 476, 477 PoDoFo::PdfXRef, 484 WriteObject PoDoFo::PdfObject, 287 PoDoFo::PdfVecObjects, 470 WritePdfHeader PoDoFo::PdfWriter, 477 WritePdfObjects PoDoFo::PdfWriter, 477 WriteStringToStream PoDoFo::PdfFont, 186 WriteSubSection PoDoFo::PdfXRef, 484 PoDoFo::PdfXRefStream, 487 WriteToBuffer PoDoFo::PdfWriter, 477 WriteXRefEntry PoDoFo::PdfXRef, 484 PoDoFo::PdfXRefStream, 487
INDEX

Podofo

Uploaded by

Document Information

Original Description:

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Podofo

Uploaded by

Copyright:

Available Formats

PoDoFo

0.9.0 Generated by Doxygen 1.7.1

Class Index 4.1 Class Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Class Index 5.1 Class List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

File Index 6.1 File List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

ii 7.1.3.7 7.1.3.8 7.1.3.9

CONTENTS EPdfContentsType . . . . . . . . . . . . . . . . . . EPdfDataType . . . . . . . . . . . . . . . . . . . . EPdfDestinationType . . . . . . . . . . . . . . . . 28 28 29 29 31 31 32 32 32 33 33 33 33 33 34 34 34 35 35 35 35 35 35 36 36 36 36 36 36 37 37 37 37

Variable Documentation . . . . . . . . . . . . . . . . . . . . 7.1.5.1 ePdfVersion_Default . . . . . . . . . . . . . . . . .

PoDoFo::NamedColorComparatorPredicate Class Reference . . . . .

Generated on Mon Mar 14 2011 21:42:01 for PoDoFo by Doxygen

CONTENTS 8.2.1 8.3 Detailed Description . . . . . . . . . . . . . . . . . . . . . .

Generated on Mon Mar 14 2011 21:42:01 for PoDoFo by Doxygen

Generated on Mon Mar 14 2011 21:42:01 for PoDoFo by Doxygen

Member Function Documentation . . . . . . . . . . . . . . . 8.8.3.1 8.8.3.2 8.8.3.3 Close . . . . . . . . . . . . . . . . . . . . . . . . . GetLength . . . . . . . . . . . . . . . . . . . . . . Write . . . . . . . . . . . . . . . . . . . . . . . . .

Generated on Mon Mar 14 2011 21:42:01 for PoDoFo by Doxygen

Generated on Mon Mar 14 2011 21:42:01 for PoDoFo by Doxygen

Generated on Mon Mar 14 2011 21:42:01 for PoDoFo by Doxygen

Generated on Mon Mar 14 2011 21:42:01 for PoDoFo by Doxygen

Generated on Mon Mar 14 2011 21:42:01 for PoDoFo by Doxygen

Generated on Mon Mar 14 2011 21:42:01 for PoDoFo by Doxygen

Generated on Mon Mar 14 2011 21:42:01 for PoDoFo by Doxygen

Generated on Mon Mar 14 2011 21:42:01 for PoDoFo by Doxygen

Generated on Mon Mar 14 2011 21:42:01 for PoDoFo by Doxygen

Generated on Mon Mar 14 2011 21:42:01 for PoDoFo by Doxygen

Generated on Mon Mar 14 2011 21:42:01 for PoDoFo by Doxygen

Generated on Mon Mar 14 2011 21:42:01 for PoDoFo by Doxygen

Generated on Mon Mar 14 2011 21:42:01 for PoDoFo by Doxygen

Generated on Mon Mar 14 2011 21:42:01 for PoDoFo by Doxygen

Generated on Mon Mar 14 2011 21:42:01 for PoDoFo by Doxygen

Generated on Mon Mar 14 2011 21:42:01 for PoDoFo by Doxygen

Generated on Mon Mar 14 2011 21:42:01 for PoDoFo by Doxygen

Generated on Mon Mar 14 2011 21:42:01 for PoDoFo by Doxygen

Generated on Mon Mar 14 2011 21:42:01 for PoDoFo by Doxygen

Generated on Mon Mar 14 2011 21:42:01 for PoDoFo by Doxygen

Generated on Mon Mar 14 2011 21:42:01 for PoDoFo by Doxygen

Generated on Mon Mar 14 2011 21:42:01 for PoDoFo by Doxygen

Generated on Mon Mar 14 2011 21:42:01 for PoDoFo by Doxygen

Generated on Mon Mar 14 2011 21:42:01 for PoDoFo by Doxygen

Generated on Mon Mar 14 2011 21:42:01 for PoDoFo by Doxygen

Generated on Mon Mar 14 2011 21:42:01 for PoDoFo by Doxygen

Generated on Mon Mar 14 2011 21:42:01 for PoDoFo by Doxygen

Generated on Mon Mar 14 2011 21:42:01 for PoDoFo by Doxygen

lx 9.1.2.3 9.1.2.4 9.2

PdfFiltersPrivate.h File Reference . . . . . . . . . . . . . . . . . . . 9.3.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . .

Generated on Mon Mar 14 2011 21:42:01 for PoDoFo by Doxygen

Generated on Mon Mar 14 2011 21:42:01 for PoDoFo by Doxygen

Generated on Mon Mar 14 2011 21:42:01 for PoDoFo by Doxygen

Generated on Mon Mar 14 2011 21:42:01 for PoDoFo by Doxygen

Generated on Mon Mar 14 2011 21:42:01 for PoDoFo by Doxygen

Generated on Mon Mar 14 2011 21:42:01 for PoDoFo by Doxygen

Generated on Mon Mar 14 2011 21:42:01 for PoDoFo by Doxygen

Here is a list of all documented namespaces with brief descriptions: PoDoFo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Generated on Mon Mar 14 2011 21:42:01 for PoDoFo by Doxygen

Generated on Mon Mar 14 2011 21:42:01 for PoDoFo by Doxygen

Generated on Mon Mar 14 2011 21:42:01 for PoDoFo by Doxygen

Generated on Mon Mar 14 2011 21:42:01 for PoDoFo by Doxygen

Generated on Mon Mar 14 2011 21:42:01 for PoDoFo by Doxygen

Generated on Mon Mar 14 2011 21:42:01 for PoDoFo by Doxygen

class PdfEncrypt class PdfEncryptAES class PdfEncryptRC4 class PdfError

Class implementing the Rijndael cipher. (For internal use only).

Generated on Mon Mar 14 2011 21:42:01 for PoDoFo by Doxygen

ePdfError_InvalidDeviceOperation, ePdfError_UnexpectedEOF, ePdfError_OutOfMemory, ePdfError_ValueOutOfRange, ePdfError_InternalLogic, ePdfError_InvalidEnumValue, PageNotFound, ePdfError_NoPdfFile, ePdfError_-