← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/gimp/oneiric-security

« back to all changes in this revision

Viewing changes to devel-docs/libgimpbase/xml/gimpbasetypes.xml

  • Committer: Package Import Robot
  • Author(s): Sebastien Bacher
  • Date: 2010-07-12 15:08:08 UTC
  • mfrom: (1.1.23) (0.4.6 sid)
  • Revision ID: package-import@ubuntu.com-20100712150808-db9xqgtxrvpyl3g2
Tags: 2.6.10-1ubuntu1
Resync on Debian, dropping changes which are in the new version

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimpbase/xml/gimpbasetypes.xml
1
 
<?xml version="1.0" encoding="UTF-8" ?>
2
 
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
3
 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
4
 
 
5
 
<refentry id="libgimpbase-gimpbasetypes">
6
 
<refmeta>
7
 
<refentrytitle role="top_of_page" id="libgimpbase-gimpbasetypes.top_of_page">gimpbasetypes</refentrytitle>
8
 
<manvolnum>3</manvolnum>
9
 
<refmiscinfo>LIBGIMPBASE Library</refmiscinfo>
10
 
</refmeta>
11
 
 
12
 
<refnamediv>
13
 
<refname>gimpbasetypes</refname>
14
 
<refpurpose>Translation between gettext translation domain identifier and GType.</refpurpose>
15
 
</refnamediv>
16
 
 
17
 
<refsynopsisdiv id="libgimpbase-gimpbasetypes.synopsis" role="synopsis">
18
 
<title role="synopsis.title">Synopsis</title>
19
 
 
20
 
<synopsis>
21
 
                    <link linkend="GimpEnumDesc">GimpEnumDesc</link>;
22
 
                    <link linkend="GimpFlagsDesc">GimpFlagsDesc</link>;
23
 
<link linkend="void">void</link>                <link linkend="gimp-type-set-translation-domain">gimp_type_set_translation_domain</link>    (<link linkend="GType">GType</link> type,
24
 
                                                         const <link linkend="gchar">gchar</link> *domain);
25
 
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);
26
 
<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,
27
 
                                                         const <link linkend="GimpEnumDesc">GimpEnumDesc</link> *descriptions);
28
 
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);
29
 
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);
30
 
<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,
31
 
                                                         const <link linkend="GimpFlagsDesc">GimpFlagsDesc</link> *descriptions);
32
 
</synopsis>
33
 
</refsynopsisdiv>
34
 
 
35
 
 
36
 
 
37
 
 
38
 
 
39
 
 
40
 
 
41
 
 
42
 
 
43
 
<refsect1 id="libgimpbase-gimpbasetypes.description" role="desc">
44
 
<title role="desc.title">Description</title>
45
 
<para>
46
 
Translation between gettext translation domain identifier and GType.
47
 
</para>
48
 
</refsect1>
49
 
 
50
 
<refsect1 id="libgimpbase-gimpbasetypes.details" role="details">
51
 
<title role="details.title">Details</title>
52
 
<refsect2 id="GimpEnumDesc" role="struct">
53
 
<title>GimpEnumDesc</title>
54
 
<indexterm zone="GimpEnumDesc"><primary sortas="GimpEnumDesc">GimpEnumDesc</primary></indexterm><programlisting>typedef struct {
55
 
  gint         value;
56
 
  const gchar *value_desc;
57
 
  const gchar *value_help;
58
 
} GimpEnumDesc;
59
 
</programlisting>
60
 
<para>
61
 
</para></refsect2>
62
 
<refsect2 id="GimpFlagsDesc" role="struct">
63
 
<title>GimpFlagsDesc</title>
64
 
<indexterm zone="GimpFlagsDesc"><primary sortas="GimpFlagsDesc">GimpFlagsDesc</primary></indexterm><programlisting>typedef struct {
65
 
  guint        value;
66
 
  const gchar *value_desc;
67
 
  const gchar *value_help;
68
 
} GimpFlagsDesc;
69
 
</programlisting>
70
 
<para>
71
 
</para></refsect2>
72
 
<refsect2 id="gimp-type-set-translation-domain" role="function" condition="since:GIMP 2.2">
73
 
<title>gimp_type_set_translation_domain ()</title>
74
 
<indexterm zone="gimp-type-set-translation-domain" role="GIMP 2.2"><primary sortas="gimp_type_set_translation_domain">gimp_type_set_translation_domain</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_type_set_translation_domain    (<link linkend="GType">GType</link> type,
75
 
                                                         const <link linkend="gchar">gchar</link> *domain);</programlisting>
76
 
<para>
77
 
This function attaches a constant string as a gettext translation
78
 
domain identifier to a <link linkend="GType"><type>GType</type></link>. The only purpose of this function is
79
 
to use it when registering a <link linkend="GTypeEnum"><type>GTypeEnum</type></link> with translatable value
80
 
names.</para>
81
 
<para>
82
 
</para><variablelist role="params">
83
 
<varlistentry><term><parameter>type</parameter>&#160;:</term>
84
 
<listitem><simpara>   a <link linkend="GType"><type>GType</type></link>
85
 
</simpara></listitem></varlistentry>
86
 
<varlistentry><term><parameter>domain</parameter>&#160;:</term>
87
 
<listitem><simpara> a constant string that identifies a translation domain or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
88
 
</simpara></listitem></varlistentry>
89
 
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
90
 
<refsect2 id="gimp-type-get-translation-domain" role="function" condition="since:GIMP 2.2">
91
 
<title>gimp_type_get_translation_domain ()</title>
92
 
<indexterm zone="gimp-type-get-translation-domain" role="GIMP 2.2"><primary sortas="gimp_type_get_translation_domain">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>
93
 
<para>
94
 
Retrieves the gettext translation domain identifier that has been
95
 
previously set using <link linkend="gimp-type-set-translation-domain"><function>gimp_type_set_translation_domain()</function></link>. You should
96
 
not need to use this function directly, use <link linkend="gimp-enum-get-value"><function>gimp_enum_get_value()</function></link>
97
 
or <link linkend="gimp-enum-value-get-name"><function>gimp_enum_value_get_name()</function></link> instead.</para>
98
 
<para>
99
 
</para><variablelist role="params">
100
 
<varlistentry><term><parameter>type</parameter>&#160;:</term>
101
 
<listitem><simpara> a <link linkend="GType"><type>GType</type></link>
102
 
</simpara></listitem></varlistentry>
103
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the translation domain associated with <parameter>type</parameter>
104
 
              or <link linkend="NULL--CAPS"><literal>NULL</literal></link> if no domain was set
105
 
 
106
 
</simpara></listitem></varlistentry>
107
 
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
108
 
<refsect2 id="gimp-enum-set-value-descriptions" role="function" condition="since:GIMP 2.2">
109
 
<title>gimp_enum_set_value_descriptions ()</title>
110
 
<indexterm zone="gimp-enum-set-value-descriptions" role="GIMP 2.2"><primary sortas="gimp_enum_set_value_descriptions">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,
111
 
                                                         const <link linkend="GimpEnumDesc">GimpEnumDesc</link> *descriptions);</programlisting>
112
 
<para>
113
 
Sets the array of human readable and translatable descriptions
114
 
and help texts for enum values.</para>
115
 
<para>
116
 
</para><variablelist role="params">
117
 
<varlistentry><term><parameter>enum_type</parameter>&#160;:</term>
118
 
<listitem><simpara>    a <link linkend="GType"><type>GType</type></link>
119
 
</simpara></listitem></varlistentry>
120
 
<varlistentry><term><parameter>descriptions</parameter>&#160;:</term>
121
 
<listitem><simpara> a <link linkend="NULL--CAPS"><literal>NULL</literal></link> terminated constant static array of <link linkend="GimpEnumDesc"><type>GimpEnumDesc</type></link>
122
 
</simpara></listitem></varlistentry>
123
 
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
124
 
<refsect2 id="gimp-enum-get-value-descriptions" role="function" condition="since:GIMP 2.2">
125
 
<title>gimp_enum_get_value_descriptions ()</title>
126
 
<indexterm zone="gimp-enum-get-value-descriptions" role="GIMP 2.2"><primary sortas="gimp_enum_get_value_descriptions">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>
127
 
<para>
128
 
Retreives the array of human readable and translatable descriptions
129
 
and help texts for enum values.</para>
130
 
<para>
131
 
</para><variablelist role="params">
132
 
<varlistentry><term><parameter>enum_type</parameter>&#160;:</term>
133
 
<listitem><simpara> a <link linkend="GType"><type>GType</type></link>
134
 
</simpara></listitem></varlistentry>
135
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="NULL--CAPS"><literal>NULL</literal></link> terminated constant array of <link linkend="GimpEnumDesc"><type>GimpEnumDesc</type></link>
136
 
 
137
 
</simpara></listitem></varlistentry>
138
 
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
139
 
<refsect2 id="gimp-flags-get-value-descriptions" role="function" condition="since:GIMP 2.2">
140
 
<title>gimp_flags_get_value_descriptions ()</title>
141
 
<indexterm zone="gimp-flags-get-value-descriptions" role="GIMP 2.2"><primary sortas="gimp_flags_get_value_descriptions">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>
142
 
<para>
143
 
Retreives the array of human readable and translatable descriptions
144
 
and help texts for flags values.</para>
145
 
<para>
146
 
</para><variablelist role="params">
147
 
<varlistentry><term><parameter>flags_type</parameter>&#160;:</term>
148
 
<listitem><simpara> a <link linkend="GType"><type>GType</type></link>
149
 
</simpara></listitem></varlistentry>
150
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="NULL--CAPS"><literal>NULL</literal></link> terminated constant array of <link linkend="GimpFlagsDesc"><type>GimpFlagsDesc</type></link>
151
 
 
152
 
</simpara></listitem></varlistentry>
153
 
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
154
 
<refsect2 id="gimp-flags-set-value-descriptions" role="function" condition="since:GIMP 2.2">
155
 
<title>gimp_flags_set_value_descriptions ()</title>
156
 
<indexterm zone="gimp-flags-set-value-descriptions" role="GIMP 2.2"><primary sortas="gimp_flags_set_value_descriptions">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,
157
 
                                                         const <link linkend="GimpFlagsDesc">GimpFlagsDesc</link> *descriptions);</programlisting>
158
 
<para>
159
 
Sets the array of human readable and translatable descriptions
160
 
and help texts for flags values.</para>
161
 
<para>
162
 
</para><variablelist role="params">
163
 
<varlistentry><term><parameter>flags_type</parameter>&#160;:</term>
164
 
<listitem><simpara>   a <link linkend="GType"><type>GType</type></link>
165
 
</simpara></listitem></varlistentry>
166
 
<varlistentry><term><parameter>descriptions</parameter>&#160;:</term>
167
 
<listitem><simpara> a <link linkend="NULL--CAPS"><literal>NULL</literal></link> terminated constant static array of <link linkend="GimpFlagsDesc"><type>GimpFlagsDesc</type></link>
168
 
</simpara></listitem></varlistentry>
169
 
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
170
 
 
171
 
</refsect1>
172
 
 
173
 
 
174
 
 
175
 
 
176
 
</refentry>