CheckboxMenuDelegate#

class omni.kit.viewport.menubar.core.CheckboxMenuDelegate(
model: SimpleBoolModel | None = None,
tooltip: str | None = None,
width: Length = 300,
height: Length = 0,
enabled: bool = True,
use_in_menubar: bool = False,
has_reset: bool = False,
)#

Bases: AbstractWidgetMenuDelegate

A menu delegate that creates checkbox within a viewport menubar.

Methods

__init__([model, tooltip, width, height, ...])

Constructor.

build_widget(item)

Build checkbox.

destroy()

Release resources.

Attributes

__init__(
model: SimpleBoolModel | None = None,
tooltip: str | None = None,
width: Length = 300,
height: Length = 0,
enabled: bool = True,
use_in_menubar: bool = False,
has_reset: bool = False,
)#

Constructor.

Keyword Arguments:

  • model (Optional[ui.SimpleBoolModel]) – Checkbox data model.

  • tooltip (Optional[str]) – Delegate tooltip text, defaults to None means no tooltip.

  • width (ui.Length) – Delegate width, defaults to 300 pixels.

  • height (ui.Length) – Delegate height, defaults to 0 means auto.

  • enabled (bool) – Delegate enabled state, defaults to True.

  • use_in_menubar (bool) – Show delegate in menu bar, defaults to False.

  • has_reset (bool) – Show reset button, defaults to False.

build_widget(
item: MenuHelper,
) → None#

Build checkbox.

Parameters:

item (ui.MenuItem) – Menu item.

destroy() → None#

Release resources.