summaryrefslogtreecommitdiff
path: root/docs/reference/gtk/tmpl/gtkfeatures.sgml
blob: 218a76b2fd3f97bc7b3f040f48dee6ae510d1c84 (plain)
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
<!-- ##### SECTION Title ##### -->
Version Information

<!-- ##### SECTION Short_Description ##### -->
variables and functions to check the GTK+ version.

<!-- ##### SECTION Long_Description ##### -->
<para>
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.
</para>

<!-- ##### SECTION See_Also ##### -->
<para>

</para>

<!-- ##### VARIABLE gtk_major_version ##### -->
<para>
The major version number of the GTK+ library.  (e.g. in GTK+ version
1.2.5 this is 1.) 
</para>

<para>
This variable is in the library, so represents the
GTK+ library you have linked against. Contrast with the
#GTK_MAJOR_VERSION macro, which represents the major version of the
GTK+ headers you have included.
</para>


<!-- ##### VARIABLE gtk_minor_version ##### -->
<para>
The minor version number of the GTK+ library.
(e.g. in GTK+ version 1.2.5 this is 2.)
</para>

<para>
This variable is in the library, so represents the
GTK+ library you have linked against. Contrast with the
#GTK_MINOR_VERSION macro, which represents the minor version of the
GTK+ headers you have included.
</para>


<!-- ##### VARIABLE gtk_micro_version ##### -->
<para>
The micro version number of the GTK+ library.
(e.g. in GTK+ version 1.2.5 this is 5.)
</para>


<para>
This variable is in the library, so represents the GTK+ library you
have linked against. Contrast with the #GTK_MICRO_VERSION macro, which
represents the micro version of the GTK+ headers you have included.
</para>


<!-- ##### VARIABLE gtk_binary_age ##### -->
<para>
This is the binary age passed to libtool. If "libtool" means nothing
to you, don't worry about it. ;-)
</para>


<!-- ##### VARIABLE gtk_interface_age ##### -->
<para>
This is the interface age passed to libtool. If "libtool" means nothing
to you, don't worry about it. ;-)
</para>


<!-- ##### FUNCTION gtk_check_version ##### -->
<para>
Checks that the GTK+ library in use is equal to the given 
version. Primarily useful to compare the header file version 
(from #GTK_MAJOR_VERSION, #GTK_MINOR_VERSION, #GTK_MICRO_VERSION) 
the the runtime library version. This should only be done 
in the build for your application, to check that the user's libraries
and header files are the same. Applications should not do this 
when deployed, because it's OK for applications to use a different
micro version of GTK+ than the one they were compiled against.
</para>

@required_major: the required major version.
@required_minor: the required major version.
@required_micro: the required major version.
@Returns: NULL if the GTK+ library is compatible with the given version, or
a string describing the version mismatch.


<!-- ##### MACRO GTK_MAJOR_VERSION ##### -->
<para>
Like #gtk_major_version, but from the headers used at
application compile time, rather than from the library linked against
at application run time.
</para>



<!-- ##### MACRO GTK_MINOR_VERSION ##### -->
<para>
Like #gtk_minor_version, but from the headers used at
application compile time, rather than from the library linked against
at application run time.
</para>



<!-- ##### MACRO GTK_MICRO_VERSION ##### -->
<para>
Like #gtk_micro_version, but from the headers used at
application compile time, rather than from the library linked against
at application run time.
</para>



<!-- ##### MACRO GTK_BINARY_AGE ##### -->
<para>
Like #gtk_binary_age, but from the headers used at
application compile time, rather than from the library linked against
at application run time.
</para>



<!-- ##### MACRO GTK_INTERFACE_AGE ##### -->
<para>
Like #gtk_interface_age, but from the headers used at
application compile time, rather than from the library linked against
at application run time.
</para>



<!-- ##### MACRO GTK_CHECK_VERSION ##### -->
<para>
Returns %TRUE if the version of the GTK+ header files is the same
as the passed-in version.
</para>

@major: major version (first number in 1.2.5)
@minor: minor version (second number in 1.2.5)
@micro: micro version (third number in 1.2.5)