Vanilla.PDF  2.0.0
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
7
8#ifdef __cplusplus
9extern "C"
10{
11#endif
12
65 typedef enum {
66 OutlineType_Undefined = 0,
67
73
80
89 VANILLAPDF_API error_type CALLING_CONVENTION OutlineBase_GetOutlineType(OutlineBaseHandle* handle, OutlineType* result);
90
94 VANILLAPDF_API error_type CALLING_CONVENTION OutlineBase_ToUnknown(OutlineBaseHandle* handle, IUnknownHandle** result);
95
99 VANILLAPDF_API error_type CALLING_CONVENTION OutlineBase_FromUnknown(IUnknownHandle* handle, OutlineBaseHandle** 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_ToOutlineBase(OutlineHandle* handle, OutlineBaseHandle** result);
142
146 VANILLAPDF_API error_type CALLING_CONVENTION Outline_FromOutlineBase(OutlineBaseHandle* handle, OutlineHandle** result);
147
151 VANILLAPDF_API error_type CALLING_CONVENTION Outline_Release(OutlineHandle* handle);
152
164 VANILLAPDF_API error_type CALLING_CONVENTION OutlineItem_GetTitle(OutlineItemHandle* handle, StringObjectHandle** result);
165
170 VANILLAPDF_API error_type CALLING_CONVENTION OutlineItem_GetParent(OutlineItemHandle* handle, OutlineBaseHandle** result);
171
176 VANILLAPDF_API error_type CALLING_CONVENTION OutlineItem_GetPrev(OutlineItemHandle* handle, OutlineItemHandle** result);
177
182 VANILLAPDF_API error_type CALLING_CONVENTION OutlineItem_GetNext(OutlineItemHandle* handle, OutlineItemHandle** result);
183
188 VANILLAPDF_API error_type CALLING_CONVENTION OutlineItem_GetFirst(OutlineItemHandle* handle, OutlineItemHandle** result);
189
194 VANILLAPDF_API error_type CALLING_CONVENTION OutlineItem_GetLast(OutlineItemHandle* handle, OutlineItemHandle** result);
195
200 VANILLAPDF_API error_type CALLING_CONVENTION OutlineItem_GetCount(OutlineItemHandle* handle, IntegerObjectHandle** result);
201
202 //VANILLAPDF_API error_type CALLING_CONVENTION OutlineItem_GetDestinations(OutlineItemHandle* handle, IntegerObjectHandle** result);
203 //VANILLAPDF_API error_type CALLING_CONVENTION OutlineItem_GetActions(OutlineItemHandle* handle, IntegerObjectHandle** result);
204 //VANILLAPDF_API error_type CALLING_CONVENTION OutlineItem_GetStructureElement(OutlineItemHandle* handle, IntegerObjectHandle** result);
205
209 VANILLAPDF_API error_type CALLING_CONVENTION OutlineItem_GetColor(OutlineItemHandle* handle, OutlineItemColorHandle** result);
210
214 VANILLAPDF_API error_type CALLING_CONVENTION OutlineItem_GetFlags(OutlineItemHandle* handle, OutlineItemFlagsHandle** result);
215
219 VANILLAPDF_API error_type CALLING_CONVENTION OutlineItem_ToOutlineBase(OutlineItemHandle* handle, OutlineBaseHandle** result);
220
224 VANILLAPDF_API error_type CALLING_CONVENTION OutlineItem_FromOutlineBase(OutlineBaseHandle* handle, OutlineItemHandle** result);
225
229 VANILLAPDF_API error_type CALLING_CONVENTION OutlineItem_Release(OutlineItemHandle* handle);
230
241 VANILLAPDF_API error_type CALLING_CONVENTION OutlineItemColor_GetRed(OutlineItemColorHandle* handle, IntegerObjectHandle** result);
242
246 VANILLAPDF_API error_type CALLING_CONVENTION OutlineItemColor_GetGreen(OutlineItemColorHandle* handle, IntegerObjectHandle** result);
247
251 VANILLAPDF_API error_type CALLING_CONVENTION OutlineItemColor_GetBlue(OutlineItemColorHandle* handle, IntegerObjectHandle** result);
252
257 VANILLAPDF_API error_type CALLING_CONVENTION OutlineItemColor_Release(OutlineItemColorHandle* handle);
258
269 VANILLAPDF_API error_type CALLING_CONVENTION OutlineItemFlags_IsItalic(OutlineItemFlagsHandle* handle, boolean_type* result);
270
274 VANILLAPDF_API error_type CALLING_CONVENTION OutlineItemFlags_IsBold(OutlineItemFlagsHandle* handle, boolean_type* result);
275
280 VANILLAPDF_API error_type CALLING_CONVENTION OutlineItemFlags_Release(OutlineItemFlagsHandle* handle);
281
284#ifdef __cplusplus
285};
286#endif
287
288#endif /* _C_OUTLINE_H */
This file contains macro declarations for importing and exporting symbols from library boundaries.
This file contains all type forward declarations returned by the library API.
This file contains types and constants used as parameters or return values.
Base class for reference counting.
Integer objects represent mathematical integers.
Base class for document outlines.
error_type CALLING_CONVENTION OutlineBase_ToUnknown(OutlineBaseHandle *handle, IUnknownHandle **result)
Reinterpret current object as IUnknownHandle.
error_type CALLING_CONVENTION OutlineBase_FromUnknown(IUnknownHandle *handle, OutlineBaseHandle **result)
Convert IUnknownHandle to CatalogHandle.
error_type CALLING_CONVENTION OutlineBase_GetOutlineType(OutlineBaseHandle *handle, OutlineType *result)
Get derived type of current object.
error_type CALLING_CONVENTION OutlineBase_Release(OutlineBaseHandle *handle)
Decrement the internal reference counter.
The root of a document's outline hierarchy.
error_type CALLING_CONVENTION Outline_ToOutlineBase(OutlineHandle *handle, OutlineBaseHandle **result)
Reinterpret current object as OutlineBaseHandle.
error_type CALLING_CONVENTION Outline_FromOutlineBase(OutlineBaseHandle *handle, OutlineHandle **result)
Convert OutlineBaseHandle to OutlineItemHandle.
error_type CALLING_CONVENTION Outline_GetLast(OutlineHandle *handle, OutlineItemHandle **result)
An outline item dictionary representing the last top-level item in the outline.
error_type CALLING_CONVENTION Outline_GetCount(OutlineHandle *handle, IntegerObjectHandle **result)
Total number of visible outline items at all levels of the outline.
error_type CALLING_CONVENTION Outline_GetFirst(OutlineHandle *handle, OutlineItemHandle **result)
An outline item dictionary representing the first top-level item in the outline.
error_type CALLING_CONVENTION Outline_Release(OutlineHandle *handle)
Decrement the internal reference counter.
Representing the components in the DeviceRGB colour space of the colour that shall be used for the ou...
error_type CALLING_CONVENTION OutlineItemColor_GetBlue(OutlineItemColorHandle *handle, IntegerObjectHandle **result)
Get blue component of defined RGB color.
error_type CALLING_CONVENTION OutlineItemColor_Release(OutlineItemColorHandle *handle)
Decrement the internal reference counter.
error_type CALLING_CONVENTION OutlineItemColor_GetGreen(OutlineItemColorHandle *handle, IntegerObjectHandle **result)
Get green component of defined RGB color.
error_type CALLING_CONVENTION OutlineItemColor_GetRed(OutlineItemColorHandle *handle, IntegerObjectHandle **result)
Get red component of defined RGB color.
A set of flags specifying style characteristics for displaying the outline item's text.
error_type CALLING_CONVENTION OutlineItemFlags_Release(OutlineItemFlagsHandle *handle)
Decrement the internal reference counter.
error_type CALLING_CONVENTION OutlineItemFlags_IsBold(OutlineItemFlagsHandle *handle, boolean_type *result)
Determine if the outline item shall be displayed in bold.
error_type CALLING_CONVENTION OutlineItemFlags_IsItalic(OutlineItemFlagsHandle *handle, boolean_type *result)
Determine if the outline item shall be displayed in italic.
Child element within tree-structured hierarchy of outline items.
error_type CALLING_CONVENTION OutlineItem_FromOutlineBase(OutlineBaseHandle *handle, OutlineItemHandle **result)
Convert OutlineBaseHandle to OutlineItemHandle.
error_type CALLING_CONVENTION OutlineItem_Release(OutlineItemHandle *handle)
Decrement the internal reference counter.
error_type CALLING_CONVENTION OutlineItem_GetTitle(OutlineItemHandle *handle, StringObjectHandle **result)
The text that shall be displayed on the screen for this item.
error_type CALLING_CONVENTION OutlineItem_GetPrev(OutlineItemHandle *handle, OutlineItemHandle **result)
The previous item at this outline level.
error_type CALLING_CONVENTION OutlineItem_ToOutlineBase(OutlineItemHandle *handle, OutlineBaseHandle **result)
Reinterpret current object as OutlineBaseHandle.
error_type CALLING_CONVENTION OutlineItem_GetParent(OutlineItemHandle *handle, OutlineBaseHandle **result)
The parent of this item in the outline hierarchy.
error_type CALLING_CONVENTION OutlineItem_GetLast(OutlineItemHandle *handle, OutlineItemHandle **result)
The last of this item's immediate children in the outline hierarchy.
error_type CALLING_CONVENTION OutlineItem_GetFlags(OutlineItemHandle *handle, OutlineItemFlagsHandle **result)
A set of flags specifying style characteristics for displaying the outline item's text.
error_type CALLING_CONVENTION OutlineItem_GetCount(OutlineItemHandle *handle, IntegerObjectHandle **result)
Sum of the number of visible descendent outline items at all levels.
error_type CALLING_CONVENTION OutlineItem_GetNext(OutlineItemHandle *handle, OutlineItemHandle **result)
The next item at this outline level.
error_type CALLING_CONVENTION OutlineItem_GetColor(OutlineItemHandle *handle, OutlineItemColorHandle **result)
Representing the components in the DeviceRGB colour space of the colour that shall be used for the ou...
error_type CALLING_CONVENTION OutlineItem_GetFirst(OutlineItemHandle *handle, OutlineItemHandle **result)
The first of this item's immediate children in the outline hierarchy.
Reprsents human readable text.
OutlineType
Available types of outlines.
Definition c_outline.h:65
@ OutlineType_Item
Child element within tree-structured hierarchy of outline items.
Definition c_outline.h:78
@ OutlineType_Outline
The root of a document's outline hierarchy.
Definition c_outline.h:72
uint32_t error_type
This is return value type of all API functions.
Definition c_types.h:25
int8_t boolean_type
Boolean type supported in C.
Definition c_types.h:31