Vanilla.PDF  1.4.1
Cross-platform toolkit for creating and modifying PDF documents
c_array_object.h
Go to the documentation of this file.
1 #ifndef _C_ARRAY_OBJECT_H
2 #define _C_ARRAY_OBJECT_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 
33  VANILLAPDF_API error_type CALLING_CONVENTION ArrayObject_Create(ArrayObjectHandle** result);
34 
38  VANILLAPDF_API error_type CALLING_CONVENTION ArrayObject_GetSize(ArrayObjectHandle* handle, size_type* result);
39 
43  VANILLAPDF_API error_type CALLING_CONVENTION ArrayObject_GetValue(ArrayObjectHandle* handle, size_type at, ObjectHandle** result);
44 
48  VANILLAPDF_API error_type CALLING_CONVENTION ArrayObject_SetValue(ArrayObjectHandle* handle, size_type at, ObjectHandle* value);
49 
53  VANILLAPDF_API error_type CALLING_CONVENTION ArrayObject_Append(ArrayObjectHandle* handle, ObjectHandle* value);
54 
58  VANILLAPDF_API error_type CALLING_CONVENTION ArrayObject_Insert(ArrayObjectHandle* handle, size_type at, ObjectHandle* value);
59 
63  VANILLAPDF_API error_type CALLING_CONVENTION ArrayObject_Remove(ArrayObjectHandle* handle, size_type at);
64 
68  VANILLAPDF_API error_type CALLING_CONVENTION ArrayObject_Clear(ArrayObjectHandle* handle);
69 
73  VANILLAPDF_API error_type CALLING_CONVENTION ArrayObject_ToObject(ArrayObjectHandle* handle, ObjectHandle** result);
74 
78  VANILLAPDF_API error_type CALLING_CONVENTION ArrayObject_FromObject(ObjectHandle* handle, ArrayObjectHandle** result);
79 
83  VANILLAPDF_API error_type CALLING_CONVENTION ArrayObject_Release(ArrayObjectHandle* handle);
84 
87 #ifdef __cplusplus
88 };
89 #endif
90 
91 #endif /* _C_ARRAY_OBJECT_H */
ArrayObjectHandle::ArrayObject_SetValue
error_type ArrayObject_SetValue(ArrayObjectHandle *handle, size_type at, ObjectHandle *value)
Set element at location at.
ArrayObjectHandle::ArrayObject_Remove
error_type ArrayObject_Remove(ArrayObjectHandle *handle, size_type at)
Remove element from location at.
ArrayObjectHandle::ArrayObject_Release
error_type ArrayObject_Release(ArrayObjectHandle *handle)
Decrement the internal reference counter.
ArrayObjectHandle::ArrayObject_Clear
error_type ArrayObject_Clear(ArrayObjectHandle *handle)
Clear all items from the collection.
ArrayObjectHandle::ArrayObject_Create
error_type ArrayObject_Create(ArrayObjectHandle **result)
Creates a new ArrayObject instance.
ArrayObjectHandle::ArrayObject_FromObject
error_type ArrayObject_FromObject(ObjectHandle *handle, ArrayObjectHandle **result)
Convert ObjectHandle to ArrayObjectHandle.
c_handles.h
This file contains all type forward declarations returned by the library API.
ArrayObjectHandle::ArrayObject_GetSize
error_type ArrayObject_GetSize(ArrayObjectHandle *handle, size_type *result)
Return size of an array.
size_type
uint32_t size_type
Size type defined in standard library.
Definition: c_types.h:62
ArrayObjectHandle
Represents array of mixed type elements.
ObjectHandle
Base class for syntactic tokens.
ArrayObjectHandle::ArrayObject_GetValue
error_type ArrayObject_GetValue(ArrayObjectHandle *handle, size_type at, ObjectHandle **result)
Get element at location at.
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...
c_values.h
This file contains types and constants used as parameters or return values.
ArrayObjectHandle::ArrayObject_ToObject
error_type ArrayObject_ToObject(ArrayObjectHandle *handle, ObjectHandle **result)
Reinterpret current object as ObjectHandle.
ArrayObjectHandle::ArrayObject_Insert
error_type ArrayObject_Insert(ArrayObjectHandle *handle, size_type at, ObjectHandle *value)
Insert new element at location at.
ArrayObjectHandle::ArrayObject_Append
error_type ArrayObject_Append(ArrayObjectHandle *handle, ObjectHandle *value)
Insert new element at the end of the array.