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
|
#------------------------------------------------------------------------------
# Copyright (c) 2005, 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: Enthought, Inc.
# Description: <Enthought pyface package component>
#------------------------------------------------------------------------------
""" Abstract base class for all action manager items. """
# Enthought library imports.
from enthought.traits.api import 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('enthought.pyface.action.api.Group')
###########################################################################
# 'ActionManagerItem' interface.
###########################################################################
def add_to_menu(self, parent, menu, controller):
""" Adds the item to a menu. """
raise NotImplementedError()
def add_to_toolbar(self, parent, tool_bar, image_cache, controller):
""" Adds the item to a tool bar. """
raise NotImplementedError()
#### EOF ######################################################################
|