Source code for pyface.action.action_controller

# (C) Copyright 2005-2022 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!
""" The default action controller for menus, menu bars and tool bars. """


from traits.api import HasTraits


[docs]class ActionController(HasTraits): """ The default action controller for menus, menu bars and tool bars. """ # ------------------------------------------------------------------------ # 'ActionController' interface. # ------------------------------------------------------------------------
[docs] def perform(self, action, event): """ Control an action invocation. Parameters ---------- action : Action instance The action to perform. event : ActionEvent instance The event that triggered the action. Returns ------- result : any The result of the action's perform method (usually None). """ return action.perform(event)
[docs] def can_add_to_menu(self, action): """ Can add an action to a menu Parameters ---------- action : Action instance The action to consider. Returns ------- can_add : bool ``True`` if the action can be added to a menu/menubar. """ return True
[docs] def add_to_menu(self, action): """ Called when an action is added to the a menu/menubar. Parameters ---------- action : Action instance The action added to the menu. """ pass
[docs] def can_add_to_toolbar(self, action): """ Returns True if the action can be added to a toolbar. Parameters ---------- action : Action instance The action to consider. Returns ------- can_add : bool ``True`` if the action can be added to a toolbar. """ return True
[docs] def add_to_toolbar(self, action): """ Called when an action is added to the a toolbar. Parameters ---------- action : Action instance The action added to the toolbar. """ pass