LayOut C API
|
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... | |
References a LayOut document.
|
related |
Gets a copy of an attribute dictionary with the given name from a document.
[in] | document | The document object. |
[in] | dictionary_name | The name of the attribute dictionary object to retrieve. |
[out] | dictionary | The attribute dictionary object. |
document
does not refer to a valid objectdictionary_name
is NULLdictionary
is NULLdocument
does not have an attribute dictionary with the given name
|
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.
[in] | document | The document object. |
[in] | dictionary_name | The name of the attribute dictionary object to remove. |
[in] | key | The key to remove from the attribute dictionary. |
document
does not refer to a valid objectdictionary_name
is NULL
|
related |
Gets an attribute from a given dictionary belonging to a document.
[in] | document | The document 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. |
document
does not refer to a valid objectvalue_out
does not refer to a valid objectdictionary_name
or key
are NULL
|
related |
Sets an attribute to a given dictionary belonging to a document.
[in] | document | The document 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. |
document
does not refer to a valid objectvalue_in
contains no datadictionary_name
or key
are NULLdictionary_name
is empty