← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/xfce4-panel/oneiric

« 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-04-06 20:59:14 UTC
  • mfrom: (1.1.31 upstream)
  • Revision ID: james.westby@ubuntu.com-20110406205914-6gd3dxr2ri71vxb7
Tags: 4.8.3-0ubuntu1
https://launchpad.net/bugs/752791
* New upstream bugfix release. lp: #752791
* debian/patches:
  - 0001-Tasklist-add-button-release-event-to-proxy-item-bug-.patch:
    dropped, included upstream.
  - xubuntu_support-multiple-vendor-default-configs.patch: refreshed
    to apply cleanly.
  - series: refreshed.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/references/html/libxfce4panel-Convenience-Functions.html
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">
10
10
<link rel="next" href="api-index-full.html" title="Index of all symbols">
11
 
<meta name="generator" content="GTK-Doc V1.15 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.17 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
26
26
                  <a href="#libxfce4panel-Convenience-Functions.description" class="shortcut">Description</a>
27
27
</td></tr>
28
28
</table>
29
 
<div class="refentry" title="Convenience Functions">
 
29
<div class="refentry">
30
30
<a name="libxfce4panel-Convenience-Functions"></a><div class="titlepage"></div>
31
31
<div class="refnamediv"><table width="100%"><tr>
32
32
<td valign="top">
35
35
</td>
36
36
<td valign="top" align="right"></td>
37
37
</tr></table></div>
38
 
<div class="refsynopsisdiv" title="Synopsis">
 
38
<div class="refsynopsisdiv">
39
39
<a name="libxfce4panel-Convenience-Functions.synopsis"></a><h2>Synopsis</h2>
40
40
<pre class="synopsis">
41
41
#include &lt;libxfce4panel/libxfce4panel.h&gt;
51
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>
52
52
</pre>
53
53
</div>
54
 
<div class="refsect1" title="Description">
 
54
<div class="refsect1">
55
55
<a name="libxfce4panel-Convenience-Functions.description"></a><h2>Description</h2>
56
56
<p>
57
57
This section describes a number of functions that were created
58
58
to help developers of Xfce Panel plugins.
59
59
</p>
60
60
</div>
61
 
<div class="refsect1" title="Details">
 
61
<div class="refsect1">
62
62
<a name="libxfce4panel-Convenience-Functions.details"></a><h2>Details</h2>
63
 
<div class="refsect2" title="xfce_panel_create_button ()">
 
63
<div class="refsect2">
64
64
<a name="xfce-panel-create-button"></a><h3>xfce_panel_create_button ()</h3>
65
65
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> *         xfce_panel_create_button            (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
66
66
<p>
71
71
<col align="left" valign="top">
72
72
<tbody><tr>
73
73
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
74
 
<td> newly created <span class="type">GtkButton</span>.
75
 
</td>
 
74
<td>newly created <span class="type">GtkButton</span>.</td>
76
75
</tr></tbody>
77
76
</table></div>
78
77
</div>
79
78
<hr>
80
 
<div class="refsect2" title="xfce_panel_create_toggle_button ()">
 
79
<div class="refsect2">
81
80
<a name="xfce-panel-create-toggle-button"></a><h3>xfce_panel_create_toggle_button ()</h3>
82
81
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> *         xfce_panel_create_toggle_button     (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
83
82
<p>
88
87
<col align="left" valign="top">
89
88
<tbody><tr>
90
89
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
91
 
<td> newly created <span class="type">GtkToggleButton</span>.
92
 
</td>
 
90
<td>newly created <span class="type">GtkToggleButton</span>.</td>
93
91
</tr></tbody>
94
92
</table></div>
95
93
</div>
96
94
<hr>
97
 
<div class="refsect2" title="xfce_panel_get_channel_name ()">
 
95
<div class="refsect2">
98
96
<a name="xfce-panel-get-channel-name"></a><h3>xfce_panel_get_channel_name ()</h3>
99
97
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       xfce_panel_get_channel_name         (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
100
98
<p>
106
104
<col align="left" valign="top">
107
105
<tbody><tr>
108
106
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
109
 
<td> name of the Xfconf channel
110
 
 
 
107
<td>name of the Xfconf channel
111
108
See also: XFCE_PANEL_CHANNEL_NAME,
112
 
          xfce_panel_plugin_xfconf_channel_new and
113
 
          xfce_panel_plugin_get_property_base
114
 
 
115
 
</td>
 
109
xfce_panel_plugin_xfconf_channel_new and
 
110
xfce_panel_plugin_get_property_base</td>
116
111
</tr></tbody>
117
112
</table></div>
118
113
<p class="since">Since 4.8</p>
119
114
</div>
120
115
<hr>
121
 
<div class="refsect2" title="xfce_panel_pixbuf_from_source ()">
 
116
<div class="refsect2">
122
117
<a name="xfce-panel-pixbuf-from-source"></a><h3>xfce_panel_pixbuf_from_source ()</h3>
123
118
<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
119
                                                         <em class="parameter"><code><span class="type">GtkIconTheme</span> *icon_theme</code></em>,
141
136
<tbody>
142
137
<tr>
143
138
<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>
 
139
<td>string that contains the location of an icon</td>
146
140
</tr>
147
141
<tr>
148
142
<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>
 
143
<td>icon theme or <code class="literal">NULL</code> to use the default icon theme</td>
151
144
</tr>
152
145
<tr>
153
146
<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>
 
147
<td>size the icon should be loaded</td>
156
148
</tr>
157
149
<tr>
158
150
<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>
 
151
<td>a GdkPixbuf or <code class="literal">NULL</code> is nothing was found. The value should
 
152
be released with g_object_unref is no long used.
 
153
See also: XfcePanelImage</td>
165
154
</tr>
166
155
</tbody>
167
156
</table></div>
168
157
<p class="since">Since 4.8</p>
169
158
</div>
170
159
<hr>
171
 
<div class="refsect2" title="xfce_allow_panel_customization">
 
160
<div class="refsect2">
172
161
<a name="xfce-allow-panel-customization"></a><h3>xfce_allow_panel_customization</h3>
173
162
<pre class="programlisting">#define xfce_allow_panel_customization  (FALSE)
174
163
</pre>
175
 
<div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
164
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
176
165
<h3 class="title">Warning</h3>
177
166
<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>
178
167
</div>
182
171
</p>
183
172
</div>
184
173
<hr>
185
 
<div class="refsect2" title="xfce_create_panel_button">
 
174
<div class="refsect2">
186
175
<a name="xfce-create-panel-button"></a><h3>xfce_create_panel_button</h3>
187
176
<pre class="programlisting">#define xfce_create_panel_button xfce_panel_create_button
188
177
</pre>
189
 
<div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
178
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
190
179
<h3 class="title">Warning</h3>
191
180
<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>
192
181
</div>
195
184
</p>
196
185
</div>
197
186
<hr>
198
 
<div class="refsect2" title="xfce_create_panel_toggle_button">
 
187
<div class="refsect2">
199
188
<a name="xfce-create-panel-toggle-button"></a><h3>xfce_create_panel_toggle_button</h3>
200
189
<pre class="programlisting">#define xfce_create_panel_toggle_button xfce_panel_create_toggle_button
201
190
</pre>
202
 
<div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
191
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
203
192
<h3 class="title">Warning</h3>
204
193
<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>
205
194
</div>
211
200
</div>
212
201
<div class="footer">
213
202
<hr>
214
 
          Generated by GTK-Doc V1.15</div>
 
203
          Generated by GTK-Doc V1.17</div>
215
204
</body>
216
205
</html>
 
 
b'\\ No newline at end of file'