LayOut C API

- Main Page
- Related Pages
- Data Structures
- Files

- File List
- Globals

All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
page.h
Go to the documentation of this file.
1 // Copyright 2015 Trimble Navigation Ltd. All rights reserved.
2 // This file is intended for public distribution.
3
4 #ifndef LAYOUT_MODEL_PAGE_H_
5 #define LAYOUT_MODEL_PAGE_H_
6
7 #include <LayOutAPI/common.h>
8 #include <LayOutAPI/model/defs.h>
9
15 typedef enum {
16 LOPageEntityIteratorFlags_None = 0x0,
17 LOPageEntityIteratorFlags_SkipHidden = 0x1,
18 LOPageEntityIteratorFlags_SkipLocked = 0x2,
19 LOPageEntityIteratorFlags_SkipHiddenOrLocked = 0x3
20 } LOPageEntityIteratorFlags;
21
27 #ifdef __cplusplus
28 extern "C" {
29 #endif // __cplusplus
30
41 LO_RESULT LOPageGetName(LOPageRef page, SUStringRef* name);
42
53 LO_RESULT LOPageSetName(LOPageRef page, const char* name);
54
64 LO_RESULT LOPageGetInPresentation(LOPageRef page, bool* in_presentation);
65
74 LO_RESULT LOPageSetInPresentation(LOPageRef page, bool in_presentation);
75
92 LO_RESULT LOPageGetLayerVisible(LOPageRef page, LOLayerRef layer_definition, bool* visible);
93
112 LO_RESULT LOPageSetLayerVisible(LOPageRef page, LOLayerRef layer_definition, bool visible);
113
131 LO_RESULT LOPageGetLayerInstances(
132 LOPageRef page, size_t array_size, LOLayerInstanceRef layer_instances[], size_t* number_copied);
133
149 LO_RESULT LOPageGetLayerInstanceAtIndex(
150 LOPageRef page, size_t index, LOLayerInstanceRef* layer_instance);
151
162 LO_RESULT LOPageGetPageIndex(LOPageRef page, size_t* index);
163
175 LO_RESULT LOPageGetNumberOfNonSharedEntities(LOPageRef page, size_t* num_nonshared_entities);
176
191 LO_RESULT LOPageGetNonSharedEntityAtIndex(LOPageRef page, size_t index, LOEntityRef* entity);
192
205 LO_RESULT LOPageGetNonSharedEntities(LOPageRef page, LOEntityListRef entity_list);
206
223 LO_RESULT LOPageCreateEntityIterator(
224 LOPageRef page, LOPageEntityIteratorFlags flags, LOEntityIteratorRef* entity_iterator);
225
242 LO_RESULT LOPageCreateReverseEntityIterator(
243 LOPageRef page, LOPageEntityIteratorFlags flags, LOEntityIteratorRef* entity_iterator);
244
255 LO_RESULT LOPageGetDocument(LOPageRef page, LODocumentRef* document);
256
271 LO_RESULT LOPageCreateAttributeDictionaryCopy(
272 LOPageRef page, const char* dictionary_name, LODictionaryRef* dictionary);
273
290 LO_RESULT LOPageSetAttribute(
291 LOPageRef page, const char* dictionary_name, const char* key, LOTypedValueRef value_in);
292
309 LO_RESULT LOPageGetAttribute(
310 LOPageRef page, const char* dictionary_name, const char* key, LOTypedValueRef value_out);
311
325 LO_RESULT LOPageDeleteAttribute(LOPageRef page, const char* dictionary_name, const char* key);
326
327 #ifdef __cplusplus
328 } // end extern "C"
329 #endif // __cplusplus
330
331 #endif // LAYOUT_MODEL_PAGE_H_