Refreshing toolbar icons

[meme]

I've added a feature to my plugin (mainly for kiwidude ) to allow you to change the behaviour of the toolbar icon through customization. By default when you install the plugin its only a dropdown menu. But you can customize it to select any of the menu's functions to be the default action (or to just show the menu). When you restart calibre, the icon will change to the split icon/menu view if you've chosen a function, and if you click the icon it will run the function you configured. You can of course click the down arrow to get the menu as usual.

I'd like to avoid having to restart calibre. I see that if I run Preferences and add/remove another icon and save, that my icon correctly updates, so I know its possible. There are many functions in the source and after testing a few I think it might be safer to ask the right way to do this in order to avoid problems later.

So how to I get the toolbar icons to refresh without restarting?

I expect to call this either in my plugins __init__ save_settings, or possibly within the ui rebuild_menus (but I think that might be calling a refresh inside of a refresh).

[kiwidude]

There is code that does this in my walk search history plugin. There is a bunch more stuff to actually hook/unhook events as appropriate but the magic line is:

        # Apply the popup type for this action in the toolbar
        # Only update on the toolbar if it is actually visible there
        if self.qaction in self.gui.tool_bar.added_actions:
            self.gui.tool_bar.setup_tool_button(self.gui.tool_bar, self.qaction, self.popup_type)

Of course with all the additional toolbars etc Calibre has nowadays perhaps it is not sufficient, I haven't tested it elsewhere than the main toolbar.

[kovidgoyal]

            self.gui.tool_bar.build_bar()
            self.gui.menu_bar.build_bar()
            self.gui.build_context_menus()

[meme]

Okay, thanks to both. Got that working. Should have known you had that in one of your plugins - but it was fun figuring the rest out

It was necessary to put the rebuild_menus into initialization complete otherwise I would get:

AttributeError: 'Main' object has no attribute 'tool_bar'

I'm using the check if the icon is in the bar before refreshing it, and then just running self.gui.tool_bar.build_bar() since I don't actually change the submenus in my plugin just the icon, although I'll put them in the code as comments so I don't forget if I ever due change the submenus.

[kovidgoyal]

Actually, I'm a little surprised that just calling setIcon on your qaction in initialization_complete doesn't automatically change the icon in the bar.

[meme]

It doesn't seem to. It appears as if the tooltip and function changes ok. But if I change from a split icon to a single icon and vice versa using

 
            self.popup_type = QToolButton.InstantPopup
or
            self.popup_type = QToolButton.MenuButtonPopup

Then the icon doesn't change until I restart or I use the build bar_function.

[kovidgoyal]

Ah yes, for the popup type you would need this

for bar in (self.gui.tool_bar, self.gui.tool_bar.child_bar):
   w = bar.widgetForAction(self.qaction)
   if w is not None:
       w.setPopupMode(QToolButton.whatever)