← Back to branch summary

~ubuntu-branches/ubuntu/wily/xfce4-panel/wily

« back to all changes in this revision

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

  • Committer: Package Import Robot
  • Author(s): Jackson Doak
  • Date: 2014-02-16 14:34:33 UTC
  • mfrom: (1.1.37)
  • Revision ID: package-import@ubuntu.com-20140216143433-dmwlwlhc7dn0bxqz
Tags: 4.11.0-0ubuntu1
* New upstream release.
* Update lintian override

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/references/html/XfcePanelImage.html
49
49
#include <libxfce4panel/libxfce4panel.h>
50
50
 
51
51
                    <a class="link" href="XfcePanelImage.html#XfcePanelImage-struct" title="XfcePanelImage">XfcePanelImage</a>;
52
 
<span class="returnvalue">GtkWidget</span> *         <a class="link" href="XfcePanelImage.html#xfce-panel-image-new" title="xfce_panel_image_new ()">xfce_panel_image_new</a>                (<em class="parameter"><code><span class="type">void</span></code></em>);
53
 
<span class="returnvalue">GtkWidget</span> *         <a class="link" href="XfcePanelImage.html#xfce-panel-image-new-from-pixbuf" title="xfce_panel_image_new_from_pixbuf ()">xfce_panel_image_new_from_pixbuf</a>    (<em class="parameter"><code><span class="type">GdkPixbuf</span> *pixbuf</code></em>);
54
 
<span class="returnvalue">GtkWidget</span> *         <a class="link" href="XfcePanelImage.html#xfce-panel-image-new-from-source" title="xfce_panel_image_new_from_source ()">xfce_panel_image_new_from_source</a>    (<em class="parameter"><code>const <span class="type">gchar</span> *source</code></em>);
 
52
<a href="http://developer.gnome.org/gtk2/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *         <a class="link" href="XfcePanelImage.html#xfce-panel-image-new" title="xfce_panel_image_new ()">xfce_panel_image_new</a>                (<em class="parameter"><code><span class="type">void</span></code></em>);
 
53
<a href="http://developer.gnome.org/gtk2/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *         <a class="link" href="XfcePanelImage.html#xfce-panel-image-new-from-pixbuf" title="xfce_panel_image_new_from_pixbuf ()">xfce_panel_image_new_from_pixbuf</a>    (<em class="parameter"><code><a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *pixbuf</code></em>);
 
54
<a href="http://developer.gnome.org/gtk2/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *         <a class="link" href="XfcePanelImage.html#xfce-panel-image-new-from-source" title="xfce_panel_image_new_from_source ()">xfce_panel_image_new_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>);
55
55
<span class="returnvalue">void</span>                <a class="link" href="XfcePanelImage.html#xfce-panel-image-set-from-pixbuf" title="xfce_panel_image_set_from_pixbuf ()">xfce_panel_image_set_from_pixbuf</a>    (<em class="parameter"><code><a class="link" href="XfcePanelImage.html" title="XfcePanelImage"><span class="type">XfcePanelImage</span></a> *image</code></em>,
56
 
                                                         <em class="parameter"><code><span class="type">GdkPixbuf</span> *pixbuf</code></em>);
 
56
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *pixbuf</code></em>);
57
57
<span class="returnvalue">void</span>                <a class="link" href="XfcePanelImage.html#xfce-panel-image-set-from-source" title="xfce_panel_image_set_from_source ()">xfce_panel_image_set_from_source</a>    (<em class="parameter"><code><a class="link" href="XfcePanelImage.html" title="XfcePanelImage"><span class="type">XfcePanelImage</span></a> *image</code></em>,
58
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *source</code></em>);
 
58
                                                         <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>);
59
59
<span class="returnvalue">void</span>                <a class="link" href="XfcePanelImage.html#xfce-panel-image-set-size" title="xfce_panel_image_set_size ()">xfce_panel_image_set_size</a>           (<em class="parameter"><code><a class="link" href="XfcePanelImage.html" title="XfcePanelImage"><span class="type">XfcePanelImage</span></a> *image</code></em>,
60
 
                                                         <em class="parameter"><code><span class="type">gint</span> size</code></em>);
61
 
<span class="returnvalue">gint</span>                <a class="link" href="XfcePanelImage.html#xfce-panel-image-get-size" title="xfce_panel_image_get_size ()">xfce_panel_image_get_size</a>           (<em class="parameter"><code><a class="link" href="XfcePanelImage.html" title="XfcePanelImage"><span class="type">XfcePanelImage</span></a> *image</code></em>);
 
60
                                                         <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>);
 
61
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                <a class="link" href="XfcePanelImage.html#xfce-panel-image-get-size" title="xfce_panel_image_get_size ()">xfce_panel_image_get_size</a>           (<em class="parameter"><code><a class="link" href="XfcePanelImage.html" title="XfcePanelImage"><span class="type">XfcePanelImage</span></a> *image</code></em>);
62
62
<span class="returnvalue">void</span>                <a class="link" href="XfcePanelImage.html#xfce-panel-image-clear" title="xfce_panel_image_clear ()">xfce_panel_image_clear</a>              (<em class="parameter"><code><a class="link" href="XfcePanelImage.html" title="XfcePanelImage"><span class="type">XfcePanelImage</span></a> *image</code></em>);
63
63
</pre>
64
64
</div>
65
65
<div class="refsect1">
66
66
<a name="XfcePanelImage.object-hierarchy"></a><h2>Object Hierarchy</h2>
67
67
<pre class="synopsis">
68
 
  GObject
69
 
   +----GInitiallyUnowned
70
 
         +----GtkObject
71
 
               +----GtkWidget
 
68
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
69
   +----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
 
70
         +----<a href="../gtk2/GtkObject.html">GtkObject</a>
 
71
               +----<a href="http://developer.gnome.org/gtk2/GtkWidget.html">GtkWidget</a>
72
72
                     +----XfcePanelImage
73
73
</pre>
74
74
</div>
76
76
<a name="XfcePanelImage.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
77
77
<p>
78
78
XfcePanelImage implements
79
 
 AtkImplementorIface and  GtkBuildable.</p>
 
79
 AtkImplementorIface and  <a href="http://developer.gnome.org/gtk2/GtkBuildable.html">GtkBuildable</a>.</p>
80
80
</div>
81
81
<div class="refsect1">
82
82
<a name="XfcePanelImage.properties"></a><h2>Properties</h2>
83
83
<pre class="synopsis">
84
 
  "<a class="link" href="XfcePanelImage.html#XfcePanelImage--pixbuf" title='The "pixbuf" property'>pixbuf</a>"                   <span class="type">GdkPixbuf</span>*            : Read / Write
85
 
  "<a class="link" href="XfcePanelImage.html#XfcePanelImage--size" title='The "size" property'>size</a>"                     <span class="type">gint</span>                  : Read / Write
86
 
  "<a class="link" href="XfcePanelImage.html#XfcePanelImage--source" title='The "source" property'>source</a>"                   <span class="type">gchar</span>*                : Read / Write
 
84
  "<a class="link" href="XfcePanelImage.html#XfcePanelImage--pixbuf" title='The "pixbuf" property'>pixbuf</a>"                   <a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a>*            : Read / Write
 
85
  "<a class="link" href="XfcePanelImage.html#XfcePanelImage--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 / Write
 
86
  "<a class="link" href="XfcePanelImage.html#XfcePanelImage--source" title='The "source" property'>source</a>"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
87
87
</pre>
88
88
</div>
89
89
<div class="refsect1">
90
90
<a name="XfcePanelImage.style-properties"></a><h2>Style Properties</h2>
91
91
<pre class="synopsis">
92
 
  "<a class="link" href="XfcePanelImage.html#XfcePanelImage--s-force-gtk-icon-sizes" title='The "force-gtk-icon-sizes" style property'>force-gtk-icon-sizes</a>"     <span class="type">gboolean</span>              : Read / Write
 
92
  "<a class="link" href="XfcePanelImage.html#XfcePanelImage--s-force-gtk-icon-sizes" title='The "force-gtk-icon-sizes" style property'>force-gtk-icon-sizes</a>"     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
93
93
</pre>
94
94
</div>
95
95
<div class="refsect1">
122
122
<hr>
123
123
<div class="refsect2">
124
124
<a name="xfce-panel-image-new"></a><h3>xfce_panel_image_new ()</h3>
125
 
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> *         xfce_panel_image_new                (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 
125
<pre class="programlisting"><a href="http://developer.gnome.org/gtk2/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *         xfce_panel_image_new                (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
126
126
<p>
127
127
Creates a new empty <a class="link" href="XfcePanelImage.html" title="XfcePanelImage"><span class="type">XfcePanelImage</span></a> widget.
128
128
</p>
141
141
<hr>
142
142
<div class="refsect2">
143
143
<a name="xfce-panel-image-new-from-pixbuf"></a><h3>xfce_panel_image_new_from_pixbuf ()</h3>
144
 
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> *         xfce_panel_image_new_from_pixbuf    (<em class="parameter"><code><span class="type">GdkPixbuf</span> *pixbuf</code></em>);</pre>
 
144
<pre class="programlisting"><a href="http://developer.gnome.org/gtk2/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *         xfce_panel_image_new_from_pixbuf    (<em class="parameter"><code><a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *pixbuf</code></em>);</pre>
145
145
<p>
146
146
Creates a new <a class="link" href="XfcePanelImage.html" title="XfcePanelImage"><span class="type">XfcePanelImage</span></a> displaying <em class="parameter"><code>pixbuf</code></em>. <a class="link" href="XfcePanelImage.html" title="XfcePanelImage"><span class="type">XfcePanelImage</span></a>
147
147
will add its own reference rather than adopting yours. You don't
157
157
<tbody>
158
158
<tr>
159
159
<td><p><span class="term"><em class="parameter"><code>pixbuf</code></em> :</span></p></td>
160
 
<td>a <span class="type">GdkPixbuf</span>, or <code class="literal">NULL</code>.</td>
 
160
<td>a <a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</td>
161
161
</tr>
162
162
<tr>
163
163
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
170
170
<hr>
171
171
<div class="refsect2">
172
172
<a name="xfce-panel-image-new-from-source"></a><h3>xfce_panel_image_new_from_source ()</h3>
173
 
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> *         xfce_panel_image_new_from_source    (<em class="parameter"><code>const <span class="type">gchar</span> *source</code></em>);</pre>
 
173
<pre class="programlisting"><a href="http://developer.gnome.org/gtk2/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *         xfce_panel_image_new_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>);</pre>
174
174
<p>
175
175
Creates a new <a class="link" href="XfcePanelImage.html" title="XfcePanelImage"><span class="type">XfcePanelImage</span></a> displaying <em class="parameter"><code>source</code></em>. <a class="link" href="XfcePanelImage.html" title="XfcePanelImage"><span class="type">XfcePanelImage</span></a>
176
176
will detect if <em class="parameter"><code>source</code></em> points to an absolute file or it and icon-name.
187
187
<tr>
188
188
<td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
189
189
<td>source of the image. This can be an absolute path or
190
 
an icon-name or <code class="literal">NULL</code>.</td>
 
190
an icon-name or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</td>
191
191
</tr>
192
192
<tr>
193
193
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
201
201
<div class="refsect2">
202
202
<a name="xfce-panel-image-set-from-pixbuf"></a><h3>xfce_panel_image_set_from_pixbuf ()</h3>
203
203
<pre class="programlisting"><span class="returnvalue">void</span>                xfce_panel_image_set_from_pixbuf    (<em class="parameter"><code><a class="link" href="XfcePanelImage.html" title="XfcePanelImage"><span class="type">XfcePanelImage</span></a> *image</code></em>,
204
 
                                                         <em class="parameter"><code><span class="type">GdkPixbuf</span> *pixbuf</code></em>);</pre>
 
204
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *pixbuf</code></em>);</pre>
205
205
<p>
206
206
See <a class="link" href="XfcePanelImage.html#xfce-panel-image-new-from-pixbuf" title="xfce_panel_image_new_from_pixbuf ()"><code class="function">xfce_panel_image_new_from_pixbuf()</code></a> for details.
207
207
</p>
217
217
</tr>
218
218
<tr>
219
219
<td><p><span class="term"><em class="parameter"><code>pixbuf</code></em> :</span></p></td>
220
 
<td>a <span class="type">GdkPixbuf</span>, or <code class="literal">NULL</code>.</td>
 
220
<td>a <a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</td>
221
221
</tr>
222
222
</tbody>
223
223
</table></div>
227
227
<div class="refsect2">
228
228
<a name="xfce-panel-image-set-from-source"></a><h3>xfce_panel_image_set_from_source ()</h3>
229
229
<pre class="programlisting"><span class="returnvalue">void</span>                xfce_panel_image_set_from_source    (<em class="parameter"><code><a class="link" href="XfcePanelImage.html" title="XfcePanelImage"><span class="type">XfcePanelImage</span></a> *image</code></em>,
230
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *source</code></em>);</pre>
 
230
                                                         <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>);</pre>
231
231
<p>
232
232
See <a class="link" href="XfcePanelImage.html#xfce-panel-image-new-from-source" title="xfce_panel_image_new_from_source ()"><code class="function">xfce_panel_image_new_from_source()</code></a> for details.
233
233
</p>
244
244
<tr>
245
245
<td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
246
246
<td>source of the image. This can be an absolute path or
247
 
an icon-name or <code class="literal">NULL</code>.</td>
 
247
an icon-name or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</td>
248
248
</tr>
249
249
</tbody>
250
250
</table></div>
254
254
<div class="refsect2">
255
255
<a name="xfce-panel-image-set-size"></a><h3>xfce_panel_image_set_size ()</h3>
256
256
<pre class="programlisting"><span class="returnvalue">void</span>                xfce_panel_image_set_size           (<em class="parameter"><code><a class="link" href="XfcePanelImage.html" title="XfcePanelImage"><span class="type">XfcePanelImage</span></a> *image</code></em>,
257
 
                                                         <em class="parameter"><code><span class="type">gint</span> size</code></em>);</pre>
 
257
                                                         <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>
258
258
<p>
259
259
This will force an image size, instead of looking at the allocation
260
260
size, see introduction for more details. You can set a <em class="parameter"><code>size</code></em> of
281
281
<hr>
282
282
<div class="refsect2">
283
283
<a name="xfce-panel-image-get-size"></a><h3>xfce_panel_image_get_size ()</h3>
284
 
<pre class="programlisting"><span class="returnvalue">gint</span>                xfce_panel_image_get_size           (<em class="parameter"><code><a class="link" href="XfcePanelImage.html" title="XfcePanelImage"><span class="type">XfcePanelImage</span></a> *image</code></em>);</pre>
 
284
<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_image_get_size           (<em class="parameter"><code><a class="link" href="XfcePanelImage.html" title="XfcePanelImage"><span class="type">XfcePanelImage</span></a> *image</code></em>);</pre>
285
285
<p>
286
286
The size of the image, set by <a class="link" href="XfcePanelImage.html#xfce-panel-image-set-size" title="xfce_panel_image_set_size ()"><code class="function">xfce_panel_image_set_size()</code></a> or -1
287
287
if no size is forced and the image is scaled to the allocation size.
328
328
<a name="XfcePanelImage.property-details"></a><h2>Property Details</h2>
329
329
<div class="refsect2">
330
330
<a name="XfcePanelImage--pixbuf"></a><h3>The <code class="literal">"pixbuf"</code> property</h3>
331
 
<pre class="programlisting">  "pixbuf"                   <span class="type">GdkPixbuf</span>*            : Read / Write</pre>
 
331
<pre class="programlisting">  "pixbuf"                   <a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a>*            : Read / Write</pre>
332
332
<p>Pixbuf image.</p>
333
333
</div>
334
334
<hr>
335
335
<div class="refsect2">
336
336
<a name="XfcePanelImage--size"></a><h3>The <code class="literal">"size"</code> property</h3>
337
 
<pre class="programlisting">  "size"                     <span class="type">gint</span>                  : Read / Write</pre>
 
337
<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 / Write</pre>
338
338
<p>Pixel size of the image.</p>
339
339
<p>Allowed values: [-1,128]</p>
340
340
<p>Default value: -1</p>
342
342
<hr>
343
343
<div class="refsect2">
344
344
<a name="XfcePanelImage--source"></a><h3>The <code class="literal">"source"</code> property</h3>
345
 
<pre class="programlisting">  "source"                   <span class="type">gchar</span>*                : Read / Write</pre>
 
345
<pre class="programlisting">  "source"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
346
346
<p>Icon or filename.</p>
347
347
<p>Default value: NULL</p>
348
348
</div>
351
351
<a name="XfcePanelImage.style-property-details"></a><h2>Style Property Details</h2>
352
352
<div class="refsect2">
353
353
<a name="XfcePanelImage--s-force-gtk-icon-sizes"></a><h3>The <code class="literal">"force-gtk-icon-sizes"</code> style property</h3>
354
 
<pre class="programlisting">  "force-gtk-icon-sizes"     <span class="type">gboolean</span>              : Read / Write</pre>
 
354
<pre class="programlisting">  "force-gtk-icon-sizes"     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
355
355
<p>Force the image to fix to GtkIconSizes.</p>
356
356
<p>Default value: FALSE</p>
357
357
</div>