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
|
# (C) Copyright 2005-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!
""" Enthought pyface package component
"""
import wx
from traits.api import Any, Bool, HasTraits, Instance, Str, provides
from pyface.i_widget import IWidget, MWidget
@provides(IWidget)
class Widget(MWidget, HasTraits):
""" The toolkit specific implementation of a Widget. See the IWidget
interface for the API documentation.
"""
# 'IWidget' interface ----------------------------------------------------
#: The toolkit specific control that represents the widget.
control = Any()
#: The control's optional parent control.
parent = Any()
#: Whether or not the control is visible
visible = Bool(True)
#: Whether or not the control is enabled
enabled = Bool(True)
#: A tooltip for the widget.
tooltip = Str()
#: An optional context menu for the widget.
context_menu = Instance("pyface.action.menu_manager.MenuManager")
# ------------------------------------------------------------------------
# 'IWidget' interface.
# ------------------------------------------------------------------------
def show(self, visible):
""" Show or hide the widget.
Parameter
---------
visible : bool
Visible should be ``True`` if the widget should be shown.
"""
self.visible = visible
if self.control is not None:
self.control.Show(visible)
def enable(self, enabled):
""" Enable or disable the widget.
Parameter
---------
enabled : bool
The enabled state to set the widget to.
"""
self.enabled = enabled
if self.control is not None:
self.control.Enable(enabled)
def focus(self):
""" Set the keyboard focus to this widget.
"""
if self.control is not None:
self.control.SetFocus()
def has_focus(self):
""" Does the widget currently have keyboard focus?
Returns
-------
focus_state : bool
Whether or not the widget has keyboard focus.
"""
return (
self.control is not None
and self.control.HasFocus()
)
def destroy(self):
if self.control is not None:
control = self.control
super().destroy()
control.Destroy()
# ------------------------------------------------------------------------
# Private interface
# ------------------------------------------------------------------------
def _get_control_tooltip(self):
""" Toolkit specific method to get the control's tooltip. """
return self.control.GetToolTipText()
def _set_control_tooltip(self, tooltip):
""" Toolkit specific method to set the control's tooltip. """
self.control.SetToolTip(tooltip)
def _observe_control_context_menu(self, remove=False):
""" Toolkit specific method to change the control menu observer. """
if remove:
self.control.Unbind(
wx.EVT_CONTEXT_MENU, handler=self._handle_control_context_menu
)
else:
self.control.Bind(
wx.EVT_CONTEXT_MENU, self._handle_control_context_menu
)
def _handle_control_context_menu(self, event):
""" Signal handler for displaying context menu. """
if self.control is not None and self.context_menu is not None:
menu = self.context_menu.create_menu(self.control)
self.control.PopupMenu(menu)
|
