~ubuntu-branches/ubuntu/vivid/xfce4-panel/vivid

« back to all changes in this revision

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

  • Committer: Package Import Robot
  • Author(s): Lionel Le Folgoc
  • Date: 2013-07-07 10:54:09 UTC
  • mfrom: (4.2.15 sid)
  • Revision ID: package-import@ubuntu.com-20130707105409-nam2sh68h1reuiv4
Tags: 4.10.1-1ubuntu1
* Merge from Debian unstable, remaining Ubuntu changes:
  - debian/patches:
    + xubuntu_migrate-tasklist-separator.patch: added, try to be smart and
      work around the non-expandable tasklist plugin from 4.10 by setting
      as expandable the separator next to it (should work with the default
      panel layouts from Xubuntu, Mythbuntu and UbuntuStudio).
    + xubuntu_add-calendar-popup-to-clock-plugin.patch: added, taken from
      upstream git to show a calendar when left-clicking on the clock plugin
      (so we don't need orage/xfce4-datetime-plugin for this feature only).

Show diffs side-by-side

added added

removed removed

Lines of Context:
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>XfcePanelImage</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7
7
<link rel="home" href="index.html" title="Libxfce4panel Reference Manual">
8
8
<link rel="up" href="libxfce4panel-widgets.html" title="Part III. Additional Widgets">
9
9
<link rel="prev" href="XfceHVBox.html" title="XfceHVBox">
49
49
#include &lt;libxfce4panel/libxfce4panel.h&gt;
50
50
 
51
51
                    <a class="link" href="XfcePanelImage.html#XfcePanelImage-struct" title="XfcePanelImage">XfcePanelImage</a>;
52
 
<a href="http://library.gnome.org/devel/gtk3/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://library.gnome.org/devel/gtk3/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://library.gnome.org/devel/gtk3/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>);
 
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
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>,
68
68
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
69
69
   +----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
70
70
         +----<a href="http://library.gnome.org/devel/gtk3/GtkObject.html">GtkObject</a>
71
 
               +----<a href="http://library.gnome.org/devel/gtk3/GtkWidget.html">GtkWidget</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  <a href="http://library.gnome.org/devel/gtk3/GtkBuildable.html">GtkBuildable</a>.</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>
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"><a href="http://library.gnome.org/devel/gtk3/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *         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>
129
 
<div class="variablelist"><table border="0">
 
129
<div class="variablelist"><table border="0" class="variablelist">
 
130
<colgroup>
130
131
<col align="left" valign="top">
 
132
<col>
 
133
</colgroup>
131
134
<tbody><tr>
132
135
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
133
136
<td>a newly created XfcePanelImage widget.</td>
138
141
<hr>
139
142
<div class="refsect2">
140
143
<a name="xfce-panel-image-new-from-pixbuf"></a><h3>xfce_panel_image_new_from_pixbuf ()</h3>
141
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/gtk3/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>
 
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>
142
145
<p>
143
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>
144
147
will add its own reference rather than adopting yours. You don't
146
149
will take care of that based on the allocation of the widget or
147
150
the size set with <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>.
148
151
</p>
149
 
<div class="variablelist"><table border="0">
 
152
<div class="variablelist"><table border="0" class="variablelist">
 
153
<colgroup>
150
154
<col align="left" valign="top">
 
155
<col>
 
156
</colgroup>
151
157
<tbody>
152
158
<tr>
153
159
<td><p><span class="term"><em class="parameter"><code>pixbuf</code></em> :</span></p></td>
164
170
<hr>
165
171
<div class="refsect2">
166
172
<a name="xfce-panel-image-new-from-source"></a><h3>xfce_panel_image_new_from_source ()</h3>
167
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/gtk3/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>
 
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>
168
174
<p>
169
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>
170
176
will detect if <em class="parameter"><code>source</code></em> points to an absolute file or it and icon-name.
172
178
strip the extensions, which makes it suitable for usage with icon
173
179
keys in .desktop files.
174
180
</p>
175
 
<div class="variablelist"><table border="0">
 
181
<div class="variablelist"><table border="0" class="variablelist">
 
182
<colgroup>
176
183
<col align="left" valign="top">
 
184
<col>
 
185
</colgroup>
177
186
<tbody>
178
187
<tr>
179
188
<td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
196
205
<p>
197
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.
198
207
</p>
199
 
<div class="variablelist"><table border="0">
 
208
<div class="variablelist"><table border="0" class="variablelist">
 
209
<colgroup>
200
210
<col align="left" valign="top">
 
211
<col>
 
212
</colgroup>
201
213
<tbody>
202
214
<tr>
203
215
<td><p><span class="term"><em class="parameter"><code>image</code></em> :</span></p></td>
219
231
<p>
220
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.
221
233
</p>
222
 
<div class="variablelist"><table border="0">
 
234
<div class="variablelist"><table border="0" class="variablelist">
 
235
<colgroup>
223
236
<col align="left" valign="top">
 
237
<col>
 
238
</colgroup>
224
239
<tbody>
225
240
<tr>
226
241
<td><p><span class="term"><em class="parameter"><code>image</code></em> :</span></p></td>
245
260
size, see introduction for more details. You can set a <em class="parameter"><code>size</code></em> of
246
261
-1 to turn this off.
247
262
</p>
248
 
<div class="variablelist"><table border="0">
 
263
<div class="variablelist"><table border="0" class="variablelist">
 
264
<colgroup>
249
265
<col align="left" valign="top">
 
266
<col>
 
267
</colgroup>
250
268
<tbody>
251
269
<tr>
252
270
<td><p><span class="term"><em class="parameter"><code>image</code></em> :</span></p></td>
268
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
269
287
if no size is forced and the image is scaled to the allocation size.
270
288
</p>
271
 
<div class="variablelist"><table border="0">
 
289
<div class="variablelist"><table border="0" class="variablelist">
 
290
<colgroup>
272
291
<col align="left" valign="top">
 
292
<col>
 
293
</colgroup>
273
294
<tbody>
274
295
<tr>
275
296
<td><p><span class="term"><em class="parameter"><code>image</code></em> :</span></p></td>
290
311
<p>
291
312
Resets the image to be empty.
292
313
</p>
293
 
<div class="variablelist"><table border="0">
 
314
<div class="variablelist"><table border="0" class="variablelist">
 
315
<colgroup>
294
316
<col align="left" valign="top">
 
317
<col>
 
318
</colgroup>
295
319
<tbody><tr>
296
320
<td><p><span class="term"><em class="parameter"><code>image</code></em> :</span></p></td>
297
321
<td>an <a class="link" href="XfcePanelImage.html" title="XfcePanelImage"><span class="type">XfcePanelImage</span></a>.</td>