LayOut C API
|
Go to the source code of this file.
Functions | |
LO_RESULT | LOReferenceEntityAddReference (LOReferenceEntityRef reference_entity) |
Adds a reference to a reference entity object. More... | |
LO_RESULT | LOReferenceEntityRelease (LOReferenceEntityRef *reference_entity) |
Releases a reference entity object. The object will be invalidated if releasing the last reference. More... | |
LO_EXPORT LOReferenceEntityRef | LOReferenceEntityFromEntity (LOEntityRef entity) |
Converts from a LOEntityRef to a LOReferenceEntityRef. This is essentially a downcast operation so the given LOEntityRef must be convertible to a LOReferenceEntityRef. More... | |
LO_EXPORT LOEntityRef | LOReferenceEntityToEntity (LOReferenceEntityRef reference_entity) |
Converts from a LOReferenceEntityRef to a LOEntityRef. This is essentially an upcast operation. More... | |
LO_RESULT | LOReferenceEntityGetClipMask (LOReferenceEntityRef reference_entity, LOEntityRef *clip_mask) |
Returns any clip mask assigned to the reference entity. More... | |
LO_RESULT | LOReferenceEntitySetClipMask (LOReferenceEntityRef reference_entity, LOEntityRef clip_mask) |
Sets the clip mask of the reference entity. A clip mask defines a region of the entity that is visible. This allows you to crop with arbitrary shapes. This operation will replace any clip mask that is already assigned to this reference entity. The entity being used must not be already part of a document or group. The clip mask entity must be either a rectangle, ellipse or a path, or may be SU_INVALID, which will remove the existing clip mask, if any. More... | |
LO_RESULT | LOReferenceEntityGetExplodedEntities (LOReferenceEntityRef reference_entity, LOEntityListRef entity_list) |
Creates the entities that represent the reference entity in its exploded form and adds them to a LOEntityListRef. It is NOT necessary to explicitly release these entities, since LOEntityListRef itself adds a reference to the entities and will release them when they are removed from the list or when the list is released. More... | |
LO_RESULT LOReferenceEntityAddReference | ( | LOReferenceEntityRef | reference_entity | ) |
Adds a reference to a reference entity object.
[in] | reference_entity | The reference entity object. |
LO_EXPORT LOReferenceEntityRef LOReferenceEntityFromEntity | ( | LOEntityRef | entity | ) |
Converts from a LOEntityRef to a LOReferenceEntityRef. This is essentially a downcast operation so the given LOEntityRef must be convertible to a LOReferenceEntityRef.
[in] | entity | The entity object. |
LO_RESULT LOReferenceEntityGetClipMask | ( | LOReferenceEntityRef | reference_entity, |
LOEntityRef * | clip_mask | ||
) |
Returns any clip mask assigned to the reference entity.
[in] | reference_entity | The reference entity object. |
[out] | clip_mask | The clip mask of the reference entity. |
LO_RESULT LOReferenceEntityGetExplodedEntities | ( | LOReferenceEntityRef | reference_entity, |
LOEntityListRef | entity_list | ||
) |
Creates the entities that represent the reference entity in its exploded form and adds them to a LOEntityListRef. It is NOT necessary to explicitly release these entities, since LOEntityListRef itself adds a reference to the entities and will release them when they are removed from the list or when the list is released.
[in] | reference_entity | The reference entity object. |
[in] | entity_list | The entity list object to add the new entities to. |
LO_RESULT LOReferenceEntityRelease | ( | LOReferenceEntityRef * | reference_entity | ) |
Releases a reference entity object. The object will be invalidated if releasing the last reference.
[in] | reference_entity | The reference entity object. |
LO_RESULT LOReferenceEntitySetClipMask | ( | LOReferenceEntityRef | reference_entity, |
LOEntityRef | clip_mask | ||
) |
Sets the clip mask of the reference entity. A clip mask defines a region of the entity that is visible. This allows you to crop with arbitrary shapes. This operation will replace any clip mask that is already assigned to this reference entity. The entity being used must not be already part of a document or group. The clip mask entity must be either a rectangle, ellipse or a path, or may be SU_INVALID, which will remove the existing clip mask, if any.
[in] | reference_entity | The reference entity object. |
[in] | clip_mask | The new clip mask for the reference entity. |
LO_EXPORT LOEntityRef LOReferenceEntityToEntity | ( | LOReferenceEntityRef | reference_entity | ) |
Converts from a LOReferenceEntityRef to a LOEntityRef. This is essentially an upcast operation.
[in] | reference_entity | The reference entity object. |