← Back to branch summary

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

« back to all changes in this revision

Viewing changes to devel-docs/libgimpwidgets/xml/gimpcolorprofilecombobox.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/libgimpwidgets/xml/gimpcolorprofilecombobox.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="GimpColorProfileComboBox">
6
 
<refmeta>
7
 
<refentrytitle role="top_of_page" id="GimpColorProfileComboBox.top_of_page">GimpColorProfileComboBox</refentrytitle>
8
 
<manvolnum>3</manvolnum>
9
 
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
10
 
</refmeta>
11
 
 
12
 
<refnamediv>
13
 
<refname>GimpColorProfileComboBox</refname>
14
 
<refpurpose></refpurpose>
15
 
</refnamediv>
16
 
 
17
 
<refsynopsisdiv id="GimpColorProfileComboBox.synopsis" role="synopsis">
18
 
<title role="synopsis.title">Synopsis</title>
19
 
 
20
 
<synopsis>
21
 
                    <link linkend="GimpColorProfileComboBox-struct">GimpColorProfileComboBox</link>;
22
 
<link linkend="GtkWidget">GtkWidget</link> *         <link linkend="gimp-color-profile-combo-box-new">gimp_color_profile_combo_box_new</link>    (<link linkend="GtkWidget">GtkWidget</link> *dialog,
23
 
                                                         const <link linkend="gchar">gchar</link> *history);
24
 
<link linkend="GtkWidget">GtkWidget</link> *         <link linkend="gimp-color-profile-combo-box-new-with-model">gimp_color_profile_combo_box_new_with_model</link>
25
 
                                                        (<link linkend="GtkWidget">GtkWidget</link> *dialog,
26
 
                                                         <link linkend="GtkTreeModel">GtkTreeModel</link> *model);
27
 
<link linkend="void">void</link>                <link linkend="gimp-color-profile-combo-box-add">gimp_color_profile_combo_box_add</link>    (<link linkend="GimpColorProfileComboBox">GimpColorProfileComboBox</link> *combo,
28
 
                                                         const <link linkend="gchar">gchar</link> *filename,
29
 
                                                         const <link linkend="gchar">gchar</link> *label);
30
 
<link linkend="void">void</link>                <link linkend="gimp-color-profile-combo-box-set-active">gimp_color_profile_combo_box_set_active</link>
31
 
                                                        (<link linkend="GimpColorProfileComboBox">GimpColorProfileComboBox</link> *combo,
32
 
                                                         const <link linkend="gchar">gchar</link> *filename,
33
 
                                                         const <link linkend="gchar">gchar</link> *label);
34
 
<link linkend="gchar">gchar</link> *             <link linkend="gimp-color-profile-combo-box-get-active">gimp_color_profile_combo_box_get_active</link>
35
 
                                                        (<link linkend="GimpColorProfileComboBox">GimpColorProfileComboBox</link> *combo);
36
 
</synopsis>
37
 
</refsynopsisdiv>
38
 
 
39
 
<refsect1 id="GimpColorProfileComboBox.object-hierarchy" role="object_hierarchy">
40
 
<title role="object_hierarchy.title">Object Hierarchy</title>
41
 
<synopsis>
42
 
  <link linkend="GObject">GObject</link>
43
 
   +----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
44
 
         +----<link linkend="GtkObject">GtkObject</link>
45
 
               +----<link linkend="GtkWidget">GtkWidget</link>
46
 
                     +----<link linkend="GtkContainer">GtkContainer</link>
47
 
                           +----<link linkend="GtkBin">GtkBin</link>
48
 
                                 +----<link linkend="GtkComboBox">GtkComboBox</link>
49
 
                                       +----GimpColorProfileComboBox
50
 
</synopsis>
51
 
</refsect1>
52
 
 
53
 
 
54
 
 
55
 
<refsect1 id="GimpColorProfileComboBox.implemented-interfaces" role="impl_interfaces">
56
 
<title role="impl_interfaces.title">Implemented Interfaces</title>
57
 
<para>
58
 
GimpColorProfileComboBox implements
59
 
 <link linkend="GtkBuildable">GtkBuildable</link>,  <link linkend="AtkImplementorIface">AtkImplementorIface</link>,  <link linkend="GtkCellEditable">GtkCellEditable</link> and  <link linkend="GtkCellLayout">GtkCellLayout</link>.</para>
60
 
</refsect1>
61
 
 
62
 
 
63
 
<refsect1 id="GimpColorProfileComboBox.properties" role="properties">
64
 
<title role="properties.title">Properties</title>
65
 
<synopsis>
66
 
  &quot;<link linkend="GimpColorProfileComboBox--dialog">dialog</link>&quot;                   <link linkend="GtkDialog">GtkDialog</link>*            : Read / Write / Construct Only
67
 
  &quot;<link linkend="GimpColorProfileComboBox--model">model</link>&quot;                    <link linkend="GimpColorProfileStore">GimpColorProfileStore</link>*  : Read / Write
68
 
</synopsis>
69
 
</refsect1>
70
 
 
71
 
 
72
 
 
73
 
<refsect1 id="GimpColorProfileComboBox.description" role="desc">
74
 
<title role="desc.title">Description</title>
75
 
<para>
76
 
</para>
77
 
</refsect1>
78
 
 
79
 
<refsect1 id="GimpColorProfileComboBox.details" role="details">
80
 
<title role="details.title">Details</title>
81
 
<refsect2 id="GimpColorProfileComboBox-struct" role="struct">
82
 
<title>GimpColorProfileComboBox</title>
83
 
<indexterm zone="GimpColorProfileComboBox-struct"><primary sortas="GimpColorProfileComboBox">GimpColorProfileComboBox</primary></indexterm><programlisting>typedef struct _GimpColorProfileComboBox GimpColorProfileComboBox;</programlisting>
84
 
<para>
85
 
</para></refsect2>
86
 
<refsect2 id="gimp-color-profile-combo-box-new" role="function" condition="since:GIMP 2.4">
87
 
<title>gimp_color_profile_combo_box_new ()</title>
88
 
<indexterm zone="gimp-color-profile-combo-box-new" role="GIMP 2.4"><primary sortas="gimp_color_profile_combo_box_new">gimp_color_profile_combo_box_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> *         gimp_color_profile_combo_box_new    (<link linkend="GtkWidget">GtkWidget</link> *dialog,
89
 
                                                         const <link linkend="gchar">gchar</link> *history);</programlisting>
90
 
<para>
91
 
Create a combo-box widget for selecting color profiles. The combo-box
92
 
is populated from the file specified as <parameter>history</parameter>. This filename is
93
 
typically created using the following code snippet:
94
 
<informalexample><programlisting>
95
 
 gchar *history = gimp_personal_rc_file ("profilerc");
96
 
</programlisting></informalexample></para>
97
 
<para>
98
 
</para><variablelist role="params">
99
 
<varlistentry><term><parameter>dialog</parameter>&#160;:</term>
100
 
<listitem><simpara>  a <link linkend="GtkDialog"><type>GtkDialog</type></link> to present when the user selects the
101
 
          "Select color profile from disk..." item
102
 
</simpara></listitem></varlistentry>
103
 
<varlistentry><term><parameter>history</parameter>&#160;:</term>
104
 
<listitem><simpara> filename of the profilerc (or <link linkend="NULL--CAPS"><literal>NULL</literal></link> for no history)
105
 
</simpara></listitem></varlistentry>
106
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="GimpColorProfileComboBox"><type>GimpColorProfileComboBox</type></link>.
107
 
 
108
 
</simpara></listitem></varlistentry>
109
 
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
110
 
<refsect2 id="gimp-color-profile-combo-box-new-with-model" role="function" condition="since:GIMP 2.4">
111
 
<title>gimp_color_profile_combo_box_new_with_model ()</title>
112
 
<indexterm zone="gimp-color-profile-combo-box-new-with-model" role="GIMP 2.4"><primary sortas="gimp_color_profile_combo_box_new_with_model">gimp_color_profile_combo_box_new_with_model</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> *         gimp_color_profile_combo_box_new_with_model
113
 
                                                        (<link linkend="GtkWidget">GtkWidget</link> *dialog,
114
 
                                                         <link linkend="GtkTreeModel">GtkTreeModel</link> *model);</programlisting>
115
 
<para>
116
 
This constructor is useful when you want to create several
117
 
combo-boxes for profile selection that all share the same
118
 
<link linkend="GimpColorProfileStore"><type>GimpColorProfileStore</type></link>. This is for example done in the
119
 
GIMP Preferences dialog.
120
 
</para>
121
 
<para>
122
 
See also <link linkend="gimp-color-profile-combo-box-new"><function>gimp_color_profile_combo_box_new()</function></link>.</para>
123
 
<para>
124
 
</para><variablelist role="params">
125
 
<varlistentry><term><parameter>dialog</parameter>&#160;:</term>
126
 
<listitem><simpara> a <link linkend="GtkDialog"><type>GtkDialog</type></link> to present when the user selects the
127
 
         "Select color profile from disk..." item
128
 
</simpara></listitem></varlistentry>
129
 
<varlistentry><term><parameter>model</parameter>&#160;:</term>
130
 
<listitem><simpara>  a <link linkend="GimpColorProfileStore"><type>GimpColorProfileStore</type></link> object
131
 
</simpara></listitem></varlistentry>
132
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="GimpColorProfileComboBox"><type>GimpColorProfileComboBox</type></link>.
133
 
 
134
 
</simpara></listitem></varlistentry>
135
 
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
136
 
<refsect2 id="gimp-color-profile-combo-box-add" role="function" condition="since:GIMP 2.4">
137
 
<title>gimp_color_profile_combo_box_add ()</title>
138
 
<indexterm zone="gimp-color-profile-combo-box-add" role="GIMP 2.4"><primary sortas="gimp_color_profile_combo_box_add">gimp_color_profile_combo_box_add</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_color_profile_combo_box_add    (<link linkend="GimpColorProfileComboBox">GimpColorProfileComboBox</link> *combo,
139
 
                                                         const <link linkend="gchar">gchar</link> *filename,
140
 
                                                         const <link linkend="gchar">gchar</link> *label);</programlisting>
141
 
<para>
142
 
This function delegates to the underlying
143
 
<link linkend="GimpColorProfileStore"><type>GimpColorProfileStore</type></link>. Please refer to the documentation of
144
 
<link linkend="gimp-color-profile-store-add"><function>gimp_color_profile_store_add()</function></link> for details.</para>
145
 
<para>
146
 
</para><variablelist role="params">
147
 
<varlistentry><term><parameter>combo</parameter>&#160;:</term>
148
 
<listitem><simpara>    a <link linkend="GimpColorProfileComboBox"><type>GimpColorProfileComboBox</type></link>
149
 
</simpara></listitem></varlistentry>
150
 
<varlistentry><term><parameter>filename</parameter>&#160;:</term>
151
 
<listitem><simpara> filename of the profile to add (or <link linkend="NULL--CAPS"><literal>NULL</literal></link>)
152
 
</simpara></listitem></varlistentry>
153
 
<varlistentry><term><parameter>label</parameter>&#160;:</term>
154
 
<listitem><simpara>    label to use for the profile
155
 
           (may only be <link linkend="NULL--CAPS"><literal>NULL</literal></link> if <parameter>filename</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link>)
156
 
</simpara></listitem></varlistentry>
157
 
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
158
 
<refsect2 id="gimp-color-profile-combo-box-set-active" role="function" condition="since:GIMP 2.4">
159
 
<title>gimp_color_profile_combo_box_set_active ()</title>
160
 
<indexterm zone="gimp-color-profile-combo-box-set-active" role="GIMP 2.4"><primary sortas="gimp_color_profile_combo_box_set_active">gimp_color_profile_combo_box_set_active</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_color_profile_combo_box_set_active
161
 
                                                        (<link linkend="GimpColorProfileComboBox">GimpColorProfileComboBox</link> *combo,
162
 
                                                         const <link linkend="gchar">gchar</link> *filename,
163
 
                                                         const <link linkend="gchar">gchar</link> *label);</programlisting>
164
 
<para>
165
 
Selects a color profile from the <parameter>combo</parameter> and makes it the active
166
 
item.  If the profile is not listed in the <parameter>combo</parameter>, then it is added
167
 
with the given <parameter>label</parameter> (or <parameter>filename</parameter> in case that <parameter>label</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link>).</para>
168
 
<para>
169
 
</para><variablelist role="params">
170
 
<varlistentry><term><parameter>combo</parameter>&#160;:</term>
171
 
<listitem><simpara>    a <link linkend="GimpColorProfileComboBox"><type>GimpColorProfileComboBox</type></link>
172
 
</simpara></listitem></varlistentry>
173
 
<varlistentry><term><parameter>filename</parameter>&#160;:</term>
174
 
<listitem><simpara> filename of the profile to select
175
 
</simpara></listitem></varlistentry>
176
 
<varlistentry><term><parameter>label</parameter>&#160;:</term>
177
 
<listitem><simpara>    label to use when adding a new entry (can be <link linkend="NULL--CAPS"><literal>NULL</literal></link>)
178
 
</simpara></listitem></varlistentry>
179
 
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
180
 
<refsect2 id="gimp-color-profile-combo-box-get-active" role="function" condition="since:GIMP 2.4">
181
 
<title>gimp_color_profile_combo_box_get_active ()</title>
182
 
<indexterm zone="gimp-color-profile-combo-box-get-active" role="GIMP 2.4"><primary sortas="gimp_color_profile_combo_box_get_active">gimp_color_profile_combo_box_get_active</primary></indexterm><programlisting><link linkend="gchar">gchar</link> *             gimp_color_profile_combo_box_get_active
183
 
                                                        (<link linkend="GimpColorProfileComboBox">GimpColorProfileComboBox</link> *combo);</programlisting>
184
 
<para>
185
 
</para>
186
 
<para>
187
 
</para><variablelist role="params">
188
 
<varlistentry><term><parameter>combo</parameter>&#160;:</term>
189
 
<listitem><simpara> a <link linkend="GimpColorProfileComboBox"><type>GimpColorProfileComboBox</type></link>
190
 
</simpara></listitem></varlistentry>
191
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The filename of the currently selected color profile.
192
 
              This is a newly allocated string and should be released
193
 
              using <link linkend="g-free"><function>g_free()</function></link> when it is not any longer needed.
194
 
 
195
 
</simpara></listitem></varlistentry>
196
 
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
197
 
 
198
 
</refsect1>
199
 
<refsect1 id="GimpColorProfileComboBox.property-details" role="property_details">
200
 
<title role="property_details.title">Property Details</title>
201
 
<refsect2 id="GimpColorProfileComboBox--dialog" role="property"><title>The <literal>&quot;dialog&quot;</literal> property</title>
202
 
<indexterm zone="GimpColorProfileComboBox--dialog" role="GIMP 2.4"><primary sortas="GimpColorProfileComboBox:dialog">GimpColorProfileComboBox:dialog</primary></indexterm><programlisting>  &quot;dialog&quot;                   <link linkend="GtkDialog">GtkDialog</link>*            : Read / Write / Construct Only</programlisting>
203
 
<para>
204
 
<link linkend="GtkDialog"><type>GtkDialog</type></link> to present when the user selects the
205
 
"Select color profile from disk..." item.</para>
206
 
<para>
207
 
</para><para>Since GIMP 2.4</para>
208
 
</refsect2>
209
 
<refsect2 id="GimpColorProfileComboBox--model" role="property"><title>The <literal>&quot;model&quot;</literal> property</title>
210
 
<indexterm zone="GimpColorProfileComboBox--model" role="GIMP 2.4"><primary sortas="GimpColorProfileComboBox:model">GimpColorProfileComboBox:model</primary></indexterm><programlisting>  &quot;model&quot;                    <link linkend="GimpColorProfileStore">GimpColorProfileStore</link>*  : Read / Write</programlisting>
211
 
<para>
212
 
Overrides the "model" property of the <link linkend="GtkComboBox"><type>GtkComboBox</type></link> class.
213
 
<link linkend="GimpColorProfileComboBox"><type>GimpColorProfileComboBox</type></link> requires the model to be a
214
 
<link linkend="GimpColorProfileStore"><type>GimpColorProfileStore</type></link>.</para>
215
 
<para>
216
 
</para><para>Since GIMP 2.4</para>
217
 
</refsect2>
218
 
</refsect1>
219
 
 
220
 
 
221
 
 
222
 
 
223
 
</refentry>