Source code for enaml.qt.qt_action

#  Copyright (c) 2012, Enthought, Inc.
#  All rights reserved.
import logging

from .qt.QtGui import QAction, QKeySequence, QIcon, QImage, QPixmap
from .qt_object import QtObject

logger = logging.getLogger(__name__)

[docs]class QtAction(QtObject): """ A Qt implementation of an Enaml Action. """ #: Temporary internal storage for the icon source url. _icon_source = '' # FIXME Currently, the checked state of the action is lost when # switching from checkable to non-checkable and back again. #-------------------------------------------------------------------------- # Setup Methods #--------------------------------------------------------------------------
[docs] def create_widget(self, parent, tree): """ Create the underlying QAction object. """ return QAction(parent)
[docs] def create(self, tree): """ Create and initialize the underlying control. """ super(QtAction, self).create(tree) self.set_text(tree['text']) self.set_tool_tip(tree['tool_tip']) self.set_status_tip(tree['status_tip']) self._icon_source = tree['icon_source'] self.set_checkable(tree['checkable']) self.set_checked(tree['checked']) self.set_enabled(tree['enabled']) self.set_visible(tree['visible']) self.set_separator(tree['separator']) widget = self.widget() widget.triggered.connect(self.on_triggered) widget.toggled.connect(self.on_toggled)
[docs] def activate(self): """ Activate the action. """ self.set_icon_source(self._icon_source) super(QtAction, self).activate() #-------------------------------------------------------------------------- # Signal Handlers #--------------------------------------------------------------------------
[docs] def on_triggered(self): """ The signal handler for the 'triggered' signal. """ content = {'checked': self.widget().isChecked()} self.send_action('triggered', content)
[docs] def on_toggled(self): """ The signal handler for the 'toggled' signal. """ if 'checked' not in self.loopback_guard: content = {'checked': self.widget().isChecked()} self.send_action('toggled', content) #-------------------------------------------------------------------------- # Message Handling #--------------------------------------------------------------------------
[docs] def on_action_set_text(self, content): """ Handle the 'set_text' action from the Enaml widget. """ self.set_text(content['text'])
[docs] def on_action_set_tool_tip(self, content): """ Handle the 'set_tool_tip' action from the Enaml widget. """ self.set_tool_tip(content['tool_tip'])
[docs] def on_action_set_status_tip(self, content): """ Handle the 'set_status_tip' action from the Enaml widget. """ self.set_status_tip(content['status_tip'])
[docs] def on_action_set_icon_source(self, content): """ Handle the 'set_icon_source' action from the Enaml widget. """ self.set_icon_source(content['icon_source'])
[docs] def on_action_set_checkable(self, content): """ Handle the 'set_checkable' action from the Enaml widget. """ self.set_checkable(content['checkable'])
[docs] def on_action_set_checked(self, content): """ Handle the 'set_checked' action from the Enaml widget. """ self.set_checked(content['checked'])
[docs] def on_action_set_enabled(self, content): """ Handle the 'set_enabled' action from the Enaml widget. """ self.set_enabled(content['enabled'])
[docs] def on_action_set_visible(self, content): """ Handle the 'set_visible' action from the Enaml widget. """ self.set_visible(content['visible'])
[docs] def on_action_set_separator(self, content): """ Handle the 'set_separator' action from the Enaml widget. """ self.set_separator(content['separator']) #-------------------------------------------------------------------------- # Widget Update Methods #--------------------------------------------------------------------------
[docs] def set_text(self, text): """ Set the text on the underlying control. """ widget = self.widget() widget.setText(text) parts = text.split('\t') if len(parts) > 1: shortcut = QKeySequence(parts[-1]) widget.setShortcut(shortcut)
[docs] def set_tool_tip(self, tool_tip): """ Set the tool tip on the underlying control. """ self.widget().setToolTip(tool_tip)
[docs] def set_status_tip(self, status_tip): """ Set the status tip on the underyling control. """ self.widget().setStatusTip(status_tip)
[docs] def set_icon_source(self, icon_source): """ Set the icon source for the action. """ if icon_source: loader = self._session.load_resource(icon_source) loader.on_load(self._on_icon_load) else: self._on_icon_load(QIcon())
[docs] def set_checkable(self, checkable): """ Set the checkable state on the underlying control. """ self.widget().setCheckable(checkable)
[docs] def set_checked(self, checked): """ Set the checked state on the underlying control. """ with self.loopback_guard('checked'): self.widget().setChecked(checked)
[docs] def set_enabled(self, enabled): """ Set the enabled state on the underlying control. """ self.widget().setEnabled(enabled)
[docs] def set_visible(self, visible): """ Set the visible state on the underlying control. """ self.widget().setVisible(visible)
[docs] def set_separator(self, separator): """ Set the separator state on the underlying control. """ self.widget().setSeparator(separator) #-------------------------------------------------------------------------- # Private API #--------------------------------------------------------------------------
def _on_icon_load(self, icon): """ A private resource loader callback. This method is invoked when the requested icon is successfully loaded. It will update the icon on the action and issue a size hint updated event to the layout system if needed. Parameters ---------- icon : QIcon or QImage The icon or image that was loaded by the request. """ if isinstance(icon, QImage): icon = QIcon(QPixmap.fromImage(icon)) elif not isinstance(icon, QIcon): msg = 'got incorrect type for icon: `%s`' logger.error(msg % type(icon).__name__) icon = QIcon() self.widget().setIcon(icon)