/usr/share/gtk-doc/html/libxfce4panel-1.0/libxfce4panel-Convenience-Functions.html is in xfce4-panel-dev 4.10.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Convenience Functions</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Libxfce4panel Reference Manual">
<link rel="up" href="libxfce4panel-miscelleanous.html" title="Part IV. Miscelleanous">
<link rel="prev" href="libxfce4panel-miscelleanous.html" title="Part IV. Miscelleanous">
<link rel="next" href="api-index-full.html" title="Index of all symbols">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libxfce4panel-miscelleanous.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libxfce4panel-miscelleanous.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Libxfce4panel Reference Manual</th>
<td><a accesskey="n" href="api-index-full.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libxfce4panel-Convenience-Functions.synopsis" class="shortcut">Top</a>
|
<a href="#libxfce4panel-Convenience-Functions.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libxfce4panel-Convenience-Functions"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libxfce4panel-Convenience-Functions.top_of_page"></a>Convenience Functions</span></h2>
<p>Convenience Functions — Special purpose widgets and utilities</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libxfce4panel-Convenience-Functions.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <libxfce4panel/libxfce4panel.h>
<a href="http://developer.gnome.org/gtk2/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * <a class="link" href="libxfce4panel-Convenience-Functions.html#xfce-panel-create-button" title="xfce_panel_create_button ()">xfce_panel_create_button</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a href="http://developer.gnome.org/gtk2/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * <a class="link" href="libxfce4panel-Convenience-Functions.html#xfce-panel-create-toggle-button" title="xfce_panel_create_toggle_button ()">xfce_panel_create_toggle_button</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
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="libxfce4panel-Convenience-Functions.html#xfce-panel-get-channel-name" title="xfce_panel_get_channel_name ()">xfce_panel_get_channel_name</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="returnvalue">GdkPixbuf</span></a> * <a class="link" href="libxfce4panel-Convenience-Functions.html#xfce-panel-pixbuf-from-source" title="xfce_panel_pixbuf_from_source ()">xfce_panel_pixbuf_from_source</a> (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *source</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/gtk2/GtkIconTheme.html"><span class="type">GtkIconTheme</span></a> *icon_theme</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> size</code></em>);
<a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="returnvalue">GdkPixbuf</span></a> * <a class="link" href="libxfce4panel-Convenience-Functions.html#xfce-panel-pixbuf-from-source-at-size" title="xfce_panel_pixbuf_from_source_at_size ()">xfce_panel_pixbuf_from_source_at_size</a>
(<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *source</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/gtk2/GtkIconTheme.html"><span class="type">GtkIconTheme</span></a> *icon_theme</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> dest_width</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> dest_height</code></em>);
#define <a class="link" href="libxfce4panel-Convenience-Functions.html#xfce-allow-panel-customization" title="xfce_allow_panel_customization">xfce_allow_panel_customization</a>
#define <a class="link" href="libxfce4panel-Convenience-Functions.html#xfce-create-panel-button" title="xfce_create_panel_button">xfce_create_panel_button</a>
#define <a class="link" href="libxfce4panel-Convenience-Functions.html#xfce-create-panel-toggle-button" title="xfce_create_panel_toggle_button">xfce_create_panel_toggle_button</a>
</pre>
</div>
<div class="refsect1">
<a name="libxfce4panel-Convenience-Functions.description"></a><h2>Description</h2>
<p>
This section describes a number of functions that were created
to help developers of Xfce Panel plugins.
</p>
</div>
<div class="refsect1">
<a name="libxfce4panel-Convenience-Functions.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="xfce-panel-create-button"></a><h3>xfce_panel_create_button ()</h3>
<pre class="programlisting"><a href="http://developer.gnome.org/gtk2/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * xfce_panel_create_button (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Create regular <a href="http://developer.gnome.org/gtk2/GtkButton.html"><span class="type">GtkButton</span></a> with a few properties set to be useful in the
Xfce panel: Flat (<a href="http://developer.gnome.org/gtk2/gtk3-Standard-Enumerations.html#GTK-RELIEF-NONE:CAPS"><code class="literal">GTK_RELIEF_NONE</code></a>), no focus on click and minimal padding.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>newly created <a href="http://developer.gnome.org/gtk2/GtkButton.html"><span class="type">GtkButton</span></a>.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="xfce-panel-create-toggle-button"></a><h3>xfce_panel_create_toggle_button ()</h3>
<pre class="programlisting"><a href="http://developer.gnome.org/gtk2/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * xfce_panel_create_toggle_button (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Create regular <a href="http://developer.gnome.org/gtk2/GtkToggleButton.html"><span class="type">GtkToggleButton</span></a> with a few properties set to be useful in
Xfce panel: Flat (<a href="http://developer.gnome.org/gtk2/gtk3-Standard-Enumerations.html#GTK-RELIEF-NONE:CAPS"><code class="literal">GTK_RELIEF_NONE</code></a>), no focus on click and minimal padding.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>newly created <a href="http://developer.gnome.org/gtk2/GtkToggleButton.html"><span class="type">GtkToggleButton</span></a>.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="xfce-panel-get-channel-name"></a><h3>xfce_panel_get_channel_name ()</h3>
<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_get_channel_name (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Function for the name of the Xfconf channel used by the panel. By default
this returns "xfce4-panel", but you can override this value with the
environment variable XFCE_PANEL_CHANNEL_NAME.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>name of the Xfconf channel
See also: XFCE_PANEL_CHANNEL_NAME,
xfce_panel_plugin_xfconf_channel_new and
xfce_panel_plugin_get_property_base</td>
</tr></tbody>
</table></div>
<p class="since">Since 4.8</p>
</div>
<hr>
<div class="refsect2">
<a name="xfce-panel-pixbuf-from-source"></a><h3>xfce_panel_pixbuf_from_source ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="returnvalue">GdkPixbuf</span></a> * xfce_panel_pixbuf_from_source (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *source</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/gtk2/GtkIconTheme.html"><span class="type">GtkIconTheme</span></a> *icon_theme</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> size</code></em>);</pre>
<p>
See xfce_panel_pixbuf_from_source_at_size
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
<td>string that contains the location of an icon</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>icon_theme</code></em> :</span></p></td>
<td>icon theme or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to use the default icon theme</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
<td>size the icon that should be loaded</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a GdkPixbuf or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if nothing was found. The value should
be released with g_object_unref when no longer used.
See also: XfcePanelImage</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 4.8</p>
</div>
<hr>
<div class="refsect2">
<a name="xfce-panel-pixbuf-from-source-at-size"></a><h3>xfce_panel_pixbuf_from_source_at_size ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="returnvalue">GdkPixbuf</span></a> * xfce_panel_pixbuf_from_source_at_size
(<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *source</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/gtk2/GtkIconTheme.html"><span class="type">GtkIconTheme</span></a> *icon_theme</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> dest_width</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> dest_height</code></em>);</pre>
<p>
Try to load a pixbuf from a source string. The source could be
an abolute path, an icon name or a filename that points to a
file in the pixmaps directory.
</p>
<p>
This function is particularly usefull for loading names from
the Icon key of desktop files.
</p>
<p>
The pixbuf is never bigger than <em class="parameter"><code>dest_width</code></em> and <em class="parameter"><code>dest_height</code></em>.
If it is when loaded from the disk, the pixbuf is scaled
preserving the aspect ratio.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
<td>string that contains the location of an icon</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>icon_theme</code></em> :</span></p></td>
<td>icon theme or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to use the default icon theme</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dest_width</code></em> :</span></p></td>
<td>the maximum returned width of the GdkPixbuf</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dest_height</code></em> :</span></p></td>
<td>the maximum returned height of the GdkPixbuf</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a GdkPixbuf or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if nothing was found. The value should
be released with g_object_unref when no longer used.
See also: XfcePanelImage</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 4.10</p>
</div>
<hr>
<div class="refsect2">
<a name="xfce-allow-panel-customization"></a><h3>xfce_allow_panel_customization</h3>
<pre class="programlisting">#define xfce_allow_panel_customization (FALSE)
</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">xfce_allow_panel_customization</code> has been deprecated since version 4.8 and should not be used in newly-written code. Look at <a class="link" href="XfcePanelPlugin.html#xfce-panel-plugin-get-locked" title="xfce_panel_plugin_get_locked ()"><code class="function">xfce_panel_plugin_get_locked()</code></a>.</p>
</div>
<p>
Always returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>. Plugins can be locked on a plugin basis
level in the future, so this function is useless.
</p>
</div>
<hr>
<div class="refsect2">
<a name="xfce-create-panel-button"></a><h3>xfce_create_panel_button</h3>
<pre class="programlisting">#define xfce_create_panel_button xfce_panel_create_button
</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">xfce_create_panel_button</code> has been deprecated since version 4.8 and should not be used in newly-written code. Use <a class="link" href="libxfce4panel-Convenience-Functions.html#xfce-panel-create-button" title="xfce_panel_create_button ()"><code class="function">xfce_panel_create_button()</code></a> instead.</p>
</div>
<p>
See <a class="link" href="libxfce4panel-Convenience-Functions.html#xfce-panel-create-button" title="xfce_panel_create_button ()"><code class="function">xfce_panel_create_button()</code></a> for more information.
</p>
</div>
<hr>
<div class="refsect2">
<a name="xfce-create-panel-toggle-button"></a><h3>xfce_create_panel_toggle_button</h3>
<pre class="programlisting">#define xfce_create_panel_toggle_button xfce_panel_create_toggle_button
</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">xfce_create_panel_toggle_button</code> has been deprecated since version 4.8 and should not be used in newly-written code. Use <a class="link" href="libxfce4panel-Convenience-Functions.html#xfce-panel-create-toggle-button" title="xfce_panel_create_toggle_button ()"><code class="function">xfce_panel_create_toggle_button()</code></a> instead.</p>
</div>
<p>
See <a class="link" href="libxfce4panel-Convenience-Functions.html#xfce-panel-create-toggle-button" title="xfce_panel_create_toggle_button ()"><code class="function">xfce_panel_create_toggle_button()</code></a> for more information.
</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|