How to set up shortcuts from module on startup?

Development
1

Hi, to register keyboard shortcuts from a scripted module i have been putting the code in the setup method of my widget class, however there is a need to run each module to register its shortcuts, where should shortcut registration be placed in a module so it can run as soon as slicer starts?
I tried setting it as a separate method in widget class then call it but then i get "Failed to obtain reference to ‘qSlicerMainWindow’ " error

def Register_Shortcuts():
    def funct():
        print("OKAY")
    shortcuts = [
        ('x', funct),
        ('b', funct)]
    for (shortcutKey, callback) in shortcuts:
        shortcut = qt.QShortcut(slicer.util.mainWindow())
        shortcut.setKey(qt.QKeySequence(shortcutKey))
        shortcut.connect('activated()', callback)
Register_Shortcuts()
2

Hi -

A couple options - if it’s just for the user you can put the code in ~/.slicerrc.py. Or if you want this to be part of the module you can use the startupComplete() signal from the application to trigger the code.

1 Like
3

Thanks a lot.
Indeed slicerrc needs to be edited which is not ideal for module sharing.
startupComplete() signal is exactly what i was looking for. Thanks a lot for your help.

Note to interested people: i had to put in the init method of the main module class to be run at slicer’s startup

4

If there is a risk of shortcuts conflicting between modules, and you only want to use specific shortcuts in your module, you could have a look at this example (search for “shortcut” in the code). It installs shortcuts when you enter the module, but uninstalls them when you switch to a different module.

2 Likes
5

Thanks for the precision, that will definitely come in handy,
i don’t see how enter and exit methods (lines 317 and 375) get called? do slicer recognize their names and runs them automatically like the setup method?

6

yes, it does automatically call them

1 Like
7

Quite useful, Thanks for your help!

8

Dear Tamas,
Could you please reload the link?

9

It’s better to take examples from the official script repository: Script repository — 3D Slicer documentation

But here it is:

1 Like