Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members

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

namespace  PoDoFo

Defines

#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  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_Number, ePdfDataType_Real, ePdfDataType_String,
  ePdfDataType_HexString, ePdfDataType_Name, ePdfDataType_Array, ePdfDataType_Dictionary,
  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
enum  EPdfPageSize {
  ePdfPageSize_A0, ePdfPageSize_A1, ePdfPageSize_A2, ePdfPageSize_A3,
  ePdfPageSize_A4, ePdfPageSize_A5, ePdfPageSize_A6, ePdfPageSize_Letter,
  ePdfPageSize_Legal, ePdfPageSize_Tabloid
}
enum  EPdfPageMode
enum  EPdfPageLayout

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)

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.

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.

Define Documentation

#define ePdfBlendMode_Normal   "Normal"
 

List of defined transparency blending modes

#define ePdfRenderingIntent_AbsoluteColorimetric   "AbsoluteColorimetric"
 

List of defined Rendering intents

#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 .

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

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


Enumeration Type Documentation

enum EPdfAlignment
 

Enum for text alignment

enum EPdfColorSpace
 

Enum for the colorspaces supported by PDF.

Enumeration values:
ePdfColorSpace_DeviceGray  Gray
ePdfColorSpace_DeviceRGB  RGB
ePdfColorSpace_DeviceCMYK  CMYK
ePdfColorSpace_Separation  Separation
ePdfColorSpace_CieLab  CIE-Lab

enum EPdfDataType
 

Every PDF datatype that can occur in a PDF file is referenced by an own enum (e.g. Bool or String).

See also:
PdfVariant
Remember to update PdfVariant::GetDataTypeString() when adding members here.
Enumeration values:
ePdfDataType_Bool  Boolean datatype: Accepts the values "true" and "false"
ePdfDataType_Number  Number datatype for integer values
ePdfDataType_Real  Real datatype for floating point numbers
ePdfDataType_String  String datatype in PDF file. Strings have the form (Hallo World!) in PDF files.
See also:
PdfString
ePdfDataType_HexString  HexString datatype in PDF file. Hex encoded strings have the form <AF00BE> in PDF files.
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 file of the form 4 0 R.
See also:
PdfObject
ePdfDataType_RawData  Raw PDF data
ePdfDataType_Unknown  The Datatype is unknown

enum EPdfFilter
 

Every filter that can be used to encode a stream in a PDF file is referenced by an own enum value. Common filters are ePdfFilter_FlateDecode (i.e. Zip) or ePdfFilter_ASCIIHexDecode

Enumeration values:
ePdfFilter_ASCIIHexDecode  Converts data from and to hexadecimal. Increases size of the data by a factor of 2!
See also:
PdfHexFilter
ePdfFilter_ASCII85Decode  Converts to and from Ascii85 encoding.
See also:
PdfAscii85Filter
ePdfFilter_FlateDecode  Compress data using the Flate algorithm of ZLib. This filter is recommended to be used always.
See also:
PdfFlateFilter
ePdfFilter_RunLengthDecode  Run length decode data.
See also:
PdfRLEFilter

enum EPdfFontType
 

Enum for the different font formats supported by PoDoFo

enum EPdfLineCapStyle
 

Enum for line cap styles when drawing.

enum EPdfLineJoinStyle
 

Enum for line join styles when drawing.

enum EPdfPageLayout
 

Enum holding the supported of types of "PageLayouts" that define how Acrobat will display the pages in relation to each other

See also:
PdfDocument

enum EPdfPageMode
 

Enum holding the supported of types of "PageModes" that define which (if any) of the "panels" are opened in Acrobat when the document is opened.

See also:
PdfDocument

enum 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
Enumeration values:
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

enum EPdfStrokeStyle
 

Enum for the different stroke styles that can be set when drawing to a PDF file (mostly for line drawing).

enum EPdfVersion
 

Enum to identify diferent versions of the PDF file format

Enumeration values:
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

enum EPdfVerticalAlignment
 

Enum for vertical text alignment

enum EPdfWriteMode
 

Specify additional options for writing the PDF.

Enumeration values:
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.


Function Documentation

template<typename T>
const T PDF_MAX const T  a,
const T  b
 

PDF_MAX(x,y)

Returns:
the maximum of x and y

template<typename T>
const T PDF_MIN const T  a,
const T  b
 

PDF_MIN(x,y)

Returns:
the minimum of x and y


Variable Documentation

const EPdfVersion PoDoFo::ePdfVersion_Default = ePdfVersion_1_3
 

The default PDF Version used by new PDF documents in PoDoFo.


Generated on Sun Feb 12 13:22:38 2012 for PoDoFo by  doxygen 1.3.9.1