## JUI Widget Directory Updated on 2025-06-25 / Release-6.4 [^1] See also: [Animation](animation.md)
[Layout](layout.md)
[Overview](overview.md)
[Styling](styling.md)
[Full API Reference](https://doc.redacted.cc/jui)
[Repository](https://git.redacted.cc/josh/ReJUI)

Widget

* The [Widget](doc.redacted.cc/jui/) is the basis of all GUI elements in JUI. * It is an abstract class, and you should not directly instantiate `Widget` for use in your UI. * Instead, create its concrete derived types (`Button`, `Text`, `Slider`) or your own custom derivation. * `class Widget` serves as the starting point for creating custom widgets. * Widgets are organized in a tree-like hierarchy, where each widget can have multiple **children** and a single **parent**. * This structure dictates rendering order, event propagation, and coordinate systems. * Operations like updating, drawing, and event dispatching typically traverse this hierarchy **recursively**. * A Widget's on-screen position is always relative to its parent. This simplifies layout management, as moving a parent automatically moves all its children. Sizing is also handled in relation to the parent. * Widgets can be given a custom string identifier which can be used to search for it in the hierarchy later. * ```Widget::Name("unique_element_4");``` ```cpp // Dispatch a "MouseMovement" event until a widget indicates that it has "observed" the event. for (auto* widget : my_element->GetChildren()) { if (widget->ObserveMouseMovement({420, 420}) return; } // Listens for an event of a child widget being added. // These event-hooks are provided to make customization easier without requiring you to derive the class. my_element->ChildAdded += [] (Widget* child) { child->Name("New Child Element!"); }; ```

Scene

* The [Scene]() widget acts as the **root container** for all your JUI elements within a window or application. * It's the top-level `Widget` that manages the entire hierarchy of your UI. * You'll typically have one `Scene` per window, serving as the canvas upon which all other widgets are placed and rendered. * Every JUI application or window requires a `Scene` to host its user interface. * All other widgets become descendants of the `Scene`. * A scene is a **mandatory** component for a JUI application. You cannot display widgets without placing them in a `Scene`. * Unlike other `Widget` types, a `Scene` does not have a parent itself. It's the **root** of the hierarchy. * Event Sink - Events from the OS / Framework (mouse clicks, key presses) are first received by the `Scene`, which then initiates the recursive dispatch process down its tree. * Z-Ordering: While individual widgets use Z-Index for sibling ordering, the `Scene` ensures that its entire content is rendered correctly, typically on top of the OpenGL scene if applicable. * A scene's viewport (aka canvas size) can be set to the window viewport, or an arbitrary value. * The scene provides a GlobalUIScale property, that can be used to scale an entire GUI uniformly. ```cpp auto* scene = new JUI::Scene(); auto* text = new JUI::Text(scene); text->Content("Hello, World!"); void app_key_press(Key key) { // Returns whether any widget should have "consumed" the event. bool sunk = scene->ObserveKeyInput(key, true); } void app_key_release(Key key) { // Returns whether any widget should have "consumed" the event. bool sunk = scene->ObserveKeyInput(key, false); } ```

BindMenu

### The BindMenu Widget is a work-in-progress. Check back in Prerelease 7.

Button