--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/eric6/Preferences/ShortcutsDialog.py Sun Apr 14 15:09:21 2019 +0200
@@ -0,0 +1,494 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2003 - 2019 Detlev Offenbach <detlev@die-offenbachs.de>
+#
+
+"""
+Module implementing a dialog for the configuration of eric6's keyboard
+shortcuts.
+"""
+
+from __future__ import unicode_literals
+
+from PyQt5.QtCore import pyqtSignal, QRegExp, Qt, pyqtSlot
+from PyQt5.QtGui import QKeySequence
+from PyQt5.QtWidgets import QHeaderView, QDialog, QTreeWidgetItem
+
+from E5Gui.E5Application import e5App
+from E5Gui import E5MessageBox
+
+from .Ui_ShortcutsDialog import Ui_ShortcutsDialog
+
+import Preferences
+from Preferences import Shortcuts
+
+
+class ShortcutsDialog(QDialog, Ui_ShortcutsDialog):
+ """
+ Class implementing a dialog for the configuration of eric6's keyboard
+ shortcuts.
+
+ @signal updateShortcuts() emitted when the user pressed the dialogs OK
+ button
+ """
+ updateShortcuts = pyqtSignal()
+
+ objectNameRole = Qt.UserRole
+ noCheckRole = Qt.UserRole + 1
+ objectTypeRole = Qt.UserRole + 2
+
+ def __init__(self, parent=None):
+ """
+ Constructor
+
+ @param parent parent widget of this dialog
+ @type QWidget
+ """
+ super(ShortcutsDialog, self).__init__(parent)
+ self.setupUi(self)
+ self.setWindowFlags(Qt.Window)
+
+ self.__helpViewer = None
+
+ self.shortcutsList.headerItem().setText(
+ self.shortcutsList.columnCount(), "")
+ self.shortcutsList.header().setSortIndicator(0, Qt.AscendingOrder)
+
+ from .ShortcutDialog import ShortcutDialog
+ self.shortcutDialog = ShortcutDialog()
+ self.shortcutDialog.shortcutChanged.connect(self.__shortcutChanged)
+
+ def __resort(self):
+ """
+ Private method to resort the tree.
+ """
+ self.shortcutsList.sortItems(
+ self.shortcutsList.sortColumn(),
+ self.shortcutsList.header().sortIndicatorOrder())
+
+ def __resizeColumns(self):
+ """
+ Private method to resize the list columns.
+ """
+ self.shortcutsList.header().resizeSections(
+ QHeaderView.ResizeToContents)
+ self.shortcutsList.header().setStretchLastSection(True)
+
+ def __generateCategoryItem(self, title):
+ """
+ Private method to generate a category item.
+
+ @param title title for the item (string)
+ @return reference to the category item (QTreeWidgetItem)
+ """
+ itm = QTreeWidgetItem(self.shortcutsList, [title])
+ itm.setExpanded(True)
+ return itm
+
+ def __generateShortcutItem(self, category, action,
+ noCheck=False, objectType=""):
+ """
+ Private method to generate a keyboard shortcut item.
+
+ @param category reference to the category item (QTreeWidgetItem)
+ @param action reference to the keyboard action (E5Action)
+ @keyparam noCheck flag indicating that no uniqueness check should
+ be performed (boolean)
+ @keyparam objectType type of the object (string). Objects of the same
+ type are not checked for duplicate shortcuts.
+ """
+ itm = QTreeWidgetItem(
+ category,
+ [action.iconText(), action.shortcut().toString(),
+ action.alternateShortcut().toString()])
+ itm.setIcon(0, action.icon())
+ itm.setData(0, self.objectNameRole, action.objectName())
+ itm.setData(0, self.noCheckRole, noCheck)
+ if objectType:
+ itm.setData(0, self.objectTypeRole, objectType)
+ else:
+ itm.setData(0, self.objectTypeRole, None)
+
+ def populate(self, helpViewer=None):
+ """
+ Public method to populate the dialog.
+
+ @param helpViewer reference to the help window object
+ """
+ self.searchEdit.clear()
+ self.searchEdit.setFocus()
+ self.shortcutsList.clear()
+ self.actionButton.setChecked(True)
+
+ self.__helpViewer = helpViewer
+
+ if helpViewer is None:
+ # let the plugin manager create on demand plugin objects
+ pm = e5App().getObject("PluginManager")
+ pm.initOnDemandPlugins()
+
+ # populate the various lists
+ self.projectItem = self.__generateCategoryItem(self.tr("Project"))
+ for act in e5App().getObject("Project").getActions():
+ self.__generateShortcutItem(self.projectItem, act)
+
+ self.uiItem = self.__generateCategoryItem(self.tr("General"))
+ for act in e5App().getObject("UserInterface").getActions('ui'):
+ self.__generateShortcutItem(self.uiItem, act)
+
+ self.wizardsItem = self.__generateCategoryItem(self.tr("Wizards"))
+ for act in e5App().getObject("UserInterface")\
+ .getActions('wizards'):
+ self.__generateShortcutItem(self.wizardsItem, act)
+
+ self.debugItem = self.__generateCategoryItem(self.tr("Debug"))
+ for act in e5App().getObject("DebugUI").getActions():
+ self.__generateShortcutItem(self.debugItem, act)
+
+ self.editItem = self.__generateCategoryItem(self.tr("Edit"))
+ for act in e5App().getObject("ViewManager").getActions('edit'):
+ self.__generateShortcutItem(self.editItem, act)
+
+ self.fileItem = self.__generateCategoryItem(self.tr("File"))
+ for act in e5App().getObject("ViewManager").getActions('file'):
+ self.__generateShortcutItem(self.fileItem, act)
+
+ self.searchItem = self.__generateCategoryItem(self.tr("Search"))
+ for act in e5App().getObject("ViewManager").getActions('search'):
+ self.__generateShortcutItem(self.searchItem, act)
+
+ self.viewItem = self.__generateCategoryItem(self.tr("View"))
+ for act in e5App().getObject("ViewManager").getActions('view'):
+ self.__generateShortcutItem(self.viewItem, act)
+
+ self.macroItem = self.__generateCategoryItem(self.tr("Macro"))
+ for act in e5App().getObject("ViewManager").getActions('macro'):
+ self.__generateShortcutItem(self.macroItem, act)
+
+ self.bookmarkItem = self.__generateCategoryItem(
+ self.tr("Bookmarks"))
+ for act in e5App().getObject("ViewManager").getActions('bookmark'):
+ self.__generateShortcutItem(self.bookmarkItem, act)
+
+ self.spellingItem = self.__generateCategoryItem(
+ self.tr("Spelling"))
+ for act in e5App().getObject("ViewManager").getActions('spelling'):
+ self.__generateShortcutItem(self.spellingItem, act)
+
+ actions = e5App().getObject("ViewManager").getActions('window')
+ if actions:
+ self.windowItem = self.__generateCategoryItem(
+ self.tr("Window"))
+ for act in actions:
+ self.__generateShortcutItem(self.windowItem, act)
+
+ self.pluginCategoryItems = []
+ for category, ref in e5App().getPluginObjects():
+ if hasattr(ref, "getActions"):
+ categoryItem = self.__generateCategoryItem(category)
+ objectType = e5App().getPluginObjectType(category)
+ for act in ref.getActions():
+ self.__generateShortcutItem(categoryItem, act,
+ objectType=objectType)
+ self.pluginCategoryItems.append(categoryItem)
+
+ else:
+ self.helpViewerItem = self.__generateCategoryItem(
+ self.tr("eric6 Web Browser"))
+ for act in helpViewer.getActions():
+ self.__generateShortcutItem(self.helpViewerItem, act, True)
+
+ self.__resort()
+ self.__resizeColumns()
+
+ self.__editTopItem = None
+
+ def on_shortcutsList_itemDoubleClicked(self, itm, column):
+ """
+ Private slot to handle a double click in the shortcuts list.
+
+ @param itm the list item that was double clicked (QTreeWidgetItem)
+ @param column the list item was double clicked in (integer)
+ """
+ if itm.childCount():
+ return
+
+ self.__editTopItem = itm.parent()
+
+ self.shortcutDialog.setKeys(
+ QKeySequence(itm.text(1)),
+ QKeySequence(itm.text(2)),
+ itm.data(0, self.noCheckRole),
+ itm.data(0, self.objectTypeRole))
+ self.shortcutDialog.show()
+
+ def on_shortcutsList_itemClicked(self, itm, column):
+ """
+ Private slot to handle a click in the shortcuts list.
+
+ @param itm the list item that was clicked (QTreeWidgetItem)
+ @param column the list item was clicked in (integer)
+ """
+ if itm.childCount() or column not in [1, 2]:
+ return
+
+ self.shortcutsList.openPersistentEditor(itm, column)
+
+ def on_shortcutsList_itemChanged(self, itm, column):
+ """
+ Private slot to handle the edit of a shortcut key.
+
+ @param itm reference to the item changed (QTreeWidgetItem)
+ @param column column changed (integer)
+ """
+ if column != 0:
+ keystr = itm.text(column).title()
+ if not itm.data(0, self.noCheckRole) and \
+ not self.__checkShortcut(QKeySequence(keystr),
+ itm.data(0, self.objectTypeRole),
+ itm.parent()):
+ itm.setText(column, "")
+ else:
+ itm.setText(column, keystr)
+ self.shortcutsList.closePersistentEditor(itm, column)
+
+ def __shortcutChanged(self, keysequence, altKeysequence, noCheck,
+ objectType):
+ """
+ Private slot to handle the shortcutChanged signal of the shortcut
+ dialog.
+
+ @param keysequence the keysequence of the changed action (QKeySequence)
+ @param altKeysequence the alternative keysequence of the changed
+ action (QKeySequence)
+ @param noCheck flag indicating that no uniqueness check should
+ be performed (boolean)
+ @param objectType type of the object (string).
+ """
+ if not noCheck and \
+ (not self.__checkShortcut(
+ keysequence, objectType, self.__editTopItem) or
+ not self.__checkShortcut(
+ altKeysequence, objectType, self.__editTopItem)):
+ return
+
+ self.shortcutsList.currentItem().setText(1, keysequence.toString())
+ self.shortcutsList.currentItem().setText(2, altKeysequence.toString())
+
+ self.__resort()
+ self.__resizeColumns()
+
+ def __checkShortcut(self, keysequence, objectType, origTopItem):
+ """
+ Private method to check a keysequence for uniqueness.
+
+ @param keysequence the keysequence to check (QKeySequence)
+ @param objectType type of the object (string). Entries with the same
+ object type are not checked for uniqueness.
+ @param origTopItem refrence to the parent of the item to be checked
+ (QTreeWidgetItem)
+ @return flag indicating uniqueness (boolean)
+ """
+ if keysequence.isEmpty():
+ return True
+
+ keystr = keysequence.toString()
+ keyname = self.shortcutsList.currentItem().text(0)
+ for topIndex in range(self.shortcutsList.topLevelItemCount()):
+ topItem = self.shortcutsList.topLevelItem(topIndex)
+ for index in range(topItem.childCount()):
+ itm = topItem.child(index)
+
+ # 1. shall a check be performed?
+ if itm.data(0, self.noCheckRole):
+ continue
+
+ # 2. check object type
+ itmObjectType = itm.data(0, self.objectTypeRole)
+ if itmObjectType and \
+ itmObjectType == objectType and \
+ topItem != origTopItem:
+ continue
+
+ # 3. check key name
+ if itm.text(0) != keyname:
+ for col in [1, 2]:
+ # check against primary, then alternative binding
+ itmseq = itm.text(col)
+ # step 1: check if shortcut is already allocated
+ if keystr == itmseq:
+ res = E5MessageBox.yesNo(
+ self,
+ self.tr("Edit shortcuts"),
+ self.tr(
+ """<p><b>{0}</b> has already been"""
+ """ allocated to the <b>{1}</b> action. """
+ """Remove this binding?</p>""")
+ .format(keystr, itm.text(0)),
+ icon=E5MessageBox.Warning)
+ if res:
+ itm.setText(col, "")
+ return True
+ else:
+ return False
+
+ if not itmseq:
+ continue
+
+ # step 2: check if shortcut hides an already allocated
+ if itmseq.startswith("{0}+".format(keystr)):
+ res = E5MessageBox.yesNo(
+ self,
+ self.tr("Edit shortcuts"),
+ self.tr(
+ """<p><b>{0}</b> hides the <b>{1}</b>"""
+ """ action. Remove this binding?</p>""")
+ .format(keystr, itm.text(0)),
+ icon=E5MessageBox.Warning)
+ if res:
+ itm.setText(col, "")
+ return True
+ else:
+ return False
+
+ # step 3: check if shortcut is hidden by an
+ # already allocated
+ if keystr.startswith("{0}+".format(itmseq)):
+ res = E5MessageBox.yesNo(
+ self,
+ self.tr("Edit shortcuts"),
+ self.tr(
+ """<p><b>{0}</b> is hidden by the """
+ """<b>{1}</b> action. """
+ """Remove this binding?</p>""")
+ .format(keystr, itm.text(0)),
+ icon=E5MessageBox.Warning)
+ if res:
+ itm.setText(col, "")
+ return True
+ else:
+ return False
+
+ return True
+
+ def __saveCategoryActions(self, category, actions):
+ """
+ Private method to save the actions for a category.
+
+ @param category reference to the category item (QTreeWidgetItem)
+ @param actions list of actions for the category (list of E5Action)
+ """
+ for index in range(category.childCount()):
+ itm = category.child(index)
+ txt = itm.data(0, self.objectNameRole)
+ for act in actions:
+ if txt == act.objectName():
+ act.setShortcut(QKeySequence(itm.text(1)))
+ act.setAlternateShortcut(
+ QKeySequence(itm.text(2)), removeEmpty=True)
+ break
+
+ def on_buttonBox_accepted(self):
+ """
+ Private slot to handle the OK button press.
+ """
+ if self.__helpViewer is None:
+ self.__saveCategoryActions(
+ self.projectItem,
+ e5App().getObject("Project").getActions())
+ self.__saveCategoryActions(
+ self.uiItem,
+ e5App().getObject("UserInterface").getActions('ui'))
+ self.__saveCategoryActions(
+ self.wizardsItem,
+ e5App().getObject("UserInterface").getActions('wizards'))
+ self.__saveCategoryActions(
+ self.debugItem,
+ e5App().getObject("DebugUI").getActions())
+ self.__saveCategoryActions(
+ self.editItem,
+ e5App().getObject("ViewManager").getActions('edit'))
+ self.__saveCategoryActions(
+ self.fileItem,
+ e5App().getObject("ViewManager").getActions('file'))
+ self.__saveCategoryActions(
+ self.searchItem,
+ e5App().getObject("ViewManager").getActions('search'))
+ self.__saveCategoryActions(
+ self.viewItem,
+ e5App().getObject("ViewManager").getActions('view'))
+ self.__saveCategoryActions(
+ self.macroItem,
+ e5App().getObject("ViewManager").getActions('macro'))
+ self.__saveCategoryActions(
+ self.bookmarkItem,
+ e5App().getObject("ViewManager").getActions('bookmark'))
+ self.__saveCategoryActions(
+ self.spellingItem,
+ e5App().getObject("ViewManager").getActions('spelling'))
+
+ actions = e5App().getObject("ViewManager").getActions('window')
+ if actions:
+ self.__saveCategoryActions(self.windowItem, actions)
+
+ for categoryItem in self.pluginCategoryItems:
+ category = categoryItem.text(0)
+ ref = e5App().getPluginObject(category)
+ if ref is not None and hasattr(ref, "getActions"):
+ self.__saveCategoryActions(categoryItem, ref.getActions())
+
+ Shortcuts.saveShortcuts()
+
+ else:
+ self.__saveCategoryActions(
+ self.helpViewerItem, self.__helpViewer.getActions())
+ Shortcuts.saveShortcuts(helpViewer=self.__helpViewer)
+
+ Preferences.syncPreferences()
+
+ self.updateShortcuts.emit()
+ self.hide()
+
+ @pyqtSlot(str)
+ def on_searchEdit_textChanged(self, txt):
+ """
+ Private slot called, when the text in the search edit changes.
+
+ @param txt text of the search edit (string)
+ """
+ for topIndex in range(self.shortcutsList.topLevelItemCount()):
+ topItem = self.shortcutsList.topLevelItem(topIndex)
+ childHiddenCount = 0
+ for index in range(topItem.childCount()):
+ itm = topItem.child(index)
+ if (self.actionButton.isChecked() and
+ not QRegExp(txt, Qt.CaseInsensitive).indexIn(
+ itm.text(0)) > -1) or \
+ (self.shortcutButton.isChecked() and
+ not txt.lower() in itm.text(1).lower() and
+ not txt.lower() in itm.text(2).lower()):
+ itm.setHidden(True)
+ childHiddenCount += 1
+ else:
+ itm.setHidden(False)
+ topItem.setHidden(childHiddenCount == topItem.childCount())
+
+ @pyqtSlot(bool)
+ def on_actionButton_toggled(self, checked):
+ """
+ Private slot called, when the action radio button is toggled.
+
+ @param checked state of the action radio button (boolean)
+ """
+ if checked:
+ self.on_searchEdit_textChanged(self.searchEdit.text())
+
+ @pyqtSlot(bool)
+ def on_shortcutButton_toggled(self, checked):
+ """
+ Private slot called, when the shortcuts radio button is toggled.
+
+ @param checked state of the shortcuts radio button (boolean)
+ """
+ if checked:
+ self.on_searchEdit_textChanged(self.searchEdit.text())
