[Xfce4-commits] <xfce4-panel:devel> Improve size-changed comment, as suggested in bug #5616.

[Nick Schermer]

Updating branch refs/heads/devel
         to f4148a0ca3667b1f2d016153e1224e9f4d29d3ce (commit)
       from 2d3d630915da36aed517e59d3d7134a9726defb0 (commit)

commit f4148a0ca3667b1f2d016153e1224e9f4d29d3ce
Author: Nick Schermer <nick at xfce.org>
Date:   Wed Oct 7 21:45:57 2009 +0200

    Improve size-changed comment, as suggested in bug #5616.

 libxfce4panel/xfce-panel-plugin.c |    6 ++++++
 1 files changed, 6 insertions(+), 0 deletions(-)

diff --git a/libxfce4panel/xfce-panel-plugin.c b/libxfce4panel/xfce-panel-plugin.c
index d314fc2..416fc0c 100644
--- a/libxfce4panel/xfce-panel-plugin.c
+++ b/libxfce4panel/xfce-panel-plugin.c
@@ -311,6 +311,12 @@ xfce_panel_plugin_class_init (XfcePanelPluginClass *klass)
    * This signal is emmitted whenever the size of the panel
    * the @plugin is on changes. Plugins writers can for example use
    * this signal to update their icon size.
+   *
+   * If the function returns %FALSE or is not used, the panel will force
+   * a square size to the plugin. If you want non-square plugins and you
+   * don't need this signal you can use something like this:
+   *
+   * g_signal_connect (plugin, "size-changed", G_CALLBACK (gtk_true), NULL);
    **/
   plugin_signals[SIZE_CHANGED] =
     g_signal_new (I_("size-changed"),