Editing PlexyUI API (section)

== macOS-style widgets ==

These widgets model shell-like controls, navigation elements, and drawers.

=== <code>plexy_toolbar</code> ===
<pre>uint32_t plexy_toolbar(PlexyWindow* win, uint32_t parent);</pre>
Create a toolbar and return its widget ID.

==== Parameters ====
{| class="wikitable"
|-
! Parameter !! Type !! Description
|-
| <code>win</code> || <code>PlexyWindow*</code> || Window handle that owns or contains the widget tree.
|-
| <code>parent</code> || <code>uint32_t</code> || Parent widget ID that will contain the new child widget.
|}

* '''Returns:''' A widget ID for the created or referenced widget.

=== <code>plexy_toolbar_item</code> ===
<pre>uint32_t plexy_toolbar_item(PlexyWindow* win, uint32_t parent, const char* label);</pre>
Create a toolbar item and return its widget ID.

==== Parameters ====
{| class="wikitable"
|-
! Parameter !! Type !! Description
|-
| <code>win</code> || <code>PlexyWindow*</code> || Window handle that owns or contains the widget tree.
|-
| <code>parent</code> || <code>uint32_t</code> || Parent widget ID that will contain the new child widget.
|-
| <code>label</code> || <code>const char*</code> || Display label shown with the widget.
|}

* '''Returns:''' A widget ID for the created or referenced widget.

=== <code>plexy_sidebar</code> ===
<pre>uint32_t plexy_sidebar(PlexyWindow* win, uint32_t parent);</pre>
Create a sidebar and return its widget ID.

==== Parameters ====
{| class="wikitable"
|-
! Parameter !! Type !! Description
|-
| <code>win</code> || <code>PlexyWindow*</code> || Window handle that owns or contains the widget tree.
|-
| <code>parent</code> || <code>uint32_t</code> || Parent widget ID that will contain the new child widget.
|}

* '''Returns:''' A widget ID for the created or referenced widget.

=== <code>plexy_sidebar_item</code> ===
<pre>uint32_t plexy_sidebar_item(PlexyWindow* win, uint32_t parent, const char* label);</pre>
Create a sidebar item and return its widget ID.

==== Parameters ====
{| class="wikitable"
|-
! Parameter !! Type !! Description
|-
| <code>win</code> || <code>PlexyWindow*</code> || Window handle that owns or contains the widget tree.
|-
| <code>parent</code> || <code>uint32_t</code> || Parent widget ID that will contain the new child widget.
|-
| <code>label</code> || <code>const char*</code> || Display label shown with the widget.
|}

* '''Returns:''' A widget ID for the created or referenced widget.

=== <code>plexy_sidebar_item_with_icon</code> ===
<pre>uint32_t plexy_sidebar_item_with_icon(PlexyWindow* win, uint32_t parent, const char* label, const char* icon_name);</pre>
Create a sidebar item with icon and return its widget ID.

==== Parameters ====
{| class="wikitable"
|-
! Parameter !! Type !! Description
|-
| <code>win</code> || <code>PlexyWindow*</code> || Window handle that owns or contains the widget tree.
|-
| <code>parent</code> || <code>uint32_t</code> || Parent widget ID that will contain the new child widget.
|-
| <code>label</code> || <code>const char*</code> || Display label shown with the widget.
|-
| <code>icon_name</code> || <code>const char*</code> || Icon name value.
|}

* '''Returns:''' A widget ID for the created or referenced widget.

=== <code>plexy_sidebar_section</code> ===
<pre>uint32_t plexy_sidebar_section(PlexyWindow* win, uint32_t parent, const char* title);</pre>
Create a sidebar section and return its widget ID.

==== Parameters ====
{| class="wikitable"
|-
! Parameter !! Type !! Description
|-
| <code>win</code> || <code>PlexyWindow*</code> || Window handle that owns or contains the widget tree.
|-
| <code>parent</code> || <code>uint32_t</code> || Parent widget ID that will contain the new child widget.
|-
| <code>title</code> || <code>const char*</code> || Human-readable label, title, or heading text.
|}

* '''Returns:''' A widget ID for the created or referenced widget.

=== <code>plexy_search_field</code> ===
<pre>uint32_t plexy_search_field(PlexyWindow* win, uint32_t parent, const char* placeholder);</pre>
Create a search field and return its widget ID.

==== Parameters ====
{| class="wikitable"
|-
! Parameter !! Type !! Description
|-
| <code>win</code> || <code>PlexyWindow*</code> || Window handle that owns or contains the widget tree.
|-
| <code>parent</code> || <code>uint32_t</code> || Parent widget ID that will contain the new child widget.
|-
| <code>placeholder</code> || <code>const char*</code> || Placeholder text shown before the user enters content.
|}

* '''Returns:''' A widget ID for the created or referenced widget.

=== <code>plexy_breadcrumb</code> ===
<pre>uint32_t plexy_breadcrumb(PlexyWindow* win, uint32_t parent, const char* path);</pre>
Create a breadcrumb and return its widget ID.

==== Parameters ====
{| class="wikitable"
|-
! Parameter !! Type !! Description
|-
| <code>win</code> || <code>PlexyWindow*</code> || Window handle that owns or contains the widget tree.
|-
| <code>parent</code> || <code>uint32_t</code> || Parent widget ID that will contain the new child widget.
|-
| <code>path</code> || <code>const char*</code> || Path text or breadcrumb string.
|}

* '''Returns:''' A widget ID for the created or referenced widget.

=== <code>plexy_split_view</code> ===
<pre>uint32_t plexy_split_view(PlexyWindow* win, uint32_t parent);</pre>
Create a split view and return its widget ID.

==== Parameters ====
{| class="wikitable"
|-
! Parameter !! Type !! Description
|-
| <code>win</code> || <code>PlexyWindow*</code> || Window handle that owns or contains the widget tree.
|-
| <code>parent</code> || <code>uint32_t</code> || Parent widget ID that will contain the new child widget.
|}

* '''Returns:''' A widget ID for the created or referenced widget.

=== <code>plexy_status_bar</code> ===
<pre>uint32_t plexy_status_bar(PlexyWindow* win, uint32_t parent, const char* text);</pre>
Create a status bar and return its widget ID.

==== Parameters ====
{| class="wikitable"
|-
! Parameter !! Type !! Description
|-
| <code>win</code> || <code>PlexyWindow*</code> || Window handle that owns or contains the widget tree.
|-
| <code>parent</code> || <code>uint32_t</code> || Parent widget ID that will contain the new child widget.
|-
| <code>text</code> || <code>const char*</code> || Text content to display or apply.
|}

* '''Returns:''' A widget ID for the created or referenced widget.

=== <code>plexy_drawer</code> ===
<pre>uint32_t plexy_drawer(PlexyWindow* win, uint32_t parent, int edge, float size);</pre>
Create a drawer and return its widget ID.

==== Parameters ====
{| class="wikitable"
|-
! Parameter !! Type !! Description
|-
| <code>win</code> || <code>PlexyWindow*</code> || Window handle that owns or contains the widget tree.
|-
| <code>parent</code> || <code>uint32_t</code> || Parent widget ID that will contain the new child widget.
|-
| <code>edge</code> || <code>int</code> || Drawer edge constant indicating which side the drawer attaches to.
|-
| <code>size</code> || <code>float</code> || Generic size value or drawer size.
|}

* '''Returns:''' A widget ID for the created or referenced widget.

=== <code>plexy_drawer_set_open</code> ===
<pre>void plexy_drawer_set_open(PlexyWindow* win, uint32_t drawer_id, int open, int animated);</pre>
Open or close a drawer and optionally animate the change.

==== Parameters ====
{| class="wikitable"
|-
! Parameter !! Type !! Description
|-
| <code>win</code> || <code>PlexyWindow*</code> || Window handle that owns or contains the widget tree.
|-
| <code>drawer_id</code> || <code>uint32_t</code> || Drawer id value.
|-
| <code>open</code> || <code>int</code> || Whether the drawer should be open.
|-
| <code>animated</code> || <code>int</code> || Whether the state change should be animated.
|}

=== <code>plexy_drawer_toggle</code> ===
<pre>void plexy_drawer_toggle(PlexyWindow* win, uint32_t drawer_id, int animated);</pre>
Toggle a drawer between open and closed states.

==== Parameters ====
{| class="wikitable"
|-
! Parameter !! Type !! Description
|-
| <code>win</code> || <code>PlexyWindow*</code> || Window handle that owns or contains the widget tree.
|-
| <code>drawer_id</code> || <code>uint32_t</code> || Drawer id value.
|-
| <code>animated</code> || <code>int</code> || Whether the state change should be animated.
|}

=== <code>plexy_drawer_is_open</code> ===
<pre>int plexy_drawer_is_open(PlexyWindow* win, uint32_t drawer_id);</pre>
Report whether a drawer is currently open.

==== Parameters ====
{| class="wikitable"
|-
! Parameter !! Type !! Description
|-
| <code>win</code> || <code>PlexyWindow*</code> || Window handle that owns or contains the widget tree.
|-
| <code>drawer_id</code> || <code>uint32_t</code> || Drawer id value.
|}

* '''Returns:''' A non-zero value when the drawer is open, otherwise zero.