API

class omni.flux.header_navigator.widget.setup_ui._SetupUI(name)

Header navigator UI

__init__(name)

create_ui()

Create the UI

get_registered_buttons() → Dict[str, Tuple[Callable[[], omni.ui._ui.Widget]]]

Get the list of registered buttons

refresh()

Refresh the UI

register_button(button: Dict[str, Tuple[Callable[[], omni.ui._ui.Widget], int]])

Register a new button

Parameters

button – the button data: {name: (callback that create the ui, priority from left (low number) to right (high number))}

select_button(button: str, value: bool = True)

Select a given button name

Parameters

• button – the button name

• value – select or not

show_logo_and_title(value)

Show or hide the logo

Parameters

value – show or hide

subscribe_button_registered(function: Callable[[str], Any])

Return the object that will automatically unsubscribe when destroyed.

subscribe_header_refreshed(function: Callable[[], Any])

Return the object that will automatically unsubscribe when destroyed.

unregister_button(button: str)

Unregister a button

Parameters

button – the button name to unregister