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
|
# (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!
""" Heading text. """
import warnings
from traits.api import HasTraits, Int, Interface, Str
class IHeadingText(Interface):
""" A widget which shows heading text in a panel. """
# 'IHeadingText' interface ---------------------------------------------
#: Heading level. This is currently unused.
level = Int(1)
#: The heading text.
text = Str("Default")
class MHeadingText(HasTraits):
""" The mixin class that contains common code for toolkit specific
implementations of the IHeadingText interface.
"""
# 'IHeadingText' interface ---------------------------------------------
#: Heading level. This is currently unused.
level = Int(1)
#: The heading text.
text = Str("Default")
def __init__(self, parent=None, **traits):
""" Creates the heading text. """
if "image" in traits:
warnings.warn(
"background images are no-longer supported for Wx and the "
"'image' trait will be removed in a future Pyface update",
DeprecationWarning,
stacklevel=2,
)
create = traits.pop("create", None)
# Base class constructor.
super().__init__(parent=parent, **traits)
if create:
# Create the widget's toolkit-specific control.
self.create()
warnings.warn(
"automatic widget creation is deprecated and will be removed "
"in a future Pyface version, code should not pass the create "
"parameter and should instead call create() explicitly",
DeprecationWarning,
stacklevel=2,
)
elif create is not None:
warnings.warn(
"setting create=False is no longer required",
DeprecationWarning,
stacklevel=2,
)
# ------------------------------------------------------------------------
# 'IWidget' interface.
# ------------------------------------------------------------------------
def _initialize_control(self):
""" Perform any toolkit-specific initialization for the control. """
super()._initialize_control()
self._set_control_text(self.text)
def _add_event_listeners(self):
super()._add_event_listeners()
self.observe(self._text_updated, 'text', dispatch="ui")
def _remove_event_listeners(self):
self.observe(self._text_updated, 'text', dispatch="ui", remove=True)
super()._remove_event_listeners()
# ------------------------------------------------------------------------
# Private interface.
# ------------------------------------------------------------------------
def _set_control_text(self, text):
""" Set the text on the control.
Parameters
----------
text : str
The text to display. This can contain basic HTML-like markeup.
"""
raise NotImplementedError()
def _get_control_text(self):
""" Get the text on the control.
Returns
----------
text : str
The text to displayed in the widget.
"""
raise NotImplementedError()
# Trait change handlers --------------------------------------------------
def _text_updated(self, event):
if self.control is not None:
self._set_control_text(self.text)
|
