Vanilla.PDF  1.5.2
Cross-platform toolkit for creating and modifying PDF documents
c_catalog.h
Go to the documentation of this file.
1 #ifndef _C_CATALOG_H
2 #define _C_CATALOG_H
3 
4 #include "vanillapdf/c_export.h"
5 #include "vanillapdf/c_handles.h"
6 #include "vanillapdf/c_values.h"
7 
9 
10 #ifdef __cplusplus
11 extern "C"
12 {
13 #endif
14 
31  typedef enum {
32 
37 
42 
47 
52 
57 
62 
67  } PageLayout;
68 
77  VANILLAPDF_API error_type CALLING_CONVENTION Catalog_GetPages(CatalogHandle* handle, PageTreeHandle** result);
78 
82  VANILLAPDF_API error_type CALLING_CONVENTION Catalog_GetPageLabels(CatalogHandle* handle, PageLabelsHandle** result);
83 
87  VANILLAPDF_API error_type CALLING_CONVENTION Catalog_GetPageLayout(CatalogHandle* handle, PageLayout* result);
88 
97  VANILLAPDF_API error_type CALLING_CONVENTION Catalog_GetVersion(CatalogHandle* handle, PDFVersion* result);
98 
106  VANILLAPDF_API error_type CALLING_CONVENTION Catalog_GetExtensions(CatalogHandle* handle, DeveloperExtensionsHandle** result);
107 
114  VANILLAPDF_API error_type CALLING_CONVENTION Catalog_GetViewerPreferences(CatalogHandle* handle, ViewerPreferencesHandle** result);
115 
119  VANILLAPDF_API error_type CALLING_CONVENTION Catalog_GetOutlines(CatalogHandle* handle, OutlineHandle** result);
120 
126  VANILLAPDF_API error_type CALLING_CONVENTION Catalog_GetDestinations(CatalogHandle* handle, NamedDestinationsHandle** result);
127 
133  VANILLAPDF_API error_type CALLING_CONVENTION Catalog_GetAcroForm(CatalogHandle* handle, InteractiveFormHandle** result);
134 
138  VANILLAPDF_API error_type CALLING_CONVENTION Catalog_ToUnknown(CatalogHandle* handle, IUnknownHandle** result);
139 
143  VANILLAPDF_API error_type CALLING_CONVENTION Catalog_FromUnknown(IUnknownHandle* handle, CatalogHandle** result);
144 
149  VANILLAPDF_API error_type CALLING_CONVENTION Catalog_Release(CatalogHandle* handle);
150 
153 #ifdef __cplusplus
154 };
155 #endif
156 
157 #endif /* _C_CATALOG_H */
error_type Catalog_GetDestinations(CatalogHandle *handle, NamedDestinationsHandle **result)
A dictionary of names and corresponding destinations (see 12.3.2.3, "Named Destinations").
An interactive form (PDF 1.2) - sometimes referred to as an AcroForm - is a collection of fields for ...
The pages of a document are accessed through a structure known as the page tree, which defines the or...
The extensions dictionary, an entry in the document's catalog dictionary, if present, shall contain one or more entries identifying developer-defined extensions to the ISO 32000-1 Standard.
Controlling the way the document shall be presented on the screen or in print.
A map of unique names mapped to their associated a DestinationHandle.
(PDF 1.5) Display the pages two at a time, with odd-numbered pages on the right
Definition: c_catalog.h:66
error_type Catalog_GetPages(CatalogHandle *handle, PageTreeHandle **result)
The root of the document's page tree (see 7.7.3, "Page Tree").
This file contains all type forward declarations returned by the library API.
error_type Catalog_Release(CatalogHandle *handle)
Decrement the internal reference counter.
error_type Catalog_GetPageLabels(CatalogHandle *handle, PageLabelsHandle **result)
A number tree defining the page labelling for the document (see 12.4.2, "Page Labels").
(PDF 1.5) Display the pages two at a time, with odd-numbered pages on the left
Definition: c_catalog.h:61
error_type Catalog_GetAcroForm(CatalogHandle *handle, InteractiveFormHandle **result)
The document's interactive form (see 12.7, "Interactive Forms").
Display the pages in one column.
Definition: c_catalog.h:46
PageLayout
Page layout which shall be used when the document is opened.
Definition: c_catalog.h:31
error_type Catalog_GetPageLayout(CatalogHandle *handle, PageLayout *result)
Page layout which shall be used when the document is opened.
uint32_t error_type
This is return value type of all API functions.
Definition: c_types.h:25
PDFVersion
Range of available PDF versions.
Definition: c_pdf_version.h:22
This file contains macro declarations for importing and exporting symbols from library boundaries...
error_type Catalog_FromUnknown(IUnknownHandle *handle, CatalogHandle **result)
Convert IUnknownHandle to CatalogHandle.
error_type Catalog_GetExtensions(CatalogHandle *handle, DeveloperExtensionsHandle **result)
An extensions dictionary containing developer prefix identification and version numbers for developer...
Undefined unitialized default value, triggers error when used.
Definition: c_catalog.h:36
The root of a document's outline hierarchy.
error_type Catalog_GetVersion(CatalogHandle *handle, PDFVersion *result)
The version of the PDF specification to which the document conforms if later than the version specifi...
error_type Catalog_GetViewerPreferences(CatalogHandle *handle, ViewerPreferencesHandle **result)
The way the document shall be displayed on the screen.
This file contains types and constants used as parameters or return values.
Display one page at a time.
Definition: c_catalog.h:41
Display the pages in two columns, with odd-numbered pages on the left.
Definition: c_catalog.h:51
error_type Catalog_ToUnknown(CatalogHandle *handle, IUnknownHandle **result)
Reinterpret current object as IUnknownHandle.
Collection of PageLabelHandle.
The root of a document's object hierarchy.
Base class for reference counting.
error_type Catalog_GetOutlines(CatalogHandle *handle, OutlineHandle **result)
Root of the document's outline hierarchy (see 12.3.3, "Document Outline").
This file contains class definitions for PDFVersion.
Display the pages in two columns, with odd-numbered pages on the right.
Definition: c_catalog.h:56