UI plugin icon not displaying in context menu

[jackie_w]

Never mind, I figured it out. My problem was due to a missing line.

popup_type = QToolButton.InstantPopup

I never have been exactly sure about the available options for popup_type. I just learnt the hard way.

Hi Kovid,

calibre 4.10.1 Win10 32-bit ... Can you shed any light on the following:

This is not a showstopper but I've just noticed a problem with non-display of the main plugin icon in some of my UI plugins. It may have been around longer but I've only just noticed it.

The problem seems to occur only in the right-click context menu and only for UI plugins which don't have a sub-menu. See attached screenshots.

Using ScrambleEbook as an example of a UI plugin with no sub-menu, as you can see (2nd image) the plugin icon displays OK in the main toolbar and in the main menu. However in the right-click context menu (1st image) the icon is blank.

Compare this with the 'TTS to MP3' (which does have a sub-menu) next to ScrambleEbook where the icon displays OK everywhere.

I notice that the built-in tools/plugins which don't have a sub-menu (e.g. 'Polish book', 'Unpack book') don't have the same problem. I don't think the problem is specific to ScrambleEbook because 2 of my other (personal) plugins have the same problem.

This is the genesis code from ScrambleEbook in case this is where the problem lies.

def genesis(self):
    self.is_library_selected = True
    self.icons = get_icons(['images/plugin_icon.png',
                            'images/azw3.png',
                            'images/epub.png',
                            'images/kepub.png',
                            'images/azw3.svg',
                            'images/epub.svg',
                            'images/kepub.svg'
                            ])
    icon = get_icons('images/plugin_icon.png')
    self.qaction.setIcon(icon)
    self.qaction.triggered.connect(self.show_dialog)

[jackie_w]

Hmm. Maybe I spoke too soon.

popup_type = QToolButton.InstantPopup

gave me the icon in the context menu but it seems to have also disabled the Shortcut key setting which is working OK when I have

popup_type = QToolButton.MenuButtonPopup

... or perhaps I haven't found the magic combo yet. The genesis is as shown in post #1 and the bit before genesis() is

class ScrambleEbookUiAction(InterfaceAction):
    name = PLUGIN_NAME
    ttip = '%s\n(%s)' % (PLUGIN_DESCRIPTION, ','.join(OK_FORMATS))
    action_spec = (PLUGIN_NAME, None, ttip, _('Ctrl+Shift+S'))
    popup_type = QToolButton.InstantPopup
    action_type = 'current'
    dont_add_to = frozenset([])
    dont_remove_from = frozenset([])

Is there an obvious error here?

[kovidgoyal]

looks ok at first glance, it would help if you posted the full plugin.

[jackie_w]

Originally Posted by kovidgoyal

looks ok at first glance, it would help if you posted the full plugin.

OK, here it is.

Just to recap, as this is a public plugin, my first priority is to enable a shortcut key and the second (cosmetic) priority is to have the icon displayed in the context menu.

If you can tell me where I'm going wrong I'll be most grateful.

[kovidgoyal]

Works for me once I commented out popup_type completely (which is the same as setting it to menubuttonpopup). I could add it to the context menu and I could use ctrl+shift+s to trigger it.

[jackie_w]

Originally Posted by kovidgoyal

Works for me once I commented out popup_type completely (which is the same as setting it to menubuttonpopup). I could add it to the context menu and I could use ctrl+shift+s to trigger it.

Perhaps I didn't explain myself well enough. I have no problem adding to (or running from) the context menu. It's just that there is no icon displayed (on my Windows10 anyway) in the context menu when popup_type is set to MenuButtonPopup.

The context menu icon does appear if popup_type is InstantPopup, but then the shortcut doesn't work.

If I have to settle for only one of the two I'll have to choose shortcut over icon, but I'd like to have both working if possible.

[kovidgoyal]

ah ok, is see, where you have

self.qaction.setIcon(icon)


add

if hasattr(self, 'shortcut_action_for_context_menu'):
   self.shortcut_action_for_context_menu.setIcon(icon)

as well.

[jackie_w]

Originally Posted by kovidgoyal

ah ok, is see, where you have

self.qaction.setIcon(icon)


add

if hasattr(self, 'shortcut_action_for_context_menu'):
   self.shortcut_action_for_context_menu.setIcon(icon)

as well.

Oh, yes, that works.

I don't think I'd ever have worked that one out on my own.

[kovidgoyal]

It's really a regression, you should not need to do it at all and it will be fixed in the next release.

[jackie_w]

Originally Posted by kovidgoyal

It's really a regression, you should not need to do it at all and it will be fixed in the next release.

OK then, before I publish the python3-ready plugin update I'll revert back to the original code I had.

Was it a 4.10 regression?

[kovidgoyal]

You can keep the code I mentioned, it's harmless. The regression was in either 4.9 or 4.10 dont remember.