8
8
<link rel="up" href="libxfce4panel-plugins.html" title="Part II. Panel Plugins">
9
9
<link rel="prev" href="libxfce4panel-plugins.html" title="Part II. Panel Plugins">
10
10
<link rel="next" href="libxfce4panel-Panel-Plugin-Register-Macros.html" title="Panel Plugin Register Macros">
11
<meta name="generator" content="GTK-Doc V1.17 (XML mode)">
11
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
55
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
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
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>);
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
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
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
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
<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>);
63
<a href="http://library.gnome.org/devel/gtk3/gtk-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
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://library.gnome.org/devel/gtk3/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://library.gnome.org/devel/gtk3/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://library.gnome.org/devel/gtk3/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://library.gnome.org/devel/gtk3/GtkMenu.html"><span class="type">GtkMenu</span></a> *menu</code></em>);
81
<a href="http://library.gnome.org/devel/gtk3/gtk-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>,
83
<em class="parameter"><code><a href="http://library.gnome.org/devel/gtk3/GtkWidget.html"><span class="type">GtkWidget</span></a> *menu_widget</code></em>,
84
<em class="parameter"><code><a href="http://library.gnome.org/devel/gtk3/GtkWidget.html"><span class="type">GtkWidget</span></a> *attach_widget</code></em>,
85
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
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><span class="type">GtkMenu</span> *menu</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://library.gnome.org/devel/gtk3/GtkMenu.html"><span class="type">GtkMenu</span></a> *menu</code></em>,
88
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
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
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
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://library.gnome.org/devel/gtk3/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
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
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>);
106
106
<pre class="synopsis">
107
107
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
108
108
+----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
109
+----<a href="http://library.gnome.org/devel/gtk3/GtkObject.html">GtkObject</a>
110
+----<a href="http://library.gnome.org/devel/gtk3/GtkWidget.html">GtkWidget</a>
111
+----<a href="http://library.gnome.org/devel/gtk3/GtkContainer.html">GtkContainer</a>
112
+----<a href="http://library.gnome.org/devel/gtk3/GtkBin.html">GtkBin</a>
113
+----<a href="http://library.gnome.org/devel/gtk3/GtkEventBox.html">GtkEventBox</a>
114
114
+----XfcePanelPlugin
127
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
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
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
"<a class="link" href="XfcePanelPlugin.html#XfcePanelPlugin--mode" title='The "mode" property'>mode</a>" <span class="type">XfcePanelPluginMode</span> : Read
130
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
131
"<a class="link" href="XfcePanelPlugin.html#XfcePanelPlugin--orientation" title='The "orientation" property'>orientation</a>" <span class="type">GtkOrientation</span> : Read
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://library.gnome.org/devel/gtk3/gtk-Standard-Enumerations.html#GtkOrientation"><span class="type">GtkOrientation</span></a> : Read
132
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>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write
133
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
134
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
140
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>
141
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>
142
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>
143
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>
144
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>
145
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>
364
384
<div class="refsect2">
365
385
<a name="xfce-panel-plugin-get-arguments"></a><h3>xfce_panel_plugin_get_arguments ()</h3>
366
<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>
386
<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>
368
388
Argument vector passed to the plugin when it was added. Most of the
369
389
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
538
558
<div class="refsect2">
539
559
<a name="xfce-panel-plugin-take-window"></a><h3>xfce_panel_plugin_take_window ()</h3>
540
560
<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>,
541
<em class="parameter"><code><span class="type">GtkWindow</span> *window</code></em>);</pre>
561
<em class="parameter"><code><a href="http://library.gnome.org/devel/gtk3/GtkWindow.html"><span class="type">GtkWindow</span></a> *window</code></em>);</pre>
543
563
Connect a dialog to a plugin. When the <em class="parameter"><code>plugin</code></em> is closed, it will
544
564
destroy the <em class="parameter"><code>window</code></em>.
562
582
<div class="refsect2">
563
583
<a name="xfce-panel-plugin-add-action-widget"></a><h3>xfce_panel_plugin_add_action_widget ()</h3>
564
584
<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>,
565
<em class="parameter"><code><span class="type">GtkWidget</span> *widget</code></em>);</pre>
585
<em class="parameter"><code><a href="http://library.gnome.org/devel/gtk3/GtkWidget.html"><span class="type">GtkWidget</span></a> *widget</code></em>);</pre>
567
587
Attach the plugin menu to this widget. Plugin writers should call this
568
588
for every widget that can receive mouse events. If you forget to call this
587
607
<div class="refsect2">
588
608
<a name="xfce-panel-plugin-menu-insert-item"></a><h3>xfce_panel_plugin_menu_insert_item ()</h3>
589
609
<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>,
590
<em class="parameter"><code><span class="type">GtkMenuItem</span> *item</code></em>);</pre>
610
<em class="parameter"><code><a href="http://library.gnome.org/devel/gtk3/GtkMenuItem.html"><span class="type">GtkMenuItem</span></a> *item</code></em>);</pre>
592
612
Insert a custom menu item to the plugin's right click menu. This item
593
613
is packed below the "Move" menu item.
697
717
<div class="refsect2">
698
718
<a name="xfce-panel-plugin-register-menu"></a><h3>xfce_panel_plugin_register_menu ()</h3>
699
719
<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>,
700
<em class="parameter"><code><span class="type">GtkMenu</span> *menu</code></em>);</pre>
720
<em class="parameter"><code><a href="http://library.gnome.org/devel/gtk3/GtkMenu.html"><span class="type">GtkMenu</span></a> *menu</code></em>);</pre>
702
722
Register a menu that is about to popup. This will make sure the panel
703
723
will properly handle its autohide behaviour. You have to call this
707
727
If you want to open the menu aligned to the side of the panel (and the
708
728
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
709
<span class="type">GtkMenuPositionFunc</span>. This callback function will take care of calling
729
<a href="http://library.gnome.org/devel/gtk3/GtkMenu.html#GtkMenuPositionFunc"><span class="type">GtkMenuPositionFunc</span></a>. This callback function will take care of calling
710
730
<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.
730
750
<div class="refsect2">
731
751
<a name="xfce-panel-plugin-arrow-type"></a><h3>xfce_panel_plugin_arrow_type ()</h3>
732
<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>
752
<pre class="programlisting"><a href="http://library.gnome.org/devel/gtk3/gtk-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>
734
Determine the <span class="type">GtkArrowType</span> for a widget that opens a menu and uses
754
Determine the <a href="http://library.gnome.org/devel/gtk3/gtk-Standard-Enumerations.html#GtkArrowType"><span class="type">GtkArrowType</span></a> for a widget that opens a menu and uses
735
755
<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.
737
757
<div class="variablelist"><table border="0">
752
772
<div class="refsect2">
753
773
<a name="xfce-panel-plugin-position-widget"></a><h3>xfce_panel_plugin_position_widget ()</h3>
754
774
<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>,
755
<em class="parameter"><code><span class="type">GtkWidget</span> *menu_widget</code></em>,
756
<em class="parameter"><code><span class="type">GtkWidget</span> *attach_widget</code></em>,
775
<em class="parameter"><code><a href="http://library.gnome.org/devel/gtk3/GtkWidget.html"><span class="type">GtkWidget</span></a> *menu_widget</code></em>,
776
<em class="parameter"><code><a href="http://library.gnome.org/devel/gtk3/GtkWidget.html"><span class="type">GtkWidget</span></a> *attach_widget</code></em>,
757
777
<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>,
758
778
<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>
765
785
This function is intended for custom menu widgets.
766
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>
767
instead (as callback argument to <code class="function">gtk_menu_popup()</code>).
786
For a regular <a href="http://library.gnome.org/devel/gtk3/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>
787
instead (as callback argument to <a href="http://library.gnome.org/devel/gtk3/GtkMenu.html#gtk-menu-popup"><code class="function">gtk_menu_popup()</code></a>).
770
790
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>.
780
800
<td><p><span class="term"><em class="parameter"><code>menu_widget</code></em> :</span></p></td>
781
<td>a <span class="type">GtkWidget</span> that will be used as popup menu.</td>
801
<td>a <a href="http://library.gnome.org/devel/gtk3/GtkWidget.html"><span class="type">GtkWidget</span></a> that will be used as popup menu.</td>
784
804
<td><p><span class="term"><em class="parameter"><code>attach_widget</code></em> :</span></p></td>
785
<td>a <span class="type">GtkWidget</span> relative to which the menu should be positioned.</td>
805
<td>a <a href="http://library.gnome.org/devel/gtk3/GtkWidget.html"><span class="type">GtkWidget</span></a> relative to which the menu should be positioned.</td>
788
808
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
799
819
<div class="refsect2">
800
820
<a name="xfce-panel-plugin-position-menu"></a><h3>xfce_panel_plugin_position_menu ()</h3>
801
<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>,
821
<pre class="programlisting"><span class="returnvalue">void</span> xfce_panel_plugin_position_menu (<em class="parameter"><code><a href="http://library.gnome.org/devel/gtk3/GtkMenu.html"><span class="type">GtkMenu</span></a> *menu</code></em>,
802
822
<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>,
803
823
<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>,
804
824
<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>,
805
825
<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>
807
Function to be used as <span class="type">GtkMenuPositionFunc</span> in a call to <code class="function">gtk_menu_popup()</code>.
827
Function to be used as <a href="http://library.gnome.org/devel/gtk3/GtkMenu.html#GtkMenuPositionFunc"><span class="type">GtkMenuPositionFunc</span></a> in a call to <a href="http://library.gnome.org/devel/gtk3/GtkMenu.html#gtk-menu-popup"><code class="function">gtk_menu_popup()</code></a>.
808
828
As data argument it needs an <a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a>.
811
831
The menu is normally positioned relative to <em class="parameter"><code>panel_plugin</code></em>. If you want the
812
832
menu to be positioned relative to another widget, you can use
813
<code class="function">gtk_menu_attach_to_widget()</code> to explicitly set a 'parent' widget.
833
<a href="http://library.gnome.org/devel/gtk3/GtkMenu.html#gtk-menu-attach-to-widget"><code class="function">gtk_menu_attach_to_widget()</code></a> to explicitly set a 'parent' widget.
816
836
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
839
859
<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.
842
See also: <code class="function">gtk_menu_popup()</code>.
862
See also: <a href="http://library.gnome.org/devel/gtk3/GtkMenu.html#gtk-menu-popup"><code class="function">gtk_menu_popup()</code></a>.
844
864
<div class="variablelist"><table border="0">
845
865
<col align="left" valign="top">
848
868
<td><p><span class="term"><em class="parameter"><code>menu</code></em> :</span></p></td>
849
<td>a <span class="type">GtkMenu</span>.</td>
869
<td>a <a href="http://library.gnome.org/devel/gtk3/GtkMenu.html"><span class="type">GtkMenu</span></a>.</td>
852
872
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
871
891
<div class="refsect2">
872
892
<a name="xfce-panel-plugin-focus-widget"></a><h3>xfce_panel_plugin_focus_widget ()</h3>
873
893
<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>,
874
<em class="parameter"><code><span class="type">GtkWidget</span> *widget</code></em>);</pre>
894
<em class="parameter"><code><a href="http://library.gnome.org/devel/gtk3/GtkWidget.html"><span class="type">GtkWidget</span></a> *widget</code></em>);</pre>
876
896
Grab the focus on <em class="parameter"><code>widget</code></em>. Asks the panel to allow focus on its items
877
897
and set the focus to the requested widget.
1081
1101
<div class="refsect2">
1102
<a name="XfcePanelPlugin--mode"></a><h3>The <code class="literal">"mode"</code> property</h3>
1103
<pre class="programlisting"> "mode" <span class="type">XfcePanelPluginMode</span> : Read</pre>
1105
Display mode of the plugin.
1107
<p>Default value: XFCE_PANEL_PLUGIN_MODE_HORIZONTAL</p>
1108
<p class="since">Since 4.10</p>
1111
<div class="refsect2">
1082
1112
<a name="XfcePanelPlugin--name"></a><h3>The <code class="literal">"name"</code> property</h3>
1083
1113
<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>
1093
1123
<div class="refsect2">
1124
<a name="XfcePanelPlugin--nrows"></a><h3>The <code class="literal">"nrows"</code> property</h3>
1125
<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>
1127
Number of rows the plugin is embedded on.
1129
<p>Allowed values: [1,6]</p>
1130
<p>Default value: 1</p>
1131
<p class="since">Since 4.10</p>
1134
<div class="refsect2">
1094
1135
<a name="XfcePanelPlugin--orientation"></a><h3>The <code class="literal">"orientation"</code> property</h3>
1095
<pre class="programlisting"> "orientation" <span class="type">GtkOrientation</span> : Read</pre>
1136
<pre class="programlisting"> "orientation" <a href="http://library.gnome.org/devel/gtk3/gtk-Standard-Enumerations.html#GtkOrientation"><span class="type">GtkOrientation</span></a> : Read</pre>
1097
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
1138
The <a href="http://library.gnome.org/devel/gtk3/gtk-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
1098
1139
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.
1100
1141
<p>Default value: GTK_ORIENTATION_HORIZONTAL</p>
1114
1155
<div class="refsect2">
1156
<a name="XfcePanelPlugin--shrink"></a><h3>The <code class="literal">"shrink"</code> property</h3>
1157
<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>
1159
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.
1160
Plugin writes can use it to read or set this property, but <code class="function">xfce_panel_plugin_set_shrink()</code>
1163
<p>Default value: FALSE</p>
1164
<p class="since">Since 4.10</p>
1167
<div class="refsect2">
1115
1168
<a name="XfcePanelPlugin--size"></a><h3>The <code class="literal">"size"</code> property</h3>
1116
1169
<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>
1118
1171
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
1119
1172
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.
1121
<p>Allowed values: [0,128]</p>
1174
<p>Allowed values: [0,768]</p>
1122
1175
<p>Default value: 0</p>
1125
1178
<div class="refsect2">
1179
<a name="XfcePanelPlugin--small"></a><h3>The <code class="literal">"small"</code> property</h3>
1180
<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>
1182
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.
1183
Plugin writes can use it to read or set this property, but <code class="function">xfce_panel_plugin_set_small()</code>
1186
<p>Default value: FALSE</p>
1187
<p class="since">Since 4.10</p>
1190
<div class="refsect2">
1126
1191
<a name="XfcePanelPlugin--unique-id"></a><h3>The <code class="literal">"unique-id"</code> property</h3>
1127
1192
<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>
1128
1193
<p>Unique plugin ID.</p>
1217
1282
<div class="refsect2">
1283
<a name="XfcePanelPlugin-mode-changed"></a><h3>The <code class="literal">"mode-changed"</code> signal</h3>
1284
<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,
1285
<span class="type">XfcePanelPluginMode</span> mode,
1286
<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>
1288
This signal is emmitted whenever the mode of the panel
1289
the <em class="parameter"><code>plugin</code></em> is on changes.
1291
<div class="variablelist"><table border="0">
1292
<col align="left" valign="top">
1295
<td><p><span class="term"><em class="parameter"><code>plugin</code></em> :</span></p></td>
1296
<td>an <a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a>.</td>
1299
<td><p><span class="term"><em class="parameter"><code>mode</code></em> :</span></p></td>
1300
<td>new <span class="type">XfcePanelPluginMode</span> of the panel.</td>
1303
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
1304
<td>user data set when the signal handler was connected.</td>
1308
<p class="since">Since 4.10</p>
1311
<div class="refsect2">
1312
<a name="XfcePanelPlugin-nrows-changed"></a><h3>The <code class="literal">"nrows-changed"</code> signal</h3>
1313
<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,
1314
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> rows,
1315
<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>
1317
This signal is emmitted whenever the nrows of the panel
1318
the <em class="parameter"><code>plugin</code></em> is on changes.
1320
<div class="variablelist"><table border="0">
1321
<col align="left" valign="top">
1324
<td><p><span class="term"><em class="parameter"><code>plugin</code></em> :</span></p></td>
1325
<td>an <a class="link" href="XfcePanelPlugin.html" title="XfcePanelPlugin"><span class="type">XfcePanelPlugin</span></a>.</td>
1328
<td><p><span class="term"><em class="parameter"><code>rows</code></em> :</span></p></td>
1329
<td>new number of rows of the panel</td>
1332
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
1333
<td>user data set when the signal handler was connected.</td>
1337
<p class="since">Since 4.10</p>
1340
<div class="refsect2">
1218
1341
<a name="XfcePanelPlugin-orientation-changed"></a><h3>The <code class="literal">"orientation-changed"</code> signal</h3>
1219
1342
<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,
1220
<span class="type">GtkOrientation</span> orientation,
1343
<a href="http://library.gnome.org/devel/gtk3/gtk-Standard-Enumerations.html#GtkOrientation"><span class="type">GtkOrientation</span></a> orientation,
1221
1344
<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>
1223
1346
This signal is emmitted whenever the orientation of the panel