opensource/obs-studio
3
0
Fork 0
mirror of https://github.com/obsproject/obs-studio.git synced 2026-09-24 23:31:36 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #2723 from exeldro/doc_prop_group

Browse Source 
docs/sphinx: Add Property Grouping
This commit is contained in:
Colin Edwards
2020-04-18 17:15:57 -05:00
committed by GitHub
parent 47cfe13be2 b7a17d5b22
commit 8a89dd7a46
1 changed files with 42 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/sphinx/reference-properties.rst
+42
View File
@@ -71,6 +71,10 @@ General Functions
---------------------
.. function:: obs_properties_t *obs_properties_get_parent(obs_properties_t *props)
---------------------
Property Object Functions
-------------------------
@@ -276,6 +280,29 @@ Property Object Functions
---------------------
.. function:: obs_property_t *obs_properties_add_group(obs_properties_t *props, const char *name, const char *description, enum obs_group_type type, obs_properties_t *group)
Adds a property group.
:param name: Setting identifier string
:param description: Localized name shown to user
:param type: Can be one of the following values:
- **OBS_GROUP_NORMAL** - A normal group with just a name and content.
- **OBS_GROUP_CHECKABLE** - A checkable group with a checkbox, name and content.
:param group: Group to add
:return: The property
Important Related Functions:
- :c:func:`obs_property_group_type`
- :c:func:`obs_property_group_content`
- :c:func:`obs_properties_get_parent`
---------------------
Property Enumeration Functions
------------------------------
@@ -340,6 +367,7 @@ Property Enumeration Functions
- OBS_PROPERTY_FONT
- OBS_PROPERTY_EDITABLE_LIST
- OBS_PROPERTY_FRAME_RATE
- OBS_PROPERTY_GROUP
---------------------
@@ -467,6 +495,20 @@ Property Enumeration Functions
---------------------
.. function:: enum obs_group_type obs_property_group_type(obs_property_t *p)
:return: One of the following values:
- OBS_COMBO_INVALID
- OBS_GROUP_NORMAL
- OBS_GROUP_CHECKABLE
---------------------
.. function:: obs_properties_t *obs_property_group_content(obs_property_t *p)
---------------------
Property Modification Functions
-------------------------------