File: String_list_ui_editor.py

package info (click to toggle)
python-traitsui 4.1.0-1
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 13,292 kB
  • sloc: python: 39,867; makefile: 120; sh: 5
file content (135 lines) | stat: -rw-r--r-- 4,130 bytes parent folder | download
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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
#  Copyright (c) 2007, Enthought, Inc.
#  License: BSD Style.

"""
Another demo showing how to use a TabularEditor to create a multi-select list
box. This demo creates a reusable StringListEditor class and uses that instead
of defining the editor as part of the demo class.

This approach greatly simplifies the actual demo class and shows how to
construct a reusable Traits UI-based editor that can be used in other
applications.
"""

#-- Imports ------------------------------------------------------------------

from traits.api \
    import HasPrivateTraits, List, Str, Property, on_trait_change

from traitsui.api \
    import View, HGroup, Item, TabularEditor

from traitsui.tabular_adapter \
    import TabularAdapter

from traitsui.ui_editor \
    import UIEditor

from traitsui.basic_editor_factory \
    import BasicEditorFactory

#-- Define the reusable StringListEditor class and its helper classes --------

# Define the tabular adapter used by the Traits UI string list editor:
class MultiSelectAdapter ( TabularAdapter ):

    # The columns in the table (just the string value):
    columns = [ ( 'Value', 'value' ) ]

    # The text property used for the 'value' column:
    value_text = Property

    def _get_value_text ( self ):
        return self.item

# Define the actual Traits UI string list editor:
class _StringListEditor ( UIEditor ):

    # Indicate that the editor is scrollable/resizable:
    scrollable = True

    # The list of available editor choices:
    choices = List( Str )

    # The list of currently selected items:
    selected = List( Str )

    # The traits UI view used by the editor:
    view = View(
        Item( 'choices',
              show_label = False,
              editor     = TabularEditor(
                               show_titles  = False,
                               selected     = 'selected',
                               editable     = False,
                               multi_select = True,
                               adapter      = MultiSelectAdapter() )
        ),
        id        = 'string_list_editor',
        resizable = True
    )

    def init_ui ( self, parent ):

        self.sync_value( self.factory.choices, 'choices', 'from',
                         is_list = True )
        self.selected = self.value

        return self.edit_traits( parent = parent, kind = 'subpanel' )

    @on_trait_change( ' selected' )
    def _selected_modified ( self ):
        self.value = self.selected

# Define the StringListEditor class used by client code:
class StringListEditor ( BasicEditorFactory ):

    # The editor implementation class:
    klass = _StringListEditor

    # The extended trait name containing the editor's set of choices:
    choices = Str

#-- Define the demo class ----------------------------------------------------

class MultiSelect ( HasPrivateTraits ):
    """ This class demonstrates using the StringListEditor to select a set
        of string values from a set of choices.
    """

    # The list of choices to select from:
    choices = List( Str )

    # The currently selected list of choices:
    selected = List( Str )

    # A dummy result so that we can display the selection using the same
    # StringListEditor:
    result = List( Str )

    # A traits view showing the list of choices on the left-hand side, and
    # the currently selected choices on the right-hand side:
    view = View(
        HGroup(
            Item( 'selected',
                  show_label = False,
                  editor     = StringListEditor( choices = 'choices' )
            ),
            Item( 'result',
                  show_label = False,
                  editor     = StringListEditor( choices = 'selected' )
            )
        ),
        width  = 0.20,
        height = 0.25
    )

# Create the demo:
demo = MultiSelect( choices  = [ 'one', 'two', 'three', 'four', 'five', 'six',
                                 'seven', 'eight', 'nine', 'ten' ],
                    selected = [ 'two', 'five', 'nine' ] )

# Run the demo (if invoked from the command line):
if __name__ == '__main__':
    demo.configure_traits()