1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
|
# (C) Copyright 2004-2023 Enthought, Inc., Austin, TX
# All rights reserved.
#
# This software is provided without warranty under the terms of the BSD
# license included in LICENSE.txt and may be redistributed only under
# the conditions described in the aforementioned license. The license
# is also available online at http://www.enthought.com/licenses/BSD.txt
#
# Thanks for using Enthought open source!
""" A single line text widget that supports functionality common to native
search widgets.
"""
from traits.api import Bool, Property, Str
from traitsui.basic_editor_factory import BasicEditorFactory
from traitsui.toolkit import toolkit_object
class SearchEditor(BasicEditorFactory):
"""A single line text widget that supports functionality common to native
search widgets.
"""
#: The editor class to be created:
klass = Property()
#: The descriptive text for the widget
text = Str("Search")
#: Is user input set on every keystroke?
auto_set = Bool(True)
#: Is user input set when the Enter key is pressed?
enter_set = Bool(False)
#: Whether to show a search button on the widget
search_button = Bool(True)
#: Whether to show a cancel button on the widget
cancel_button = Bool(False)
#: Fire this event on the object whenever a search should be triggered,
#: regardless of whether the search term changed
search_event_trait = Str()
def _get_klass(self):
"""Returns the toolkit-specific editor class to be instantiated."""
return toolkit_object("search_editor:SearchEditor")
|
