Vanilla.PDF  1.5.1
Cross-platform toolkit for creating and modifying PDF documents
c_outline.h
Go to the documentation of this file.
1 #ifndef _C_OUTLINE_H
2 #define _C_OUTLINE_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 
65  typedef enum {
66  OutlineType_Undefined = 0,
67 
73 
79  } OutlineType;
80 
89  VANILLAPDF_API error_type CALLING_CONVENTION OutlineBase_GetOutlineType(OutlineBaseHandle* handle, OutlineType* result);
90 
94  VANILLAPDF_API error_type CALLING_CONVENTION OutlineBase_ToOutline(OutlineBaseHandle* handle, OutlineHandle** result);
95 
99  VANILLAPDF_API error_type CALLING_CONVENTION OutlineBase_ToOutlineItem(OutlineBaseHandle* handle, OutlineItemHandle** result);
100 
105  VANILLAPDF_API error_type CALLING_CONVENTION OutlineBase_Release(OutlineBaseHandle* handle);
106 
119  VANILLAPDF_API error_type CALLING_CONVENTION Outline_GetFirst(OutlineHandle* handle, OutlineItemHandle** result);
120 
126  VANILLAPDF_API error_type CALLING_CONVENTION Outline_GetLast(OutlineHandle* handle, OutlineItemHandle** result);
127 
136  VANILLAPDF_API error_type CALLING_CONVENTION Outline_GetCount(OutlineHandle* handle, IntegerObjectHandle** result);
137 
141  VANILLAPDF_API error_type CALLING_CONVENTION Outline_Release(OutlineHandle* handle);
142 
154  VANILLAPDF_API error_type CALLING_CONVENTION OutlineItem_GetTitle(OutlineItemHandle* handle, StringObjectHandle** result);
155 
160  VANILLAPDF_API error_type CALLING_CONVENTION OutlineItem_GetParent(OutlineItemHandle* handle, OutlineBaseHandle** result);
161 
166  VANILLAPDF_API error_type CALLING_CONVENTION OutlineItem_GetPrev(OutlineItemHandle* handle, OutlineItemHandle** result);
167 
172  VANILLAPDF_API error_type CALLING_CONVENTION OutlineItem_GetNext(OutlineItemHandle* handle, OutlineItemHandle** result);
173 
178  VANILLAPDF_API error_type CALLING_CONVENTION OutlineItem_GetFirst(OutlineItemHandle* handle, OutlineItemHandle** result);
179 
184  VANILLAPDF_API error_type CALLING_CONVENTION OutlineItem_GetLast(OutlineItemHandle* handle, OutlineItemHandle** result);
185 
190  VANILLAPDF_API error_type CALLING_CONVENTION OutlineItem_GetCount(OutlineItemHandle* handle, IntegerObjectHandle** result);
191 
192  //VANILLAPDF_API error_type CALLING_CONVENTION OutlineItem_GetDestinations(OutlineItemHandle* handle, IntegerObjectHandle** result);
193  //VANILLAPDF_API error_type CALLING_CONVENTION OutlineItem_GetActions(OutlineItemHandle* handle, IntegerObjectHandle** result);
194  //VANILLAPDF_API error_type CALLING_CONVENTION OutlineItem_GetStructureElement(OutlineItemHandle* handle, IntegerObjectHandle** result);
195 
199  VANILLAPDF_API error_type CALLING_CONVENTION OutlineItem_GetColor(OutlineItemHandle* handle, OutlineItemColorHandle** result);
200 
204  VANILLAPDF_API error_type CALLING_CONVENTION OutlineItem_GetFlags(OutlineItemHandle* handle, OutlineItemFlagsHandle** result);
205 
209  VANILLAPDF_API error_type CALLING_CONVENTION OutlineItem_Release(OutlineItemHandle* handle);
210 
221  VANILLAPDF_API error_type CALLING_CONVENTION OutlineItemColor_GetRed(OutlineItemColorHandle* handle, IntegerObjectHandle** result);
222 
226  VANILLAPDF_API error_type CALLING_CONVENTION OutlineItemColor_GetGreen(OutlineItemColorHandle* handle, IntegerObjectHandle** result);
227 
231  VANILLAPDF_API error_type CALLING_CONVENTION OutlineItemColor_GetBlue(OutlineItemColorHandle* handle, IntegerObjectHandle** result);
232 
237  VANILLAPDF_API error_type CALLING_CONVENTION OutlineItemColor_Release(OutlineItemColorHandle* handle);
238 
249  VANILLAPDF_API error_type CALLING_CONVENTION OutlineItemFlags_IsItalic(OutlineItemFlagsHandle* handle, boolean_type* result);
250 
254  VANILLAPDF_API error_type CALLING_CONVENTION OutlineItemFlags_IsBold(OutlineItemFlagsHandle* handle, boolean_type* result);
255 
260  VANILLAPDF_API error_type CALLING_CONVENTION OutlineItemFlags_Release(OutlineItemFlagsHandle* handle);
261 
264 #ifdef __cplusplus
265 };
266 #endif
267 
268 #endif /* _C_OUTLINE_H */
error_type OutlineItem_GetFirst(OutlineItemHandle *handle, OutlineItemHandle **result)
The first of this item's immediate children in the outline hierarchy.
Definition: c_outline.h:78
error_type OutlineItemFlags_Release(OutlineItemFlagsHandle *handle)
Decrement the internal reference counter.
error_type OutlineItem_GetPrev(OutlineItemHandle *handle, OutlineItemHandle **result)
The previous item at this outline level.
error_type OutlineItem_GetCount(OutlineItemHandle *handle, IntegerObjectHandle **result)
Sum of the number of visible descendent outline items at all levels.
error_type OutlineItemColor_GetRed(OutlineItemColorHandle *handle, IntegerObjectHandle **result)
Get red component of defined RGB color.
Representing the components in the DeviceRGB colour space of the colour that shall be used for the ou...
error_type OutlineItemFlags_IsBold(OutlineItemFlagsHandle *handle, boolean_type *result)
Determine if the outline item shall be displayed in bold.
error_type OutlineItemColor_GetBlue(OutlineItemColorHandle *handle, IntegerObjectHandle **result)
Get blue component of defined RGB color.
error_type OutlineBase_ToOutlineItem(OutlineBaseHandle *handle, OutlineItemHandle **result)
Reinterpret current object as OutlineItemHandle.
Base class for document outlines.
error_type OutlineItem_Release(OutlineItemHandle *handle)
Decrement the internal reference counter.
Integer objects represent mathematical integers.
error_type OutlineItem_GetNext(OutlineItemHandle *handle, OutlineItemHandle **result)
The next item at this outline level.
This file contains all type forward declarations returned by the library API.
error_type OutlineItemColor_Release(OutlineItemColorHandle *handle)
Decrement the internal reference counter.
error_type OutlineBase_Release(OutlineBaseHandle *handle)
Decrement the internal reference counter.
error_type Outline_GetFirst(OutlineHandle *handle, OutlineItemHandle **result)
An outline item dictionary representing the first top-level item in the outline.
error_type OutlineBase_ToOutline(OutlineBaseHandle *handle, OutlineHandle **result)
Reinterpret current object as OutlineHandle.
error_type OutlineItem_GetTitle(OutlineItemHandle *handle, StringObjectHandle **result)
The text that shall be displayed on the screen for this item.
error_type OutlineItem_GetParent(OutlineItemHandle *handle, OutlineBaseHandle **result)
The parent of this item in the outline hierarchy.
error_type OutlineItem_GetLast(OutlineItemHandle *handle, OutlineItemHandle **result)
The last of this item's immediate children in the outline hierarchy.
uint32_t error_type
This is return value type of all API functions.
Definition: c_types.h:25
error_type OutlineItemFlags_IsItalic(OutlineItemFlagsHandle *handle, boolean_type *result)
Determine if the outline item shall be displayed in italic.
This file contains macro declarations for importing and exporting symbols from library boundaries...
A set of flags specifying style characteristics for displaying the outline item's text...
The root of a document's outline hierarchy.
error_type OutlineItem_GetFlags(OutlineItemHandle *handle, OutlineItemFlagsHandle **result)
A set of flags specifying style characteristics for displaying the outline item's text...
error_type Outline_GetLast(OutlineHandle *handle, OutlineItemHandle **result)
An outline item dictionary representing the last top-level item in the outline.
Definition: c_outline.h:72
error_type OutlineItemColor_GetGreen(OutlineItemColorHandle *handle, IntegerObjectHandle **result)
Get green component of defined RGB color.
This file contains types and constants used as parameters or return values.
error_type OutlineBase_GetOutlineType(OutlineBaseHandle *handle, OutlineType *result)
Get derived type of current object.
error_type Outline_Release(OutlineHandle *handle)
Decrement the internal reference counter.
OutlineType
Available types of outlines.
Definition: c_outline.h:65
error_type Outline_GetCount(OutlineHandle *handle, IntegerObjectHandle **result)
Total number of visible outline items at all levels of the outline.
Reprsents human readable text.
Child element within tree-structured hierarchy of outline items.
error_type OutlineItem_GetColor(OutlineItemHandle *handle, OutlineItemColorHandle **result)
Representing the components in the DeviceRGB colour space of the colour that shall be used for the ou...
int8_t boolean_type
Boolean type supported in C.
Definition: c_types.h:31