PoDoFo  0.9.6
Namespaces | Macros | Enumerations | Functions | Variables
PdfDefines.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

 PoDoFo
 

Macros

#define PODOFO_MAKE_VERSION_REAL(M, m, p)   ( (M<<16)+(m<<8)+(p) )
 
#define PODOFO_MAKE_VERSION_STR_REAL(M, m, p)   M ## . ## m ## . ## p
 
#define ePdfRenderingIntent_AbsoluteColorimetric   "AbsoluteColorimetric"
 
#define ePdfBlendMode_Normal   "Normal"
 

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 = 0xff
}
 
enum  PoDoFo::EPdfFilter {
  PoDoFo::ePdfFilter_None = -1 , PoDoFo::ePdfFilter_ASCIIHexDecode , PoDoFo::ePdfFilter_ASCII85Decode , ePdfFilter_LZWDecode ,
  PoDoFo::ePdfFilter_FlateDecode , PoDoFo::ePdfFilter_RunLengthDecode , ePdfFilter_CCITTFaxDecode , ePdfFilter_JBIG2Decode ,
  ePdfFilter_DCTDecode , ePdfFilter_JPXDecode , ePdfFilter_Crypt
}
 
enum  PoDoFo::EPdfFontType
 
enum  PoDoFo::EPdfColorSpace {
  PoDoFo::ePdfColorSpace_DeviceGray , PoDoFo::ePdfColorSpace_DeviceRGB , PoDoFo::ePdfColorSpace_DeviceCMYK , PoDoFo::ePdfColorSpace_Separation ,
  PoDoFo::ePdfColorSpace_CieLab , PoDoFo::ePdfColorSpace_Indexed , ePdfColorSpace_Unknown = 0xff
}
 
enum  PoDoFo::EPdfTextRenderingMode {
  PoDoFo::ePdfTextRenderingMode_Fill = 0 , PoDoFo::ePdfTextRenderingMode_Stroke , PoDoFo::ePdfTextRenderingMode_FillAndStroke , PoDoFo::ePdfTextRenderingMode_Invisible ,
  PoDoFo::ePdfTextRenderingMode_FillToClipPath , PoDoFo::ePdfTextRenderingMode_StrokeToClipPath , PoDoFo::ePdfTextRenderingMode_FillAndStrokeToClipPath , PoDoFo::ePdfTextRenderingMode_ToClipPath ,
  ePdfTextRenderingMode_Unknown = 0xff
}
 
enum  PoDoFo::EPdfStrokeStyle
 
enum  PoDoFo::EPdfTilingPatternType
 
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)
 

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.
 

Detailed Description

This file should be included as the FIRST file in every header of PoDoFo lib. It includes all standard files, defines some useful macros, some datatypes and all important enumeration types. On supporting platforms it will be precompiled to speed compilation.

Macro Definition Documentation

◆ ePdfBlendMode_Normal

#define ePdfBlendMode_Normal   "Normal"

List of defined transparency blending modes

◆ ePdfRenderingIntent_AbsoluteColorimetric

#define ePdfRenderingIntent_AbsoluteColorimetric   "AbsoluteColorimetric"

List of defined Rendering intents

◆ PODOFO_MAKE_VERSION_REAL

#define PODOFO_MAKE_VERSION_REAL (   M,
  m,
 
)    ( (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 .

◆ PODOFO_MAKE_VERSION_STR_REAL

#define PODOFO_MAKE_VERSION_STR_REAL (   M,
  m,
 
)    M ## . ## m ## . ## p

PoDoFo version represented as a string literal, eg '0.7.99'