An entity is an object shown on a page of a LayOut document. More...

#include <entity.h>

Related Functions
(Note that these are not member functions.)
LO_RESULT	LOEntityCreateAttributeDictionaryCopy (LOEntityRef entity, const char dictionary_name, LODictionaryRef dictionary)
	Gets a copy of an attribute dictionary with the given name from an entity. More...

LO_RESULT	LOEntitySetAttribute (LOEntityRef entity, const char dictionary_name, const char key, LOTypedValueRef value_in)
	Sets an attribute dictionary to a given dictionary belonging to an entity. More...

LO_RESULT	LOEntityGetAttribute (LOEntityRef entity, const char dictionary_name, const char key, LOTypedValueRef value_out)
	Gets an attribute from a given dictionary belonging to an entity. More...

LO_RESULT	LOEntityDeleteAttribute (LOEntityRef entity, const char dictionary_name, const char key)
	Removes an attribute from a given dictionary belonging to an Entity. If key is nullptr, then the entire dictionary will be removed from the Entity. More...

Detailed Description

An entity is an object shown on a page of a LayOut document.

Friends And Related Function Documentation

LO_RESULT LOEntityCreateAttributeDictionaryCopy	(	LOEntityRef	entity,
		const char *	dictionary_name,
		LODictionaryRef *	dictionary
	)

Parameters

[in]	entity	The entity object.
[in]	dictionary_name	The name of the attribute dictionary object to retrieve.
[out]	dictionary	The attribute dictionary object.

Returns

SU_ERROR_NONE on success
SU_ERROR_INVALID_INPUT if entity does not refer to a valid object
SU_ERROR_NULL_POINTER_INPUT if dictionary_name is NULL
SU_ERROR_NULL_POINTER_OUTPUT if dictionary is NULL
SU_ERROR_NO_DATA if entity does not have an attribute dictionary with the given name
SU_ERROR_UNSUPPORTED if entity does not support attribute dictionaries

LO_RESULT LOEntityDeleteAttribute	(	LOEntityRef	entity,
		const char *	dictionary_name,
		const char *	key
	)

Parameters

[in]	entity	The entity object.
[in]	dictionary_name	The name of the attribute dictionary object to remove.
[in]	key	The key to remove from the attribute dictionary.

Returns

LO_RESULT LOEntityGetAttribute	(	LOEntityRef	entity,
		const char *	dictionary_name,
		const char *	key,
		LOTypedValueRef	value_out
	)

Parameters

[in]	entity	The entity object.
[in]	dictionary_name	The name of the attribute dictionary object to retrieve the value from.
[in]	key	The key to use when adding to the attribute dictionary.
[out]	value_out	The value retrieved from the attribute dictionary.

Returns

SU_ERROR_NONE on success
SU_ERROR_INVALID_INPUT if document does not refer to a valid object
SU_ERROR_INVALID_OUTPUT if value_out does not refer to a valid object
SU_ERROR_NULL_POINTER_INPUT if dictionary_name or key are NULL
SU_ERROR_NO_DATA if no attribute dictionary exists with the given name, or if the attribute dictionary does not contain the given key

LO_RESULT LOEntitySetAttribute	(	LOEntityRef	entity,
		const char *	dictionary_name,
		const char *	key,
		LOTypedValueRef	value_in
	)

Parameters

[in]	entity	The entity object.
[in]	dictionary_name	The name of the attribute dictionary object being added to.
[in]	key	The key to use when adding to the attribute dictionary.
[in]	value_in	The value to be added to the attribute dictionary.

Returns

SU_ERROR_NONE on success
SU_ERROR_INVALID_INPUT if entity does not refer to a valid object
SU_ERROR_INVALID_ARGUMENT if value_in contains no data
SU_ERROR_NULL_POINTER_INPUT if dictionary_name or key are NULL
SU_ERROR_UNSUPPORTED if entity does not support attribute dictionaries or dictionary_name or key are empty

The documentation for this struct was generated from the following file: