|
pdfmm 0.9.20
|
Typedefs | |
| typedef std::shared_ptr< const PdfEncodingMap > | PdfEncodingMapConstPtr |
| typedef std::shared_ptr< const PdfFontMetrics > | PdfFontMetricsConstPtr |
Functions | |
| void PDFMM_API | PdfLocaleImbue (std::ios_base &) |
Variables | |
| constexpr PdfVersion | PdfVersionDefault = PdfVersion::V1_4 |
Copyright (C) 2007 by Dominik Seichter domse.nosp@m.icht.nosp@m.er@we.nosp@m.b.de Copyright (C) 2020 by Francesco Pretto ceztk.nosp@m.o@gm.nosp@m.ail.c.nosp@m.om
Licensed under GNU Library General Public License 2.0 or later. Some rights reserved. See COPYING, AUTHORS.
Copyright (C) 2006 by Dominik Seichter domse.nosp@m.icht.nosp@m.er@we.nosp@m.b.de Copyright (C) 2020 by Francesco Pretto ceztk.nosp@m.o@gm.nosp@m.ail.c.nosp@m.om
Licensed under GNU Library General Public License 2.0 or later. Some rights reserved. See COPYING, AUTHORS.
Copyright (C) 2021 by Francesco Pretto ceztk.nosp@m.o@gm.nosp@m.ail.c.nosp@m.om
Licensed under GNU Lesser General Public License 2.1. Some rights reserved. See COPYING, AUTHORS.
Copyright (C) 2005 by Dominik Seichter domse.nosp@m.icht.nosp@m.er@we.nosp@m.b.de
Licensed under GNU Library General Public License 2.0 or later. Some rights reserved. See COPYING, AUTHORS.
Copyright (C) 2006 by Dominik Seichter domse.nosp@m.icht.nosp@m.er@we.nosp@m.b.de
Licensed under GNU Library General Public License 2.0 or later. Some rights reserved. See COPYING, AUTHORS.
Copyright (C) 2005 by Dominik Seichter domse.nosp@m.icht.nosp@m.er@we.nosp@m.b.de Copyright (C) 2020 by Francesco Pretto ceztk.nosp@m.o@gm.nosp@m.ail.c.nosp@m.om
Licensed under GNU Library General Public License 2.0 or later. Some rights reserved. See COPYING, AUTHORS.
All classes, functions, types and enums of pdfmm are members of these namespace.
If you use pdfmm, you might want to add the line: using namespace mm; to your application.
Copyright (C) 2011 by Dominik Seichter domse.nosp@m.icht.nosp@m.er@we.nosp@m.b.de Copyright (C) 2020 by Francesco Pretto ceztk.nosp@m.o@gm.nosp@m.ail.c.nosp@m.om
Licensed under GNU Library General Public License 2.0 or later. Some rights reserved. See COPYING, AUTHORS.
Copyright (C) 2008 by Dominik Seichter domse.nosp@m.icht.nosp@m.er@we.nosp@m.b.de Copyright (C) 2020 by Francesco Pretto ceztk.nosp@m.o@gm.nosp@m.ail.c.nosp@m.om
Licensed under GNU Library General Public License 2.0 or later. Some rights reserved. See COPYING, AUTHORS.
Copyright (C) 2007 by Dominik Seichter domse.nosp@m.icht.nosp@m.er@we.nosp@m.b.de
Licensed under GNU Library General Public License 2.0 or later. Some rights reserved. See COPYING, AUTHORS.
Copyright (C) 2010 by Dominik Seichter domse.nosp@m.icht.nosp@m.er@we.nosp@m.b.de Copyright (C) 2020 by Francesco Pretto ceztk.nosp@m.o@gm.nosp@m.ail.c.nosp@m.om
Licensed under GNU Library General Public License 2.0 or later. Some rights reserved. See COPYING, AUTHORS.
Copyright (C) 2008 by Dominik Seichter domse.nosp@m.icht.nosp@m.er@we.nosp@m.b.de Copyright (C) 2021 by Francesco Pretto ceztk.nosp@m.o@gm.nosp@m.ail.c.nosp@m.om
Licensed under GNU Library General Public License 2.0 or later. Some rights reserved. See COPYING, AUTHORS.
Copyright (C) 2006 by Dominik Seichter domse.nosp@m.icht.nosp@m.er@we.nosp@m.b.de Copyright (C) 2021 by Francesco Pretto ceztk.nosp@m.o@gm.nosp@m.ail.c.nosp@m.om
Licensed under GNU Library General Public License 2.0 or later. Some rights reserved. See COPYING, AUTHORS.
Copyright (C) 2009 by Dominik Seichter domse.nosp@m.icht.nosp@m.er@we.nosp@m.b.de Copyright (C) 2021 by Francesco Pretto ceztk.nosp@m.o@gm.nosp@m.ail.c.nosp@m.om
Licensed under GNU Library General Public License 2.0 or later. Some rights reserved. See COPYING, AUTHORS.
Copyright (C) 2021 by Francesco Pretto ceztk.nosp@m.o@gm.nosp@m.ail.c.nosp@m.om
Licensed under GNU Library General Public License 2.0 or later. Some rights reserved. See COPYING, AUTHORS.
Copyright (C) 2011 by Dominik Seichter domse.nosp@m.icht.nosp@m.er@we.nosp@m.b.de Copyright (C) 2011 by Petr Pytelka Copyright (C) 2020 by Francesco Pretto ceztk.nosp@m.o@gm.nosp@m.ail.c.nosp@m.om
Licensed under GNU Library General Public License 2.0 or later. Some rights reserved. See COPYING, AUTHORS.
Copyright (C) 2020 by Francesco Pretto ceztk.nosp@m.o@gm.nosp@m.ail.c.nosp@m.om
Licensed under GNU Lesser General Public License 2.1. Some rights reserved. See COPYING, AUTHORS.
Copyright (C) 2009 by Dominik Seichter domse.nosp@m.icht.nosp@m.er@we.nosp@m.b.de Copyright (C) 2020 by Francesco Pretto ceztk.nosp@m.o@gm.nosp@m.ail.c.nosp@m.om
Licensed under GNU Library General Public License 2.0 or later. Some rights reserved. See COPYING, AUTHORS.
Copyright (C) 2010 by Dominik Seichter domse.nosp@m.icht.nosp@m.er@we.nosp@m.b.de
Licensed under GNU Library General Public License 2.0 or later. Some rights reserved. See COPYING, AUTHORS.
| typedef std::shared_ptr<const PdfEncodingMap> mm::PdfEncodingMapConstPtr |
Convenience typedef for a const PdfEncoding shared ptr
| typedef std::shared_ptr<const PdfFontMetrics> mm::PdfFontMetricsConstPtr |
Convenience typedef for a const PdfEncoding shared ptr
|
strong |
Used in PdfError::LogMessage to specify the log level.
| Enumerator | |
|---|---|
| None | Logging disabled. |
| Error | Error. |
| Warning | Warning. |
| Information | Information message. |
| Debug | Debug information. |
|
strong |
|
strong |
The type of the action. PDF supports different action types, each of them has different keys and propeties.
Not all action types listed here are supported yet.
Please make also sure that the action type you use is supported by the PDF version you are using.
|
strong |
Type of the annotation appearance.
| Enumerator | |
|---|---|
| Normal | Normal appearance. |
| Rollover | Rollover appearance; the default is PdfAnnotationAppearance::Normal. |
| Down | Down appearance; the default is PdfAnnotationAppearance::Normal. |
|
strong |
Flags that control the appearance of a PdfAnnotation. You can OR them together and pass it to PdfAnnotation::SetFlags.
|
strong |
The type of the annotation. PDF supports different annotation types, each of them has different keys and propeties.
Not all annotation types listed here are supported yet.
Please make also sure that the annotation type you use is supported by the PDF version you are using.
|
strong |
|
strong |
Defines the base encoding from which a PdfDifferenceEncoding differs.
| Enumerator | |
|---|---|
| Implicit | See Table 5.11 PdfRefence 1.7. |
| WinAnsi | Use WinAnsiEncoding as base encoding. |
| MacRoman | Use MacRomanEncoding as base encoding. |
| MacExpert | Use MacExpertEncoding as base encoding. |
|
strong |
|
strong |
An enum describing the type of a read token
|
strong |
Every PDF datatype that can occur in a PDF file is referenced by an own enum (e.g. Bool or String).
Remember to update PdfVariant::GetDataTypeString() when adding members here.
| Enumerator | |
|---|---|
| Unknown | The Datatype is unknown. The value is chosen to enable value storage in 8-bit unsigned integer. |
| Bool | Boolean datatype: Accepts the values "true" and "false". |
| Number | Number datatype for integer values. |
| Real | Real datatype for floating point numbers. |
| String | String datatype in PDF file. Strings have the form (Hallo World!) in PDF files.
|
| Name | Name datatype. Names are used as keys in dictionary to reference values.
|
| Array | An array of other PDF data types. |
| Dictionary | A dictionary associates keys with values. A key can have another dictionary as value. |
| Null | The null datatype is always null. |
| Reference | The reference datatype contains references to PDF objects in the PDF file of the form 4 0 R.
|
| RawData | Raw PDF data. |
|
strong |
Destination type, as per 12.3.2.2 of the Pdf spec.
(see table 151 in the pdf spec)
|
strong |
|
strong |
|
strong |
Error Code enum values which are used in PdfError to describe the error.
If you add an error code to this enum, please also add it to PdfError::ErrorName() and PdfError::ErrorMessage().
|
strong |
The type of PDF field
|
strong |
Every filter that can be used to encode a stream in a PDF file is referenced by an own enum value. Common filters are PdfFilterType::FlateDecode (i.e. Zip) or PdfFilterType::ASCIIHexDecode
| Enumerator | |
|---|---|
| None | Do not use any filtering. |
| ASCIIHexDecode | Converts data from and to hexadecimal. Increases size of the data by a factor of 2!
|
| ASCII85Decode | Converts to and from Ascii85 encoding.
|
| FlateDecode | Compress data using the Flate algorithm of ZLib. This filter is recommended to be used always.
|
| RunLengthDecode | Run length decode data.
|
|
strong |
|
strong |
Enum for the different font metrics formats supported by pdfmm
|
strong |
|
strong |
The possible highlighting modes for a PdfField. I.e the visual effect that is to be used when the mouse button is pressed.
The default value is PdfHighlightingMode::Invert
| Enumerator | |
|---|---|
| None | Do no highlighting. |
| Invert | Invert the PdfField. |
| InvertOutline | Invert the fields border. |
| Push | Display the fields down appearance (requires an additional appearance stream to be set) |
|
strong |
Enum for text alignment
|
strong |
Enum to specifiy the initial information of the info dictionary.
|
strong |
A enum specifying a valid keylength for a PDF encryption key. Keys must be in the range 40 to 128 bit and have to be a multiple of 8.
Adobe Reader supports only keys with 40, 128 or 256 bits!
|
strong |
Enum for line cap styles when drawing.
|
strong |
Enum for line join styles when drawing.
|
strong |
|
strong |
Enum holding the supported of types of "PageLayouts" that define how Acrobat will display the pages in relation to each other
|
strong |
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.
|
strong |
|
strong |
|
strong |
Set user permissions/restrictions on a document
| Enumerator | |
|---|---|
Allow printing the document. | |
| Edit | Allow modifying the document besides annotations, form fields or changing pages. |
| Copy | Allow text and graphic extraction. |
| EditNotes | Add or modify text annotations or form fields (if PdfPermissions::Edit is set also allow to create interactive form fields including signature) |
| FillAndSign | Fill in existing form or signature fields. |
| Accessible | Extract text and graphics to support user with disabilities. |
| DocAssembly | Assemble the document: insert, create, rotate delete pages or add bookmarks. |
| HighPrint | Print a high resolution version of the document. |
|
strong |
|
strong |
Enum for the different stroke styles that can be set when drawing to a PDF file (mostly for line drawing).
|
strong |
Enum for text rendering mode (Tr)
|
strong |
Enum for predefined tiling patterns.
|
strong |
|
strong |
Enum for vertical text alignment
|
strong |
Specify additional options for writing the PDF.
| Enumerator | |
|---|---|
| Clean | Create a PDF that is readable in a text editor, i.e. insert spaces and linebreaks between tokens. |
| NoInlineLiteral | Don't write spaces before literal types (numerical, references, null) |
| NoPDFAPreserve | When writing compact (PdfWriteMode::Clean is unset) code, preserving PDF/A compliance is not required. |
|
strong |
| void PDFMM_API mm::PdfLocaleImbue | ( | std::ios_base & | ) |
Imbue the passed stream with a locale that will be safe to do I/O of the low level PDF format with.
PDF document structure I/O is done with the C++ standard library IOStreams code. By default, this will adapt to the current locale. That's not good at all when doing I/O of PDF data structures, which follow POSIX/English locale conventions irrespective of runtime locale. Make sure to to call this function on any stream you intend to use for PDF I/O. Avoid using this stream for anything that should be done in the regional locale.
If you fail to call this on a stream you use for PDF I/O you will encounter problems like German and other European users getting numbers in the format "10110,4" or even "10.110,4" instead of "10110.4" .
|
constexpr |
The default PDF Version used by new PDF documents in pdfmm.