group.h

Go to the documentation of this file.

// Copyright 2015-2025 Trimble Inc. All rights reserved.
// This file is intended for public distribution.

#ifndef LAYOUT_MODEL_GROUP_H_
#define LAYOUT_MODEL_GROUP_H_

#include <LayOutAPI/common.h>
#include <LayOutAPI/model/defs.h>
#include <LayOutAPI/model/document.h>

#ifdef __cplusplus
extern "C" {
#endif  // __cplusplus

typedef enum {
  LOGroupResizeBehaviorType_None = 0,       
  LOGroupResizeBehaviorType_Bounds,         
  LOGroupResizeBehaviorType_BoundsAndFonts  
} LOGroupResizeBehaviorType;

LO_RESULT LOGroupCreate(LOGroupRef* group, LOEntityListRef entity_list);

LO_RESULT LOGroupAddReference(LOGroupRef group);

LO_RESULT LOGroupRelease(LOGroupRef* group);

LO_EXPORT LOGroupRef LOGroupFromEntity(LOEntityRef entity);

LO_EXPORT LOEntityRef LOGroupToEntity(LOGroupRef group);

LO_RESULT LOGroupUngroup(LOGroupRef* group);

LO_RESULT LOGroupGetEntities(LOGroupRef group, LOEntityListRef entity_list);

LO_RESULT LOGroupGetNumberOfEntities(LOGroupRef group, size_t* num_entities);

LO_RESULT LOGroupGetEntityAtIndex(LOGroupRef group, size_t index, LOEntityRef* child_entity);

LO_RESULT LOGroupGetScaleFactor(LOGroupRef group, double* scale_factor);

LO_RESULT LOGroupSetScaleFactor(
    LOGroupRef group, double scale_factor, LODocumentUnits units,
    LOGroupResizeBehaviorType resize_behavior);


LO_RESULT LOGroupGetScaleUnits(LOGroupRef group, LODocumentUnits* units, double* precision);

LO_RESULT LOGroupSetScaleUnits(LOGroupRef group, LODocumentUnits units, double precision);

LO_RESULT LOGroupRemoveScaleFactor(LOGroupRef group, LOGroupResizeBehaviorType resize_behavior);

#ifdef __cplusplus
}  // end extern C
#endif  // __cplusplus

#endif  // LAYOUT_MODEL_GROUP_H_