Class List

Here are the classes, structs, unions and interfaces with brief descriptions:
pdftron::PDF::ActionActions are typically what happens when a user clicks on a link or bookmark
pdftron::PDF::AnnotAnnot is a base class for different types of annotations
pdftron::Filters::ASCII85EncodeASCII85Encode filter can be used to encode any data stream into a stream that does not contain any binary characters
pdftron::PDF::Struct::AttrObjAn application or plug-in extension that processes logical structure can attach additional information, called attributes, to any structure element
pdftron::PDF::BookmarkA 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
pdftron::PDF::Annot::BorderStyleBorderStyle structure specifies the characteristics of the annotation's border
pdftron::PDF::Annots::CaretA Caret annotation (PDF 1.5) is a visual symbol that indicates the presence of text edits
pdftron::PDF::Annots::CircleA Circle annotation is a type of markup annotation that displays an ellipse on the page
pdftron::PDF::Struct::ClassMap
pdftron::PDF::ColorPtColorPt is an array of colorants (or tint values) representing a color point in an associated color space
pdftron::PDF::ColorSpaceThis abstract class is used to serve as a color space tag to identify the specific color space of a Color object
pdftron::PDF::OCG::ConfigThe OCG::Config object represents an optional-content (OC) configuration structure (see section 4.10.3 in PDF Reference), used to persist a set of visibility states and other optional-content information in a PDF file A document has a default configuration, saved in the D entry in the 'OCProperties' dictionary (that can be obtained using pdfdoc.GetOCConfig()), and can have a list of other configurations, saved as an array in the 'Configs' entry in the OCProperties dictionary
pdftron::PDF::Struct::ContentItemContent items are graphical objects that exist in the document independently of the structure tree but are associated with structure elements
pdftron::PDF::OCG::Context
pdftron::PDF::ConvertConverter is a utility class used to convert documents and files to PDF
pdftron::PDF::DateUtility class used to simplify work with PDF date objects
pdftron::PDF::DestinationA destination defines a particular view of a document, consisting of the following:
pdftron::SDF::DictIteratorDictIterator is used to traverse key/value pairs in a dictionary
pdftron::PDF::ElementElement is the abstract interface used to access graphical elements used to build the display list
pdftron::PDF::ElementBuilderElementBuilder is used to build new PDF::Elements (e.g
pdftron::PDF::ElementReaderElementReader can be used to parse and process content streams
pdftron::PDF::ElementWriterElementWriter can be used to assemble and write new content to a page, Form XObject, Type3 Glyph stream, pattern stream, or any other content stream
pdftron::PDF::PDFViewCtrl::EventHandlersClass containing the event handlers to be called when certain GUI actions are happening
pdftron::Common::ExceptionException is derived from standard C++ exception class and it is a superclass for all PDFNet library exceptions
pdftron::FDF::FDFDocFDFDoc is a class representing Forms Data Format (FDF) documents
pdftron::FDF::FDFField
pdftron::PDF::FieldAn interactive form (sometimes referred to as an AcroForm) is a collection of fields for gathering information interactively from the user
pdftron::PDF::Annots::FileAttachmentA file attachment annotation contains a reference to a file, which may be embedded in the PDF document
pdftron::PDF::FileSpecFileSpec corresponds to the PDF file specification object
pdftron::Filters::FilterProvides a generic view of a sequence of bytes
pdftron::Filters::FilterReaderFilterReader is a utility class providing a convenient way to read data from an input filter (using Filter directly is not very intuitive)
pdftron::Filters::FilterWriterFilterWriter is a utility class providing a convenient way to write data to an output filter (using Filter directly is not very intuitive)
pdftron::Filters::FlateEncodeFlateEncode filter can be used to compress any data stream using Flate (i.e
pdftron::PDF::FontA font that is used to draw text on a page
pdftron::PDF::Annots::FreeTextA FreeText annotation (PDF 1.3) displays text directly on the page
pdftron::PDF::FunctionAlthough 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
pdftron::PDF::OCG::GroupThe OCG::Group object represents an optional-content group
pdftron::PDF::GStateGState is a class that keeps track of a number of style attributes used to visually define graphical Elements
pdftron::PDF::Annots::HighlightA Highlight annotation covers a word or a group of contiguous words with partially transparent color
pdftron::PDF::HighlightsHighlights is used to store the necessary information and perform certain tasks in accordance with Adobe's Highlight standard, whose details can be found at:
pdftron::PDF::ImageImage class provides common methods for working with PDF images
pdftron::PDF::Image2RGBImage2RGB is a filter that can decompress and normalize any PDF image stream (e.g
pdftron::PDF::Image2RGBAImage2RGBA is a filter that can decompress and normalize any PDF image stream (e.g
pdftron::PDF::Annots::InkAn ink annotation (PDF 1.3) represents a freehand “scribble” composed of one or more disjoint paths
pdftron::Common::Iterator< T >Supports a simple iteration over a generic collection
pdftron::Common::Iterator< int >The Iterator specialization for integer type
pdftron::PDF::PDFViewCtrl::KeyEventStruct containing the data necessary to process key event callback on the client side
pdftron::PDF::TextExtractor::LineTextExtractor::Line object represents a line of text on a PDF page
pdftron::PDF::Annots::LineA line annotation (PDF 1.3) is used to display a single straight line on the page
pdftron::PDF::Annots::LinkA link annotation represents either a hypertext link to a destination elsewhere in the document or an action to be performed
pdftron::PDF::Annots::MarkupMarkup is a base class for a number of annotations types that are used to mark up PDF documents
pdftron::Common::Matrix2D2D Matrix
pdftron::Filters::MemoryFilterMemoryFilter is a memory buffer that can be used as a source or a sink Filter in the Filter pipeline
pdftron::PDF::PDFViewCtrl::MouseEventStruct containing the data necessary to process mouse event callback on the client side
pdftron::PDF::Annots::MovieA movie annotation contains animated graphics and sound to be presented on the computer screen and through the speakers
pdftron::SDF::NameTreeA NameTree is a common data structure in PDF
pdftron::SDF::NumberTreeA NumberTree is a common data structure in PDF
pdftron::SDF::ObjObj is a concrete class for all SDF/Cos objects
pdftron::SDF::ObjSetObjSet is a lightweight container that can hold a collection of SDF objects
pdftron::PDF::OCG::OCMDThe OCMD object represents an Optional Content Membership Dictionary (OCMD) that allows the visibility of optional content to depend on the states in a set of optional-content groups (OCG::Group)
pdftron::PDF::PagePage is a high-level class representing PDF page object (see 'Page Objects' in Section 3.6.2, 'Page Tree,' in PDF Reference Manual)
pdftron::PDF::PageLabelPDF page labels can be used to describe a page
pdftron::PDF::PDFViewCtrl::PaintEventStruct containing the data necessary to process paint event callback on the client side
pdftron::PDF::PatternColorPatterns 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
pdftron::PDF::PDFA::PDFACompliancePDFACompliance class is used to validate PDF documents for PDF/A (ISO 19005-1) compliance or to convert existing PDF files to PDF/A compliant documents
pdftron::PDF::PDFDCPDFDC is a utility class used to represent a PDF Device Context (DC)
pdftron::PDF::PDFDCEXPDFDCEX is a utility class used to represent a PDF Device Context (DC)
pdftron::PDF::PDFDocPDFDoc is a high-level class describing a single PDF (Portable Document Format) document
pdftron::PDF::PDFDocInfoPDFDocInfo is a high-level utility class that can be used to read and modify document's metadata
pdftron::PDF::PDFDocViewPrefsPDFDocViewPrefs 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
pdftron::PDF::PDFDrawPDFDraw contains methods for converting PDF pages to images and to Bitmap objects
pdftron::PDFNetPDFNet contains global library initialization, registration, configuration, and termination methods
pdftron::PDF::PDFRasterizerPDFRasterizer is a low-level PDF rasterizer
pdftron::PDF::PDFViewPDFView is a utility class that can be used for interactive rendering of PDF documents
pdftron::PDF::PDFViewCtrlPDFViewCtrl is a utility class that can be used for interactive rendering of PDF documents
pdftron::PDF::Point
pdftron::PDF::Annots::Polygon
pdftron::PDF::Annots::PolyLineThis header defines classes for the Polygon and PolyLine annotations
pdftron::PDF::Annots::PopupA pop-up annotation (PDF 1.3) displays text in a pop-up window for entry and editing
pdftron::PDF::Print
pdftron::PDF::Convert::PrinterConvert::Printer is a utility class to install the a printer for print-based conversion of documents for Convert::ToPdf
pdftron::PDF::PrinterModePrinterMode is a utility class used to represent options for printing
pdftron::PDF::QuadPoint
pdftron::PDF::RectRect is a utility class used to manipulate PDF rectangle objects (refer to section 3.8.3 of the PDF Reference Manual)
pdftron::PDF::Annots::RedactionA redaction annotation (PDF 1.7) identifies content that is intended to be removed from the document
pdftron::PDF::Struct::RoleMapRoleMap is a dictionary that maps the names of structure types used in the document to their approximate equivalents in the set of standard structure types
pdftron::PDF::Annots::RubberStampA RubberStamp annotation displays text or graphics intended to look as if they were stamped on the page with a rubber stamp
pdftron::PDF::Annots::ScreenA screen annotation (PDF 1.5) specifies a region of a page upon which media clips may be played
pdftron::SDF::SDFDocSDFDoc is a low-level document representing a graph of SDF::Obj nodes that can be used to build higher-level document models such as PDF (Portable Document Format) or FDF (Forms Document Format)
pdftron::PDFNet::SecurityDescriptorSecurityDescriptor is a class describing SecurityHandler
pdftron::SDF::SecurityHandlerStandard Security Handler is a standard password-based security handler
pdftron::PDF::PDFView::SelectionA class representing the current text selection
pdftron::PDF::PDFViewCtrl::SelectionA class representing the current text selection
pdftron::PDF::Struct::SElementSElement represents PDF structural elements, which are nodes in a tree structure, defining a PDF document's logical structure
pdftron::PDF::ShadingShading is a class that represents a flat interface around all PDF shading types:
pdftron::PDF::PDFViewCtrl::SizeEvent
pdftron::PDF::Annots::SoundA Sound annotation represents a sound recording attached to a point in the PDF document
pdftron::PDF::Annots::SquareSquare annotation is used to display a rectangle on the page
pdftron::PDF::Annots::SquigglyA Squiggly annotation shows as a wavy line segment across the bottom of a word or a group of contiguous words
pdftron::Filters::StdFileStdFile is a utility class to read from, write to, open, and close files on a file system
pdftron::PDF::Struct::STreeSTree is the root of the structure tree, which is a central repository for information related to a PDF document's logical structure
pdftron::PDF::Annots::StrikeOutA StrikeOut annotation shows as a line segment crossing out a word or a group of contiguous words
pdftron::PDF::TextExtractor::StyleA class representing predominant text style associated with a given Line, a Word, or a Glyph
pdftron::PDF::Annots::TextA text annotation represents a "sticky note" attached to a point in the PDF document
pdftron::PDF::TextExtractorTextExtractor is used to analyze a PDF page and extract words and logical structure within a given region
pdftron::PDF::Annots::TextMarkupA TextMarkup is a base class for highlight, underline, strikeout, and squiggly annotations
pdftron::PDF::TextSearchTextSearch searches through a PDF document for a user-given search pattern
pdftron::PDF::Annots::UnderlineAn Underline annotation shows as a line segment across the bottom of a word or a group of contiguous words
pdftron::UStringRepresents text as a series of Unicode characters
pdftron::PDF::Annots::WatermarkA Watermark annotation is an annotation that is printed at a fixed size and position on a page, regardless of the dimensions of the printed page
pdftron::PDF::Annots::WidgetA Widget annotation (PDF 1.2) are used to represent the appearance of interactive form field and to manage user interactions with forms
pdftron::PDF::TextExtractor::WordTextExtractor::Word object represents a word on a PDF page

© 2002-2010 PDFTron Systems Inc.