ComboListBoxWidget#

class omni.kit.widget.searchable_combobox.combo_widget.ComboListBoxWidget(
search_widget: ~omni.kit.widget.searchable_combobox.search_widget.SearchWidget,
item_list: list,
theme: str,
window_id: str = 'SearchableComboBoxWindow',
delegate: ~omni.ui._ui.AbstractItemDelegate = <omni.kit.widget.searchable_combobox.combo_model.ComboBoxListDelegate object>,
)#

Bases: object

A widget that combines a search field with a list box for item selection.

This widget facilitates the selection of items from a list that can be filtered through a search interface. Users can type in the search widget to filter the items displayed in the list box below it. It supports customization through themes and delegates for item display.

Parameters:

  • search_widget – SearchWidget An instance of SearchWidget to handle search input.

  • item_list – list A list of items to be displayed and filtered in the list box.

  • theme – str The visual theme for the widget’s appearance.

  • window_id – str The identifier for the window; default is ‘SearchableComboBoxWindow’.

  • delegate – ui.AbstractItemDelegate Delegate for custom item rendering; defaults to ComboBoxListDelegate.

Methods

__init__(search_widget, item_list, theme[, ...])

A widget that combines a search field with a list box for item selection.

build_ui()

builds UI for the ComboListBoxWidget UI.

clean()

Cleans up the ComboListBoxWidget and destroys models.

destroy()

Destroys the ComboListBoxWidget widget.

destroy_ui(visible)

destroys the ComboListBoxWidget UI.

set_parent(parent)

Set the parent widget
__init__(
search_widget: ~omni.kit.widget.searchable_combobox.search_widget.SearchWidget,
item_list: list,
theme: str,
window_id: str = 'SearchableComboBoxWindow',
delegate: ~omni.ui._ui.AbstractItemDelegate = <omni.kit.widget.searchable_combobox.combo_model.ComboBoxListDelegate object>,
)#

A widget that combines a search field with a list box for item selection.

This widget facilitates the selection of items from a list that can be filtered through a search interface. Users can type in the search widget to filter the items displayed in the list box below it. It supports customization through themes and delegates for item display.

Parameters:

  • search_widget – SearchWidget An instance of SearchWidget to handle search input.

  • item_list – list A list of items to be displayed and filtered in the list box.

  • theme – str The visual theme for the widget’s appearance.

  • window_id – str The identifier for the window; default is ‘SearchableComboBoxWindow’.

  • delegate – ui.AbstractItemDelegate Delegate for custom item rendering; defaults to ComboBoxListDelegate.

build_ui()#

builds UI for the ComboListBoxWidget UI.

clean()#

Cleans up the ComboListBoxWidget and destroys models.

destroy()#

Destroys the ComboListBoxWidget widget.

destroy_ui(visible)#

destroys the ComboListBoxWidget UI.

set_parent(parent)#

Set the parent widget

Parameters:

parent – prent widget.