Add Custom User Configuration Popup to Viewer Plugin

[naveen.chandran]

Hello,

I have created a viewer plugin, and would like to know how to include settings in the toolbar on the left of the viewer (similar to preferences).

I would also like to know how I would be able to save and get preference values, as well as display them for editing to the user.

I saw on the documentation for plugins the
save_settings(config_widget)
and
config_widget()

methods, but I do not know how to implement them.

Could anyone provide me with more information on this?

[kovidgoyal]

You can add any buttons you like to the viewer toolbars, see the documentation of the ViewerPlugin.customize_ui method on how to do that.

Those buttons can trigger any action you like, including showing a dialog with config options. You will just need to use the standard PyQt QDialog class to create such a dialog.

As for how to store the configuration options, you can store them in any way that you like, just choose a unique name for the config file, so that it does not conflict with the rest of calibre's config files. Use the calibre JSONConfig class to manage the config file easily.

[naveen.chandran]

Should I implement the ConfigWidgetBase or just implement isCustomizable(), save_settings(), and config_widget in my main plugin class?

[kovidgoyal]

You dont need to implement any of those. Those are all for plugins that dont want their own config UI and are intended t be configured via Preferences->Plugins