action.py

Go to the documentation of this file.

#  Copyright 2008-2015 Nokia Networks
#  Copyright 2016-     Robot Framework Foundation
#
#  Licensed under the Apache License, Version 2.0 (the "License");
#  you may not use this file except in compliance with the License.
#  You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
#  Unless required by applicable law or agreed to in writing, software
#  distributed under the License is distributed on an "AS IS" BASIS,
#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#  See the License for the specific language governing permissions and
#  limitations under the License.
 
 
def ActionFactory(action_info):
    if action_info.is_separator():
        return _MenuSeparator(action_info)
    return Action(action_info)
 
 
class _Registrable():
 
    def __init__(self, action_info):
        self._registered_to_registered_to = []
        self.actionaction = None
        self.shortcutshortcut = None
        self.iconicon = None
        self._insertion_point_insertion_point = action_info.insertion_point
        self._enabled_enabled = True
        self._enabled_status_listeners_enabled_status_listeners = []
 
    disable = enable = lambda event: None
 
    def is_separator(self):
        return False
 
    def get_insertion_index(self, menu):
        return self._insertion_point_insertion_point.get_index(menu)
 
    def register(self, registerer):
        self._registered_to_registered_to.append(registerer)
 
    def unregister(self):
        for registerer in self._registered_to_registered_to:
            registerer.unregister(self)
        self._registered_to_registered_to = []
 
    def has_action(self):
        return self.actionaction is not None
 
    def has_shortcut(self):
        return bool(self.shortcutshortcut)
 
    def has_icon(self):
        return self.iconicon is not None
 
    def inform_changes_in_enabled_status(self, listener):
        self._enabled_status_listeners_enabled_status_listeners.append(listener)
 
 
 
class Action(_Registrable):
 
    def __init__(self, action_info):
        _Registrable.__init__(self, action_info)
        self.menu_namemenu_name = action_info.menu_name
        self.namename = action_info.name
        self.actionactionaction = action_info.action
        self.containercontainer = action_info.container
        self.shortcutshortcutshortcut = action_info.shortcut
        self.iconiconicon = action_info.icon
        self.docdoc = action_info.doc
        # print("DEBUG: Action: %s::%s" % (self.menu_name,self.name))
 
    def get_shortcut(self):
        return self.shortcutshortcutshortcut.printable
 
    def act(self, event):
        if self.is_activeis_active():
            self.actionactionaction(event)
 
    
    def disable(self):
        self._enabled_enabled_enabled = False
        self._inform_changes_in_enabled_status_inform_changes_in_enabled_status()
 
    
    def enable(self):
        self._enabled_enabled_enabled = True
        self._inform_changes_in_enabled_status_inform_changes_in_enabled_status()
 
    def _inform_changes_in_enabled_status(self):
        for listener in self._enabled_status_listeners_enabled_status_listeners:
            listener.enabled_status_changed(self)
 
    def is_active(self):
        if self._is_always_inactive_is_always_inactive() or not self._enabled_enabled_enabled:
            return False
        if self._is_always_active_is_always_active():
            return True
        return self._container_is_active_container_is_active()
 
    def _is_always_inactive(self):
        return self.actionactionaction is None
 
    def _is_always_active(self):
        return self.containercontainer is None
 
    def _container_is_active(self):
        if not self.containercontainer.IsShownOnScreen():
            return False
        widget = self.containercontainer.FindFocus()
        while widget:
            if widget == self.containercontainer.Parent:
                return True
            widget = widget.GetParent()
        return False
 
 
class _MenuSeparator(_Registrable):
 
    def __init__(self, action_info):
        _Registrable.__init__(self, action_info)
        self.menu_namemenu_name = action_info.menu_name
        self.namename = '---'
 
    def is_separator(self):
        return True