Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision |
dev:howto:panel_plugins [2019/11/11 07:59] – [Introduction] added link to API documentation kevinbowen | dev:howto:panel_plugins [2024/03/26 18:11] (current) – [Testing and Releasing the plugin] gael |
---|
====== Xfce Panel Plugins How To ====== | ====== Xfce Panel Plugins How To ====== |
<note tip>You can get the sample plugin from [[https://git.xfce.org/panel-plugins/xfce4-sample-plugin/|git]].</note> | <note tip>You can find the sample plugin [[https://gitlab.xfce.org/panel-plugins/xfce4-sample-plugin|on GitLab]]. There is also a [[https://gitlab.xfce.org/itsManjeet/xfce4-python-sample-plugin|Python version]].</note> |
| |
===== Introduction ===== | ===== Introduction ===== |
required headers (''gtk'' and ''libxfce4util''): | required headers (''gtk'' and ''libxfce4util''): |
| |
#include <libxfce4panel/xfce-panel-plugin.h> | #include <libxfce4panel/libxfce4panel.h> |
| |
===== Plugin Registration ===== | ===== Plugin Registration ===== |
For creating a release you need to run ''./autogen.sh && make distcheck''. Fix all warnings and errors in make distcheck before distributing the package. | For creating a release you need to run ''./autogen.sh && make distcheck''. Fix all warnings and errors in make distcheck before distributing the package. |
| |
To help development, you can also test plugins without installing them on panel's prefix (e.g. /usr), you can also directly run plugins from the source so you don't need to to overwrite a plugin version from your distribution. To accomplish this, build the plugin with make and then follow these steps: | To help development, you can also test plugins without installing them on panel's prefix (e.g. /usr). As for 4.19.4, you can install the plugin in a directory of XDG_DATA_DIRS or in XDG_HOME_DIR, and the panel should find it. In particular, a default plugin installation in /usr/local with a panel in /usr should work on its own (or a plugin installation in ~/.local without root permissions). |
| |
| You can also directly run plugins from the source so you don't need to overwrite a plugin version from your distribution. To accomplish this, build the plugin with make and then follow these steps: |
| |
* Create a symbolic link from your plugin binary to the panel's prefix installation, e.g. ''ln -s /home/johndoe/where/your/src/is/panel-plugin/.libs/libyourplugin.so /usr/lib/xfce4/panel-plugins/libyourplugin-git.so'' | * Create a symbolic link from your plugin binary to the panel's prefix installation, e.g. ''ln -s /home/johndoe/where/your/src/is/panel-plugin/.libs/libyourplugin.so /usr/lib/xfce4/panel-plugins/libyourplugin-git.so'' |