Plugins

Safa Alfulaij edited this page Jan 7, 2015 · 31 revisions

Available pages:

Clone this wiki locally

Page translations: Прикључци

Plugins

QupZilla plugins are small dynamic loaded libraries (.so on *nix / .dll on windows) which can do a lot of various jobs.
QupZilla plugins are classic Qt Lower Level-API extensions.

How to start

To create your first QupZilla plugin, you will have to download the source code of the QupZilla version you are targeting. You will find it in the Downloads section.
After that, you have to compile QupZilla in order to generate libQupZilla to link your plugin against it. Generally, qmake && make should work for you. Of course, you need to have at least basic Qt/C++ skills to write a plugin.

Plugins API

Every plugin needs to contain a subclass of the PluginInterface class. This class offers some pure virtual functions that are called directly from QupZilla. The global object PluginProxy offers some functions as well, but it mainly emits signals for plugins.

For detailed information about available functions and signals, please see Plugins API page.

Examples

The TestPlugin is a suitable example to do the first steps. Every single file contains useful explanations and comments, so please take a look at it first.

Loading plugins

Plugins are loaded from predefined directories:

  • DATADIR + /plugins (/usr/share/qupzilla/plugins on Linux, exe-location/plugins on Windows)
  • PROFILEDIR + /plugins (~/.qupzilla/plugins on Linux, somewhere-in-documents/.qupzilla/plugins on Windows)
  • Linux only: /usr/lib/qupzilla

Go back to Home page