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
|
#------------------------------------------------------------------------------
# Copyright (c) 2013-2025, Nucleic Development Team.
#
# Distributed under the terms of the Modified BSD License.
#
# The full license is in the file LICENSE, distributed with this software.
#------------------------------------------------------------------------------
from atom.api import Coerced, Event, Str, Bool, Range, Typed, ForwardTyped
from enaml.application import deferred_call
from enaml.core.declarative import d_, observe
from enaml.icon import Icon
from enaml.layout.geometry import Size
from .close_event import CloseEvent
from .container import Container
from .widget import Widget, ProxyWidget
class ProxyDockItem(ProxyWidget):
""" The abstract definition of a proxy DockItem object.
"""
#: A reference to the DockItem declaration.
declaration = ForwardTyped(lambda: DockItem)
def set_title(self, title):
raise NotImplementedError
def set_title_editable(self, editable):
raise NotImplementedError
def set_title_bar_visible(self, visible):
raise NotImplementedError
def set_icon(self, icon):
raise NotImplementedError
def set_icon_size(self, size):
raise NotImplementedError
def set_stretch(self, stretch):
raise NotImplementedError
def set_closable(self, closable):
raise NotImplementedError
def alert(self, level, on, off, repeat, persist):
raise NotImplementedError
class DockItem(Widget):
""" A widget which can be docked in a DockArea.
A DockItem is a widget which can be docked inside of a DockArea. It
can have at most a single Container child widget.
"""
#: The title to use in the title bar.
title = d_(Str())
#: Whether or the not the title is user editable.
title_editable = d_(Bool(False))
#: Whether or not the title bar is visible.
title_bar_visible = d_(Bool(True))
#: The icon to use in the title bar.
icon = d_(Typed(Icon))
#: The size to use for the icon in the title bar.
icon_size = d_(Coerced(Size, (-1, -1)))
#: The stretch factor for the item when docked in a splitter.
stretch = d_(Range(low=0, value=1))
#: Whether or not the dock item is closable via a close button.
closable = d_(Bool(True))
#: An event emitted when the title bar is right clicked.
title_bar_right_clicked = d_(Event(), writable=False)
#: An event fired when the user request the dock item to be closed.
#: This will happen when the user clicks on the "X" button in the
#: title bar button, or when the 'close' method is called. The
#: payload will be a CloseEvent object which will allow code to
#: veto the close event and prevent the item from closing.
closing = d_(Event(CloseEvent), writable=False)
#: An event emitted when the dock item is closed. The item will be
#: destroyed after this event has completed.
closed = d_(Event(), writable=False)
#: A reference to the ProxyDockItem object.
proxy = Typed(ProxyDockItem)
def dock_widget(self):
""" Get the dock widget defined for the dock pane.
The last child Container is considered the dock widget.
"""
for child in reversed(self.children):
if isinstance(child, Container):
return child
def alert(self, level, on=250, off=250, repeat=4, persist=False):
""" Set the alert level on the dock item.
This will override any currently applied alert level.
Parameters
----------
level : unicode
The alert level token to apply to the dock item.
on : int
The duration of the 'on' cycle, in ms. A value of -1 means
always on.
off : int
The duration of the 'off' cycle, in ms. If 'on' is -1, this
value is ignored.
repeat : int
The number of times to repeat the on-off cycle. If 'on' is
-1, this value is ignored.
persist : bool
Whether to leave the alert in the 'on' state when the cycles
finish. If 'on' is -1, this value is ignored.
"""
if self.proxy_is_active:
self.proxy.alert(level, on, off, repeat, persist)
#--------------------------------------------------------------------------
# Observers
#--------------------------------------------------------------------------
@observe('title', 'title_editable', 'title_bar_visible', 'icon',
'icon_size', 'stretch', 'closable')
def _update_proxy(self, change):
""" Update the proxy when the item state changes.
"""
# The superclass implementation is sufficient.
super(DockItem, self)._update_proxy(change)
#--------------------------------------------------------------------------
# Private API
#--------------------------------------------------------------------------
def _item_closed(self):
""" Called by the proxy when the toolkit item is closed.
This is performed as a deferred call so that the window may fully
close before the declaration is potentially destroyed.
"""
self.closed()
self.destroy()
|
