~ubuntu-branches/ubuntu/precise/xfce4-panel/precise

« back to all changes in this revision

Viewing changes to docs/API/html/libxfce4panel-Common-macros.html

  • Committer: Bazaar Package Importer
  • Author(s): Lionel Le Folgoc
  • Date: 2010-12-04 15:45:53 UTC
  • mto: (4.1.3 experimental)
  • mto: This revision was merged to the branch mainline in revision 50.
  • Revision ID: james.westby@ubuntu.com-20101204154553-f452gq02eiksf09f
Tags: upstream-4.7.5
Import upstream version 4.7.5

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
 
<html>
3
 
<head>
4
 
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
 
<title>Common macros</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7
 
<link rel="home" href="index.html" title="Libxfce4panel Reference Manual">
8
 
<link rel="up" href="libxfce4panel-fundamentals.html" title="Fundamentals">
9
 
<link rel="prev" href="libxfce4panel-fundamentals.html" title="Fundamentals">
10
 
<link rel="next" href="libxfce4panel-Standard-Enumerations.html" title="Standard Enumerations">
11
 
<meta name="generator" content="GTK-Doc V1.14 (XML mode)">
12
 
<link rel="stylesheet" href="style.css" type="text/css">
13
 
</head>
14
 
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15
 
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
16
 
<tr valign="middle">
17
 
<td><a accesskey="p" href="libxfce4panel-fundamentals.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18
 
<td><a accesskey="u" href="libxfce4panel-fundamentals.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19
 
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20
 
<th width="100%" align="center">Libxfce4panel Reference Manual</th>
21
 
<td><a accesskey="n" href="libxfce4panel-Standard-Enumerations.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
22
 
</tr>
23
 
<tr><td colspan="5" class="shortcuts">
24
 
<a href="#libxfce4panel-Common-macros.synopsis" class="shortcut">Top</a>
25
 
                   | 
26
 
                  <a href="#libxfce4panel-Common-macros.description" class="shortcut">Description</a>
27
 
</td></tr>
28
 
</table>
29
 
<div class="refentry" title="Common macros">
30
 
<a name="libxfce4panel-Common-macros"></a><div class="titlepage"></div>
31
 
<div class="refnamediv"><table width="100%"><tr>
32
 
<td valign="top">
33
 
<h2><span class="refentrytitle"><a name="libxfce4panel-Common-macros.top_of_page"></a>Common macros</span></h2>
34
 
<p>Common macros — Macros to work glib version independent.</p>
35
 
</td>
36
 
<td valign="top" align="right"></td>
37
 
</tr></table></div>
38
 
<div class="refsynopsisdiv" title="Synopsis">
39
 
<a name="libxfce4panel-Common-macros.synopsis"></a><h2>Synopsis</h2>
40
 
<pre class="synopsis">
41
 
#include &lt;libxfce4panel/libxfce4panel.h&gt;
42
 
 
43
 
#define             <a class="link" href="libxfce4panel-Common-macros.html#panel-slice-alloc" title="panel_slice_alloc()">panel_slice_alloc</a>                   (block_size)
44
 
#define             <a class="link" href="libxfce4panel-Common-macros.html#panel-slice-alloc0" title="panel_slice_alloc0()">panel_slice_alloc0</a>                  (block_size)
45
 
#define             <a class="link" href="libxfce4panel-Common-macros.html#panel-slice-free" title="panel_slice_free()">panel_slice_free</a>                    (type,
46
 
                                                         ptr)
47
 
#define             <a class="link" href="libxfce4panel-Common-macros.html#panel-slice-free1" title="panel_slice_free1()">panel_slice_free1</a>                   (block_size,
48
 
                                                         mem_block)
49
 
#define             <a class="link" href="libxfce4panel-Common-macros.html#panel-slice-new" title="panel_slice_new()">panel_slice_new</a>                     (type)
50
 
#define             <a class="link" href="libxfce4panel-Common-macros.html#panel-slice-new0" title="panel_slice_new0()">panel_slice_new0</a>                    (type)
51
 
#define             <a class="link" href="libxfce4panel-Common-macros.html#PANEL-PARAM-READABLE:CAPS" title="PANEL_PARAM_READABLE">PANEL_PARAM_READABLE</a>
52
 
#define             <a class="link" href="libxfce4panel-Common-macros.html#PANEL-PARAM-READWRITE:CAPS" title="PANEL_PARAM_READWRITE">PANEL_PARAM_READWRITE</a>
53
 
#define             <a class="link" href="libxfce4panel-Common-macros.html#PANEL-PARAM-WRITABLE:CAPS" title="PANEL_PARAM_WRITABLE">PANEL_PARAM_WRITABLE</a>
54
 
#define             <a class="link" href="libxfce4panel-Common-macros.html#I-:CAPS" title="I_()">I_</a>                                  (string)
55
 
</pre>
56
 
</div>
57
 
<div class="refsect1" title="Description">
58
 
<a name="libxfce4panel-Common-macros.description"></a><h2>Description</h2>
59
 
<p>
60
 
Macros for plugin writers to use new features in Glib 2.8 and 2.10 without
61
 
breaking old versions of Glib. It is recommended to use those macros
62
 
when possible.
63
 
</p>
64
 
</div>
65
 
<div class="refsect1" title="Details">
66
 
<a name="libxfce4panel-Common-macros.details"></a><h2>Details</h2>
67
 
<div class="refsect2" title="panel_slice_alloc()">
68
 
<a name="panel-slice-alloc"></a><h3>panel_slice_alloc()</h3>
69
 
<pre class="programlisting">#define             panel_slice_alloc(block_size)</pre>
70
 
<p>
71
 
Use <span class="type">g_slice_alloc</span> when available, fallback to <span class="type">g_malloc</span>.
72
 
</p>
73
 
<div class="variablelist"><table border="0">
74
 
<col align="left" valign="top">
75
 
<tbody><tr>
76
 
<td><p><span class="term"><em class="parameter"><code>block_size</code></em> :</span></p></td>
77
 
<td>the number of bytes to allocate
78
 
</td>
79
 
</tr></tbody>
80
 
</table></div>
81
 
</div>
82
 
<hr>
83
 
<div class="refsect2" title="panel_slice_alloc0()">
84
 
<a name="panel-slice-alloc0"></a><h3>panel_slice_alloc0()</h3>
85
 
<pre class="programlisting">#define             panel_slice_alloc0(block_size)</pre>
86
 
<p>
87
 
Use <span class="type">g_slice_alloc0</span> when available, fallback to <span class="type">g_malloc0</span>.
88
 
</p>
89
 
<div class="variablelist"><table border="0">
90
 
<col align="left" valign="top">
91
 
<tbody><tr>
92
 
<td><p><span class="term"><em class="parameter"><code>block_size</code></em> :</span></p></td>
93
 
<td>the number of bytes to allocate
94
 
</td>
95
 
</tr></tbody>
96
 
</table></div>
97
 
</div>
98
 
<hr>
99
 
<div class="refsect2" title="panel_slice_free()">
100
 
<a name="panel-slice-free"></a><h3>panel_slice_free()</h3>
101
 
<pre class="programlisting">#define             panel_slice_free(type, ptr)</pre>
102
 
<p>
103
 
Use <span class="type">g_slice_free</span> when available, fallback to <span class="type">g_free</span>.
104
 
</p>
105
 
<div class="variablelist"><table border="0">
106
 
<col align="left" valign="top">
107
 
<tbody>
108
 
<tr>
109
 
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
110
 
<td>the type to allocate, typically a structure name
111
 
</td>
112
 
</tr>
113
 
<tr>
114
 
<td><p><span class="term"><em class="parameter"><code>ptr</code></em> :</span></p></td>
115
 
<td>a pointer to the block to free
116
 
</td>
117
 
</tr>
118
 
</tbody>
119
 
</table></div>
120
 
</div>
121
 
<hr>
122
 
<div class="refsect2" title="panel_slice_free1()">
123
 
<a name="panel-slice-free1"></a><h3>panel_slice_free1()</h3>
124
 
<pre class="programlisting">#define             panel_slice_free1(block_size, mem_block)</pre>
125
 
<p>
126
 
Use <span class="type">g_slice_free1</span> when available, fallback to <span class="type">g_free</span>.
127
 
</p>
128
 
<div class="variablelist"><table border="0">
129
 
<col align="left" valign="top">
130
 
<tbody>
131
 
<tr>
132
 
<td><p><span class="term"><em class="parameter"><code>block_size</code></em> :</span></p></td>
133
 
<td>the number of bytes to allocate
134
 
</td>
135
 
</tr>
136
 
<tr>
137
 
<td><p><span class="term"><em class="parameter"><code>mem_block</code></em> :</span></p></td>
138
 
<td>a pointer to the block to free
139
 
</td>
140
 
</tr>
141
 
</tbody>
142
 
</table></div>
143
 
</div>
144
 
<hr>
145
 
<div class="refsect2" title="panel_slice_new()">
146
 
<a name="panel-slice-new"></a><h3>panel_slice_new()</h3>
147
 
<pre class="programlisting">#define             panel_slice_new(type)</pre>
148
 
<p>
149
 
Use <span class="type">g_slice_new</span> when available, fallback to <span class="type">g_new</span>.
150
 
</p>
151
 
<div class="variablelist"><table border="0">
152
 
<col align="left" valign="top">
153
 
<tbody><tr>
154
 
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
155
 
<td>    the type to allocate, typically a structure name
156
 
</td>
157
 
</tr></tbody>
158
 
</table></div>
159
 
</div>
160
 
<hr>
161
 
<div class="refsect2" title="panel_slice_new0()">
162
 
<a name="panel-slice-new0"></a><h3>panel_slice_new0()</h3>
163
 
<pre class="programlisting">#define             panel_slice_new0(type)</pre>
164
 
<p>
165
 
Use <span class="type">g_slice_new0</span> when available, fallback to <span class="type">g_new0</span>.
166
 
</p>
167
 
<div class="variablelist"><table border="0">
168
 
<col align="left" valign="top">
169
 
<tbody><tr>
170
 
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
171
 
<td>    the type to allocate, typically a structure name
172
 
</td>
173
 
</tr></tbody>
174
 
</table></div>
175
 
</div>
176
 
<hr>
177
 
<div class="refsect2" title="PANEL_PARAM_READABLE">
178
 
<a name="PANEL-PARAM-READABLE:CAPS"></a><h3>PANEL_PARAM_READABLE</h3>
179
 
<pre class="programlisting">#define             PANEL_PARAM_READABLE</pre>
180
 
<p>
181
 
Alias for <span class="type">G_PARAM_READABLE</span> | <span class="type">G_PARAM_STATIC_NAME</span> | <span class="type">G_PARAM_STATIC_NICK</span> | <span class="type">G_PARAM_STATIC_BLURB</span>
182
 
</p>
183
 
</div>
184
 
<hr>
185
 
<div class="refsect2" title="PANEL_PARAM_READWRITE">
186
 
<a name="PANEL-PARAM-READWRITE:CAPS"></a><h3>PANEL_PARAM_READWRITE</h3>
187
 
<pre class="programlisting">#define             PANEL_PARAM_READWRITE</pre>
188
 
<p>
189
 
Alias for <span class="type">G_PARAM_WRITABLE</span> | <span class="type">G_PARAM_STATIC_NAME</span> | <span class="type">G_PARAM_STATIC_NICK</span> | <span class="type">G_PARAM_STATIC_BLURB</span>
190
 
</p>
191
 
</div>
192
 
<hr>
193
 
<div class="refsect2" title="PANEL_PARAM_WRITABLE">
194
 
<a name="PANEL-PARAM-WRITABLE:CAPS"></a><h3>PANEL_PARAM_WRITABLE</h3>
195
 
<pre class="programlisting">#define             PANEL_PARAM_WRITABLE</pre>
196
 
<p>
197
 
Alias for <span class="type">G_PARAM_READWRITE</span> | <span class="type">G_PARAM_STATIC_NAME</span> | <span class="type">G_PARAM_STATIC_NICK</span> | <span class="type">G_PARAM_STATIC_BLURB</span>
198
 
</p>
199
 
</div>
200
 
<hr>
201
 
<div class="refsect2" title="I_()">
202
 
<a name="I-:CAPS"></a><h3>I_()</h3>
203
 
<pre class="programlisting">#define             I_(string)</pre>
204
 
<p>
205
 
Canonical representation for <em class="parameter"><code>string</code></em>. This can be use in functions like <span class="type">g_object_get_data</span>.
206
 
</p>
207
 
<div class="variablelist"><table border="0">
208
 
<col align="left" valign="top">
209
 
<tbody><tr>
210
 
<td><p><span class="term"><em class="parameter"><code>string</code></em> :</span></p></td>
211
 
<td>a string
212
 
</td>
213
 
</tr></tbody>
214
 
</table></div>
215
 
</div>
216
 
</div>
217
 
</div>
218
 
<div class="footer">
219
 
<hr>
220
 
          Generated by GTK-Doc V1.14</div>
221
 
</body>
222
 
</html>
 
 
b'\\ No newline at end of file'