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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
|
# This file is part of the Frescobaldi project, http://www.frescobaldi.org/
#
# Copyright (c) 2008 - 2012 by Wilbert Berendsen
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
# See http://www.gnu.org/licenses/ for more information.
"""
Manages ActionCollections for a MainWindow (and so, effectively, for the whole
application.)
This makes it possible to edit actions and check whether keyboard shortcuts of
actions conflict with other actions.
"""
from __future__ import unicode_literals
import weakref
from PyQt4.QtGui import QMessageBox
import actioncollection
import plugin
import qutil
def manager(mainwindow):
"""Returns the ActionCollectionManager belonging to mainwindow."""
return ActionCollectionManager.instance(mainwindow)
class ActionCollectionManager(plugin.MainWindowPlugin):
"""Manages ActionCollections for a MainWindow."""
def __init__(self, mainwindow):
"""Creates the ActionCollectionManager for the given mainwindow."""
self._actioncollections = weakref.WeakValueDictionary()
def addActionCollection(self, collection):
"""Add an actioncollection to our list (used for changing keyboard shortcuts).
Does not keep a reference to it. If the ActionCollection gets garbage collected,
it is removed automatically from our list.
"""
if collection.name not in self._actioncollections:
self._actioncollections[collection.name] = collection
def removeActionCollection(self, collection):
"""Removes the given ActionCollection from our list."""
if collection.name in self._actioncollections:
del self._actioncollections[collection.name]
def actionCollections(self):
"""Iterate over the ActionCollections in our list."""
return self._actioncollections.values()
def action(self, collection_name, action_name):
"""Returns the named action from the named collection."""
collection = self._actioncollections.get(collection_name)
if collection:
if isinstance(collection, actioncollection.ShortcutCollection):
return collection.realAction(action_name)
return getattr(collection, action_name, None)
def editAction(self, parent, action, default=None, skip=None):
"""Edits the keyboard shortcut for a single action.
Returns True if editing was Ok, False if cancelled.
parent is the widget to show the dialog above.
default gives None or a list with QKeySequence objects that are the default shortcut.
Use skip to give the action to skip (e.g. the action that is about to be changed).
skip can also be a tuple (collection, name) to define the action to skip.
Just uses the dialog in widgets.shortcuteditdialog but implements conflict checking
(without altering other shortcuts. The implementation of conflict checking in
preferences/shortcuts.py also can change other shortcuts in the prefs dialog.)
"""
skip_ = lambda: a is skip
if skip is None:
skip = action
elif isinstance(skip, tuple):
skip_ = lambda: (collection, name) == skip
from widgets import shortcuteditdialog
dlg = shortcuteditdialog.ShortcutEditDialog(parent)
with qutil.deleteLater(dlg):
while dlg.editAction(action, default):
# conflict checking
shortcuts = action.shortcuts()
if shortcuts:
conflicts = {}
for collection in self.actionCollections():
for name, a in collection.actions().items():
# we use collection.shortcuts(name) instead of a.shortcuts()
# because the (real) actions returned by ShortcutCollection.action()
# don't have the shortcuts set.
if not skip_() and collection.shortcuts(name):
for s1 in collection.shortcuts(name):
for s2 in action.shortcuts():
if s2.matches(s1) or s1.matches(s2):
# s2 conflicts with a
conflicts.setdefault(a, []).append(s2)
# do shortcuts remain?
if s2 in shortcuts:
shortcuts.remove(s2)
if conflicts:
msg = [_("This shortcut conflicts with the following command:",
"This shortcut conflicts with the following commands:", len(conflicts))]
msg.append("<br/>".join("{name} ({key})".format(
name = qutil.removeAccelelator(a.text()),
key=' \u2014 '.join(s.toString() for s in conflicts[a])) for a in conflicts))
msg = '<p>{0}</p>'.format('</p><p>'.join(msg))
box = QMessageBox(QMessageBox.Warning, _("Shortcut Conflict"), msg,
QMessageBox.Ok | QMessageBox.Cancel, parent)
box.button(QMessageBox.Ok).setText(_("Edit again"))
if box.exec_() == QMessageBox.Ok:
action.setShortcuts(shortcuts)
continue
else:
break
return True
return False
|
