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
group.h
Go to the documentation of this file.
1 // Copyright 2015-2025 Trimble Inc. All rights reserved.
2 // This file is intended for public distribution.
3
4 #ifndef LAYOUT_MODEL_GROUP_H_
5 #define LAYOUT_MODEL_GROUP_H_
6
7 #include <LayOutAPI/common.h>
8 #include <LayOutAPI/model/defs.h>
9 #include <LayOutAPI/model/document.h>
10
21 #ifdef __cplusplus
22 extern "C" {
23 #endif // __cplusplus
24
29 typedef enum {
30 LOGroupResizeBehaviorType_None = 0,
31 LOGroupResizeBehaviorType_Bounds,
32 LOGroupResizeBehaviorType_BoundsAndFonts
33 } LOGroupResizeBehaviorType;
34
61 LO_RESULT LOGroupCreate(LOGroupRef* group, LOEntityListRef entity_list);
62
70 LO_RESULT LOGroupAddReference(LOGroupRef group);
71
81 LO_RESULT LOGroupRelease(LOGroupRef* group);
82
92 LO_EXPORT LOGroupRef LOGroupFromEntity(LOEntityRef entity);
93
102 LO_EXPORT LOEntityRef LOGroupToEntity(LOGroupRef group);
103
115 LO_RESULT LOGroupUngroup(LOGroupRef* group);
116
127 LO_RESULT LOGroupGetEntities(LOGroupRef group, LOEntityListRef entity_list);
128
138 LO_RESULT LOGroupGetNumberOfEntities(LOGroupRef group, size_t* num_entities);
139
152 LO_RESULT LOGroupGetEntityAtIndex(LOGroupRef group, size_t index, LOEntityRef* child_entity);
153
165 LO_RESULT LOGroupGetScaleFactor(LOGroupRef group, double* scale_factor);
166
183 LO_RESULT LOGroupSetScaleFactor(
184 LOGroupRef group, double scale_factor, LODocumentUnits units,
185 LOGroupResizeBehaviorType resize_behavior);
186
187
202 LO_RESULT LOGroupGetScaleUnits(LOGroupRef group, LODocumentUnits* units, double* precision);
203
223 LO_RESULT LOGroupSetScaleUnits(LOGroupRef group, LODocumentUnits units, double precision);
224
238 LO_RESULT LOGroupRemoveScaleFactor(LOGroupRef group, LOGroupResizeBehaviorType resize_behavior);
239
240 #ifdef __cplusplus
241 } // end extern C
242 #endif // __cplusplus
243
244 #endif // LAYOUT_MODEL_GROUP_H_