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
layer.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_LAYER_H_
5 #define LAYOUT_MODEL_LAYER_H_
6
7 #include <LayOutAPI/common.h>
8 #include <LayOutAPI/model/defs.h>
9
21 typedef enum {
22 LOShareLayerAction_Clear,
23 LOShareLayerAction_KeepOnePage,
24 LOShareLayerAction_MergeAllPages,
25
26 LONumShareLayerActions
27 } LOShareLayerAction;
28
34 typedef enum {
35 LOUnshareLayerAction_Clear,
36 LOUnshareLayerAction_CopyToOnePage,
37 LOUnshareLayerAction_CopyToAllPages,
38
39 LONumUnshareLayerActions
40 } LOUnshareLayerAction;
41
42 #ifdef __cplusplus
43 extern "C" {
44 #endif // __cplusplus
45
57 LO_RESULT LOLayerGetName(LOLayerRef layer_definition, SUStringRef* name);
58
70 LO_RESULT LOLayerSetName(LOLayerRef layer_definition, const char* name);
71
82 LO_RESULT LOLayerGetLocked(LOLayerRef layer_definition, bool* is_locked);
83
100 LO_RESULT LOLayerSetLocked(LOLayerRef layer_definition, bool is_locked);
101
112 LO_RESULT LOLayerGetShared(LOLayerRef layer_definition, bool* is_shared);
113
133 LO_RESULT LOLayerSetShared(LOLayerRef layer_definition, LOPageRef page, LOShareLayerAction action);
134
154 LO_RESULT LOLayerSetNonShared(
155 LOLayerRef layer_definition, LOPageRef page, LOUnshareLayerAction action);
156
175 LO_RESULT LOLayerGetLayerInstance(
176 LOLayerRef layer_definition, LOPageRef page, LOLayerInstanceRef* layer_instance);
177
188 LO_RESULT LOLayerGetLayerIndex(LOLayerRef layer_definition, size_t* index);
189
201 LO_RESULT LOLayerGetDocument(LOLayerRef layer_definition, LODocumentRef* document);
202
203 #ifdef __cplusplus
204 } // end extern "C"
205 #endif // __cplusplus
206
207 #endif // LAYOUT_MODEL_LAYER_H_