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
|
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="libgimpbase-gimpbasetypes">
<refmeta>
<refentrytitle role="top_of_page">gimpbasetypes</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMPBASE Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>gimpbasetypes</refname>
<refpurpose>Translation between gettext translation domain identifier and GType.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="GimpEnumDesc">GimpEnumDesc</link>;
<link linkend="GimpFlagsDesc">GimpFlagsDesc</link>;
<link linkend="void">void</link> <link linkend="gimp-type-set-translation-domain">gimp_type_set_translation_domain</link>
(<link linkend="GType">GType</link> type,
const <link linkend="gchar">gchar</link> *domain);
const <link linkend="gchar">gchar</link>* <link linkend="gimp-type-get-translation-domain">gimp_type_get_translation_domain</link>
(<link linkend="GType">GType</link> type);
<link linkend="void">void</link> <link linkend="gimp-enum-set-value-descriptions">gimp_enum_set_value_descriptions</link>
(<link linkend="GType">GType</link> enum_type,
const <link linkend="GimpEnumDesc">GimpEnumDesc</link> *descriptions);
const <link linkend="GimpEnumDesc">GimpEnumDesc</link>* <link linkend="gimp-enum-get-value-descriptions">gimp_enum_get_value_descriptions</link>
(<link linkend="GType">GType</link> enum_type);
const <link linkend="GimpFlagsDesc">GimpFlagsDesc</link>* <link linkend="gimp-flags-get-value-descriptions">gimp_flags_get_value_descriptions</link>
(<link linkend="GType">GType</link> flags_type);
<link linkend="void">void</link> <link linkend="gimp-flags-set-value-descriptions">gimp_flags_set_value_descriptions</link>
(<link linkend="GType">GType</link> flags_type,
const <link linkend="GimpFlagsDesc">GimpFlagsDesc</link> *descriptions);
</synopsis>
</refsynopsisdiv>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
Translation between gettext translation domain identifier and GType.
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="GimpEnumDesc" role="struct"/>GimpEnumDesc</title>
<indexterm><primary>GimpEnumDesc</primary></indexterm><programlisting>typedef struct {
gint value;
gchar *value_desc;
gchar *value_help;
} GimpEnumDesc;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpFlagsDesc" role="struct"/>GimpFlagsDesc</title>
<indexterm><primary>GimpFlagsDesc</primary></indexterm><programlisting>typedef struct {
guint value;
gchar *value_desc;
gchar *value_help;
} GimpFlagsDesc;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="gimp-type-set-translation-domain" role="function" condition="since:GIMP 2.2"/>gimp_type_set_translation_domain ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_type_set_translation_domain</primary></indexterm><programlisting><link linkend="void">void</link> gimp_type_set_translation_domain
(<link linkend="GType">GType</link> type,
const <link linkend="gchar">gchar</link> *domain);</programlisting>
<para>
This function attaches a constant string as a gettext translation
domain identifier to a <link linkend="GType"><type>GType</type></link>. The only purpose of this function is
to use it when registering a <link linkend="GTypeEnum"><type>GTypeEnum</type></link> with translatable value
names.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>type</parameter> :</term>
<listitem><simpara> a <link linkend="GType"><type>GType</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>domain</parameter> :</term>
<listitem><simpara> a constant string that identifies a translation domain or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-type-get-translation-domain" role="function" condition="since:GIMP 2.2"/>gimp_type_get_translation_domain ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_type_get_translation_domain</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_type_get_translation_domain
(<link linkend="GType">GType</link> type);</programlisting>
<para>
Retrieves the gettext translation domain identifier that has been
previously set using <link linkend="gimp-type-set-translation-domain"><function>gimp_type_set_translation_domain()</function></link>. You should
not need to use this function directly, use <link linkend="gimp-enum-get-value"><function>gimp_enum_get_value()</function></link>
or <link linkend="gimp-enum-value-get-name"><function>gimp_enum_value_get_name()</function></link> instead.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>type</parameter> :</term>
<listitem><simpara> a <link linkend="GType"><type>GType</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the translation domain associated with <parameter>type</parameter>
or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if no domain was set
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-enum-set-value-descriptions" role="function" condition="since:GIMP 2.2"/>gimp_enum_set_value_descriptions ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_enum_set_value_descriptions</primary></indexterm><programlisting><link linkend="void">void</link> gimp_enum_set_value_descriptions
(<link linkend="GType">GType</link> enum_type,
const <link linkend="GimpEnumDesc">GimpEnumDesc</link> *descriptions);</programlisting>
<para>
Sets the array of human readable and translatable descriptions
and help texts for enum values.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>enum_type</parameter> :</term>
<listitem><simpara> a <link linkend="GType"><type>GType</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>descriptions</parameter> :</term>
<listitem><simpara> a <link linkend="NULL:CAPS"><literal>NULL</literal></link> terminated constant static array of <link linkend="GimpEnumDesc"><type>GimpEnumDesc</type></link>
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-enum-get-value-descriptions" role="function" condition="since:GIMP 2.2"/>gimp_enum_get_value_descriptions ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_enum_get_value_descriptions</primary></indexterm><programlisting>const <link linkend="GimpEnumDesc">GimpEnumDesc</link>* gimp_enum_get_value_descriptions
(<link linkend="GType">GType</link> enum_type);</programlisting>
<para>
Retreives the array of human readable and translatable descriptions
and help texts for enum values.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>enum_type</parameter> :</term>
<listitem><simpara> a <link linkend="GType"><type>GType</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a <link linkend="NULL:CAPS"><literal>NULL</literal></link> terminated constant array of <link linkend="GimpEnumDesc"><type>GimpEnumDesc</type></link>
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-flags-get-value-descriptions" role="function" condition="since:GIMP 2.2"/>gimp_flags_get_value_descriptions ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_flags_get_value_descriptions</primary></indexterm><programlisting>const <link linkend="GimpFlagsDesc">GimpFlagsDesc</link>* gimp_flags_get_value_descriptions
(<link linkend="GType">GType</link> flags_type);</programlisting>
<para>
Retreives the array of human readable and translatable descriptions
and help texts for flags values.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>flags_type</parameter> :</term>
<listitem><simpara> a <link linkend="GType"><type>GType</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a <link linkend="NULL:CAPS"><literal>NULL</literal></link> terminated constant array of <link linkend="GimpFlagsDesc"><type>GimpFlagsDesc</type></link>
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-flags-set-value-descriptions" role="function" condition="since:GIMP 2.2"/>gimp_flags_set_value_descriptions ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_flags_set_value_descriptions</primary></indexterm><programlisting><link linkend="void">void</link> gimp_flags_set_value_descriptions
(<link linkend="GType">GType</link> flags_type,
const <link linkend="GimpFlagsDesc">GimpFlagsDesc</link> *descriptions);</programlisting>
<para>
Sets the array of human readable and translatable descriptions
and help texts for flags values.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>flags_type</parameter> :</term>
<listitem><simpara> a <link linkend="GType"><type>GType</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>descriptions</parameter> :</term>
<listitem><simpara> a <link linkend="NULL:CAPS"><literal>NULL</literal></link> terminated constant static array of <link linkend="GimpFlagsDesc"><type>GimpFlagsDesc</type></link>
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
</refsect1>
</refentry>
|
