← 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/gimpenumcombobox.xml

  • Committer: Bazaar Package Importer
  • Author(s): Robert Ancell
  • Date: 2009-08-31 10:24:10 UTC
  • mfrom: (0.2.2 upstream)
  • mto: This revision was merged to the branch mainline in revision 48.
  • Revision ID: james.westby@ubuntu.com-20090831102410-5ne3s5jnk79y3hs5
Tags: upstream-2.6.7
Import upstream version 2.6.7

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimpwidgets/xml/gimpenumcombobox.xml
12
12
<refnamediv>
13
13
<refname>GimpEnumComboBox</refname>
14
14
<refpurpose></refpurpose>
15
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
16
15
</refnamediv>
17
16
 
18
17
<refsynopsisdiv id="GimpEnumComboBox.synopsis" role="synopsis">
20
19
 
21
20
<synopsis>
22
21
                    <link linkend="GimpEnumComboBox-struct">GimpEnumComboBox</link>;
23
 
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="gimp-enum-combo-box-new">gimp_enum_combo_box_new</link>             (<link linkend="GType">GType</link> enum_type);
24
 
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="gimp-enum-combo-box-new-with-model">gimp_enum_combo_box_new_with_model</link>  (<link linkend="GimpEnumStore">GimpEnumStore</link> *enum_store);
 
22
<link linkend="GtkWidget">GtkWidget</link> *         <link linkend="gimp-enum-combo-box-new">gimp_enum_combo_box_new</link>             (<link linkend="GType">GType</link> enum_type);
 
23
<link linkend="GtkWidget">GtkWidget</link> *         <link linkend="gimp-enum-combo-box-new-with-model">gimp_enum_combo_box_new_with_model</link>  (<link linkend="GimpEnumStore">GimpEnumStore</link> *enum_store);
25
24
<link linkend="void">void</link>                <link linkend="gimp-enum-combo-box-set-stock-prefix">gimp_enum_combo_box_set_stock_prefix</link>
26
25
                                                        (<link linkend="GimpEnumComboBox">GimpEnumComboBox</link> *combo_box,
27
26
                                                         const <link linkend="gchar">gchar</link> *stock_prefix);
41
40
                                       +----<link linkend="GimpIntComboBox">GimpIntComboBox</link>
42
41
                                             +----GimpEnumComboBox
43
42
</synopsis>
44
 
 
45
43
</refsect1>
46
44
 
47
45
 
50
48
<title role="impl_interfaces.title">Implemented Interfaces</title>
51
49
<para>
52
50
GimpEnumComboBox implements
53
 
 <link linkend="AtkImplementorIface">AtkImplementorIface</link>,  <link linkend="GtkBuildable">GtkBuildable</link>,  <link linkend="GtkCellEditable">GtkCellEditable</link> and  <link linkend="GtkCellLayout">GtkCellLayout</link>.</para>
54
 
 
 
51
 <link linkend="GtkBuildable">GtkBuildable</link>,  <link linkend="AtkImplementorIface">AtkImplementorIface</link>,  <link linkend="GtkCellEditable">GtkCellEditable</link> and  <link linkend="GtkCellLayout">GtkCellLayout</link>.</para>
55
52
</refsect1>
56
53
 
57
54
 
67
64
<refsect1 id="GimpEnumComboBox.description" role="desc">
68
65
<title role="desc.title">Description</title>
69
66
<para>
70
 
 
71
67
</para>
72
68
</refsect1>
73
69
 
75
71
<title role="details.title">Details</title>
76
72
<refsect2 id="GimpEnumComboBox-struct" role="struct">
77
73
<title>GimpEnumComboBox</title>
78
 
<indexterm zone="GimpEnumComboBox-struct"><primary>GimpEnumComboBox</primary></indexterm><programlisting>typedef struct _GimpEnumComboBox GimpEnumComboBox;</programlisting>
 
74
<indexterm zone="GimpEnumComboBox-struct"><primary sortas="GimpEnumComboBox">GimpEnumComboBox</primary></indexterm><programlisting>typedef struct _GimpEnumComboBox GimpEnumComboBox;</programlisting>
79
75
<para>
80
 
 
81
76
</para></refsect2>
82
77
<refsect2 id="gimp-enum-combo-box-new" role="function" condition="since:GIMP 2.4">
83
78
<title>gimp_enum_combo_box_new ()</title>
84
 
<indexterm zone="gimp-enum-combo-box-new" role="GIMP 2.4"><primary>gimp_enum_combo_box_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          gimp_enum_combo_box_new             (<link linkend="GType">GType</link> enum_type);</programlisting>
 
79
<indexterm zone="gimp-enum-combo-box-new" role="GIMP 2.4"><primary sortas="gimp_enum_combo_box_new">gimp_enum_combo_box_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> *         gimp_enum_combo_box_new             (<link linkend="GType">GType</link> enum_type);</programlisting>
85
80
<para>
86
81
Creates a <link linkend="GtkComboBox"><type>GtkComboBox</type></link> readily filled with all enum values from a
87
82
given <parameter>enum_type</parameter>. The enum needs to be registered to the type
94
89
the enum values that appear in the combo_box, you can create your
95
90
own <link linkend="GimpEnumStore"><type>GimpEnumStore</type></link> and use <link linkend="gimp-enum-combo-box-new-with-model"><function>gimp_enum_combo_box_new_with_model()</function></link>.</para>
96
91
<para>
97
 
 
98
92
</para><variablelist role="params">
99
 
<varlistentry><term><parameter>enum_type</parameter>&nbsp;:</term>
 
93
<varlistentry><term><parameter>enum_type</parameter>&#160;:</term>
100
94
<listitem><simpara> the <link linkend="GType"><type>GType</type></link> of an enum.
101
95
</simpara></listitem></varlistentry>
102
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="GimpEnumComboBox"><type>GimpEnumComboBox</type></link>.
 
96
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="GimpEnumComboBox"><type>GimpEnumComboBox</type></link>.
103
97
 
104
98
</simpara></listitem></varlistentry>
105
 
</variablelist><para role="since">Since  GIMP 2.4
106
 
</para></refsect2>
 
99
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
107
100
<refsect2 id="gimp-enum-combo-box-new-with-model" role="function" condition="since:GIMP 2.4">
108
101
<title>gimp_enum_combo_box_new_with_model ()</title>
109
 
<indexterm zone="gimp-enum-combo-box-new-with-model" role="GIMP 2.4"><primary>gimp_enum_combo_box_new_with_model</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          gimp_enum_combo_box_new_with_model  (<link linkend="GimpEnumStore">GimpEnumStore</link> *enum_store);</programlisting>
 
102
<indexterm zone="gimp-enum-combo-box-new-with-model" role="GIMP 2.4"><primary sortas="gimp_enum_combo_box_new_with_model">gimp_enum_combo_box_new_with_model</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> *         gimp_enum_combo_box_new_with_model  (<link linkend="GimpEnumStore">GimpEnumStore</link> *enum_store);</programlisting>
110
103
<para>
111
104
Creates a <link linkend="GtkComboBox"><type>GtkComboBox</type></link> for the given <parameter>enum_store</parameter>.</para>
112
105
<para>
113
 
 
114
106
</para><variablelist role="params">
115
 
<varlistentry><term><parameter>enum_store</parameter>&nbsp;:</term>
 
107
<varlistentry><term><parameter>enum_store</parameter>&#160;:</term>
116
108
<listitem><simpara> a <link linkend="GimpEnumStore"><type>GimpEnumStore</type></link> to use as the model
117
109
</simpara></listitem></varlistentry>
118
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="GimpEnumComboBox"><type>GimpEnumComboBox</type></link>.
 
110
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="GimpEnumComboBox"><type>GimpEnumComboBox</type></link>.
119
111
 
120
112
</simpara></listitem></varlistentry>
121
 
</variablelist><para role="since">Since  GIMP 2.4
122
 
</para></refsect2>
 
113
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
123
114
<refsect2 id="gimp-enum-combo-box-set-stock-prefix" role="function" condition="since:GIMP 2.4">
124
115
<title>gimp_enum_combo_box_set_stock_prefix ()</title>
125
 
<indexterm zone="gimp-enum-combo-box-set-stock-prefix" role="GIMP 2.4"><primary>gimp_enum_combo_box_set_stock_prefix</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_enum_combo_box_set_stock_prefix
 
116
<indexterm zone="gimp-enum-combo-box-set-stock-prefix" role="GIMP 2.4"><primary sortas="gimp_enum_combo_box_set_stock_prefix">gimp_enum_combo_box_set_stock_prefix</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_enum_combo_box_set_stock_prefix
126
117
                                                        (<link linkend="GimpEnumComboBox">GimpEnumComboBox</link> *combo_box,
127
118
                                                         const <link linkend="gchar">gchar</link> *stock_prefix);</programlisting>
128
119
<para>
129
120
Attempts to create stock icons for all items in the <parameter>combo_box</parameter>. See
130
121
<link linkend="gimp-enum-store-set-icons"><function>gimp_enum_store_set_icons()</function></link> to find out what to use as <parameter>stock_prefix</parameter>.</para>
131
122
<para>
132
 
 
133
123
</para><variablelist role="params">
134
 
<varlistentry><term><parameter>combo_box</parameter>&nbsp;:</term>
 
124
<varlistentry><term><parameter>combo_box</parameter>&#160;:</term>
135
125
<listitem><simpara>    a <link linkend="GimpEnumComboBox"><type>GimpEnumComboBox</type></link>
136
126
</simpara></listitem></varlistentry>
137
 
<varlistentry><term><parameter>stock_prefix</parameter>&nbsp;:</term>
 
127
<varlistentry><term><parameter>stock_prefix</parameter>&#160;:</term>
138
128
<listitem><simpara> a prefix to create icon stock ID from enum values
139
129
</simpara></listitem></varlistentry>
140
 
</variablelist><para role="since">Since  GIMP 2.4
141
 
</para></refsect2>
 
130
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
142
131
 
143
132
</refsect1>
144
133
<refsect1 id="GimpEnumComboBox.property-details" role="property_details">
145
134
<title role="property_details.title">Property Details</title>
146
 
<refsect2 id="GimpEnumComboBox--model"><title>The <literal>&quot;model&quot;</literal> property</title>
147
 
<indexterm zone="GimpEnumComboBox--model"><primary>GimpEnumComboBox:model</primary></indexterm><programlisting>  &quot;model&quot;                    <link linkend="GimpEnumStore">GimpEnumStore</link>*        : Read / Write</programlisting>
 
135
<refsect2 id="GimpEnumComboBox--model" role="property"><title>The <literal>&quot;model&quot;</literal> property</title>
 
136
<indexterm zone="GimpEnumComboBox--model"><primary sortas="GimpEnumComboBox:model">GimpEnumComboBox:model</primary></indexterm><programlisting>  &quot;model&quot;                    <link linkend="GimpEnumStore">GimpEnumStore</link>*        : Read / Write</programlisting>
148
137
<para></para></refsect2>
149
 
 
150
138
</refsect1>
151
139
 
152
140