traitsui.editors.search_editor module

A single line text widget that supports functionality common to native search widgets.

class traitsui.editors.search_editor.SearchEditor(*args, **traits)[source]

Bases: BasicEditorFactory

A single line text widget that supports functionality common to native search widgets.

auto_set = Bool(True)

Is user input set on every keystroke?

cancel_button = Bool(False)

Whether to show a cancel button on the widget

enter_set = Bool(False)

Is user input set when the Enter key is pressed?

klass = Property()

The editor class to be created:

search_button = Bool(True)

Whether to show a search button on the widget

search_event_trait = Str()

Fire this event on the object whenever a search should be triggered, regardless of whether the search term changed

text = Str("Search")

The descriptive text for the widget