← Back to branch summary

~xubuntu-dev/libxfce4util/maverick

« back to all changes in this revision

Viewing changes to docs/xml/libxfce4util-config.xml

  • Committer: Bazaar Package Importer
  • Author(s): Yves-Alexis Perez
  • Date: 2008-07-06 10:58:49 UTC
  • mfrom: (1.2.11 upstream)
  • mto: (2.2.1 squeeze)
  • mto: This revision was merged to the branch mainline in revision 18.
  • Revision ID: james.westby@ubuntu.com-20080706105849-zetal1iaztbjbj6x
Tags: 4.4.2-3
http://bugs.debian.org/489493
* debian/control:
  - fixed typo in short description.                          closes: #489493
  - removed Martin Loschwitz from Uploaders.
  - updated standards version to 3.8.0.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/xml/libxfce4util-config.xml
 
1
<refentry id="libxfce4util-Version-Information">
 
2
<refmeta>
 
3
<refentrytitle role="top_of_page">Version Information</refentrytitle>
 
4
<manvolnum>3</manvolnum>
 
5
<refmiscinfo>LIBXFCE4UTIL Library</refmiscinfo>
 
6
</refmeta>
 
7
 
 
8
<refnamediv>
 
9
<refname>Version Information</refname>
 
10
<refpurpose>Variables and functions to check the libxfce4util version</refpurpose>
 
11
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
 
12
</refnamediv>
 
13
 
 
14
<refsynopsisdiv role="synopsis">
 
15
<title role="synopsis.title">Synopsis</title>
 
16
 
 
17
<synopsis>
 
18
 
 
19
#include &lt;libxfce4util/libxfce4util.h&gt;
 
20
 
 
21
 
 
22
const <link linkend="gchar">gchar</link>*        <link linkend="xfce-version-string">xfce_version_string</link>                 (void);
 
23
extern              const guint <link linkend="libxfce4util-major-version">libxfce4util_major_version</link>;
 
24
extern              const guint <link linkend="libxfce4util-minor-version">libxfce4util_minor_version</link>;
 
25
extern              const guint <link linkend="libxfce4util-micro-version">libxfce4util_micro_version</link>;
 
26
 
 
27
#define             <link linkend="LIBXFCE4UTIL-MAJOR-VERSION:CAPS">LIBXFCE4UTIL_MAJOR_VERSION</link>
 
28
#define             <link linkend="LIBXFCE4UTIL-MINOR-VERSION:CAPS">LIBXFCE4UTIL_MINOR_VERSION</link>
 
29
#define             <link linkend="LIBXFCE4UTIL-MICRO-VERSION:CAPS">LIBXFCE4UTIL_MICRO_VERSION</link>
 
30
#define             <link linkend="LIBXFCE4UTIL-CHECK-VERSION:CAPS">LIBXFCE4UTIL_CHECK_VERSION</link>          (major,minor,micro)
 
31
</synopsis>
 
32
</refsynopsisdiv>
 
33
 
 
34
 
 
35
 
 
36
 
 
37
 
 
38
 
 
39
 
 
40
 
 
41
 
 
42
<refsect1 role="desc">
 
43
<title role="desc.title">Description</title>
 
44
<para>
 
45
These macros provide a few commonly-used features.
 
46
</para>
 
47
</refsect1>
 
48
 
 
49
<refsect1 role="details">
 
50
<title role="details.title">Details</title>
 
51
<refsect2>
 
52
<title><anchor id="xfce-version-string" role="function" condition="since:4.2"/>xfce_version_string ()</title>
 
53
<indexterm role="4.2"><primary>xfce_version_string</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        xfce_version_string                 (void);</programlisting>
 
54
<para>
 
55
Queries the version string of the installed Xfce desktop environment.</para>
 
56
<para>
 
57
 
 
58
</para><variablelist role="params">
 
59
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the overall version information of the installed Xfce desktop.
 
60
 
 
61
</simpara></listitem></varlistentry>
 
62
</variablelist><para role="since">Since  4.2
 
63
</para></refsect2>
 
64
<refsect2>
 
65
<title><anchor id="libxfce4util-major-version" role="variable"/>libxfce4util_major_version</title>
 
66
<indexterm><primary>libxfce4util_major_version</primary></indexterm><programlisting>extern const guint libxfce4util_major_version;
 
67
</programlisting>
 
68
<para>
 
69
 
 
70
</para></refsect2>
 
71
<refsect2>
 
72
<title><anchor id="libxfce4util-minor-version" role="variable"/>libxfce4util_minor_version</title>
 
73
<indexterm><primary>libxfce4util_minor_version</primary></indexterm><programlisting>extern const guint libxfce4util_minor_version;
 
74
</programlisting>
 
75
<para>
 
76
 
 
77
</para></refsect2>
 
78
<refsect2>
 
79
<title><anchor id="libxfce4util-micro-version" role="variable"/>libxfce4util_micro_version</title>
 
80
<indexterm><primary>libxfce4util_micro_version</primary></indexterm><programlisting>extern const guint libxfce4util_micro_version;
 
81
</programlisting>
 
82
<para>
 
83
 
 
84
</para></refsect2>
 
85
<refsect2>
 
86
<title><anchor id="LIBXFCE4UTIL-MAJOR-VERSION:CAPS" role="macro"/>LIBXFCE4UTIL_MAJOR_VERSION</title>
 
87
<indexterm><primary>LIBXFCE4UTIL_MAJOR_VERSION</primary></indexterm><programlisting>#define LIBXFCE4UTIL_MAJOR_VERSION  4
 
88
</programlisting>
 
89
<para>
 
90
The major version number of the libxfce4util.
 
91
</para></refsect2>
 
92
<refsect2>
 
93
<title><anchor id="LIBXFCE4UTIL-MINOR-VERSION:CAPS" role="macro"/>LIBXFCE4UTIL_MINOR_VERSION</title>
 
94
<indexterm><primary>LIBXFCE4UTIL_MINOR_VERSION</primary></indexterm><programlisting>#define LIBXFCE4UTIL_MINOR_VERSION  4
 
95
</programlisting>
 
96
<para>
 
97
The minor version number of the libxfce4util.
 
98
</para></refsect2>
 
99
<refsect2>
 
100
<title><anchor id="LIBXFCE4UTIL-MICRO-VERSION:CAPS" role="macro"/>LIBXFCE4UTIL_MICRO_VERSION</title>
 
101
<indexterm><primary>LIBXFCE4UTIL_MICRO_VERSION</primary></indexterm><programlisting>#define LIBXFCE4UTIL_MICRO_VERSION  2
 
102
</programlisting>
 
103
<para>
 
104
The micro version number of the libxfce4util.
 
105
</para></refsect2>
 
106
<refsect2>
 
107
<title><anchor id="LIBXFCE4UTIL-CHECK-VERSION:CAPS" role="macro"/>LIBXFCE4UTIL_CHECK_VERSION()</title>
 
108
<indexterm><primary>LIBXFCE4UTIL_CHECK_VERSION</primary></indexterm><programlisting>#define             LIBXFCE4UTIL_CHECK_VERSION(major,minor,micro)</programlisting>
 
109
<para>
 
110
Checks the version of the libxfce4util library. It returns TRUE if the
 
111
libxfce4util library is the same or newer than the given version.
 
112
<example>
 
113
<title>Checking the version of the libxfce4util library</title>
 
114
<programlisting>
 
115
  if (!LIBXFCE4UTIL_CHECK_VERSION (4, 1, 6))
 
116
    g_error ("libxfce4util version 4.1.6 or above is required.");
 
117
</programlisting>
 
118
</example>
 
119
</para><variablelist role="params">
 
120
<varlistentry><term><parameter>major</parameter>&nbsp;:</term>
 
121
<listitem><simpara>the major version number.
 
122
</simpara></listitem></varlistentry>
 
123
<varlistentry><term><parameter>minor</parameter>&nbsp;:</term>
 
124
<listitem><simpara>the minor version number.
 
125
</simpara></listitem></varlistentry>
 
126
<varlistentry><term><parameter>micro</parameter>&nbsp;:</term>
 
127
<listitem><simpara>the micro version number.
 
128
 
 
129
 
 
130
</simpara></listitem></varlistentry>
 
131
</variablelist></refsect2>
 
132
 
 
133
</refsect1>
 
134
 
 
135
 
 
136
 
 
137
<refsect1>
 
138
<title>See Also</title>
 
139
<para>
 
140
<ulink url="http://developer.gnome.org/doc/API/2.0/glib/glib-Standard-Macros.html">GLib Standard Macros</ulink>
 
141
</para>
 
142
</refsect1>
 
143
 
 
144
</refentry>