LayOut C API
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Related Functions
LODocumentRef Struct Reference

References a LayOut document. More...

#include <document.h>

Related Functions

(Note that these are not member functions.)

LO_RESULT LODocumentCreateAttributeDictionaryCopy (LODocumentRef document, const char *dictionary_name, LODictionaryRef *dictionary)
 Gets a copy of an attribute dictionary with the given name from a document. More...
 
LO_RESULT LODocumentSetAttribute (LODocumentRef document, const char *dictionary_name, const char *key, LOTypedValueRef value_in)
 Sets an attribute to a given dictionary belonging to a document. More...
 
LO_RESULT LODocumentGetAttribute (LODocumentRef document, const char *dictionary_name, const char *key, LOTypedValueRef value_out)
 Gets an attribute from a given dictionary belonging to a document. More...
 
LO_RESULT LODocumentDeleteAttribute (LODocumentRef document, const char *dictionary_name, const char *key)
 Removes an attribute from a given dictionary belonging to a Document. If key is nullptr, then the entire dictionary will be removed from the Document. More...
 

Detailed Description

References a LayOut document.

Friends And Related Function Documentation

LO_RESULT LODocumentCreateAttributeDictionaryCopy ( LODocumentRef  document,
const char *  dictionary_name,
LODictionaryRef dictionary 
)
related

Gets a copy of an attribute dictionary with the given name from a document.

Since
LayOut 2026, API 11.0
Parameters
[in]documentThe document object.
[in]dictionary_nameThe name of the attribute dictionary object to retrieve.
[out]dictionaryThe attribute dictionary object.
Returns
LO_RESULT LODocumentDeleteAttribute ( LODocumentRef  document,
const char *  dictionary_name,
const char *  key 
)
related

Removes an attribute from a given dictionary belonging to a Document. If key is nullptr, then the entire dictionary will be removed from the Document.

Since
LayOut 2026, API 11.0
Parameters
[in]documentThe document object.
[in]dictionary_nameThe name of the attribute dictionary object to remove.
[in]keyThe key to remove from the attribute dictionary.
Returns
LO_RESULT LODocumentGetAttribute ( LODocumentRef  document,
const char *  dictionary_name,
const char *  key,
LOTypedValueRef  value_out 
)
related

Gets an attribute from a given dictionary belonging to a document.

Since
LayOut 2026, API 11.0
Parameters
[in]documentThe document object.
[in]dictionary_nameThe name of the attribute dictionary object to retrieve the value from.
[in]keyThe key to use when adding to the attribute dictionary.
[out]value_outThe value retrieved from the attribute dictionary.
Returns
LO_RESULT LODocumentSetAttribute ( LODocumentRef  document,
const char *  dictionary_name,
const char *  key,
LOTypedValueRef  value_in 
)
related

Sets an attribute to a given dictionary belonging to a document.

Since
LayOut 2026, API 11.0
Parameters
[in]documentThe document object.
[in]dictionary_nameThe name of the attribute dictionary object being added to.
[in]keyThe key to use when adding to the attribute dictionary.
[in]value_inThe value to be added to the attribute dictionary.
Returns

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