diff options
| author | David Robillard <d@drobilla.net> | 2021-01-07 15:25:36 +0100 |
|---|---|---|
| committer | David Robillard <d@drobilla.net> | 2021-01-07 17:29:33 +0100 |
| commit | eb0f335d49ac3b501626d9e1ec140978fe795df6 (patch) | |
| tree | d5f6c8c9874555abdb42f1b901cc47d8f6597fec /doc/c/uis.rst | |
| parent | efa8abca4b80b2388e828fce069821a20dc68a68 (diff) | |
| download | lilv-eb0f335d49ac3b501626d9e1ec140978fe795df6.tar.gz lilv-eb0f335d49ac3b501626d9e1ec140978fe795df6.tar.bz2 lilv-eb0f335d49ac3b501626d9e1ec140978fe795df6.zip | |
Generate documentation with Sphinx and add an overview
Diffstat (limited to 'doc/c/uis.rst')
| -rw-r--r-- | doc/c/uis.rst | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/c/uis.rst b/doc/c/uis.rst new file mode 100644 index 0000000..cbca8f6 --- /dev/null +++ b/doc/c/uis.rst @@ -0,0 +1,21 @@ +.. default-domain:: c +.. highlight:: c + +############### +User Interfaces +############### + +Plugins may have custom user interfaces, or `UIs`, +which are installed in bundles just like plugins. + +The available UIs for a plugin can be accessed with :func:`lilv_plugin_get_uis`: + +.. code-block:: c + + LilvUIs* uis = lilv_plugin_get_uis(plugin); + +:struct:`LilvUIs` is a collection much like `LilvPlugins`, +except it is of course a set of :struct:`LilvUI` rather than a set of :struct:`LilvPlugin`. +Also like plugins, +the :struct:`LilvUI` class has various accessors that can be used to get information about the UI. +See the :doc:`API reference <api/ui>` for details. |