← Back to branch summary

~ubuntu-branches/ubuntu/utopic/xfce4-panel/utopic

« back to all changes in this revision

Viewing changes to docs/references/html/XfcePanelPlugin.html

  • Committer: Package Import Robot
  • Author(s): Jackson Doak
  • Date: 2014-02-16 14:34:33 UTC
  • mto: (4.1.8 experimental)
  • mto: This revision was merged to the branch mainline in revision 74.
  • Revision ID: package-import@ubuntu.com-20140216143433-p8txgs80qz1ybqns
Tags: upstream-4.11.0
Import upstream version 4.11.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/references/html/XfcePanelPlugin.html
50
50
 
51
51
                    <a class="link" href="XfcePanelPlugin.html#XfcePanelPlugin-struct" title="XfcePanelPlugin">XfcePanelPlugin</a>;
52
52
struct              <a class="link" href="XfcePanelPlugin.html#XfcePanelPluginClass" title="struct XfcePanelPluginClass">XfcePanelPluginClass</a>;
53
 
const <span class="returnvalue">gchar</span> *       <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-get-name" title="xfce_panel_plugin_get_name ()">xfce_panel_plugin_get_name</a>          (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>);
54
 
const <span class="returnvalue">gchar</span> *       <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-get-display-name" title="xfce_panel_plugin_get_display_name ()">xfce_panel_plugin_get_display_name</a>  (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>);
55
 
const <span class="returnvalue">gchar</span> *       <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-get-comment" title="xfce_panel_plugin_get_comment ()">xfce_panel_plugin_get_comment</a>       (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>);
56
 
<span class="returnvalue">gint</span>                <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-get-unique-id" title="xfce_panel_plugin_get_unique_id ()">xfce_panel_plugin_get_unique_id</a>     (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>);
57
 
const <span class="returnvalue">gchar</span> *       <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-get-property-base" title="xfce_panel_plugin_get_property_base ()">xfce_panel_plugin_get_property_base</a> (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>);
58
 
const <span class="returnvalue">gchar</span> * const  * <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-get-arguments" title="xfce_panel_plugin_get_arguments ()">xfce_panel_plugin_get_arguments</a>  (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>);
59
 
<span class="returnvalue">gint</span>                <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-get-size" title="xfce_panel_plugin_get_size ()">xfce_panel_plugin_get_size</a>          (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>);
60
 
<span class="returnvalue">gboolean</span>            <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-get-expand" title="xfce_panel_plugin_get_expand ()">xfce_panel_plugin_get_expand</a>        (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>);
 
53
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-get-name" title="xfce_panel_plugin_get_name ()">xfce_panel_plugin_get_name</a>          (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>);
 
54
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-get-display-name" title="xfce_panel_plugin_get_display_name ()">xfce_panel_plugin_get_display_name</a>  (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>);
 
55
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-get-comment" title="xfce_panel_plugin_get_comment ()">xfce_panel_plugin_get_comment</a>       (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>);
 
56
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-get-unique-id" title="xfce_panel_plugin_get_unique_id ()">xfce_panel_plugin_get_unique_id</a>     (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>);
 
57
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-get-property-base" title="xfce_panel_plugin_get_property_base ()">xfce_panel_plugin_get_property_base</a> (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>);
 
58
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * const  * <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-get-arguments" title="xfce_panel_plugin_get_arguments ()">xfce_panel_plugin_get_arguments</a>  (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>);
 
59
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-get-size" title="xfce_panel_plugin_get_size ()">xfce_panel_plugin_get_size</a>          (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>);
 
60
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-get-expand" title="xfce_panel_plugin_get_expand ()">xfce_panel_plugin_get_expand</a>        (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>);
61
61
<span class="returnvalue">void</span>                <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-set-expand" title="xfce_panel_plugin_set_expand ()">xfce_panel_plugin_set_expand</a>        (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>,
62
 
                                                         <em class="parameter"><code><span class="type">gboolean</span> expand</code></em>);
63
 
<span class="returnvalue">GtkOrientation</span>      <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-get-orientation" title="xfce_panel_plugin_get_orientation ()">xfce_panel_plugin_get_orientation</a>   (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>);
 
62
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> expand</code></em>);
 
63
<a href="http://developer.gnome.org/gtk2/gtk3-Standard-Enumerations.html#GtkOrientation"><span class="returnvalue">GtkOrientation</span></a>      <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-get-orientation" title="xfce_panel_plugin_get_orientation ()">xfce_panel_plugin_get_orientation</a>   (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>);
64
64
<a class="link" href="libxfce4panel-Standard-Enumerations.html#XfceScreenPosition" title="enum XfceScreenPosition"><span class="returnvalue">XfceScreenPosition</span></a>  <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-get-screen-position" title="xfce_panel_plugin_get_screen_position ()">xfce_panel_plugin_get_screen_position</a>
65
65
                                                        (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>);
66
 
<span class="returnvalue">gboolean</span>            <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-get-locked" title="xfce_panel_plugin_get_locked ()">xfce_panel_plugin_get_locked</a>        (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>);
 
66
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-get-locked" title="xfce_panel_plugin_get_locked ()">xfce_panel_plugin_get_locked</a>        (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>);
67
67
<span class="returnvalue">void</span>                <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-take-window" title="xfce_panel_plugin_take_window ()">xfce_panel_plugin_take_window</a>       (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>,
68
 
                                                         <em class="parameter"><code><span class="type">GtkWindow</span> *window</code></em>);
 
68
                                                         <em class="parameter"><code><a href="http://developer.gnome.org/gtk2/GtkWindow.html"><span class="type">GtkWindow</span></a> *window</code></em>);
69
69
<span class="returnvalue">void</span>                <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-add-action-widget" title="xfce_panel_plugin_add_action_widget ()">xfce_panel_plugin_add_action_widget</a> (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>,
70
 
                                                         <em class="parameter"><code><span class="type">GtkWidget</span> *widget</code></em>);
 
70
                                                         <em class="parameter"><code><a href="http://developer.gnome.org/gtk2/GtkWidget.html"><span class="type">GtkWidget</span></a> *widget</code></em>);
71
71
<span class="returnvalue">void</span>                <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-menu-insert-item" title="xfce_panel_plugin_menu_insert_item ()">xfce_panel_plugin_menu_insert_item</a>  (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>,
72
 
                                                         <em class="parameter"><code><span class="type">GtkMenuItem</span> *item</code></em>);
 
72
                                                         <em class="parameter"><code><a href="http://developer.gnome.org/gtk2/GtkMenuItem.html"><span class="type">GtkMenuItem</span></a> *item</code></em>);
73
73
<span class="returnvalue">void</span>                <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-menu-show-configure" title="xfce_panel_plugin_menu_show_configure ()">xfce_panel_plugin_menu_show_configure</a>
74
74
                                                        (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>);
75
75
<span class="returnvalue">void</span>                <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-menu-show-about" title="xfce_panel_plugin_menu_show_about ()">xfce_panel_plugin_menu_show_about</a>   (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>);
77
77
<span class="returnvalue">void</span>                <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-block-menu" title="xfce_panel_plugin_block_menu ()">xfce_panel_plugin_block_menu</a>        (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>);
78
78
<span class="returnvalue">void</span>                <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-unblock-menu" title="xfce_panel_plugin_unblock_menu ()">xfce_panel_plugin_unblock_menu</a>      (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>);
79
79
<span class="returnvalue">void</span>                <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-register-menu" title="xfce_panel_plugin_register_menu ()">xfce_panel_plugin_register_menu</a>     (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>,
80
 
                                                         <em class="parameter"><code><span class="type">GtkMenu</span> *menu</code></em>);
81
 
<span class="returnvalue">GtkArrowType</span>        <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-arrow-type" title="xfce_panel_plugin_arrow_type ()">xfce_panel_plugin_arrow_type</a>        (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>);
 
80
                                                         <em class="parameter"><code><a href="http://developer.gnome.org/gtk2/GtkMenu.html"><span class="type">GtkMenu</span></a> *menu</code></em>);
 
81
<a href="http://developer.gnome.org/gtk2/gtk3-Standard-Enumerations.html#GtkArrowType"><span class="returnvalue">GtkArrowType</span></a>        <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-arrow-type" title="xfce_panel_plugin_arrow_type ()">xfce_panel_plugin_arrow_type</a>        (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>);
82
82
<span class="returnvalue">void</span>                <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-position-widget" title="xfce_panel_plugin_position_widget ()">xfce_panel_plugin_position_widget</a>   (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>,
83
 
                                                         <em class="parameter"><code><span class="type">GtkWidget</span> *menu_widget</code></em>,
84
 
                                                         <em class="parameter"><code><span class="type">GtkWidget</span> *attach_widget</code></em>,
85
 
                                                         <em class="parameter"><code><span class="type">gint</span> *x</code></em>,
86
 
                                                         <em class="parameter"><code><span class="type">gint</span> *y</code></em>);
87
 
<span class="returnvalue">void</span>                <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-position-menu" title="xfce_panel_plugin_position_menu ()">xfce_panel_plugin_position_menu</a>     (<em class="parameter"><code><span class="type">GtkMenu</span> *menu</code></em>,
88
 
                                                         <em class="parameter"><code><span class="type">gint</span> *x</code></em>,
89
 
                                                         <em class="parameter"><code><span class="type">gint</span> *y</code></em>,
90
 
                                                         <em class="parameter"><code><span class="type">gboolean</span> *push_in</code></em>,
91
 
                                                         <em class="parameter"><code><span class="type">gpointer</span> panel_plugin</code></em>);
 
83
                                                         <em class="parameter"><code><a href="http://developer.gnome.org/gtk2/GtkWidget.html"><span class="type">GtkWidget</span></a> *menu_widget</code></em>,
 
84
                                                         <em class="parameter"><code><a href="http://developer.gnome.org/gtk2/GtkWidget.html"><span class="type">GtkWidget</span></a> *attach_widget</code></em>,
 
85
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *x</code></em>,
 
86
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *y</code></em>);
 
87
<span class="returnvalue">void</span>                <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-position-menu" title="xfce_panel_plugin_position_menu ()">xfce_panel_plugin_position_menu</a>     (<em class="parameter"><code><a href="http://developer.gnome.org/gtk2/GtkMenu.html"><span class="type">GtkMenu</span></a> *menu</code></em>,
 
88
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *x</code></em>,
 
89
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *y</code></em>,
 
90
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *push_in</code></em>,
 
91
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> panel_plugin</code></em>);
92
92
<span class="returnvalue">void</span>                <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-focus-widget" title="xfce_panel_plugin_focus_widget ()">xfce_panel_plugin_focus_widget</a>      (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>,
93
 
                                                         <em class="parameter"><code><span class="type">GtkWidget</span> *widget</code></em>);
 
93
                                                         <em class="parameter"><code><a href="http://developer.gnome.org/gtk2/GtkWidget.html"><span class="type">GtkWidget</span></a> *widget</code></em>);
94
94
<span class="returnvalue">void</span>                <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-block-autohide" title="xfce_panel_plugin_block_autohide ()">xfce_panel_plugin_block_autohide</a>    (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>,
95
 
                                                         <em class="parameter"><code><span class="type">gboolean</span> blocked</code></em>);
96
 
<span class="returnvalue">gchar</span> *             <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-lookup-rc-file" title="xfce_panel_plugin_lookup_rc_file ()">xfce_panel_plugin_lookup_rc_file</a>    (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>);
97
 
<span class="returnvalue">gchar</span> *             <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-save-location" title="xfce_panel_plugin_save_location ()">xfce_panel_plugin_save_location</a>     (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>,
98
 
                                                         <em class="parameter"><code><span class="type">gboolean</span> create</code></em>);
 
95
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> blocked</code></em>);
 
96
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-lookup-rc-file" title="xfce_panel_plugin_lookup_rc_file ()">xfce_panel_plugin_lookup_rc_file</a>    (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>);
 
97
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-save-location" title="xfce_panel_plugin_save_location ()">xfce_panel_plugin_save_location</a>     (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>,
 
98
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> create</code></em>);
99
99
#define             <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-xfconf-channel-new" title="xfce_panel_plugin_xfconf_channel_new()">xfce_panel_plugin_xfconf_channel_new</a>(plugin)
100
100
#define             <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-set-panel-hidden" title="xfce_panel_plugin_set_panel_hidden()">xfce_panel_plugin_set_panel_hidden</a>  (plugin,
101
101
                                                         hidden)
104
104
<div class="refsect1">
105
105
<a name="XfcePanelPlugin.object-hierarchy"></a><h2>Object Hierarchy</h2>
106
106
<pre class="synopsis">
107
 
  GObject
108
 
   +----GInitiallyUnowned
109
 
         +----GtkObject
110
 
               +----GtkWidget
111
 
                     +----GtkContainer
112
 
                           +----GtkBin
113
 
                                 +----GtkEventBox
 
107
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
108
   +----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
 
109
         +----<a href="../gtk2/GtkObject.html">GtkObject</a>
 
110
               +----<a href="http://developer.gnome.org/gtk2/GtkWidget.html">GtkWidget</a>
 
111
                     +----<a href="http://developer.gnome.org/gtk2/GtkContainer.html">GtkContainer</a>
 
112
                           +----<a href="http://developer.gnome.org/gtk2/GtkBin.html">GtkBin</a>
 
113
                                 +----<a href="http://developer.gnome.org/gtk2/GtkEventBox.html">GtkEventBox</a>
114
114
                                       +----XfcePanelPlugin
115
115
</pre>
116
116
</div>
118
118
<a name="XfcePanelPlugin.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
119
119
<p>
120
120
XfcePanelPlugin implements
121
 
 AtkImplementorIface,  GtkBuildable and  XfcePanelPluginProvider.</p>
 
121
 AtkImplementorIface,  <a href="http://developer.gnome.org/gtk2/GtkBuildable.html">GtkBuildable</a> and  XfcePanelPluginProvider.</p>
122
122
</div>
123
123
<div class="refsect1">
124
124
<a name="XfcePanelPlugin.properties"></a><h2>Properties</h2>
125
125
<pre class="synopsis">
126
 
  "<a class="link" href="XfcePanelPlugin.html#XfcePanelPlugin--arguments" title='The "arguments" property'>arguments</a>"                <span class="type">GStrv</span>                 : Read / Write / Construct Only
127
 
  "<a class="link" href="XfcePanelPlugin.html#XfcePanelPlugin--comment" title='The "comment" property'>comment</a>"                  <span class="type">gchar</span>*                : Read / Write / Construct Only
128
 
  "<a class="link" href="XfcePanelPlugin.html#XfcePanelPlugin--display-name" title='The "display-name" property'>display-name</a>"             <span class="type">gchar</span>*                : Read / Write / Construct Only
129
 
  "<a class="link" href="XfcePanelPlugin.html#XfcePanelPlugin--expand" title='The "expand" property'>expand</a>"                   <span class="type">gboolean</span>              : Read / Write
 
126
  "<a class="link" href="XfcePanelPlugin.html#XfcePanelPlugin--arguments" title='The "arguments" property'>arguments</a>"                <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Boxed-Types.html#GStrv"><span class="type">GStrv</span></a>                 : Read / Write / Construct Only
 
127
  "<a class="link" href="XfcePanelPlugin.html#XfcePanelPlugin--comment" title='The "comment" property'>comment</a>"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only
 
128
  "<a class="link" href="XfcePanelPlugin.html#XfcePanelPlugin--display-name" title='The "display-name" property'>display-name</a>"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only
 
129
  "<a class="link" href="XfcePanelPlugin.html#XfcePanelPlugin--expand" title='The "expand" property'>expand</a>"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
130
130
  "<a class="link" href="XfcePanelPlugin.html#XfcePanelPlugin--mode" title='The "mode" property'>mode</a>"                     <span class="type">XfcePanelPluginMode</span>   : Read
131
 
  "<a class="link" href="XfcePanelPlugin.html#XfcePanelPlugin--name" title='The "name" property'>name</a>"                     <span class="type">gchar</span>*                : Read / Write / Construct Only
132
 
  "<a class="link" href="XfcePanelPlugin.html#XfcePanelPlugin--nrows" title='The "nrows" property'>nrows</a>"                    <span class="type">guint</span>                 : Read
133
 
  "<a class="link" href="XfcePanelPlugin.html#XfcePanelPlugin--orientation" title='The "orientation" property'>orientation</a>"              <span class="type">GtkOrientation</span>        : Read
 
131
  "<a class="link" href="XfcePanelPlugin.html#XfcePanelPlugin--name" title='The "name" property'>name</a>"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only
 
132
  "<a class="link" href="XfcePanelPlugin.html#XfcePanelPlugin--nrows" title='The "nrows" property'>nrows</a>"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read
 
133
  "<a class="link" href="XfcePanelPlugin.html#XfcePanelPlugin--orientation" title='The "orientation" property'>orientation</a>"              <a href="http://developer.gnome.org/gtk2/gtk3-Standard-Enumerations.html#GtkOrientation"><span class="type">GtkOrientation</span></a>        : Read
134
134
  "<a class="link" href="XfcePanelPlugin.html#XfcePanelPlugin--screen-position" title='The "screen-position" property'>screen-position</a>"          <a class="link" href="libxfce4panel-Standard-Enumerations.html#XfceScreenPosition" title="enum XfceScreenPosition"><span class="type">XfceScreenPosition</span></a>    : Read
135
 
  "<a class="link" href="XfcePanelPlugin.html#XfcePanelPlugin--shrink" title='The "shrink" property'>shrink</a>"                   <span class="type">gboolean</span>              : Read / Write
136
 
  "<a class="link" href="XfcePanelPlugin.html#XfcePanelPlugin--size" title='The "size" property'>size</a>"                     <span class="type">gint</span>                  : Read
137
 
  "<a class="link" href="XfcePanelPlugin.html#XfcePanelPlugin--small" title='The "small" property'>small</a>"                    <span class="type">gboolean</span>              : Read / Write
138
 
  "<a class="link" href="XfcePanelPlugin.html#XfcePanelPlugin--unique-id" title='The "unique-id" property'>unique-id</a>"                <span class="type">gint</span>                  : Read / Write / Construct Only
 
135
  "<a class="link" href="XfcePanelPlugin.html#XfcePanelPlugin--shrink" title='The "shrink" property'>shrink</a>"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
 
136
  "<a class="link" href="XfcePanelPlugin.html#XfcePanelPlugin--size" title='The "size" property'>size</a>"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read
 
137
  "<a class="link" href="XfcePanelPlugin.html#XfcePanelPlugin--small" title='The "small" property'>small</a>"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
 
138
  "<a class="link" href="XfcePanelPlugin.html#XfcePanelPlugin--unique-id" title='The "unique-id" property'>unique-id</a>"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct Only
139
139
</pre>
140
140
</div>
141
141
<div class="refsect1">
142
142
<a name="XfcePanelPlugin.signals"></a><h2>Signals</h2>
143
143
<pre class="synopsis">
144
 
  "<a class="link" href="XfcePanelPlugin.html#XfcePanelPlugin-about" title='The "about" signal'>about</a>"                                          : <code class="literal">Run Last</code>
145
 
  "<a class="link" href="XfcePanelPlugin.html#XfcePanelPlugin-configure-plugin" title='The "configure-plugin" signal'>configure-plugin</a>"                               : <code class="literal">Run Last</code>
146
 
  "<a class="link" href="XfcePanelPlugin.html#XfcePanelPlugin-free-data" title='The "free-data" signal'>free-data</a>"                                      : <code class="literal">Run Last</code>
147
 
  "<a class="link" href="XfcePanelPlugin.html#XfcePanelPlugin-mode-changed" title='The "mode-changed" signal'>mode-changed</a>"                                   : <code class="literal">Run Last</code>
148
 
  "<a class="link" href="XfcePanelPlugin.html#XfcePanelPlugin-nrows-changed" title='The "nrows-changed" signal'>nrows-changed</a>"                                  : <code class="literal">Run Last</code>
149
 
  "<a class="link" href="XfcePanelPlugin.html#XfcePanelPlugin-orientation-changed" title='The "orientation-changed" signal'>orientation-changed</a>"                            : <code class="literal">Run Last</code>
150
 
  "<a class="link" href="XfcePanelPlugin.html#XfcePanelPlugin-remote-event" title='The "remote-event" signal'>remote-event</a>"                                   : <code class="literal">Run Last</code>
151
 
  "<a class="link" href="XfcePanelPlugin.html#XfcePanelPlugin-removed" title='The "removed" signal'>removed</a>"                                        : <code class="literal">Run Last</code>
152
 
  "<a class="link" href="XfcePanelPlugin.html#XfcePanelPlugin-save" title='The "save" signal'>save</a>"                                           : <code class="literal">Run Last</code>
153
 
  "<a class="link" href="XfcePanelPlugin.html#XfcePanelPlugin-screen-position-changed" title='The "screen-position-changed" signal'>screen-position-changed</a>"                        : <code class="literal">Run Last</code>
154
 
  "<a class="link" href="XfcePanelPlugin.html#XfcePanelPlugin-size-changed" title='The "size-changed" signal'>size-changed</a>"                                   : <code class="literal">Run Last</code>
 
144
  "<a class="link" href="XfcePanelPlugin.html#XfcePanelPlugin-about" title='The "about" signal'>about</a>"                                          : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
 
145
  "<a class="link" href="XfcePanelPlugin.html#XfcePanelPlugin-configure-plugin" title='The "configure-plugin" signal'>configure-plugin</a>"                               : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
 
146
  "<a class="link" href="XfcePanelPlugin.html#XfcePanelPlugin-free-data" title='The "free-data" signal'>free-data</a>"                                      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
 
147
  "<a class="link" href="XfcePanelPlugin.html#XfcePanelPlugin-mode-changed" title='The "mode-changed" signal'>mode-changed</a>"                                   : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
 
148
  "<a class="link" href="XfcePanelPlugin.html#XfcePanelPlugin-nrows-changed" title='The "nrows-changed" signal'>nrows-changed</a>"                                  : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
 
149
  "<a class="link" href="XfcePanelPlugin.html#XfcePanelPlugin-orientation-changed" title='The "orientation-changed" signal'>orientation-changed</a>"                            : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
 
150
  "<a class="link" href="XfcePanelPlugin.html#XfcePanelPlugin-remote-event" title='The "remote-event" signal'>remote-event</a>"                                   : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
 
151
  "<a class="link" href="XfcePanelPlugin.html#XfcePanelPlugin-removed" title='The "removed" signal'>removed</a>"                                        : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
 
152
  "<a class="link" href="XfcePanelPlugin.html#XfcePanelPlugin-save" title='The "save" signal'>save</a>"                                           : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
 
153
  "<a class="link" href="XfcePanelPlugin.html#XfcePanelPlugin-screen-position-changed" title='The "screen-position-changed" signal'>screen-position-changed</a>"                        : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
 
154
  "<a class="link" href="XfcePanelPlugin.html#XfcePanelPlugin-size-changed" title='The "size-changed" signal'>size-changed</a>"                                   : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
155
155
</pre>
156
156
</div>
157
157
<div class="refsect1">
271
271
<hr>
272
272
<div class="refsect2">
273
273
<a name="xfce-panel-plugin-get-name"></a><h3>xfce_panel_plugin_get_name ()</h3>
274
 
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       xfce_panel_plugin_get_name          (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>);</pre>
 
274
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       xfce_panel_plugin_get_name          (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>);</pre>
275
275
<p>
276
276
The internal name of the panel plugin.
277
277
</p>
295
295
<hr>
296
296
<div class="refsect2">
297
297
<a name="xfce-panel-plugin-get-display-name"></a><h3>xfce_panel_plugin_get_display_name ()</h3>
298
 
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       xfce_panel_plugin_get_display_name  (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>);</pre>
 
298
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       xfce_panel_plugin_get_display_name  (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>);</pre>
299
299
<p>
300
300
This returns the translated name of the plugin set in the .desktop
301
301
file of the plugin.
320
320
<hr>
321
321
<div class="refsect2">
322
322
<a name="xfce-panel-plugin-get-comment"></a><h3>xfce_panel_plugin_get_comment ()</h3>
323
 
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       xfce_panel_plugin_get_comment       (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>);</pre>
 
323
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       xfce_panel_plugin_get_comment       (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>);</pre>
324
324
<p>
325
325
This returns the translated comment of the plugin set in
326
326
the .desktop file of the plugin.
346
346
<hr>
347
347
<div class="refsect2">
348
348
<a name="xfce-panel-plugin-get-unique-id"></a><h3>xfce_panel_plugin_get_unique_id ()</h3>
349
 
<pre class="programlisting"><span class="returnvalue">gint</span>                xfce_panel_plugin_get_unique_id     (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>);</pre>
 
349
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                xfce_panel_plugin_get_unique_id     (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>);</pre>
350
350
<p>
351
351
The internal unique id of the plugin. Each plugin in the panel has
352
352
a unique number that is for example used for the config file name
373
373
<hr>
374
374
<div class="refsect2">
375
375
<a name="xfce-panel-plugin-get-property-base"></a><h3>xfce_panel_plugin_get_property_base ()</h3>
376
 
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       xfce_panel_plugin_get_property_base (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>);</pre>
 
376
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       xfce_panel_plugin_get_property_base (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>);</pre>
377
377
<p>
378
378
The property base for this plugin in the xfce4-panel XfconfChannel,
379
379
this name is something like /plugins/plugin-1.
401
401
<hr>
402
402
<div class="refsect2">
403
403
<a name="xfce-panel-plugin-get-arguments"></a><h3>xfce_panel_plugin_get_arguments ()</h3>
404
 
<pre class="programlisting">const <span class="returnvalue">gchar</span> * const  * xfce_panel_plugin_get_arguments  (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>);</pre>
 
404
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * const  * xfce_panel_plugin_get_arguments  (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>);</pre>
405
405
<p>
406
406
Argument vector passed to the plugin when it was added. Most of the
407
 
time the return value will be <code class="literal">NULL</code>, but if could for example contain
 
407
time the return value will be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, but if could for example contain
408
408
a list of filenames when the user added the plugin with
409
409
</p>
410
410
<p>
435
435
<hr>
436
436
<div class="refsect2">
437
437
<a name="xfce-panel-plugin-get-size"></a><h3>xfce_panel_plugin_get_size ()</h3>
438
 
<pre class="programlisting"><span class="returnvalue">gint</span>                xfce_panel_plugin_get_size          (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>);</pre>
 
438
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                xfce_panel_plugin_get_size          (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>);</pre>
439
439
<p>
440
440
The size of the panel in which the plugin is embedded.
441
441
</p>
459
459
<hr>
460
460
<div class="refsect2">
461
461
<a name="xfce-panel-plugin-get-expand"></a><h3>xfce_panel_plugin_get_expand ()</h3>
462
 
<pre class="programlisting"><span class="returnvalue">gboolean</span>            xfce_panel_plugin_get_expand        (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>);</pre>
 
462
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            xfce_panel_plugin_get_expand        (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>);</pre>
463
463
<p>
464
464
Whether the plugin is expanded or not. This set by the plugin using
465
465
<a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-set-expand" title="xfce_panel_plugin_set_expand ()"><code class="function">xfce_panel_plugin_set_expand()</code></a>.
477
477
<tr>
478
478
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
479
479
<td>
480
 
<code class="literal">TRUE</code> when the plugin should expand,
481
 
<code class="literal">FALSE</code> otherwise.</td>
 
480
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> when the plugin should expand,
 
481
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</td>
482
482
</tr>
483
483
</tbody>
484
484
</table></div>
487
487
<div class="refsect2">
488
488
<a name="xfce-panel-plugin-set-expand"></a><h3>xfce_panel_plugin_set_expand ()</h3>
489
489
<pre class="programlisting"><span class="returnvalue">void</span>                xfce_panel_plugin_set_expand        (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>,
490
 
                                                         <em class="parameter"><code><span class="type">gboolean</span> expand</code></em>);</pre>
 
490
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> expand</code></em>);</pre>
491
491
<p>
492
492
Wether the plugin should expand of not
493
493
</p>
511
511
<hr>
512
512
<div class="refsect2">
513
513
<a name="xfce-panel-plugin-get-orientation"></a><h3>xfce_panel_plugin_get_orientation ()</h3>
514
 
<pre class="programlisting"><span class="returnvalue">GtkOrientation</span>      xfce_panel_plugin_get_orientation   (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>);</pre>
 
514
<pre class="programlisting"><a href="http://developer.gnome.org/gtk2/gtk3-Standard-Enumerations.html#GtkOrientation"><span class="returnvalue">GtkOrientation</span></a>      xfce_panel_plugin_get_orientation   (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>);</pre>
515
515
<p>
516
516
The orientation of the panel in which the plugin is embedded.
517
517
</p>
527
527
</tr>
528
528
<tr>
529
529
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
530
 
<td>the current <span class="type">GtkOrientation</span> of the panel.</td>
 
530
<td>the current <a href="http://developer.gnome.org/gtk2/gtk3-Standard-Enumerations.html#GtkOrientation"><span class="type">GtkOrientation</span></a> of the panel.</td>
531
531
</tr>
532
532
</tbody>
533
533
</table></div>
560
560
<hr>
561
561
<div class="refsect2">
562
562
<a name="xfce-panel-plugin-get-locked"></a><h3>xfce_panel_plugin_get_locked ()</h3>
563
 
<pre class="programlisting"><span class="returnvalue">gboolean</span>            xfce_panel_plugin_get_locked        (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>);</pre>
 
563
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            xfce_panel_plugin_get_locked        (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>);</pre>
564
564
<p>
565
565
Whether the plugin is locked (not allowing customization). This
566
566
is emitted through the panel based on the Xfconf locking of the
586
586
<tr>
587
587
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
588
588
<td>
589
 
<code class="literal">TRUE</code> if the user is not allowed to modify the plugin,
590
 
<code class="literal">FALSE</code> is customization is allowed.</td>
 
589
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the user is not allowed to modify the plugin,
 
590
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is customization is allowed.</td>
591
591
</tr>
592
592
</tbody>
593
593
</table></div>
597
597
<div class="refsect2">
598
598
<a name="xfce-panel-plugin-take-window"></a><h3>xfce_panel_plugin_take_window ()</h3>
599
599
<pre class="programlisting"><span class="returnvalue">void</span>                xfce_panel_plugin_take_window       (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>,
600
 
                                                         <em class="parameter"><code><span class="type">GtkWindow</span> *window</code></em>);</pre>
 
600
                                                         <em class="parameter"><code><a href="http://developer.gnome.org/gtk2/GtkWindow.html"><span class="type">GtkWindow</span></a> *window</code></em>);</pre>
601
601
<p>
602
602
Connect a dialog to a plugin. When the <em class="parameter"><code>plugin</code></em> is closed, it will
603
603
destroy the <em class="parameter"><code>window</code></em>.
614
614
</tr>
615
615
<tr>
616
616
<td><p><span class="term"><em class="parameter"><code>window</code></em> :</span></p></td>
617
 
<td>a <span class="type">GtkWindow</span>.</td>
 
617
<td>a <a href="http://developer.gnome.org/gtk2/GtkWindow.html"><span class="type">GtkWindow</span></a>.</td>
618
618
</tr>
619
619
</tbody>
620
620
</table></div>
624
624
<div class="refsect2">
625
625
<a name="xfce-panel-plugin-add-action-widget"></a><h3>xfce_panel_plugin_add_action_widget ()</h3>
626
626
<pre class="programlisting"><span class="returnvalue">void</span>                xfce_panel_plugin_add_action_widget (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>,
627
 
                                                         <em class="parameter"><code><span class="type">GtkWidget</span> *widget</code></em>);</pre>
 
627
                                                         <em class="parameter"><code><a href="http://developer.gnome.org/gtk2/GtkWidget.html"><span class="type">GtkWidget</span></a> *widget</code></em>);</pre>
628
628
<p>
629
629
Attach the plugin menu to this widget. Plugin writers should call this
630
630
for every widget that can receive mouse events. If you forget to call this
643
643
</tr>
644
644
<tr>
645
645
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
646
 
<td>a <span class="type">GtkWidget</span> that receives mouse events.</td>
 
646
<td>a <a href="http://developer.gnome.org/gtk2/GtkWidget.html"><span class="type">GtkWidget</span></a> that receives mouse events.</td>
647
647
</tr>
648
648
</tbody>
649
649
</table></div>
652
652
<div class="refsect2">
653
653
<a name="xfce-panel-plugin-menu-insert-item"></a><h3>xfce_panel_plugin_menu_insert_item ()</h3>
654
654
<pre class="programlisting"><span class="returnvalue">void</span>                xfce_panel_plugin_menu_insert_item  (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>,
655
 
                                                         <em class="parameter"><code><span class="type">GtkMenuItem</span> *item</code></em>);</pre>
 
655
                                                         <em class="parameter"><code><a href="http://developer.gnome.org/gtk2/GtkMenuItem.html"><span class="type">GtkMenuItem</span></a> *item</code></em>);</pre>
656
656
<p>
657
657
Insert a custom menu item to the plugin's right click menu. This item
658
658
is packed below the "Move" menu item.
669
669
</tr>
670
670
<tr>
671
671
<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>
672
 
<td>a <span class="type">GtkMenuItem</span>.</td>
 
672
<td>a <a href="http://developer.gnome.org/gtk2/GtkMenuItem.html"><span class="type">GtkMenuItem</span></a>.</td>
673
673
</tr>
674
674
</tbody>
675
675
</table></div>
780
780
<div class="refsect2">
781
781
<a name="xfce-panel-plugin-register-menu"></a><h3>xfce_panel_plugin_register_menu ()</h3>
782
782
<pre class="programlisting"><span class="returnvalue">void</span>                xfce_panel_plugin_register_menu     (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>,
783
 
                                                         <em class="parameter"><code><span class="type">GtkMenu</span> *menu</code></em>);</pre>
 
783
                                                         <em class="parameter"><code><a href="http://developer.gnome.org/gtk2/GtkMenu.html"><span class="type">GtkMenu</span></a> *menu</code></em>);</pre>
784
784
<p>
785
785
Register a menu that is about to popup. This will make sure the panel
786
786
will properly handle its autohide behaviour. You have to call this
789
789
<p>
790
790
If you want to open the menu aligned to the side of the panel (and the
791
791
plugin), you should use <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-position-menu" title="xfce_panel_plugin_position_menu ()"><code class="function">xfce_panel_plugin_position_menu()</code></a> as
792
 
<span class="type">GtkMenuPositionFunc</span>. This callback function will take care of calling
 
792
<a href="http://developer.gnome.org/gtk2/GtkMenu.html#GtkMenuPositionFunc"><span class="type">GtkMenuPositionFunc</span></a>. This callback function will take care of calling
793
793
<a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-register-menu" title="xfce_panel_plugin_register_menu ()"><code class="function">xfce_panel_plugin_register_menu()</code></a> as well.
794
794
</p>
795
795
<p>
807
807
</tr>
808
808
<tr>
809
809
<td><p><span class="term"><em class="parameter"><code>menu</code></em> :</span></p></td>
810
 
<td>a <span class="type">GtkMenu</span> that will be opened</td>
 
810
<td>a <a href="http://developer.gnome.org/gtk2/GtkMenu.html"><span class="type">GtkMenu</span></a> that will be opened</td>
811
811
</tr>
812
812
</tbody>
813
813
</table></div>
815
815
<hr>
816
816
<div class="refsect2">
817
817
<a name="xfce-panel-plugin-arrow-type"></a><h3>xfce_panel_plugin_arrow_type ()</h3>
818
 
<pre class="programlisting"><span class="returnvalue">GtkArrowType</span>        xfce_panel_plugin_arrow_type        (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>);</pre>
 
818
<pre class="programlisting"><a href="http://developer.gnome.org/gtk2/gtk3-Standard-Enumerations.html#GtkArrowType"><span class="returnvalue">GtkArrowType</span></a>        xfce_panel_plugin_arrow_type        (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>);</pre>
819
819
<p>
820
 
Determine the <span class="type">GtkArrowType</span> for a widget that opens a menu and uses
 
820
Determine the <a href="http://developer.gnome.org/gtk2/gtk3-Standard-Enumerations.html#GtkArrowType"><span class="type">GtkArrowType</span></a> for a widget that opens a menu and uses
821
821
<a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-position-menu" title="xfce_panel_plugin_position_menu ()"><code class="function">xfce_panel_plugin_position_menu()</code></a> to position the menu.
822
822
</p>
823
823
<div class="variablelist"><table border="0" class="variablelist">
832
832
</tr>
833
833
<tr>
834
834
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
835
 
<td>the <span class="type">GtkArrowType</span> to use.</td>
 
835
<td>the <a href="http://developer.gnome.org/gtk2/gtk3-Standard-Enumerations.html#GtkArrowType"><span class="type">GtkArrowType</span></a> to use.</td>
836
836
</tr>
837
837
</tbody>
838
838
</table></div>
841
841
<div class="refsect2">
842
842
<a name="xfce-panel-plugin-position-widget"></a><h3>xfce_panel_plugin_position_widget ()</h3>
843
843
<pre class="programlisting"><span class="returnvalue">void</span>                xfce_panel_plugin_position_widget   (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>,
844
 
                                                         <em class="parameter"><code><span class="type">GtkWidget</span> *menu_widget</code></em>,
845
 
                                                         <em class="parameter"><code><span class="type">GtkWidget</span> *attach_widget</code></em>,
846
 
                                                         <em class="parameter"><code><span class="type">gint</span> *x</code></em>,
847
 
                                                         <em class="parameter"><code><span class="type">gint</span> *y</code></em>);</pre>
 
844
                                                         <em class="parameter"><code><a href="http://developer.gnome.org/gtk2/GtkWidget.html"><span class="type">GtkWidget</span></a> *menu_widget</code></em>,
 
845
                                                         <em class="parameter"><code><a href="http://developer.gnome.org/gtk2/GtkWidget.html"><span class="type">GtkWidget</span></a> *attach_widget</code></em>,
 
846
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *x</code></em>,
 
847
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *y</code></em>);</pre>
848
848
<p>
849
849
The menu widget is positioned relative to <em class="parameter"><code>attach_widget</code></em>.
850
850
If <em class="parameter"><code>attach_widget</code></em> is NULL, the menu widget is instead positioned
852
852
</p>
853
853
<p>
854
854
This function is intended for custom menu widgets.
855
 
For a regular <span class="type">GtkMenu</span> you should use <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-position-menu" title="xfce_panel_plugin_position_menu ()"><code class="function">xfce_panel_plugin_position_menu()</code></a>
856
 
instead (as callback argument to <code class="function">gtk_menu_popup()</code>).
 
855
For a regular <a href="http://developer.gnome.org/gtk2/GtkMenu.html"><span class="type">GtkMenu</span></a> you should use <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-position-menu" title="xfce_panel_plugin_position_menu ()"><code class="function">xfce_panel_plugin_position_menu()</code></a>
 
856
instead (as callback argument to <a href="http://developer.gnome.org/gtk2/GtkMenu.html#gtk-menu-popup"><code class="function">gtk_menu_popup()</code></a>).
857
857
</p>
858
858
<p>
859
859
See also: <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-position-menu" title="xfce_panel_plugin_position_menu ()"><code class="function">xfce_panel_plugin_position_menu()</code></a>.
870
870
</tr>
871
871
<tr>
872
872
<td><p><span class="term"><em class="parameter"><code>menu_widget</code></em> :</span></p></td>
873
 
<td>a <span class="type">GtkWidget</span> that will be used as popup menu.</td>
 
873
<td>a <a href="http://developer.gnome.org/gtk2/GtkWidget.html"><span class="type">GtkWidget</span></a> that will be used as popup menu.</td>
874
874
</tr>
875
875
<tr>
876
876
<td><p><span class="term"><em class="parameter"><code>attach_widget</code></em> :</span></p></td>
877
 
<td>a <span class="type">GtkWidget</span> relative to which the menu should be positioned.</td>
 
877
<td>a <a href="http://developer.gnome.org/gtk2/GtkWidget.html"><span class="type">GtkWidget</span></a> relative to which the menu should be positioned.</td>
878
878
</tr>
879
879
<tr>
880
880
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
890
890
<hr>
891
891
<div class="refsect2">
892
892
<a name="xfce-panel-plugin-position-menu"></a><h3>xfce_panel_plugin_position_menu ()</h3>
893
 
<pre class="programlisting"><span class="returnvalue">void</span>                xfce_panel_plugin_position_menu     (<em class="parameter"><code><span class="type">GtkMenu</span> *menu</code></em>,
894
 
                                                         <em class="parameter"><code><span class="type">gint</span> *x</code></em>,
895
 
                                                         <em class="parameter"><code><span class="type">gint</span> *y</code></em>,
896
 
                                                         <em class="parameter"><code><span class="type">gboolean</span> *push_in</code></em>,
897
 
                                                         <em class="parameter"><code><span class="type">gpointer</span> panel_plugin</code></em>);</pre>
 
893
<pre class="programlisting"><span class="returnvalue">void</span>                xfce_panel_plugin_position_menu     (<em class="parameter"><code><a href="http://developer.gnome.org/gtk2/GtkMenu.html"><span class="type">GtkMenu</span></a> *menu</code></em>,
 
894
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *x</code></em>,
 
895
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *y</code></em>,
 
896
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *push_in</code></em>,
 
897
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> panel_plugin</code></em>);</pre>
898
898
<p>
899
 
Function to be used as <span class="type">GtkMenuPositionFunc</span> in a call to <code class="function">gtk_menu_popup()</code>.
 
899
Function to be used as <a href="http://developer.gnome.org/gtk2/GtkMenu.html#GtkMenuPositionFunc"><span class="type">GtkMenuPositionFunc</span></a> in a call to <a href="http://developer.gnome.org/gtk2/GtkMenu.html#gtk-menu-popup"><code class="function">gtk_menu_popup()</code></a>.
900
900
As data argument it needs an <a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a>.
901
901
</p>
902
902
<p>
903
903
The menu is normally positioned relative to <em class="parameter"><code>panel_plugin</code></em>. If you want the
904
904
menu to be positioned relative to another widget, you can use
905
 
<code class="function">gtk_menu_attach_to_widget()</code> to explicitly set a 'parent' widget.
 
905
<a href="http://developer.gnome.org/gtk2/GtkMenu.html#gtk-menu-attach-to-widget"><code class="function">gtk_menu_attach_to_widget()</code></a> to explicitly set a 'parent' widget.
906
906
</p>
907
907
<p>
908
908
As a convenience, <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-position-menu" title="xfce_panel_plugin_position_menu ()"><code class="function">xfce_panel_plugin_position_menu()</code></a> calls
931
931
<a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-position-widget" title="xfce_panel_plugin_position_widget ()"><code class="function">xfce_panel_plugin_position_widget()</code></a> instead.
932
932
</p>
933
933
<p>
934
 
See also: <code class="function">gtk_menu_popup()</code>.
 
934
See also: <a href="http://developer.gnome.org/gtk2/GtkMenu.html#gtk-menu-popup"><code class="function">gtk_menu_popup()</code></a>.
935
935
</p>
936
936
<div class="variablelist"><table border="0" class="variablelist">
937
937
<colgroup>
941
941
<tbody>
942
942
<tr>
943
943
<td><p><span class="term"><em class="parameter"><code>menu</code></em> :</span></p></td>
944
 
<td>a <span class="type">GtkMenu</span>.</td>
 
944
<td>a <a href="http://developer.gnome.org/gtk2/GtkMenu.html"><span class="type">GtkMenu</span></a>.</td>
945
945
</tr>
946
946
<tr>
947
947
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
953
953
</tr>
954
954
<tr>
955
955
<td><p><span class="term"><em class="parameter"><code>push_in</code></em> :</span></p></td>
956
 
<td>keep inside the screen (see <span class="type">GtkMenuPositionFunc</span>)</td>
 
956
<td>keep inside the screen (see <a href="http://developer.gnome.org/gtk2/GtkMenu.html#GtkMenuPositionFunc"><span class="type">GtkMenuPositionFunc</span></a>)</td>
957
957
</tr>
958
958
<tr>
959
959
<td><p><span class="term"><em class="parameter"><code>panel_plugin</code></em> :</span></p></td>
966
966
<div class="refsect2">
967
967
<a name="xfce-panel-plugin-focus-widget"></a><h3>xfce_panel_plugin_focus_widget ()</h3>
968
968
<pre class="programlisting"><span class="returnvalue">void</span>                xfce_panel_plugin_focus_widget      (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>,
969
 
                                                         <em class="parameter"><code><span class="type">GtkWidget</span> *widget</code></em>);</pre>
 
969
                                                         <em class="parameter"><code><a href="http://developer.gnome.org/gtk2/GtkWidget.html"><span class="type">GtkWidget</span></a> *widget</code></em>);</pre>
970
970
<p>
971
971
Grab the focus on <em class="parameter"><code>widget</code></em>. Asks the panel to allow focus on its items
972
972
and set the focus to the requested widget.
983
983
</tr>
984
984
<tr>
985
985
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
986
 
<td>a <span class="type">GtkWidget</span> inside the plugins that should be focussed.</td>
 
986
<td>a <a href="http://developer.gnome.org/gtk2/GtkWidget.html"><span class="type">GtkWidget</span></a> inside the plugins that should be focussed.</td>
987
987
</tr>
988
988
</tbody>
989
989
</table></div>
992
992
<div class="refsect2">
993
993
<a name="xfce-panel-plugin-block-autohide"></a><h3>xfce_panel_plugin_block_autohide ()</h3>
994
994
<pre class="programlisting"><span class="returnvalue">void</span>                xfce_panel_plugin_block_autohide    (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>,
995
 
                                                         <em class="parameter"><code><span class="type">gboolean</span> blocked</code></em>);</pre>
 
995
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> blocked</code></em>);</pre>
996
996
<p>
997
997
Wether this plugin blocks the autohide functality of the panel. Use
998
998
this when you 'popup' something that is visually attached to the
1023
1023
<hr>
1024
1024
<div class="refsect2">
1025
1025
<a name="xfce-panel-plugin-lookup-rc-file"></a><h3>xfce_panel_plugin_lookup_rc_file ()</h3>
1026
 
<pre class="programlisting"><span class="returnvalue">gchar</span> *             xfce_panel_plugin_lookup_rc_file    (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>);</pre>
 
1026
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             xfce_panel_plugin_lookup_rc_file    (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>);</pre>
1027
1027
<p>
1028
1028
Looks for the plugin resource file. This should be used to get the
1029
1029
plugin read location of the config file. You should only use the
1031
1031
not-writable file (in kiosk mode for example).
1032
1032
</p>
1033
1033
<p>
1034
 
See also: <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-save-location" title="xfce_panel_plugin_save_location ()"><code class="function">xfce_panel_plugin_save_location()</code></a> and <a href="/usr/share/gtk-doc/html/libxfce4util/libxfce4util-Resource-lookup-functions.html#xfce-resource-lookup"><code class="function">xfce_resource_lookup()</code></a>
 
1034
See also: <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-save-location" title="xfce_panel_plugin_save_location ()"><code class="function">xfce_panel_plugin_save_location()</code></a> and <code class="function">xfce_resource_lookup()</code>
1035
1035
</p>
1036
1036
<div class="variablelist"><table border="0" class="variablelist">
1037
1037
<colgroup>
1045
1045
</tr>
1046
1046
<tr>
1047
1047
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1048
 
<td>The path to a config file or <code class="literal">NULL</code> if no file was found.
1049
 
The returned string must be freed using <code class="function">g_free()</code>
 
1048
<td>The path to a config file or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if no file was found.
 
1049
The returned string must be freed using <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>
1050
1050
</td>
1051
1051
</tr>
1052
1052
</tbody>
1055
1055
<hr>
1056
1056
<div class="refsect2">
1057
1057
<a name="xfce-panel-plugin-save-location"></a><h3>xfce_panel_plugin_save_location ()</h3>
1058
 
<pre class="programlisting"><span class="returnvalue">gchar</span> *             xfce_panel_plugin_save_location     (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>,
1059
 
                                                         <em class="parameter"><code><span class="type">gboolean</span> create</code></em>);</pre>
 
1058
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             xfce_panel_plugin_save_location     (<em class="parameter"><code><a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin</code></em>,
 
1059
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> create</code></em>);</pre>
1060
1060
<p>
1061
1061
Returns the path that can be used to store configuration information.
1062
1062
Don't use this function if you want to read from the config file, but
1063
1063
use <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-lookup-rc-file" title="xfce_panel_plugin_lookup_rc_file ()"><code class="function">xfce_panel_plugin_lookup_rc_file()</code></a> instead.
1064
1064
</p>
1065
1065
<p>
1066
 
See also: <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-lookup-rc-file" title="xfce_panel_plugin_lookup_rc_file ()"><code class="function">xfce_panel_plugin_lookup_rc_file()</code></a> and <a href="/usr/share/gtk-doc/html/libxfce4util/libxfce4util-Resource-lookup-functions.html#xfce-resource-save-location"><code class="function">xfce_resource_save_location()</code></a>
 
1066
See also: <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-lookup-rc-file" title="xfce_panel_plugin_lookup_rc_file ()"><code class="function">xfce_panel_plugin_lookup_rc_file()</code></a> and <code class="function">xfce_resource_save_location()</code>
1067
1067
</p>
1068
1068
<div class="variablelist"><table border="0" class="variablelist">
1069
1069
<colgroup>
1081
1081
</tr>
1082
1082
<tr>
1083
1083
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1084
 
<td>The path to a config file or <code class="literal">NULL</code> if no file was found.
1085
 
The returned string must be freed u sing <code class="function">g_free()</code>.</td>
 
1084
<td>The path to a config file or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if no file was found.
 
1085
The returned string must be freed u sing <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>.</td>
1086
1086
</tr>
1087
1087
</tbody>
1088
1088
</table></div>
1146
1146
<a name="XfcePanelPlugin.property-details"></a><h2>Property Details</h2>
1147
1147
<div class="refsect2">
1148
1148
<a name="XfcePanelPlugin--arguments"></a><h3>The <code class="literal">"arguments"</code> property</h3>
1149
 
<pre class="programlisting">  "arguments"                <span class="type">GStrv</span>                 : Read / Write / Construct Only</pre>
 
1149
<pre class="programlisting">  "arguments"                <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Boxed-Types.html#GStrv"><span class="type">GStrv</span></a>                 : Read / Write / Construct Only</pre>
1150
1150
<p>
1151
1151
The arguments the plugin was started with. If the plugin was not
1152
 
started with any arguments this value is <code class="literal">NULL</code>. Plugin writer can
 
1152
started with any arguments this value is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. Plugin writer can
1153
1153
use it to read the arguments array, but
1154
1154
<a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-get-arguments" title="xfce_panel_plugin_get_arguments ()"><code class="function">xfce_panel_plugin_get_arguments()</code></a> is recommended.
1155
1155
</p>
1157
1157
<hr>
1158
1158
<div class="refsect2">
1159
1159
<a name="XfcePanelPlugin--comment"></a><h3>The <code class="literal">"comment"</code> property</h3>
1160
 
<pre class="programlisting">  "comment"                  <span class="type">gchar</span>*                : Read / Write / Construct Only</pre>
 
1160
<pre class="programlisting">  "comment"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only</pre>
1161
1161
<p>
1162
1162
The translated description of the <a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a>. This property is set
1163
1163
during plugin construction and can't be set twice. Plugin writer can use
1170
1170
<hr>
1171
1171
<div class="refsect2">
1172
1172
<a name="XfcePanelPlugin--display-name"></a><h3>The <code class="literal">"display-name"</code> property</h3>
1173
 
<pre class="programlisting">  "display-name"             <span class="type">gchar</span>*                : Read / Write / Construct Only</pre>
 
1173
<pre class="programlisting">  "display-name"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only</pre>
1174
1174
<p>
1175
1175
The translated display name of the <a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a>. This property is set
1176
1176
during plugin construction and can't be set twice. Plugin writer can use
1182
1182
<hr>
1183
1183
<div class="refsect2">
1184
1184
<a name="XfcePanelPlugin--expand"></a><h3>The <code class="literal">"expand"</code> property</h3>
1185
 
<pre class="programlisting">  "expand"                   <span class="type">gboolean</span>              : Read / Write</pre>
 
1185
<pre class="programlisting">  "expand"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
1186
1186
<p>
1187
1187
Wether the <a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> expands on the panel. Plugin writes can use it
1188
1188
to read or set this property, but <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-set-expand" title="xfce_panel_plugin_set_expand ()"><code class="function">xfce_panel_plugin_set_expand()</code></a>
1203
1203
<hr>
1204
1204
<div class="refsect2">
1205
1205
<a name="XfcePanelPlugin--name"></a><h3>The <code class="literal">"name"</code> property</h3>
1206
 
<pre class="programlisting">  "name"                     <span class="type">gchar</span>*                : Read / Write / Construct Only</pre>
 
1206
<pre class="programlisting">  "name"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only</pre>
1207
1207
<p>
1208
1208
The internal, unstranslated, name of the <a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a>. Plugin
1209
1209
writer can use it to read the plugin name, but
1215
1215
<hr>
1216
1216
<div class="refsect2">
1217
1217
<a name="XfcePanelPlugin--nrows"></a><h3>The <code class="literal">"nrows"</code> property</h3>
1218
 
<pre class="programlisting">  "nrows"                    <span class="type">guint</span>                 : Read</pre>
 
1218
<pre class="programlisting">  "nrows"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read</pre>
1219
1219
<p>
1220
1220
Number of rows the plugin is embedded on.
1221
1221
</p>
1226
1226
<hr>
1227
1227
<div class="refsect2">
1228
1228
<a name="XfcePanelPlugin--orientation"></a><h3>The <code class="literal">"orientation"</code> property</h3>
1229
 
<pre class="programlisting">  "orientation"              <span class="type">GtkOrientation</span>        : Read</pre>
 
1229
<pre class="programlisting">  "orientation"              <a href="http://developer.gnome.org/gtk2/gtk3-Standard-Enumerations.html#GtkOrientation"><span class="type">GtkOrientation</span></a>        : Read</pre>
1230
1230
<p>
1231
 
The <span class="type">GtkOrientation</span> of the <a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a>. Plugin writer can use it to read the
 
1231
The <a href="http://developer.gnome.org/gtk2/gtk3-Standard-Enumerations.html#GtkOrientation"><span class="type">GtkOrientation</span></a> of the <a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a>. Plugin writer can use it to read the
1232
1232
plugin orientation, but <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-get-orientation" title="xfce_panel_plugin_get_orientation ()"><code class="function">xfce_panel_plugin_get_orientation()</code></a> is recommended.
1233
1233
</p>
1234
1234
<p>Default value: GTK_ORIENTATION_HORIZONTAL</p>
1247
1247
<hr>
1248
1248
<div class="refsect2">
1249
1249
<a name="XfcePanelPlugin--shrink"></a><h3>The <code class="literal">"shrink"</code> property</h3>
1250
 
<pre class="programlisting">  "shrink"                   <span class="type">gboolean</span>              : Read / Write</pre>
 
1250
<pre class="programlisting">  "shrink"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
1251
1251
<p>
1252
1252
Wether the <a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> can shrink when there is no space left on the panel.
1253
1253
Plugin writes can use it to read or set this property, but <code class="function">xfce_panel_plugin_set_shrink()</code>
1259
1259
<hr>
1260
1260
<div class="refsect2">
1261
1261
<a name="XfcePanelPlugin--size"></a><h3>The <code class="literal">"size"</code> property</h3>
1262
 
<pre class="programlisting">  "size"                     <span class="type">gint</span>                  : Read</pre>
 
1262
<pre class="programlisting">  "size"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read</pre>
1263
1263
<p>
1264
1264
The size in pixels of the <a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a>. Plugin writer can use it to read the
1265
1265
plugin size, but <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-get-size" title="xfce_panel_plugin_get_size ()"><code class="function">xfce_panel_plugin_get_size()</code></a> is recommended.
1270
1270
<hr>
1271
1271
<div class="refsect2">
1272
1272
<a name="XfcePanelPlugin--small"></a><h3>The <code class="literal">"small"</code> property</h3>
1273
 
<pre class="programlisting">  "small"                    <span class="type">gboolean</span>              : Read / Write</pre>
 
1273
<pre class="programlisting">  "small"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
1274
1274
<p>
1275
1275
Wether the <a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> is small enough to fit a single row of a multi-row panel.
1276
1276
Plugin writes can use it to read or set this property, but <code class="function">xfce_panel_plugin_set_small()</code>
1282
1282
<hr>
1283
1283
<div class="refsect2">
1284
1284
<a name="XfcePanelPlugin--unique-id"></a><h3>The <code class="literal">"unique-id"</code> property</h3>
1285
 
<pre class="programlisting">  "unique-id"                <span class="type">gint</span>                  : Read / Write / Construct Only</pre>
 
1285
<pre class="programlisting">  "unique-id"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct Only</pre>
1286
1286
<p>Unique plugin ID.</p>
1287
1287
<p>Allowed values: &gt;= -1</p>
1288
1288
<p>Default value: -1</p>
1293
1293
<div class="refsect2">
1294
1294
<a name="XfcePanelPlugin-about"></a><h3>The <code class="literal">"about"</code> signal</h3>
1295
1295
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin,
1296
 
                                                        <span class="type">gpointer</span>         user_data)      : <code class="literal">Run Last</code></pre>
 
1296
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>         user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
1297
1297
<p>
1298
1298
This signal is emmitted when the About entry in the right-click
1299
1299
menu is clicked. Plugin writes can use it to show information
1324
1324
<div class="refsect2">
1325
1325
<a name="XfcePanelPlugin-configure-plugin"></a><h3>The <code class="literal">"configure-plugin"</code> signal</h3>
1326
1326
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin,
1327
 
                                                        <span class="type">gpointer</span>         user_data)      : <code class="literal">Run Last</code></pre>
 
1327
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>         user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
1328
1328
<p>
1329
1329
This signal is emmitted when the Properties entry in the right-click
1330
1330
menu is clicked. Plugin writes can use this signal to open a
1332
1332
</p>
1333
1333
<p>
1334
1334
See also: <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-menu-show-configure" title="xfce_panel_plugin_menu_show_configure ()"><code class="function">xfce_panel_plugin_menu_show_configure()</code></a> and
1335
 
          <a href="/usr/share/gtk-doc/html/libxfce4ui/libxfce4ui-xfce-titled-dialog.html#xfce-titled-dialog-new"><code class="function">xfce_titled_dialog_new()</code></a>.
 
1335
          <code class="function">xfce_titled_dialog_new()</code>.
1336
1336
</p>
1337
1337
<div class="variablelist"><table border="0" class="variablelist">
1338
1338
<colgroup>
1355
1355
<div class="refsect2">
1356
1356
<a name="XfcePanelPlugin-free-data"></a><h3>The <code class="literal">"free-data"</code> signal</h3>
1357
1357
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin,
1358
 
                                                        <span class="type">gpointer</span>         user_data)      : <code class="literal">Run Last</code></pre>
 
1358
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>         user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
1359
1359
<p>
1360
1360
This signal is emmitted when the plugin is closing. Plugin
1361
1361
writers should use this signal to free any allocated resources.
1385
1385
<a name="XfcePanelPlugin-mode-changed"></a><h3>The <code class="literal">"mode-changed"</code> signal</h3>
1386
1386
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a>    *plugin,
1387
1387
                                                        <span class="type">XfcePanelPluginMode</span> mode,
1388
 
                                                        <span class="type">gpointer</span>            user_data)      : <code class="literal">Run Last</code></pre>
 
1388
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>            user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
1389
1389
<p>
1390
1390
This signal is emmitted whenever the mode of the panel
1391
1391
the <em class="parameter"><code>plugin</code></em> is on changes.
1416
1416
<div class="refsect2">
1417
1417
<a name="XfcePanelPlugin-nrows-changed"></a><h3>The <code class="literal">"nrows-changed"</code> signal</h3>
1418
1418
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin,
1419
 
                                                        <span class="type">guint</span>            rows,
1420
 
                                                        <span class="type">gpointer</span>         user_data)      : <code class="literal">Run Last</code></pre>
 
1419
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>            rows,
 
1420
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>         user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
1421
1421
<p>
1422
1422
This signal is emmitted whenever the nrows of the panel
1423
1423
the <em class="parameter"><code>plugin</code></em> is on changes.
1448
1448
<div class="refsect2">
1449
1449
<a name="XfcePanelPlugin-orientation-changed"></a><h3>The <code class="literal">"orientation-changed"</code> signal</h3>
1450
1450
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin,
1451
 
                                                        <span class="type">GtkOrientation</span>   orientation,
1452
 
                                                        <span class="type">gpointer</span>         user_data)        : <code class="literal">Run Last</code></pre>
 
1451
                                                        <a href="http://developer.gnome.org/gtk2/gtk3-Standard-Enumerations.html#GtkOrientation"><span class="type">GtkOrientation</span></a>   orientation,
 
1452
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>         user_data)        : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
1453
1453
<p>
1454
1454
This signal is emmitted whenever the orientation of the panel
1455
1455
the <em class="parameter"><code>plugin</code></em> is on changes. Plugins writers can for example use
1470
1470
</tr>
1471
1471
<tr>
1472
1472
<td><p><span class="term"><em class="parameter"><code>orientation</code></em> :</span></p></td>
1473
 
<td>new <span class="type">GtkOrientation</span> of the panel.</td>
 
1473
<td>new <a href="http://developer.gnome.org/gtk2/gtk3-Standard-Enumerations.html#GtkOrientation"><span class="type">GtkOrientation</span></a> of the panel.</td>
1474
1474
</tr>
1475
1475
<tr>
1476
1476
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
1482
1482
<hr>
1483
1483
<div class="refsect2">
1484
1484
<a name="XfcePanelPlugin-remote-event"></a><h3>The <code class="literal">"remote-event"</code> signal</h3>
1485
 
<pre class="programlisting"><span class="returnvalue">gboolean</span>            user_function                      (<a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin,
1486
 
                                                        <span class="type">gchar</span>           *name,
1487
 
                                                        <span class="type">GValue</span>          *value,
1488
 
                                                        <span class="type">gpointer</span>         user_data)      : <code class="literal">Run Last</code></pre>
 
1485
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            user_function                      (<a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin,
 
1486
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>           *name,
 
1487
                                                        <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a>          *value,
 
1488
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>         user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
1489
1489
<p>
1490
1490
This signal is emmitted by the user by running
1491
1491
xfce4-panel --plugin-event=plugin-name:name:type:value. It can be
1516
1516
<tr>
1517
1517
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1518
1518
<td>
1519
 
<code class="literal">TRUE</code> to stop signal emission to other plugins, <code class="literal">FALSE</code>
 
1519
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to stop signal emission to other plugins, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>
1520
1520
to send the signal also to other plugins with the same
1521
1521
name.</td>
1522
1522
</tr>
1527
1527
<div class="refsect2">
1528
1528
<a name="XfcePanelPlugin-removed"></a><h3>The <code class="literal">"removed"</code> signal</h3>
1529
1529
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin,
1530
 
                                                        <span class="type">gpointer</span>         user_data)      : <code class="literal">Run Last</code></pre>
 
1530
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>         user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
1531
1531
<p>
1532
1532
This signal is emmitted when the plugin is permanently removed from
1533
1533
the panel configuration by the user. Developers can use this signal
1564
1564
<div class="refsect2">
1565
1565
<a name="XfcePanelPlugin-save"></a><h3>The <code class="literal">"save"</code> signal</h3>
1566
1566
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin,
1567
 
                                                        <span class="type">gpointer</span>         user_data)      : <code class="literal">Run Last</code></pre>
 
1567
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>         user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
1568
1568
<p>
1569
1569
This signal is emitted when the plugin should save it's
1570
1570
configuration. The signal is always emmitted before the plugin
1596
1596
<a name="XfcePanelPlugin-screen-position-changed"></a><h3>The <code class="literal">"screen-position-changed"</code> signal</h3>
1597
1597
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a>   *plugin,
1598
1598
                                                        <a class="link" href="libxfce4panel-Standard-Enumerations.html#XfceScreenPosition" title="enum XfceScreenPosition"><span class="type">XfceScreenPosition</span></a> position,
1599
 
                                                        <span class="type">gpointer</span>           user_data)      : <code class="literal">Run Last</code></pre>
 
1599
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>           user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
1600
1600
<p>
1601
1601
This signal is emmitted whenever the screen position of the panel
1602
1602
the <em class="parameter"><code>plugin</code></em> is on changes. Plugins writers can for example use
1626
1626
<hr>
1627
1627
<div class="refsect2">
1628
1628
<a name="XfcePanelPlugin-size-changed"></a><h3>The <code class="literal">"size-changed"</code> signal</h3>
1629
 
<pre class="programlisting"><span class="returnvalue">gboolean</span>            user_function                      (<a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin,
1630
 
                                                        <span class="type">gint</span>             size,
1631
 
                                                        <span class="type">gpointer</span>         user_data)      : <code class="literal">Run Last</code></pre>
 
1629
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            user_function                      (<a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a> *plugin,
 
1630
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>             size,
 
1631
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>         user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
1632
1632
<p>
1633
1633
This signal is emmitted whenever the size of the panel
1634
1634
the <em class="parameter"><code>plugin</code></em> is on changes. Plugins writers can for example use
1635
1635
this signal to update their icon size.
1636
1636
</p>
1637
1637
<p>
1638
 
If the function returns <code class="literal">FALSE</code> or is not used, the panel will force
 
1638
If the function returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> or is not used, the panel will force
1639
1639
a square size to the plugin. If you want non-square plugins and you
1640
1640
don't need this signal you can use something like this:
1641
1641
</p>