Podofo 0.9.0
Total Page:16
File Type:pdf, Size:1020Kb
PoDoFo 0.9.0 Generated by Doxygen 1.7.1 Mon Mar 14 2011 21:42:01 Contents 1 Main Page1 2 (Codingstyle)3 3 Namespace Index9 3.1 Namespace List.............................9 4 Class Index 11 4.1 Class Hierarchy............................. 11 5 Class Index 15 5.1 Class List................................ 15 6 File Index 19 6.1 File List................................. 19 7 Namespace Documentation 21 7.1 PoDoFo Namespace Reference..................... 21 7.1.1 Detailed Description...................... 26 7.1.2 Typedef Documentation.................... 27 7.1.2.1 PdfArrayBaseClass................. 27 7.1.3 Enumeration Type Documentation............... 27 7.1.3.1 ELogSeverity.................... 27 7.1.3.2 EPdfAction..................... 27 7.1.3.3 EPdfAlignment................... 27 7.1.3.4 EPdfAnnotation................... 28 7.1.3.5 EPdfAnnotationFlags................ 28 7.1.3.6 EPdfColorSpace................... 28 ii CONTENTS 7.1.3.7 EPdfContentsType.................. 28 7.1.3.8 EPdfDataType.................... 28 7.1.3.9 EPdfDestinationType................ 29 7.1.3.10 EPdfError...................... 29 7.1.3.11 EPdfField...................... 31 7.1.3.12 EPdfFilter...................... 31 7.1.3.13 EPdfFontType.................... 32 7.1.3.14 EPdfFunctionType.................. 32 7.1.3.15 EPdfHighlightingMode............... 32 7.1.3.16 EPdfLineCapStyle.................. 33 7.1.3.17 EPdfLineJoinStyle.................. 33 7.1.3.18 EPdfOutlineFormat................. 33 7.1.3.19 EPdfPageLayout................... 33 7.1.3.20 EPdfPageMode................... 33 7.1.3.21 EPdfPageSize.................... 34 7.1.3.22 EPdfStrokeStyle................... 34 7.1.3.23 EPdfVersion..................... 34 7.1.3.24 EPdfVerticalAlignment............... 35 7.1.3.25 EPdfWriteMode................... 35 7.1.4 Function Documentation.................... 35 7.1.4.1 PDF_MAX..................... 35 7.1.4.2 PDF_MIN...................... 35 7.1.4.3 PdfLocaleImbue................... 35 7.1.4.4 podofo_free..................... 36 7.1.4.5 podofo_is_little_endian............... 36 7.1.4.6 podofo_malloc.................... 36 7.1.4.7 podofo_realloc.................... 36 7.1.5 Variable Documentation.................... 36 7.1.5.1 ePdfVersion_Default................. 36 8 Class Documentation 37 8.1 PoDoFo::MD5Context Struct Reference................ 37 8.1.1 Detailed Description...................... 37 8.2 PoDoFo::NamedColorComparatorPredicate Class Reference..... 37 Generated on Mon Mar 14 2011 21:42:01 for PoDoFo by Doxygen CONTENTS iii 8.2.1 Detailed Description...................... 37 8.3 PoDoFo::PdfVecObjects::Observer Class Reference.......... 37 8.3.1 Detailed Description...................... 38 8.3.2 Member Function Documentation............... 38 8.3.2.1 BeginAppendStream................. 38 8.3.2.2 EndAppendStream.................. 38 8.3.2.3 ParentDestructed................... 38 8.4 PoDoFo::PdfAction Class Reference.................. 38 8.4.1 Detailed Description...................... 39 8.4.2 Constructor & Destructor Documentation........... 39 8.4.2.1 PdfAction...................... 39 8.4.2.2 PdfAction...................... 39 8.4.2.3 PdfAction...................... 39 8.4.3 Member Function Documentation............... 40 8.4.3.1 AddToDictionary.................. 40 8.4.3.2 GetType....................... 40 8.4.3.3 GetURI....................... 40 8.4.3.4 HasURI....................... 40 8.4.3.5 SetURI........................ 40 8.5 PoDoFo::PdfAnnotation Class Reference............... 41 8.5.1 Detailed Description...................... 42 8.5.2 Constructor & Destructor Documentation........... 42 8.5.2.1 PdfAnnotation.................... 42 8.5.2.2 PdfAnnotation.................... 42 8.5.3 Member Function Documentation............... 42 8.5.3.1 GetAction...................... 42 8.5.3.2 GetColor....................... 43 8.5.3.3 GetContents..................... 43 8.5.3.4 GetDestination.................... 43 8.5.3.5 GetFileAttachement................. 44 8.5.3.6 GetFlags....................... 44 8.5.3.7 GetOpen....................... 44 8.5.3.8 GetPage....................... 44 8.5.3.9 GetQuadPoints.................... 44 Generated on Mon Mar 14 2011 21:42:01 for PoDoFo by Doxygen iv CONTENTS 8.5.3.10 GetRect....................... 45 8.5.3.11 GetTitle....................... 45 8.5.3.12 GetType....................... 45 8.5.3.13 HasAction...................... 45 8.5.3.14 HasAppearanceStream............... 45 8.5.3.15 HasDestination................... 45 8.5.3.16 HasFileAttachement................. 46 8.5.3.17 SetAction...................... 46 8.5.3.18 SetAppearanceStream................ 46 8.5.3.19 SetBorderStyle.................... 46 8.5.3.20 SetBorderStyle.................... 46 8.5.3.21 SetColor....................... 47 8.5.3.22 SetColor....................... 47 8.5.3.23 SetColor....................... 47 8.5.3.24 SetColor....................... 47 8.5.3.25 SetContents..................... 48 8.5.3.26 SetDestination.................... 48 8.5.3.27 SetFileAttachement................. 48 8.5.3.28 SetFlags....................... 48 8.5.3.29 SetOpen....................... 49 8.5.3.30 SetQuadPoints.................... 49 8.5.3.31 SetTitle........................ 49 8.6 PoDoFo::PdfAscii85Filter Class Reference.............. 49 8.6.1 Detailed Description...................... 50 8.6.2 Member Function Documentation............... 50 8.6.2.1 BeginDecodeImpl.................. 50 8.6.2.2 BeginEncodeImpl.................. 50 8.6.2.3 CanDecode..................... 51 8.6.2.4 CanEncode...................... 51 8.6.2.5 DecodeBlockImpl.................. 51 8.6.2.6 EncodeBlockImpl.................. 51 8.6.2.7 EndDecodeImpl................... 52 8.6.2.8 EndEncodeImpl................... 52 8.6.2.9 GetType....................... 52 Generated on Mon Mar 14 2011 21:42:01 for PoDoFo by Doxygen CONTENTS v 8.7 PoDoFo::PdfAxialShadingPattern Class Reference.......... 53 8.7.1 Detailed Description...................... 53 8.7.2 Constructor & Destructor Documentation........... 53 8.7.2.1 PdfAxialShadingPattern............... 53 8.7.2.2 PdfAxialShadingPattern............... 54 8.8 PoDoFo::PdfBufferOutputStream Class Reference........... 54 8.8.1 Detailed Description...................... 54 8.8.2 Constructor & Destructor Documentation........... 55 8.8.2.1 PdfBufferOutputStream............... 55 8.8.3 Member Function Documentation............... 55 8.8.3.1 Close......................... 55 8.8.3.2 GetLength...................... 55 8.8.3.3 Write......................... 55 8.9 PoDoFo::PdfCanvas Class Reference.................. 56 8.9.1 Detailed Description...................... 56 8.9.2 Constructor & Destructor Documentation........... 56 8.9.2.1 ∼PdfCanvas..................... 56 8.9.3 Member Function Documentation............... 57 8.9.3.1 AddColorResource................. 57 8.9.3.2 AddResource.................... 57 8.9.3.3 GetContents..................... 57 8.9.3.4 GetContentsForAppending............. 57 8.9.3.5 GetPageSize..................... 58 8.9.3.6 GetProcSet...................... 58 8.9.3.7 GetResources.................... 58 8.10 PoDoFo::PdfCheckBox Class Reference................ 58 8.10.1 Detailed Description...................... 59 8.10.2 Constructor & Destructor Documentation........... 59 8.10.2.1 PdfCheckBox.................... 59 8.10.2.2 PdfCheckBox.................... 59 8.10.2.3 PdfCheckBox.................... 59 8.10.2.4 PdfCheckBox.................... 59 8.10.2.5 PdfCheckBox.................... 59 8.10.3 Member Function Documentation............... 59 Generated on Mon Mar 14 2011 21:42:01 for PoDoFo by Doxygen vi CONTENTS 8.10.3.1 IsChecked...................... 59 8.10.3.2 SetAppearanceChecked............... 60 8.10.3.3 SetAppearanceUnchecked.............. 60 8.10.3.4 SetChecked..................... 60 8.11 PoDoFo::PdfColor Class Reference.................. 60 8.11.1 Detailed Description...................... 61 8.11.2 Constructor & Destructor Documentation........... 62 8.11.2.1 PdfColor....................... 62 8.11.2.2 PdfColor....................... 62 8.11.2.3 PdfColor....................... 62 8.11.2.4 PdfColor....................... 62 8.11.2.5 PdfColor....................... 62 8.11.2.6 ∼PdfColor...................... 63 8.11.3 Member Function Documentation............... 63 8.11.3.1 BuildColorSpace................... 63 8.11.3.2 ConvertToCMYK.................. 63 8.11.3.3 ConvertToGrayScale................. 63 8.11.3.4 ConvertToRGB................... 64 8.11.3.5 FromArray...................... 64 8.11.3.6 FromString...................... 64 8.11.3.7 GetAlternateColorSpace............... 65 8.11.3.8 GetBlack....................... 65 8.11.3.9 GetBlue....................... 65 8.11.3.10 GetCieA....................... 65 8.11.3.11 GetCieB....................... 66 8.11.3.12 GetCieL....................... 66 8.11.3.13 GetColorSpace.................... 66 8.11.3.14 GetColorSpaceForName............... 66 8.11.3.15 GetCyan....................... 67 8.11.3.16 GetDensity...................... 67 8.11.3.17 GetGrayScale.................... 67 8.11.3.18 GetGreen....................... 67 8.11.3.19 GetMagenta..................... 68 8.11.3.20 GetName....................... 68 Generated on Mon Mar 14 2011 21:42:01 for PoDoFo by Doxygen CONTENTS vii 8.11.3.21 GetNameForColorSpace............... 68 8.11.3.22 GetRed........................ 69 8.11.3.23 GetYellow...................... 69 8.11.3.24 IsCieLab....................... 69 8.11.3.25 IsCMYK....................... 69 8.11.3.26 IsGrayScale..................... 69 8.11.3.27