File: gimpenumcombobox.xml

package info (click to toggle)
gimp 2.4.7-1
  • links: PTS, VCS
  • area: main
  • in suites: lenny
  • size: 130,648 kB
  • ctags: 50,475
  • sloc: ansic: 607,353; xml: 48,593; lisp: 10,881; sh: 9,811; makefile: 9,583; python: 3,333; perl: 2,683; yacc: 523; lex: 340
file content (155 lines) | stat: -rw-r--r-- 8,385 bytes parent folder | download
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
<?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="GimpEnumComboBox">
<refmeta>
<refentrytitle role="top_of_page" id="GimpEnumComboBox.top_of_page">GimpEnumComboBox</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>GimpEnumComboBox</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

<refsynopsisdiv id="GimpEnumComboBox.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>
                    <link linkend="GimpEnumComboBox-struct">GimpEnumComboBox</link>;
<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);
<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);
<link linkend="void">void</link>                <link linkend="gimp-enum-combo-box-set-stock-prefix">gimp_enum_combo_box_set_stock_prefix</link>
                                                        (<link linkend="GimpEnumComboBox">GimpEnumComboBox</link> *combo_box,
                                                         const <link linkend="gchar">gchar</link> *stock_prefix);
</synopsis>
</refsynopsisdiv>

<refsect1 id="GimpEnumComboBox.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
  <link linkend="GObject">GObject</link>
   +----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
         +----<link linkend="GtkObject">GtkObject</link>
               +----<link linkend="GtkWidget">GtkWidget</link>
                     +----<link linkend="GtkContainer">GtkContainer</link>
                           +----<link linkend="GtkBin">GtkBin</link>
                                 +----<link linkend="GtkComboBox">GtkComboBox</link>
                                       +----<link linkend="GimpIntComboBox">GimpIntComboBox</link>
                                             +----GimpEnumComboBox
</synopsis>

</refsect1>



<refsect1 id="GimpEnumComboBox.implemented-interfaces" role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
GimpEnumComboBox implements
 <link linkend="AtkImplementorIface">AtkImplementorIface</link>,  <link linkend="GtkBuildable">GtkBuildable</link>,  <link linkend="GtkCellEditable">GtkCellEditable</link> and  <link linkend="GtkCellLayout">GtkCellLayout</link>.</para>

</refsect1>


<refsect1 id="GimpEnumComboBox.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
  &quot;<link linkend="GimpEnumComboBox--model">model</link>&quot;                    <link linkend="GimpEnumStore">GimpEnumStore</link>*        : Read / Write
</synopsis>
</refsect1>



<refsect1 id="GimpEnumComboBox.description" role="desc">
<title role="desc.title">Description</title>
<para>

</para>
</refsect1>

<refsect1 id="GimpEnumComboBox.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="GimpEnumComboBox-struct" role="struct">
<title>GimpEnumComboBox</title>
<indexterm zone="GimpEnumComboBox-struct"><primary>GimpEnumComboBox</primary></indexterm><programlisting>typedef struct _GimpEnumComboBox GimpEnumComboBox;</programlisting>
<para>

</para></refsect2>
<refsect2 id="gimp-enum-combo-box-new" role="function" condition="since:GIMP 2.4">
<title>gimp_enum_combo_box_new ()</title>
<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>
<para>
Creates a <link linkend="GtkComboBox"><type>GtkComboBox</type></link> readily filled with all enum values from a
given <parameter>enum_type</parameter>. The enum needs to be registered to the type
system. It should also have <link linkend="GimpEnumDesc"><literal>GimpEnumDesc</literal></link> descriptions registered
that contain translatable value names. This is the case for the
enums used in the GIMP PDB functions.
</para>
<para>
This is just a convenience function. If you need more control over
the enum values that appear in the combo_box, you can create your
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>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>enum_type</parameter>&nbsp;:</term>
<listitem><simpara> the <link linkend="GType"><type>GType</type></link> of an enum.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="GimpEnumComboBox"><type>GimpEnumComboBox</type></link>.

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since  GIMP 2.4
</para></refsect2>
<refsect2 id="gimp-enum-combo-box-new-with-model" role="function" condition="since:GIMP 2.4">
<title>gimp_enum_combo_box_new_with_model ()</title>
<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>
<para>
Creates a <link linkend="GtkComboBox"><type>GtkComboBox</type></link> for the given <parameter>enum_store</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>enum_store</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GimpEnumStore"><type>GimpEnumStore</type></link> to use as the model
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="GimpEnumComboBox"><type>GimpEnumComboBox</type></link>.

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since  GIMP 2.4
</para></refsect2>
<refsect2 id="gimp-enum-combo-box-set-stock-prefix" role="function" condition="since:GIMP 2.4">
<title>gimp_enum_combo_box_set_stock_prefix ()</title>
<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
                                                        (<link linkend="GimpEnumComboBox">GimpEnumComboBox</link> *combo_box,
                                                         const <link linkend="gchar">gchar</link> *stock_prefix);</programlisting>
<para>
Attempts to create stock icons for all items in the <parameter>combo_box</parameter>. See
<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>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>combo_box</parameter>&nbsp;:</term>
<listitem><simpara>    a <link linkend="GimpEnumComboBox"><type>GimpEnumComboBox</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>stock_prefix</parameter>&nbsp;:</term>
<listitem><simpara> a prefix to create icon stock ID from enum values
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since  GIMP 2.4
</para></refsect2>

</refsect1>
<refsect1 id="GimpEnumComboBox.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="GimpEnumComboBox--model"><title>The <literal>&quot;model&quot;</literal> property</title>
<indexterm zone="GimpEnumComboBox--model"><primary>GimpEnumComboBox:model</primary></indexterm><programlisting>  &quot;model&quot;                    <link linkend="GimpEnumStore">GimpEnumStore</link>*        : Read / Write</programlisting>
<para></para></refsect2>

</refsect1>




</refentry>