ToolBar

class omni.kit.window.filepicker.ToolBar(**kwargs)

Bases: object

Methods

__init__(**kwargs)
destroy()	Destroy the widget.
set_bookmarked(true_false)	Set whether or not the bookmark image should be shown.
set_config_value(name, value)	Set a value for a config button.
set_path(path)	Sets the path to search for.
set_search_delegate(delegate)	Sets a custom search delegate for the tool bar.

Attributes

SAVED_SETTINGS_OPTIONS_MENU	Build a ToolBar for file picker widget.
bookmarked	Whether or not the current path is bookmarked.
config_values	Returns the values of the configuration button.
path	Path to the currently displayed file.

__init__(**kwargs)

destroy()

Destroy the widget.

set_bookmarked(true_false: bool)

Set whether or not the bookmark image should be shown.

Parameters:

true_false (bool) – True if the bookmark image should be shown else False.

set_config_value(name: str, value: bool)

Set a value for a config button.

Parameters:

• name (str) – The name of the value to set.

• value (bool) – The value to set for the name.

set_path(path: str)

Sets the path to search for.

Parameters:

path (str) – The path to search

set_search_delegate(delegate)

Sets a custom search delegate for the tool bar.

Parameters:

delegate (SearchDelegate) – Object that creates the search widget.

SAVED_SETTINGS_OPTIONS_MENU = '/persistent/app/omniverse/filepicker/options_menu'

Build a ToolBar for file picker widget.

Keyword Arguments:

• current_directory_provider (Optional[Callable]) – A provider for the current directory.

• branching_options_handler (Optional[Callable]) – A handler for branching options.

• apply_path_handler (Optional[Callable]) – A handler for applying a path.

• toggle_bookmark_handler (Optional[Callable]) – A handler for toggling bookmarks.

• config_values_changed_handler (Optional[Callable]) – A handler for handling changes in configuration values.

• begin_edit_handler (Optional[Callable]) – A handler for starting an edit operation.

• prefix_separator (Optional[str]) – A separator for prefixes.

• enable_soft_delete (bool) – A flag indicating whether soft delete is enabled (default: False).

• search_delegate (Optional[SearchDelegate]) – A delegate for search functionality.

• modal (bool) – A flag indicating whether the toolbar is modal (default: False).

property bookmarked: bool

Whether or not the current path is bookmarked.

Returns:

True if the current path is bookmarked else False.

Return type:

bool

property config_values

Returns the values of the configuration button.

Returns:

A dictionary of the configuration button values

Return type:

Dict[str, bool]

property path: str

Path to the currently displayed file.

Returns:

Path to the currently displayed file or None if there is no browser bar.

Return type:

str