Vanilla.PDF  1.5.3
Cross-platform toolkit for creating and modifying PDF documents
c_page_labels.h
Go to the documentation of this file.
1 #ifndef _C_PAGE_LABELS_H
2 #define _C_PAGE_LABELS_H
3 
4 #include "vanillapdf/c_export.h"
5 #include "vanillapdf/c_handles.h"
6 #include "vanillapdf/c_values.h"
7 
8 #ifdef __cplusplus
9 extern "C"
10 {
11 #endif
12 
41  typedef enum {
42  NumberingStyle_Undefined = 0,
43 
47  NumberingStyle_Decimal,
48 
52  NumberingStyle_UpperRoman,
53 
57  NumberingStyle_LowerRoman,
58 
65  NumberingStyle_UpperLetters,
66 
73  NumberingStyle_LowerLetters
74  } NumberingStyle;
75 
86  VANILLAPDF_API error_type CALLING_CONVENTION PageLabels_Contains(PageLabelsHandle* handle, size_type page_number, boolean_type* result);
87 
92  VANILLAPDF_API error_type CALLING_CONVENTION PageLabels_At(PageLabelsHandle* handle, size_type page_number, PageLabelHandle** result);
93 
98  VANILLAPDF_API error_type CALLING_CONVENTION PageLabels_Release(PageLabelsHandle* handle);
99 
110  VANILLAPDF_API error_type CALLING_CONVENTION PageLabel_Prefix(PageLabelHandle* handle, StringObjectHandle** result);
111 
116  VANILLAPDF_API error_type CALLING_CONVENTION PageLabel_Start(PageLabelHandle* handle, IntegerObjectHandle** result);
117 
123  VANILLAPDF_API error_type CALLING_CONVENTION PageLabel_Style(PageLabelHandle* handle, NumberingStyle* result);
124 
129  VANILLAPDF_API error_type CALLING_CONVENTION PageLabel_Release(PageLabelHandle* handle);
130 
133 #ifdef __cplusplus
134 };
135 #endif
136 
137 #endif /* _C_PAGE_LABELS_H */
NumberingStyle
NumberingStyle
Numbering style types.
Definition: c_page_labels.h:41
PageLabelHandle::PageLabel_Style
error_type PageLabel_Style(PageLabelHandle *handle, NumberingStyle *result)
The numbering style that shall be used for the numeric portion of each page label.
PageLabelsHandle::PageLabels_Contains
error_type PageLabels_Contains(PageLabelsHandle *handle, size_type page_number, boolean_type *result)
Detemines if collection contains label for page number page_number.
PageLabelHandle::PageLabel_Release
error_type PageLabel_Release(PageLabelHandle *handle)
Decrement the internal reference counter.
NumberingStyle_UpperRoman
Uppercase roman numerals.
Definition: c_page_labels.h:52
IntegerObjectHandle
Integer objects represent mathematical integers.
c_handles.h
This file contains all type forward declarations returned by the library API.
size_type
uint32_t size_type
Size type defined in standard library.
Definition: c_types.h:62
NumberingStyle_LowerLetters
Lowercase letters (a to z for the first 26 pages, aa to zz for the next 26, and so on)...
Definition: c_page_labels.h:73
NumberingStyle_UpperLetters
Uppercase letters (A to Z for the first 26 pages, AA to ZZ for the next 26, and so on)...
Definition: c_page_labels.h:65
PageLabelsHandle::PageLabels_Release
error_type PageLabels_Release(PageLabelsHandle *handle)
Decrement the internal reference counter.
error_type
uint32_t error_type
This is return value type of all API functions.
Definition: c_types.h:25
c_export.h
This file contains macro declarations for importing and exporting symbols from library boundaries...
NumberingStyle_LowerRoman
Lowercase roman numerals.
Definition: c_page_labels.h:57
PageLabelsHandle::PageLabels_At
error_type PageLabels_At(PageLabelsHandle *handle, size_type page_number, PageLabelHandle **result)
Get page label for page number page_number.
c_values.h
This file contains types and constants used as parameters or return values.
PageLabelHandle
Page labels are used for numbering or otherwise identifying individual pages.
PageLabelsHandle
Collection of PageLabelHandle.
StringObjectHandle
Reprsents human readable text.
PageLabelHandle::PageLabel_Prefix
error_type PageLabel_Prefix(PageLabelHandle *handle, StringObjectHandle **result)
The label prefix for page labels in this range.
PageLabelHandle::PageLabel_Start
error_type PageLabel_Start(PageLabelHandle *handle, IntegerObjectHandle **result)
The value of the numeric portion for the first page label in the range.
boolean_type
int8_t boolean_type
Boolean type supported in C.
Definition: c_types.h:31
NumberingStyle_Decimal
Decimal arabic numerals.
Definition: c_page_labels.h:47