Skip to content

Warn user on shortcut override and speed up filtering slightly #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 11, 2020
Merged

Warn user on shortcut override and speed up filtering slightly #12

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d19061f
Confirm Shortcut override
herronelou Jul 3, 2019
b90ae60
Fix shortcut override and speed up filtering
herronelou Jul 3, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
126 changes: 82 additions & 44 deletions shortcuteditor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
traceback.print_exc()
"""

__version__ = "1.2"
__version__ = "1.2dev"


import nuke
Expand Down Expand Up @@ -46,6 +46,8 @@ class KeySequenceWidget(QtWidgets.QWidget):
def __init__(self, parent=None):
QtWidgets.QWidget.__init__(self, parent)

self.setMinimumWidth(140)

layout = QtWidgets.QHBoxLayout()
layout.setContentsMargins(0, 0, 0, 0)
layout.setSpacing(2)
Expand Down Expand Up @@ -97,8 +99,8 @@ class KeySequenceButton(QtWidgets.QPushButton):

def __init__(self, parent=None):
QtWidgets.QPushButton.__init__(self, parent)
#self.setIcon(icons.get("configure"))
self._modifierlessAllowed = True # True allows "b" as a shortcut, False requires shift/alt/ctrl/etc
# self.setIcon(icons.get("configure"))
self._modifierlessAllowed = True # True allows "b" as a shortcut, False requires shift/alt/ctrl/etc
self._seq = QtGui.QKeySequence()
self._timer = QtCore.QTimer()
self._timer.setSingleShot(True)
Expand Down Expand Up @@ -144,7 +146,7 @@ def keyPressEvent(self, ev):
return QtWidgets.QPushButton.keyPressEvent(self, ev)
if ev.isAutoRepeat():
return
#modifiers = int(ev.modifiers() & (Qt.SHIFT | Qt.CTRL | Qt.ALT | Qt.META))
# modifiers = int(ev.modifiers() & (Qt.SHIFT | Qt.CTRL | Qt.ALT | Qt.META))
modifiers = ev.modifiers()

ev.accept()
Expand Down Expand Up @@ -210,7 +212,7 @@ def controlTimer(self):
self._timer.start(600)

def startRecording(self):
#self.setFocus(True) # because of QTBUG 17810
# self.setFocus(True) # because of QTBUG 17810
self.setDown(True)
self.setStyleSheet("text-align: left;")
self._isrecording = True
Expand All @@ -235,10 +237,7 @@ def cancelRecording(self):
self.updateDisplay()





def _find_menu_items(menu, _path = None, _top_menu_name = None):
def _find_menu_items(menu, _path=None, _top_menu_name=None):
"""Extracts items from a given Nuke menu

Returns a list of strings, with the path to each item
Expand Down Expand Up @@ -285,7 +284,6 @@ def _widget_with_label(towrap, text):
layout = QtWidgets.QHBoxLayout()
layout.setContentsMargins(0, 0, 0, 0)
label = QtWidgets.QLabel(text)
label.setAlignment(QtCore.Qt.AlignRight)
layout.addWidget(label)
layout.addWidget(towrap)
w.setLayout(layout)
Expand Down Expand Up @@ -322,12 +320,12 @@ def _save_internal():
try:
os.makedirs(ndir)
except OSError, e:
if e.errno != 17: # errno 17 is "already exists"
if e.errno != 17: # errno 17 is "already exists"
raise

f = open(path, "w")
# TODO: Limit number of saved items to some sane number
json.dump(obj, fp = f, sort_keys=True, indent=1, separators=(',', ': '))
json.dump(obj, fp=f, sort_keys=True, indent=1, separators=(',', ': '))
f.write("\n")
f.close()

Expand All @@ -348,7 +346,7 @@ def _restore_overrides(overrides):
if item is None:
nuke.warning("WARNING: %r (menu: %r) does not exist?" % (path, menu_name))
else:
#print "Restoring shortcut %r for %r (menu: %r)" % (key, path, menu_name)
# print "Restoring shortcut %r for %r (menu: %r)" % (key, path, menu_name)
item.setShortcut(key)


Expand All @@ -359,7 +357,6 @@ def _overrides_as_code(overrides):

menus.setdefault(menu_name, []).append((path, key))


lines = []
lines.append("def apply_key_overrides():")
lines.append(" overrides = {")
Expand All @@ -379,7 +376,6 @@ def _overrides_as_code(overrides):
lines.append(" item.setShortcut(key)")
return "\n".join(lines)


lines.append("apply_key_overrides()")
return "\n".join(lines)

Expand All @@ -392,7 +388,7 @@ def save(self):
settings = {
'overrides': self.overrides,
'version': 1,
}
}
_save_yaml(obj=settings, path=self.settings_path)

def clear(self):
Expand All @@ -416,12 +412,11 @@ def restore(self):

else:
nuke.warning("Wrong version of shortcut, nothing loaded (version was %s expected 1), path was %r" % (
int(settings['version']),
self.settings_path))
int(settings['version']),
self.settings_path))
return



class ShortcutEditorWidget(QtWidgets.QDialog):
closed = QtCore.Signal()

Expand Down Expand Up @@ -453,10 +448,9 @@ def __init__(self):

# By-key filter bar
key_filter = KeySequenceWidget()
key_filter.keySequenceChanged.connect(self.populate)
key_filter.keySequenceChanged.connect(self.filter_entries)
self.key_filter = key_filter


search_layout.addWidget(_widget_with_label(key_filter, "Search by key"))

# text filter bar
Expand All @@ -483,7 +477,6 @@ def __init__(self):
layout.addWidget(button_reset)
self.button_reset = button_reset


button_close = QtWidgets.QPushButton("Close")
button_close.clicked.connect(self.close)
layout.addWidget(button_close)
Expand All @@ -505,8 +498,26 @@ def search(self):
else:
self._search_timer = QtCore.QTimer()
self._search_timer.setSingleShot(True)
self._search_timer.timeout.connect(self.populate)
self._search_timer.start(200) # 200ms timeout
self._search_timer.timeout.connect(self.filter_entries)
self._search_timer.start(200) # 200ms timeout

def filter_entries(self):
""" Iterate through the rows in the table and hide/show according to filters"""
# We use the fact that self.list_menu() would never change to our advantage
menu_items = self.list_menu()

for rownum, menuitem in enumerate(menu_items):
# filter them, first by the input text
search = self.search_input.text()
found = search.lower() in menuitem['menupath'].lower().replace("&", "")

# ..and also filter by the shortcut, if one is specified
key_match = True
if self.key_filter.shortcut().toString() != "":
key_match = menuitem['menuobj'].shortcut() == self.key_filter.shortcut()

keep_result = all([found, key_match])
self.table.setRowHidden(rownum, not keep_result)

def list_menu(self):
"""Gets the list-of-dicts containing all menu items
Expand All @@ -526,16 +537,6 @@ def populate(self):
# Get menu items
menu_items = self.list_menu()

# ..and filter them, first by the input text
search = self.search_input.text()
menu_items = [x for x in menu_items
if search.lower() in x['menupath'].lower().replace("&", "")]

# ..and also filter by the shortcut, if one is specified
if self.key_filter.shortcut().toString() != "":
menu_items = [x for x in menu_items
if x['menuobj'].shortcut() == self.key_filter.shortcut()]

# Setup table
self.table.clear()
self.table.setRowCount(len(menu_items))
Expand All @@ -545,29 +546,63 @@ def populate(self):
for rownum, menuitem in enumerate(menu_items):
shortcut = QtGui.QKeySequence(menuitem['menuobj'].shortcut())

w = KeySequenceWidget()
w.setShortcut(shortcut)
widget = KeySequenceWidget()
widget.setShortcut(shortcut)

self.table.setCellWidget(rownum, 0, w)
self.table.setCellWidget(rownum, 1, QtWidgets.QLabel("%s (menu: %s)" % (menuitem['menupath'], menuitem['top_menu_name'])))
self.table.setCellWidget(rownum, 0, widget)
self.table.setCellWidget(rownum, 1, QtWidgets.QLabel("%s (menu: %s)" % (menuitem['menupath'],
menuitem['top_menu_name'])))

w.keySequenceChanged.connect(lambda menuitem=menuitem, w=w: self.setkey(menuitem = menuitem, shortcut_widget=w))
widget.keySequenceChanged.connect(lambda menu_item=menuitem, w=widget: self.setkey(menuitem=menu_item,
shortcut_widget=w))

def setkey(self, menuitem, shortcut_widget):
"""Called when shortcut is edited

Updates the Nuke menu, and puts the key in the Overrides setting-thing
"""
menuitem['menuobj'].setShortcut(shortcut_widget.shortcut().toString())
self.settings.overrides["%s/%s" % (menuitem['top_menu_name'], menuitem['menupath'])] = shortcut_widget.shortcut().toString()

# Check if shortcut is already assigned to something else:
shortcut = shortcut_widget.shortcut().toString()
menu_items = self.list_menu()
for index, other_item in enumerate(menu_items):
if shortcut and other_item['menuobj'].shortcut() == shortcut and other_item != menuitem:
answer = self.confirm_override(other_item, shortcut)
if not answer:
shortcut_widget.setShortcut(QtGui.QKeySequence(menuitem['menuobj'].shortcut()))
return

# Un-assign the shortcut first
other_item['menuobj'].setShortcut('')
self.settings.overrides["%s/%s" % (other_item['top_menu_name'], other_item['menupath'])] = ""
self.table.cellWidget(index, 0).setShortcut(QtGui.QKeySequence(""))

menuitem['menuobj'].setShortcut(shortcut)
self.settings.overrides[
"%s/%s" % (menuitem['top_menu_name'], menuitem['menupath'])] = shortcut_widget.shortcut().toString()

def confirm_override(self, menu_item, shortcut):
""" Ask the user if they are sure they want to override the shortcut"""
mb = QtWidgets.QMessageBox(self)

mb.setText("Shortcut '%s' is already assigned to %s (Menu: %s)." % (shortcut,
menu_item['menupath'],
menu_item['top_menu_name']))
mb.setInformativeText("Are you sure you want to replace it?")
mb.setIcon(QtWidgets.QMessageBox.Warning)

mb.setStandardButtons(QtWidgets.QMessageBox.Yes | QtWidgets.QMessageBox.No)
mb.setDefaultButton(QtWidgets.QMessageBox.Yes)
ret = mb.exec_()
return ret == QtWidgets.QMessageBox.Yes

def reset(self):
"""Reset some or all of the key overrides
"""

mb = QtWidgets.QMessageBox(
self,
)
)

mb.setText("Clear all key overrides?")
mb.setInformativeText("Really remove all %s key overrides?" % len(self.settings.overrides))
Expand Down Expand Up @@ -603,7 +638,7 @@ def clamp(val, mi, ma):
return max(min(val, ma), mi)

# Get cursor position, and screen dimensions on active screen
cursor = QtWidgets.QCursor().pos()
cursor = QtGui.QCursor().pos()
screen = QtWidgets.QDesktopWidget().screenGeometry(cursor)

# Get window position so cursor is just over text input
Expand All @@ -629,6 +664,8 @@ def load_shortcuts():


_sew_instance = None


def gui():
"""Launch the key-override editor GUI

Expand All @@ -654,9 +691,10 @@ def gui():
def when_closed():
global _sew_instance
_sew_instance = None

_sew_instance.closed.connect(when_closed)

modal=False
modal = False
if modal:
_sew_instance.exec_()
else:
Expand Down