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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
|
#------------------------------------------------------------------------------
#
# Copyright (c) 2008, Enthought, Inc.
# All rights reserved.
#
# This software is provided without warranty under the terms of the BSD
# license included in enthought/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!
#
# Author: David C. Morrill
#
#------------------------------------------------------------------------------
""" Defines the tree editor factory for all traits user interface toolkits.
"""
#-------------------------------------------------------------------------------
# Imports:
#-------------------------------------------------------------------------------
from __future__ import absolute_import
from traits.api import Any, Dict, Bool, Tuple, Int, List, Instance, Str, Enum
from ..tree_node import TreeNode
from ..dock_window_theme import DockWindowTheme
from ..editor_factory import EditorFactory
from ..helper import Orientation
#-------------------------------------------------------------------------------
# Trait definitions:
#-------------------------------------------------------------------------------
# Size of each tree node icon
IconSize = Tuple( ( 16, 16 ), Int, Int )
#-------------------------------------------------------------------------------
# 'ToolkitEditorFactory' class:
#-------------------------------------------------------------------------------
class ToolkitEditorFactory ( EditorFactory ):
""" Editor factory for tree editors.
"""
#---------------------------------------------------------------------------
# Trait definitions:
#---------------------------------------------------------------------------
# Supported TreeNode objects
nodes = List( TreeNode )
# Mapping from TreeNode tuples to MultiTreeNodes
multi_nodes = Dict
# The column header labels if any.
column_headers = List(Str)
# Are the individual nodes editable?
editable = Bool(True)
# Selection mode.
selection_mode = Enum('single', 'extended')
# Is the editor shared across trees?
shared_editor = Bool(False)
# Reference to a shared object editor
editor = Instance( EditorFactory )
# The DockWindow graphical theme
# FIXME: Implemented only in wx backend.
dock_theme = Instance( DockWindowTheme )
# Show icons for tree nodes?
show_icons = Bool(True)
# Hide the tree root node?
hide_root = Bool(False)
# Layout orientation of the tree and the editor
orientation = Orientation
# Number of tree levels (down from the root) that should be automatically
# opened
auto_open = Int
# Size of the tree node icons
# FIXME: Document as unimplemented or wx specific.
icon_size = IconSize
# Called when a node is selected
on_select = Any
# Called when a node is clicked
on_click = Any
# Called when a node is double-clicked
on_dclick = Any
# Call when the mouse hovers over a node
on_hover = Any
# The optional extended trait name of the trait to synchronize with the
# editor's current selection:
selected = Str
# The optional extended trait name of the trait that should be assigned
# a node object when a tree node is activated, by double-clicking or
# pressing the Enter key when a node has focus (Note: if you want to
# receive repeated activated events on the same node, make sure the trait
# is defined as an Event):
activated = Str
# The optional extended trait name of the trait that should be assigned
# a node object when a tree node is clicked on (Note: If you want to
# receive repeated clicks on the same node, make sure the trait is defined
# as an Event):
click = Str
# The optional extended trait name of the trait that should be assigned
# a node object when a tree node is double-clicked on (Note: if you want to
# receive repeated double-clicks on the same node, make sure the trait is
# defined as an Event):
dclick = Str
# The optional extended trait name of the trait event that is fired
# whenever the application wishes to veto a tree action in progress (e.g.
# double-clicking a non-leaf tree node normally opens or closes the node,
# but if you are handling the double-click event in your program, you may
# wish to veto the open or close operation). Be sure to fire the veto event
# in the event handler triggered by the operation (e.g. the 'dclick' event
# handler.
veto = Str
# The optional extended trait name of the trait event that is fired when the
# application wishes the currently visible portion of the tree widget to
# repaint itself.
refresh = Str
# Mode for lines connecting tree nodes
#
# * 'appearance': Show lines only when they look good.
# * 'on': Always show lines.
# * 'off': Don't show lines.
lines_mode = Enum ( 'appearance', 'on', 'off' )
# FIXME: Document as unimplemented or wx specific.
# Whether to alternate row colors or not.
alternating_row_colors = Bool(False)
# Any extra vertical padding to add.
vertical_padding = Int(0)
# Whether or not to expand on a double-click.
expands_on_dclick = Bool(True)
# Whether the labels should be wrapped around, if not an ellipsis is shown
# This works only in the qt backend and if there is only one column in tree
word_wrap = Bool(False)
# Define the TreeEditor class.
TreeEditor = ToolkitEditorFactory
### EOF #######################################################################
|
