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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
|
# (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!
""" Traits UI editor factory for editing lists of strings.
"""
from pyface.image_resource import ImageResource
from traits.api import Any, Str, Enum, List, Bool, Instance, Property
from traitsui.basic_editor_factory import BasicEditorFactory
from traitsui.toolkit import toolkit_object
# -------------------------------------------------------------------------
# 'ListStrEditor' editor factory class:
# -------------------------------------------------------------------------
class ListStrEditor(BasicEditorFactory):
"""Editor factory for list of string editors."""
# -- Trait Definitions ----------------------------------------------------
#: The editor class to be created:
klass = Property()
#: The optional extended name of the trait to synchronize the selection
#: values with:
selected = Str()
#: The optional extended name of the trait to synchronize the selection
#: indices with:
selected_index = Str()
#: The optional extended name of the trait to synchronize the activated
#: value with:
activated = Str()
#: The optional extended name of the trait to synchronize the activated
#: value's index with:
activated_index = Str()
#: The optional extended name of the trait to synchronize the right clicked
#: value with:
right_clicked = Str()
#: The optional extended name of the trait to synchronize the right clicked
#: value's index with:
right_clicked_index = Str()
#: Can the user edit the values?
editable = Bool(True)
#: Are multiple selected items allowed?
multi_select = Bool(False)
#: Should horizontal lines be drawn between items?
horizontal_lines = Bool(False)
#: The title for the editor:
title = Str()
#: The optional extended name of the trait containing the editor title:
title_name = Str()
#: Should a new item automatically be added to the end of the list to allow
#: the user to create new entries?
auto_add = Bool(False)
#: The adapter from list items to editor values:
adapter = Instance("traitsui.list_str_adapter.ListStrAdapter", ())
#: The optional extended name of the trait containing the adapter:
adapter_name = Str()
#: What type of operations are allowed on the list:
operations = List(
Enum("delete", "insert", "append", "edit", "move"),
["delete", "insert", "append", "edit", "move"],
)
#: Are 'drag_move' operations allowed (i.e. True), or should they always be
#: treated as 'drag_copy' operations (i.e. False):
drag_move = Bool(False)
#: The set of images that can be used:
images = List(ImageResource)
#: Right-click context menu (Qt4 only). The value can be one of:
#:
#: - Instance( Menu ): Use this menu as the context menu
#: - string: Name of traits that will provide menu
#: - None: Use the default context menu
#: - False: Do not display a context menu
menu = Any()
def _get_klass(self):
"""Returns the editor class to be created."""
return toolkit_object("list_str_editor:_ListStrEditor")
|
