pdftron::PDF Namespace Reference


Namespaces

namespace  Struct
namespace  OCG
namespace  Annots
namespace  PDFA

Classes

class  Action
 Actions are typically what happens when a user clicks on a link or bookmark. More...
class  Annot
 Annot is a base class for different types of annotations. More...
class  Bookmark
 A PDF document may optionally display a document outline on the screen, allowing the user to navigate interactively from one part of the document to another. More...
class  ColorPt
 ColorPt is an array of colorants (or tint values) representing a color point in an associated color space. More...
class  ColorSpace
 This abstract class is used to serve as a color space tag to identify the specific color space of a Color object. More...
class  Convert
 Converter is a utility class used to convert documents and files to PDF. More...
class  Date
 The Date class is a utility class used to simplify work with PDF date objects. More...
class  Destination
 A destination defines a particular view of a document, consisting of the following:. More...
class  Element
 Element is the abstract interface used to access graphical elements used to build the display list. More...
class  ElementBuilder
 ElementBuilder is used to build new PDF::Elements (e.g. More...
class  ElementReader
 ElementReader can be used to parse and process content streams. More...
class  ElementWriter
 ElementWriter can be used to assemble and write new content to a page, Form XObject, Type3 Glyph stream, pattern stream, or any other content stream. More...
class  Field
 An interactive form (sometimes referred to as an AcroForm) is a collection of fields for gathering information interactively from the user. More...
class  FileSpec
 FileSpec corresponds to the PDF file specification object. More...
class  Font
 A font that is used to draw text on a page. More...
class  Function
 Although PDF is not a programming language it provides several types of function object that represent parameterized classes of functions, including mathematical formulas and sampled representations with arbitrary resolution. More...
class  GState
 GState is a class that keeps track of a number of style attributes used to visually define graphical Elements. More...
class  Highlights
 Highlights is used to store the necessary information and perform certain tasks in accordance with Adobe's Highlight standard, whose details can be found at:. More...
class  Image
 Image class provides common methods for working with PDF images. More...
class  Page
 Page is a high-level class representing PDF page object (see 'Page Objects' in Section 3.6.2, 'Page Tree,' in PDF Reference Manual). More...
class  PageLabel
 PDF page labels can be used to describe a page. More...
class  PatternColor
 Patterns are quite general, and have many uses; for example, they can be used to create various graphical textures, such as weaves, brick walls, sunbursts, and similar geometrical and chromatic effects. More...
class  PDFDC
 PDFDC is a utility class used to represent a PDF Device Context (DC). More...
class  PDFDCEX
 PDFDCEX is a utility class used to represent a PDF Device Context (DC). More...
class  PDFDoc
 PDFDoc is a high-level class describing a single PDF (Portable Document Format) document. More...
class  PDFDocInfo
 PDFDocInfo is a high-level utility class that can be used to read and modify document's metadata. More...
class  PDFDocViewPrefs
 PDFDocViewPrefs is a high-level utility class that can be used to control the way the document is to be presented on the screen or in print. More...
class  PDFDraw
 PDFDraw contains methods for converting PDF pages to images and to Bitmap objects. More...
class  PDFRasterizer
 PDFRasterizer is a low-level PDF rasterizer. More...
class  PDFView
 PDFView is a utility class that can be used for interactive rendering of PDF documents. More...
class  PDFViewCtrl
 PDFViewCtrl is a utility class that can be used for interactive rendering of PDF documents. More...
class  Point
class  Print
class  PrinterMode
 PrinterMode is a utility class used to represent options for printing. More...
class  QuadPoint
class  Rect
 Rect is a utility class used to manipulate PDF rectangle objects (refer to section 3.8.3 of the PDF Reference Manual). More...
class  Shading
 Shading is a class that represents a flat interface around all PDF shading types:. More...
class  TextExtractor
 TextExtractor is used to analyze a PDF page and extract words and logical structure within a given region. More...
class  TextSearch
 TextSearch searches through a PDF document for a user-given search pattern. More...
class  Image2RGB
 Image2RGB is a filter that can decompress and normalize any PDF image stream (e.g. More...
class  Image2RGBA
 Image2RGBA is a filter that can decompress and normalize any PDF image stream (e.g. More...

Typedefs

typedef Common::Iterator
< TRN_CharData > 
CharIterator
typedef Common::Iterator< int > GSChangesIterator
 GSChangesIterator is an iterator type that can be used to traverse a list of changes in the graphics state between subsequent graphical elements on the page.
typedef Common::Iterator< PagePageIterator
 PageIterator is an iterator type that can be used to traverse a list pages in a PDF document.
typedef Common::Iterator< FieldFieldIterator
 FieldIterator is an iterator type that can be used to traverse a list form fields in a PDF document.

Typedef Documentation

CharIterator is an iterator type that can be used to traverse CharData in the current e_text element. For a sample use case, please take a look at ElementReaderAdv sample project.

CharData is a data structure returned by CharIterator that is used to provide extra information about a character within a text run. The extra information includes positioning information, the character data and a number of bytes taken by the character.

char_code := for SimpleFonts char_code := char_data[0], for composite fonts char_code is the numeric value of data stored in char_data buffer.

(x, y) is a virtual point (x, y), located on the baseline. This point is called the pen position, and is used to position glyphs. The pen position has already taken into account the effects of any inter-character adjustments due to properties such as font size, text rise, character spacing, word spacing and positioning adjustments on 'TJ' elements.

char_data is a pointer to the buffer containing character data. For simple fonts each character is represented by a single byte. For multibyte (CID or Type0) fonts each character may take more than one byte.

bytes - the number of bytes representing this character in char_data buffer. For simple fonts 'bytes' will equal 1. For multibyte (CID or Type0) fonts 'bytes may be larger than 1.

GSChangesIterator is an iterator type that can be used to traverse a list of changes in the graphics state between subsequent graphical elements on the page.

For a sample use case, please see ElementReaderAdv sample project.

PageIterator is an iterator type that can be used to traverse a list pages in a PDF document.

For more information, please PDFDoc::GetPageIterator().

FieldIterator is an iterator type that can be used to traverse a list form fields in a PDF document.

For more information, please PDFDoc::GetFieldIterator().


© 2002-2010 PDFTron Systems Inc.