/usr/share/doc/libgtk-3-doc/gtk3/gtk3-Feature-Test-Macros.html is in libgtk-3-doc 3.4.2-0ubuntu0.9.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Version Information</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="GTK+ 3 Reference Manual">
<link rel="up" href="gtkbase.html" title="Part II. GTK+ Core Reference">
<link rel="prev" href="gtk3-General.html" title="Main loop and Events">
<link rel="next" href="gtk3-Keyboard-Accelerators.html" title="Accelerator Groups">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="gtk3-General.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="gtkbase.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GTK+ 3 Reference Manual</th>
<td><a accesskey="n" href="gtk3-Keyboard-Accelerators.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#gtk3-Feature-Test-Macros.synopsis" class="shortcut">Top</a>
|
<a href="#gtk3-Feature-Test-Macros.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="gtk3-Feature-Test-Macros"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gtk3-Feature-Test-Macros.top_of_page"></a>Version Information</span></h2>
<p>Version Information — Variables and functions to check the GTK+ version</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="gtk3-Feature-Test-Macros.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <gtk/gtk.h>
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> <a class="link" href="gtk3-Feature-Test-Macros.html#gtk-get-major-version" title="gtk_get_major_version ()">gtk_get_major_version</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> <a class="link" href="gtk3-Feature-Test-Macros.html#gtk-get-minor-version" title="gtk_get_minor_version ()">gtk_get_minor_version</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> <a class="link" href="gtk3-Feature-Test-Macros.html#gtk-get-micro-version" title="gtk_get_micro_version ()">gtk_get_micro_version</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> <a class="link" href="gtk3-Feature-Test-Macros.html#gtk-get-binary-age" title="gtk_get_binary_age ()">gtk_get_binary_age</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> <a class="link" href="gtk3-Feature-Test-Macros.html#gtk-get-interface-age" title="gtk_get_interface_age ()">gtk_get_interface_age</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="gtk3-Feature-Test-Macros.html#gtk-check-version" title="gtk_check_version ()">gtk_check_version</a> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> required_major</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> required_minor</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> required_micro</code></em>);
#define <a class="link" href="gtk3-Feature-Test-Macros.html#GTK-MAJOR-VERSION:CAPS" title="GTK_MAJOR_VERSION">GTK_MAJOR_VERSION</a>
#define <a class="link" href="gtk3-Feature-Test-Macros.html#GTK-MINOR-VERSION:CAPS" title="GTK_MINOR_VERSION">GTK_MINOR_VERSION</a>
#define <a class="link" href="gtk3-Feature-Test-Macros.html#GTK-MICRO-VERSION:CAPS" title="GTK_MICRO_VERSION">GTK_MICRO_VERSION</a>
#define <a class="link" href="gtk3-Feature-Test-Macros.html#GTK-BINARY-AGE:CAPS" title="GTK_BINARY_AGE">GTK_BINARY_AGE</a>
#define <a class="link" href="gtk3-Feature-Test-Macros.html#GTK-INTERFACE-AGE:CAPS" title="GTK_INTERFACE_AGE">GTK_INTERFACE_AGE</a>
#define <a class="link" href="gtk3-Feature-Test-Macros.html#GTK-CHECK-VERSION:CAPS" title="GTK_CHECK_VERSION()">GTK_CHECK_VERSION</a> (major,
minor,
micro)
</pre>
</div>
<div class="refsect1">
<a name="gtk3-Feature-Test-Macros.description"></a><h2>Description</h2>
<p>
GTK+ provides version information, primarily useful in configure checks
for builds that have a configure script. Applications will not typically
use the features described here.
</p>
</div>
<div class="refsect1">
<a name="gtk3-Feature-Test-Macros.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="gtk-get-major-version"></a><h3>gtk_get_major_version ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> gtk_get_major_version (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Returns the major version number of the GTK+ library.
(e.g. in GTK+ version 3.1.5 this is 3.)
</p>
<p>
This function is in the library, so it represents the GTK+ library
your code is running against. Contrast with the <a class="link" href="gtk3-Feature-Test-Macros.html#GTK-MAJOR-VERSION:CAPS" title="GTK_MAJOR_VERSION"><span class="type">GTK_MAJOR_VERSION</span></a>
macro, which represents the major version of the GTK+ headers you
have included when compiling your code.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the major version number of the GTK+ library</td>
</tr></tbody>
</table></div>
<p class="since">Since 3.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-get-minor-version"></a><h3>gtk_get_minor_version ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> gtk_get_minor_version (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Returns the minor version number of the GTK+ library.
(e.g. in GTK+ version 3.1.5 this is 1.)
</p>
<p>
This function is in the library, so it represents the GTK+ library
your code is are running against. Contrast with the
<a class="link" href="gtk3-Feature-Test-Macros.html#GTK-MINOR-VERSION:CAPS" title="GTK_MINOR_VERSION"><span class="type">GTK_MINOR_VERSION</span></a> macro, which represents the minor version of the
GTK+ headers you have included when compiling your code.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the minor version number of the GTK+ library</td>
</tr></tbody>
</table></div>
<p class="since">Since 3.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-get-micro-version"></a><h3>gtk_get_micro_version ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> gtk_get_micro_version (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Returns the micro version number of the GTK+ library.
(e.g. in GTK+ version 3.1.5 this is 5.)
</p>
<p>
This function is in the library, so it represents the GTK+ library
your code is are running against. Contrast with the
<a class="link" href="gtk3-Feature-Test-Macros.html#GTK-MICRO-VERSION:CAPS" title="GTK_MICRO_VERSION"><span class="type">GTK_MICRO_VERSION</span></a> macro, which represents the micro version of the
GTK+ headers you have included when compiling your code.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the micro version number of the GTK+ library</td>
</tr></tbody>
</table></div>
<p class="since">Since 3.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-get-binary-age"></a><h3>gtk_get_binary_age ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> gtk_get_binary_age (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Returns the binary age as passed to <span class="application">libtool</span>
when building the GTK+ library the process is running against.
If <span class="application">libtool</span> means nothing to you, don't
worry about it.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the binary age of the GTK+ library</td>
</tr></tbody>
</table></div>
<p class="since">Since 3.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-get-interface-age"></a><h3>gtk_get_interface_age ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> gtk_get_interface_age (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Returns the interface age as passed to <span class="application">libtool</span>
when building the GTK+ library the process is running against.
If <span class="application">libtool</span> means nothing to you, don't
worry about it.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the interface age of the GTK+ library</td>
</tr></tbody>
</table></div>
<p class="since">Since 3.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-check-version"></a><h3>gtk_check_version ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gtk_check_version (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> required_major</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> required_minor</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> required_micro</code></em>);</pre>
<p>
Checks that the GTK+ library in use is compatible with the
given version. Generally you would pass in the constants
<a class="link" href="gtk3-Feature-Test-Macros.html#GTK-MAJOR-VERSION:CAPS" title="GTK_MAJOR_VERSION"><span class="type">GTK_MAJOR_VERSION</span></a>, <a class="link" href="gtk3-Feature-Test-Macros.html#GTK-MINOR-VERSION:CAPS" title="GTK_MINOR_VERSION"><span class="type">GTK_MINOR_VERSION</span></a>, <a class="link" href="gtk3-Feature-Test-Macros.html#GTK-MICRO-VERSION:CAPS" title="GTK_MICRO_VERSION"><span class="type">GTK_MICRO_VERSION</span></a>
as the three arguments to this function; that produces
a check that the library in use is compatible with
the version of GTK+ the application or module was compiled
against.
</p>
<p>
Compatibility is defined by two things: first the version
of the running library is newer than the version
<em class="parameter"><code>required_major.required_minor</code></em>.<em class="parameter"><code>required_micro</code></em>. Second
the running library must be binary compatible with the
version <em class="parameter"><code>required_major.required_minor</code></em>.<em class="parameter"><code>required_micro</code></em>
(same major version.)
</p>
<p>
This function is primarily for GTK+ modules; the module
can call this function to check that it wasn't loaded
into an incompatible version of GTK+. However, such a
check isn't completely reliable, since the module may be
linked against an old version of GTK+ and calling the
old version of <a class="link" href="gtk3-Feature-Test-Macros.html#gtk-check-version" title="gtk_check_version ()"><code class="function">gtk_check_version()</code></a>, but still get loaded
into an application using a newer version of GTK+.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>required_major</code></em> :</span></p></td>
<td>the required major version</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>required_minor</code></em> :</span></p></td>
<td>the required minor version</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>required_micro</code></em> :</span></p></td>
<td>the required micro version</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the GTK+ library is compatible with the
given version, or a string describing the version mismatch.
The returned string is owned by GTK+ and should not be modified
or freed.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GTK-MAJOR-VERSION:CAPS"></a><h3>GTK_MAJOR_VERSION</h3>
<pre class="programlisting">#define GTK_MAJOR_VERSION (3)
</pre>
<p>
Like <a class="link" href="gtk3-Feature-Test-Macros.html#gtk-get-major-version" title="gtk_get_major_version ()"><code class="function">gtk_get_major_version()</code></a>, but from the headers used at
application compile time, rather than from the library linked
against at application run time.
</p>
</div>
<hr>
<div class="refsect2">
<a name="GTK-MINOR-VERSION:CAPS"></a><h3>GTK_MINOR_VERSION</h3>
<pre class="programlisting">#define GTK_MINOR_VERSION (4)
</pre>
<p>
Like <a class="link" href="gtk3-Feature-Test-Macros.html#gtk-get-minor-version" title="gtk_get_minor_version ()"><code class="function">gtk_get_minor_version()</code></a>, but from the headers used at
application compile time, rather than from the library linked
against at application run time.
</p>
</div>
<hr>
<div class="refsect2">
<a name="GTK-MICRO-VERSION:CAPS"></a><h3>GTK_MICRO_VERSION</h3>
<pre class="programlisting">#define GTK_MICRO_VERSION (2)
</pre>
<p>
Like <a class="link" href="gtk3-Feature-Test-Macros.html#gtk-get-micro-version" title="gtk_get_micro_version ()"><code class="function">gtk_get_micro_version()</code></a>, but from the headers used at
application compile time, rather than from the library linked
against at application run time.
</p>
</div>
<hr>
<div class="refsect2">
<a name="GTK-BINARY-AGE:CAPS"></a><h3>GTK_BINARY_AGE</h3>
<pre class="programlisting">#define GTK_BINARY_AGE (402)
</pre>
<p>
Like <a class="link" href="gtk3-Feature-Test-Macros.html#gtk-get-binary-age" title="gtk_get_binary_age ()"><code class="function">gtk_get_binary_age()</code></a>, but from the headers used at
application compile time, rather than from the library linked
against at application run time.
</p>
</div>
<hr>
<div class="refsect2">
<a name="GTK-INTERFACE-AGE:CAPS"></a><h3>GTK_INTERFACE_AGE</h3>
<pre class="programlisting">#define GTK_INTERFACE_AGE (2)
</pre>
<p>
Like <a class="link" href="gtk3-Feature-Test-Macros.html#gtk-get-interface-age" title="gtk_get_interface_age ()"><code class="function">gtk_get_interface_age()</code></a>, but from the headers used at
application compile time, rather than from the library linked
against at application run time.
</p>
</div>
<hr>
<div class="refsect2">
<a name="GTK-CHECK-VERSION:CAPS"></a><h3>GTK_CHECK_VERSION()</h3>
<pre class="programlisting">#define GTK_CHECK_VERSION(major,minor,micro)</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>major</code></em> :</span></p></td>
<td>major version (e.g. 1 for version 1.2.5)</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>minor</code></em> :</span></p></td>
<td>minor version (e.g. 2 for version 1.2.5)</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>micro</code></em> :</span></p></td>
<td>micro version (e.g. 5 for version 1.2.5)</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the version of the GTK+ header files
is the same as or newer than the passed-in version.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|