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
|
# (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!
""" Abstract base class for all action manager items. """
from traits.api import Bool, HasTraits, Instance, Str
class ActionManagerItem(HasTraits):
""" Abstract base class for all action manager items.
An action manager item represents a contribution to a shared UI resource
such as a menu bar, menu or tool bar.
Action manager items know how to add themselves to menu bars, menus and
tool bars. In a tool bar a contribution item is represented as a tool or a
separator. In a menu bar a contribution item is a menu, and in a menu
a contribution item is a menu item or separator.
"""
#: The item's unique identifier ('unique' in this case means unique within
#: its group)
id = Str()
#: The group the item belongs to.
parent = Instance("pyface.action.group.Group")
#: Is the item enabled?
enabled = Bool(True)
#: Is the item visible?
visible = Bool(True)
# ------------------------------------------------------------------------
# 'ActionManagerItem' interface.
# ------------------------------------------------------------------------
def add_to_menu(self, parent, menu, controller):
""" Adds the item to a menu.
Parameters
----------
parent : toolkit control
The parent of the new menu item control.
menu : toolkit menu
The menu to add the action item to.
controller : pyface.action.action_controller.ActionController or None
The controller to use.
"""
raise NotImplementedError()
def add_to_toolbar(self, parent, tool_bar, image_cache, controller):
""" Adds the item to a tool bar.
Parameters
----------
parent : toolkit control
The parent of the new menu item control.
tool_bar : toolkit toolbar
The toolbar to add the action item to.
image_cache : ImageCache
The image cache for resized images.
controller : pyface.action.action_controller.ActionController or None
The controller to use.
show_labels : bool
Should the toolbar item show a label.
"""
raise NotImplementedError()
|
