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">
5
<refentry id="GimpEnumComboBox">
7
<refentrytitle role="top_of_page">GimpEnumComboBox</refentrytitle>
8
<manvolnum>3</manvolnum>
9
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
13
<refname>GimpEnumComboBox</refname>
14
<refpurpose></refpurpose>
15
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
18
<refsynopsisdiv role="synopsis">
19
<title role="synopsis.title">Synopsis</title>
25
<link linkend="GimpEnumComboBox-struct">GimpEnumComboBox</link>;
26
<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);
27
<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);
28
<link linkend="void">void</link> <link linkend="gimp-enum-combo-box-set-stock-prefix">gimp_enum_combo_box_set_stock_prefix</link>
29
(<link linkend="GimpEnumComboBox">GimpEnumComboBox</link> *combo_box,
30
const <link linkend="gchar">gchar</link> *stock_prefix);
35
<refsect1 role="object_hierarchy">
36
<title role="object_hierarchy.title">Object Hierarchy</title>
39
<link linkend="GObject">GObject</link>
40
+----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
41
+----<link linkend="GtkObject">GtkObject</link>
42
+----<link linkend="GtkWidget">GtkWidget</link>
43
+----<link linkend="GtkContainer">GtkContainer</link>
44
+----<link linkend="GtkBin">GtkBin</link>
45
+----<link linkend="GtkComboBox">GtkComboBox</link>
46
+----<link linkend="GimpIntComboBox">GimpIntComboBox</link>
54
<refsect1 role="impl_interfaces">
55
<title role="impl_interfaces.title">Implemented Interfaces</title>
57
GimpEnumComboBox implements
58
<link linkend="AtkImplementorIface">AtkImplementorIface</link>, <link linkend="GtkCellEditable">GtkCellEditable</link> and <link linkend="GtkCellLayout">GtkCellLayout</link>.</para>
63
<refsect1 role="properties">
64
<title role="properties.title">Properties</title>
67
"<link linkend="GimpEnumComboBox--model">model</link>" <link linkend="GimpEnumStore">GimpEnumStore</link> : Read / Write
73
<refsect1 role="desc">
74
<title role="desc.title">Description</title>
80
<refsect1 role="details">
81
<title role="details.title">Details</title>
83
<title><anchor id="GimpEnumComboBox-struct" role="struct"/>GimpEnumComboBox</title>
84
<indexterm><primary>GimpEnumComboBox</primary></indexterm><programlisting>typedef struct _GimpEnumComboBox GimpEnumComboBox;</programlisting>
89
<title><anchor id="gimp-enum-combo-box-new" role="function" condition="since:GIMP 2.4"/>gimp_enum_combo_box_new ()</title>
90
<indexterm 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>
92
Creates a <link linkend="GtkComboBox"><type>GtkComboBox</type></link> readily filled with all enum values from a
93
given <parameter>enum_type</parameter>. The enum needs to be registered to the type
94
system. It should also have <link linkend="GimpEnumDesc"><literal>GimpEnumDesc</literal></link> descriptions registered
95
that contain translatable value names. This is the case for the
96
enums used in the GIMP PDB functions.
99
This is just a convenience function. If you need more control over
100
the enum values that appear in the combo_box, you can create your
101
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>
104
</para><variablelist role="params">
105
<varlistentry><term><parameter>enum_type</parameter> :</term>
106
<listitem><simpara> the <link linkend="GType"><type>GType</type></link> of an enum.
107
</simpara></listitem></varlistentry>
108
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="GimpEnumComboBox"><type>GimpEnumComboBox</type></link>.
110
</simpara></listitem></varlistentry>
111
</variablelist><para role="since">Since GIMP 2.4
114
<title><anchor id="gimp-enum-combo-box-new-with-model" role="function" condition="since:GIMP 2.4"/>gimp_enum_combo_box_new_with_model ()</title>
115
<indexterm 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>
117
Creates a <link linkend="GtkComboBox"><type>GtkComboBox</type></link> for the given <parameter>enum_store</parameter>.</para>
120
</para><variablelist role="params">
121
<varlistentry><term><parameter>enum_store</parameter> :</term>
122
<listitem><simpara> a <link linkend="GimpEnumStore"><type>GimpEnumStore</type></link> to use as the model
123
</simpara></listitem></varlistentry>
124
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="GimpEnumComboBox"><type>GimpEnumComboBox</type></link>.
126
</simpara></listitem></varlistentry>
127
</variablelist><para role="since">Since GIMP 2.4
130
<title><anchor id="gimp-enum-combo-box-set-stock-prefix" role="function" condition="since:GIMP 2.4"/>gimp_enum_combo_box_set_stock_prefix ()</title>
131
<indexterm 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
132
(<link linkend="GimpEnumComboBox">GimpEnumComboBox</link> *combo_box,
133
const <link linkend="gchar">gchar</link> *stock_prefix);</programlisting>
135
Attempts to create stock icons for all items in the <parameter>combo_box</parameter>. See
136
<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>
139
</para><variablelist role="params">
140
<varlistentry><term><parameter>combo_box</parameter> :</term>
141
<listitem><simpara> a <link linkend="GimpEnumComboBox"><type>GimpEnumComboBox</type></link>
142
</simpara></listitem></varlistentry>
143
<varlistentry><term><parameter>stock_prefix</parameter> :</term>
144
<listitem><simpara> a prefix to create icon stock ID from enum values
145
</simpara></listitem></varlistentry>
146
</variablelist><para role="since">Since GIMP 2.4
150
<refsect1 role="property_details">
151
<title role="property_details.title">Property Details</title>
152
<refsect2><title><anchor id="GimpEnumComboBox--model"/>The "<literal>model</literal>" property</title>
153
<indexterm><primary>GimpEnumComboBox:model</primary></indexterm><programlisting> "model" <link linkend="GimpEnumStore">GimpEnumStore</link> : Read / Write</programlisting>
154
<para></para></refsect2>
added
removed
devel-docs/libgimpwidgets/xml/gimpenumcombobox.xml
