← Back to branch summary

~ubuntu-branches/ubuntu/natty/xfce4-panel/natty

« back to all changes in this revision

Viewing changes to docs/references/html/libxfce4panel-Convenience-Functions.html

  • Committer: Bazaar Package Importer
  • Author(s): Lionel Le Folgoc
  • Date: 2011-01-04 19:42:23 UTC
  • mfrom: (1.1.27 upstream)
  • Revision ID: james.westby@ubuntu.com-20110104194223-fuf883uda9kxvwn5
Tags: 4.7.7-0ubuntu1
* New upstream development release.
* debian/patches/abicheck.diff: dropped, included upstream.
* debian/xfce4-panel.shlibs: bumped to >= 4.7.7, because of some changes
  for external plugins.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/references/html/libxfce4panel-Convenience-Functions.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>Convenience Functions</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.76.0">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7
7
<link rel="home" href="index.html" title="Libxfce4panel Reference Manual">
8
8
<link rel="up" href="libxfce4panel-miscelleanous.html" title="Part IV. Miscelleanous">
9
9
<link rel="prev" href="libxfce4panel-miscelleanous.html" title="Part IV. Miscelleanous">
43
43
<span class="returnvalue">GtkWidget</span> *         <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>);
44
44
<span class="returnvalue">GtkWidget</span> *         <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>);
45
45
const <span class="returnvalue">gchar</span> *       <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>);
 
46
<a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.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 <span class="type">gchar</span> *source</code></em>,
 
47
                                                         <em class="parameter"><code><span class="type">GtkIconTheme</span> *icon_theme</code></em>,
 
48
                                                         <em class="parameter"><code><span class="type">gint</span> size</code></em>);
46
49
#define             <a class="link" href="libxfce4panel-Convenience-Functions.html#xfce-allow-panel-customization" title="xfce_allow_panel_customization">xfce_allow_panel_customization</a>
47
50
#define             <a class="link" href="libxfce4panel-Convenience-Functions.html#xfce-create-panel-button" title="xfce_create_panel_button">xfce_create_panel_button</a>
48
51
#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>
115
118
<p class="since">Since 4.8</p>
116
119
</div>
117
120
<hr>
 
121
<div class="refsect2" title="xfce_panel_pixbuf_from_source ()">
 
122
<a name="xfce-panel-pixbuf-from-source"></a><h3>xfce_panel_pixbuf_from_source ()</h3>
 
123
<pre class="programlisting"><a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"><span class="returnvalue">GdkPixbuf</span></a> *         xfce_panel_pixbuf_from_source       (<em class="parameter"><code>const <span class="type">gchar</span> *source</code></em>,
 
124
                                                         <em class="parameter"><code><span class="type">GtkIconTheme</span> *icon_theme</code></em>,
 
125
                                                         <em class="parameter"><code><span class="type">gint</span> size</code></em>);</pre>
 
126
<p>
 
127
Try to load a pixbug from a source string. The source could be
 
128
an abolute path, an icon name or a filename that point to a
 
129
file in the pixmaps directory.
 
130
</p>
 
131
<p>
 
132
This function is particularly usefull for loading names from
 
133
the Icon key of desktop files.
 
134
</p>
 
135
<p>
 
136
The pixbufs is never bigger then <em class="parameter"><code>size</code></em>. If it is when loaded from the
 
137
disk, the pixbuf is scales preserving the aspect ratio.
 
138
</p>
 
139
<div class="variablelist"><table border="0">
 
140
<col align="left" valign="top">
 
141
<tbody>
 
142
<tr>
 
143
<td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
 
144
<td>string that contains the location of an icon
 
145
</td>
 
146
</tr>
 
147
<tr>
 
148
<td><p><span class="term"><em class="parameter"><code>icon_theme</code></em> :</span></p></td>
 
149
<td>icon theme or <code class="literal">NULL</code> to use the default icon theme
 
150
</td>
 
151
</tr>
 
152
<tr>
 
153
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
 
154
<td>size the icon should be loaded
 
155
</td>
 
156
</tr>
 
157
<tr>
 
158
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
159
<td> a GdkPixbuf or <code class="literal">NULL</code> is nothing was found. The value should
 
160
         be released with g_object_unref is no long used.
 
161
 
 
162
See also: XfcePanelImage
 
163
 
 
164
</td>
 
165
</tr>
 
166
</tbody>
 
167
</table></div>
 
168
<p class="since">Since 4.8</p>
 
169
</div>
 
170
<hr>
118
171
<div class="refsect2" title="xfce_allow_panel_customization">
119
172
<a name="xfce-allow-panel-customization"></a><h3>xfce_allow_panel_customization</h3>
120
173
<pre class="programlisting">#define xfce_allow_panel_customization  (FALSE)