Debian Codegraph @

docs/reference/html/libxfce4ui-libxfce4ui-config.html

raw
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>libxfce4ui config: libxfce4ui Reference Manual</title>
6 <meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
7 <link rel="home" href="index.html" title="libxfce4ui Reference Manual">
8 <link rel="up" href="ch01.html" title="[Insert title here]">
9 <link rel="prev" href="ch01.html" title="[Insert title here]">
10 <link rel="next" href="libxfce4ui-Spawn.html" title="Spawn">
11 <meta name="generator" content="GTK-Doc V1.34.0 (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="5"><tr valign="middle">
16 <td width="100%" align="left" class="shortcuts">
17 <a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
18 <a href="#libxfce4ui-libxfce4ui-config.description" class="shortcut">Description</a></span>
19 </td>
20 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
21 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
22 <td><a accesskey="p" href="ch01.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
23 <td><a accesskey="n" href="libxfce4ui-Spawn.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
24 </tr></table>
25 <div class="refentry">
26 <a name="libxfce4ui-libxfce4ui-config"></a><div class="titlepage"></div>
27 <div class="refnamediv"><table width="100%"><tr>
28 <td valign="top">
29 <h2><span class="refentrytitle"><a name="libxfce4ui-libxfce4ui-config.top_of_page"></a>libxfce4ui config</span></h2>
30 <p>libxfce4ui config — libxfce4ui config macros</p>
31 </td>
32 <td class="gallery_image" valign="top" align="right"></td>
33 </tr></table></div>
34 <div class="refsect1">
35 <a name="libxfce4ui-libxfce4ui-config.stability-level"></a><h2>Stability Level</h2>
36 <acronym title="The intention of a Stable interface is to enable arbitrary third parties to
37 develop applications to these interfaces, release them, and have confidence that
38 they will run on all minor releases of the product (after the one in which the
39 interface was introduced, and within the same major release). Even at a major
40 release, incompatible changes are expected to be rare, and to have strong
41 justifications.
42 "><span class="acronym">Stable</span></acronym>, unless otherwise indicated
43 </div>
44 <div class="refsect1">
45 <a name="libxfce4ui-libxfce4ui-config.functions"></a><h2>Functions</h2>
46 <div class="informaltable"><table class="informaltable" width="100%" border="0">
47 <colgroup>
48 <col width="150px" class="functions_proto_type">
49 <col class="functions_proto_name">
50 </colgroup>
51 <tbody>
52 <tr>
53 <td class="function_type">const <span class="returnvalue">gchar</span> *
54 </td>
55 <td class="function_name">
56 <a class="link" href="libxfce4ui-libxfce4ui-config.html#libxfce4ui-check-version" title="libxfce4ui_check_version ()">libxfce4ui_check_version</a> <span class="c_punctuation">()</span>
57 </td>
58 </tr>
59 <tr>
60 <td class="define_keyword">#define</td>
61 <td class="function_name">
62 <a class="link" href="libxfce4ui-libxfce4ui-config.html#LIBXFCE4UI-CHECK-VERSION:CAPS" title="LIBXFCE4UI_CHECK_VERSION()">LIBXFCE4UI_CHECK_VERSION</a><span class="c_punctuation">()</span>
63 </td>
64 </tr>
65 </tbody>
66 </table></div>
67 </div>
68 <div class="refsect1">
69 <a name="libxfce4ui-libxfce4ui-config.other"></a><h2>Types and Values</h2>
70 <div class="informaltable"><table class="informaltable" width="100%" border="0">
71 <colgroup>
72 <col width="150px" class="other_proto_type">
73 <col class="other_proto_name">
74 </colgroup>
75 <tbody>
76 <tr>
77 <td class="variable_type">extern const guint </td>
78 <td class="function_name"><a class="link" href="libxfce4ui-libxfce4ui-config.html#libxfce4ui-major-version" title="libxfce4ui_major_version">libxfce4ui_major_version</a></td>
79 </tr>
80 <tr>
81 <td class="variable_type">extern const guint </td>
82 <td class="function_name"><a class="link" href="libxfce4ui-libxfce4ui-config.html#libxfce4ui-minor-version" title="libxfce4ui_minor_version">libxfce4ui_minor_version</a></td>
83 </tr>
84 <tr>
85 <td class="variable_type">extern const guint </td>
86 <td class="function_name"><a class="link" href="libxfce4ui-libxfce4ui-config.html#libxfce4ui-micro-version" title="libxfce4ui_micro_version">libxfce4ui_micro_version</a></td>
87 </tr>
88 <tr>
89 <td class="define_keyword">#define</td>
90 <td class="function_name"><a class="link" href="libxfce4ui-libxfce4ui-config.html#LIBXFCE4UI-MAJOR-VERSION:CAPS" title="LIBXFCE4UI_MAJOR_VERSION">LIBXFCE4UI_MAJOR_VERSION</a></td>
91 </tr>
92 <tr>
93 <td class="define_keyword">#define</td>
94 <td class="function_name"><a class="link" href="libxfce4ui-libxfce4ui-config.html#LIBXFCE4UI-MINOR-VERSION:CAPS" title="LIBXFCE4UI_MINOR_VERSION">LIBXFCE4UI_MINOR_VERSION</a></td>
95 </tr>
96 <tr>
97 <td class="define_keyword">#define</td>
98 <td class="function_name"><a class="link" href="libxfce4ui-libxfce4ui-config.html#LIBXFCE4UI-MICRO-VERSION:CAPS" title="LIBXFCE4UI_MICRO_VERSION">LIBXFCE4UI_MICRO_VERSION</a></td>
99 </tr>
100 </tbody>
101 </table></div>
102 </div>
103 <div class="refsect1">
104 <a name="libxfce4ui-libxfce4ui-config.includes"></a><h2>Includes</h2>
105 <pre class="synopsis">#include &lt;libxfce4ui/libxfce4ui.h&gt;
106 </pre>
107 </div>
108 <div class="refsect1">
109 <a name="libxfce4ui-libxfce4ui-config.description"></a><h2>Description</h2>
110 <p>Variables and functions to check the Libxfce4ui version.</p>
111 </div>
112 <div class="refsect1">
113 <a name="libxfce4ui-libxfce4ui-config.functions_details"></a><h2>Functions</h2>
114 <div class="refsect2">
115 <a name="libxfce4ui-check-version"></a><h3>libxfce4ui_check_version ()</h3>
116 <pre class="programlisting">const <span class="returnvalue">gchar</span> *
117 libxfce4ui_check_version (<em class="parameter"><code><span class="type">guint</span> required_major</code></em>,
118 <em class="parameter"><code><span class="type">guint</span> required_minor</code></em>,
119 <em class="parameter"><code><span class="type">guint</span> required_micro</code></em>);</pre>
120 <p>Checks that the <code class="systemitem">libxfce4ui</code> library
121 in use is compatible with the given version. Generally you would pass in
122 the constants <a class="link" href="libxfce4ui-libxfce4ui-config.html#LIBXFCE4UI-MAJOR-VERSION:CAPS" title="LIBXFCE4UI_MAJOR_VERSION"><span class="type">LIBXFCE4UI_MAJOR_VERSION</span></a>, <a class="link" href="libxfce4ui-libxfce4ui-config.html#LIBXFCE4UI-MINOR-VERSION:CAPS" title="LIBXFCE4UI_MINOR_VERSION"><span class="type">LIBXFCE4UI_MINOR_VERSION</span></a> and
123 <a class="link" href="libxfce4ui-libxfce4ui-config.html#LIBXFCE4UI-MICRO-VERSION:CAPS" title="LIBXFCE4UI_MICRO_VERSION"><span class="type">LIBXFCE4UI_MICRO_VERSION</span></a> as the three arguments to this function; that produces
124 a check that the library in use is compatible with the version of</p>
125 <code class="systemitem">libxfce4ui</code> the extension was
126 <p>compiled against.</p>
127 <div class="example">
128 <a name="id-1.2.2.8.2.7"></a><p class="title"><b>Example 1. Checking the runtime version of the Libxfce4ui library</b></p>
129 <div class="example-contents">
130 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
131 <tbody>
132 <tr>
133 <td class="listing_lines" align="right"><pre>1
134 2
135 3
136 4
137 5
138 6</pre></td>
139 <td class="listing_code"><pre class="programlisting"><span class="k">const</span><span class="w"> </span><span class="n">gchar</span><span class="w"> </span><span class="o">*</span><span class="n">mismatch</span><span class="p">;</span>
140 <span class="n">mismatch</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">libxfce4ui_check_version</span><span class="w"> </span><span class="p">(</span><span class="n">LIBXFCE4UI_MAJOR_VERSION</span><span class="p">,</span>
141 <span class="w"> </span><span class="n">LIBXFCE4UI_MINOR_VERSION</span><span class="p">,</span>
142 <span class="w"> </span><span class="n">LIBXFCE4UI_MICRO_VERSION</span><span class="p">);</span>
143 <span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">G_UNLIKELY</span><span class="w"> </span><span class="p">(</span><span class="n">mismatch</span><span class="w"> </span><span class="o">!=</span><span class="w"> </span><span class="nb">NULL</span><span class="p">))</span>
144 <span class="w"> </span><span class="n">g_error</span><span class="w"> </span><span class="p">(</span><span class="s">&quot;Version mismatch: %s&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">mismatch</span><span class="p">);</span></pre></td>
145 </tr>
146 </tbody>
147 </table>
148 </div>
149
150 </div>
151 <br class="example-break"><div class="refsect3">
152 <a name="libxfce4ui-check-version.parameters"></a><h4>Parameters</h4>
153 <div class="informaltable"><table class="informaltable" width="100%" border="0">
154 <colgroup>
155 <col width="150px" class="parameters_name">
156 <col class="parameters_description">
157 <col width="200px" class="parameters_annotations">
158 </colgroup>
159 <tbody>
160 <tr>
161 <td class="parameter_name"><p>required_major</p></td>
162 <td class="parameter_description"><p>the required major version.</p></td>
163 <td class="parameter_annotations"> </td>
164 </tr>
165 <tr>
166 <td class="parameter_name"><p>required_minor</p></td>
167 <td class="parameter_description"><p>the required minor version.</p></td>
168 <td class="parameter_annotations"> </td>
169 </tr>
170 <tr>
171 <td class="parameter_name"><p>required_micro</p></td>
172 <td class="parameter_description"><p>the required micro version.</p></td>
173 <td class="parameter_annotations"> </td>
174 </tr>
175 </tbody>
176 </table></div>
177 </div>
178 <div class="refsect3">
179 <a name="libxfce4ui-check-version.returns"></a><h4>Returns</h4>
180 <p> <code class="literal">NULL</code> if the library is compatible with the given version,
181 or a string describing the version mismatch. The returned
182 string is owned by the library and must not be freed or
183 modified by the caller.</p>
184 </div>
185 </div>
186 <hr>
187 <div class="refsect2">
188 <a name="LIBXFCE4UI-CHECK-VERSION:CAPS"></a><h3>LIBXFCE4UI_CHECK_VERSION()</h3>
189 <pre class="programlisting">#define LIBXFCE4UI_CHECK_VERSION(major, minor, micro)</pre>
190 <p>A macro to compare libxfce4ui versions to determine if a particular
191 function is available.</p>
192 <div class="refsect3">
193 <a name="LIBXFCE4UI-CHECK-VERSION.parameters"></a><h4>Parameters</h4>
194 <div class="informaltable"><table class="informaltable" width="100%" border="0">
195 <colgroup>
196 <col width="150px" class="parameters_name">
197 <col class="parameters_description">
198 <col width="200px" class="parameters_annotations">
199 </colgroup>
200 <tbody>
201 <tr>
202 <td class="parameter_name"><p>major</p></td>
203 <td class="parameter_description"><p>The major version of the library, i.e. 4</p></td>
204 <td class="parameter_annotations"> </td>
205 </tr>
206 <tr>
207 <td class="parameter_name"><p>minor</p></td>
208 <td class="parameter_description"><p>The minor version of the library, i.e. 20</p></td>
209 <td class="parameter_annotations"> </td>
210 </tr>
211 <tr>
212 <td class="parameter_name"><p>micro</p></td>
213 <td class="parameter_description"><p>The micro release of the library, i.e. 2</p></td>
214 <td class="parameter_annotations"> </td>
215 </tr>
216 </tbody>
217 </table></div>
218 </div>
219 </div>
220 </div>
221 <div class="refsect1">
222 <a name="libxfce4ui-libxfce4ui-config.other_details"></a><h2>Types and Values</h2>
223 <div class="refsect2">
224 <a name="libxfce4ui-major-version"></a><h3>libxfce4ui_major_version</h3>
225 <pre class="programlisting">extern const guint libxfce4ui_major_version;
226 </pre>
227 <p>A constat that evaluates to the major version of libxfce4ui.</p>
228 </div>
229 <hr>
230 <div class="refsect2">
231 <a name="libxfce4ui-minor-version"></a><h3>libxfce4ui_minor_version</h3>
232 <pre class="programlisting">extern const guint libxfce4ui_minor_version;
233 </pre>
234 <p>A constat that evaluates to the minor version of libxfce4ui.</p>
235 </div>
236 <hr>
237 <div class="refsect2">
238 <a name="libxfce4ui-micro-version"></a><h3>libxfce4ui_micro_version</h3>
239 <pre class="programlisting">extern const guint libxfce4ui_micro_version;
240 </pre>
241 <p>A constat that evaluates to the micro version of libxfce4ui.</p>
242 </div>
243 <hr>
244 <div class="refsect2">
245 <a name="LIBXFCE4UI-MAJOR-VERSION:CAPS"></a><h3>LIBXFCE4UI_MAJOR_VERSION</h3>
246 <pre class="programlisting">#define LIBXFCE4UI_MAJOR_VERSION (4)
247 </pre>
248 <p>A macro that evaluates to the major version of libxfce4ui, in a format
249 that can be used by the C pre-processor.</p>
250 </div>
251 <hr>
252 <div class="refsect2">
253 <a name="LIBXFCE4UI-MINOR-VERSION:CAPS"></a><h3>LIBXFCE4UI_MINOR_VERSION</h3>
254 <pre class="programlisting">#define LIBXFCE4UI_MINOR_VERSION (20)
255 </pre>
256 <p>A macro that evaluates to the minor version of libxfce4ui, in a format
257 that can be used by the C pre-processor.</p>
258 </div>
259 <hr>
260 <div class="refsect2">
261 <a name="LIBXFCE4UI-MICRO-VERSION:CAPS"></a><h3>LIBXFCE4UI_MICRO_VERSION</h3>
262 <pre class="programlisting">#define LIBXFCE4UI_MICRO_VERSION (2)
263 </pre>
264 <p>A macro that evaluates to the micro version of libxfce4ui, in a format
265 that can be used by the C pre-processor.</p>
266 </div>
267 </div>
268 </div>
269 <div class="footer">
270 <hr>Generated by GTK-Doc V1.34.0</div>
271 </body>
272 </html>