← Back to branch summary

~ubuntu-branches/ubuntu/jaunty/gimp/jaunty-security

« back to all changes in this revision

Viewing changes to devel-docs/libgimpwidgets/xml/gimpstringcombobox.xml

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Holbach
  • Date: 2007-05-02 16:33:03 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20070502163303-bvzhjzbpw8qglc4y
Tags: 2.3.16-1ubuntu1
* Resynchronized with Debian, remaining Ubuntu changes:
  - debian/rules: i18n magic.
* debian/control.in:
  - Maintainer: Ubuntu Core Developers <ubuntu-devel@lists.ubuntu.com>
* debian/patches/02_help-message.patch,
  debian/patches/03_gimp.desktop.in.in.patch,
  debian/patches/10_dont_show_wizard.patch: updated.
* debian/patches/04_composite-signedness.patch,
  debian/patches/05_add-letter-spacing.patch: dropped, used upstream.

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimpwidgets/xml/gimpstringcombobox.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="GimpStringComboBox">
 
6
<refmeta>
 
7
<refentrytitle role="top_of_page">GimpStringComboBox</refentrytitle>
 
8
<manvolnum>3</manvolnum>
 
9
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
 
10
</refmeta>
 
11
 
 
12
<refnamediv>
 
13
<refname>GimpStringComboBox</refname>
 
14
<refpurpose></refpurpose>
 
15
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
 
16
</refnamediv>
 
17
 
 
18
<refsynopsisdiv role="synopsis">
 
19
<title role="synopsis.title">Synopsis</title>
 
20
 
 
21
<synopsis>
 
22
 
 
23
 
 
24
 
 
25
                    <link linkend="GimpStringComboBox-struct">GimpStringComboBox</link>;
 
26
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="gimp-string-combo-box-new">gimp_string_combo_box_new</link>           (<link linkend="GtkTreeModel">GtkTreeModel</link> *model,
 
27
                                                         <link linkend="gint">gint</link> id_column,
 
28
                                                         <link linkend="gint">gint</link> label_column);
 
29
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-string-combo-box-set-active">gimp_string_combo_box_set_active</link>    (<link linkend="GimpStringComboBox">GimpStringComboBox</link> *combo_box,
 
30
                                                         const <link linkend="gchar">gchar</link> *id);
 
31
<link linkend="gchar">gchar</link>*              <link linkend="gimp-string-combo-box-get-active">gimp_string_combo_box_get_active</link>    (<link linkend="GimpStringComboBox">GimpStringComboBox</link> *combo_box);
 
32
 
 
33
</synopsis>
 
34
</refsynopsisdiv>
 
35
 
 
36
<refsect1 role="object_hierarchy">
 
37
<title role="object_hierarchy.title">Object Hierarchy</title>
 
38
<synopsis>
 
39
 
 
40
  <link linkend="GObject">GObject</link>
 
41
   +----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
 
42
         +----<link linkend="GtkObject">GtkObject</link>
 
43
               +----<link linkend="GtkWidget">GtkWidget</link>
 
44
                     +----<link linkend="GtkContainer">GtkContainer</link>
 
45
                           +----<link linkend="GtkBin">GtkBin</link>
 
46
                                 +----<link linkend="GtkComboBox">GtkComboBox</link>
 
47
                                       +----GimpStringComboBox
 
48
</synopsis>
 
49
 
 
50
</refsect1>
 
51
 
 
52
 
 
53
 
 
54
<refsect1 role="impl_interfaces">
 
55
<title role="impl_interfaces.title">Implemented Interfaces</title>
 
56
<para>
 
57
GimpStringComboBox implements
 
58
 <link linkend="AtkImplementorIface">AtkImplementorIface</link>,  <link linkend="GtkCellEditable">GtkCellEditable</link> and  <link linkend="GtkCellLayout">GtkCellLayout</link>.</para>
 
59
 
 
60
</refsect1>
 
61
 
 
62
 
 
63
<refsect1 role="properties">
 
64
<title role="properties.title">Properties</title>
 
65
<synopsis>
 
66
 
 
67
  &quot;<link linkend="GimpStringComboBox--ellipsize">ellipsize</link>&quot;                <link linkend="PangoEllipsizeMode">PangoEllipsizeMode</link>    : Read / Write
 
68
  &quot;<link linkend="GimpStringComboBox--id-column">id-column</link>&quot;                <link linkend="gint">gint</link>                  : Read / Write / Construct Only
 
69
  &quot;<link linkend="GimpStringComboBox--label-column">label-column</link>&quot;             <link linkend="gint">gint</link>                  : Read / Write / Construct Only
 
70
</synopsis>
 
71
</refsect1>
 
72
 
 
73
 
 
74
 
 
75
<refsect1 role="desc">
 
76
<title role="desc.title">Description</title>
 
77
<para>
 
78
 
 
79
</para>
 
80
</refsect1>
 
81
 
 
82
<refsect1 role="details">
 
83
<title role="details.title">Details</title>
 
84
<refsect2>
 
85
<title><anchor id="GimpStringComboBox-struct" role="struct"/>GimpStringComboBox</title>
 
86
<indexterm><primary>GimpStringComboBox</primary></indexterm><programlisting>typedef struct _GimpStringComboBox GimpStringComboBox;</programlisting>
 
87
<para>
 
88
 
 
89
</para></refsect2>
 
90
<refsect2>
 
91
<title><anchor id="gimp-string-combo-box-new" role="function" condition="since:GIMP 2.4"/>gimp_string_combo_box_new ()</title>
 
92
<indexterm role="GIMP 2.4"><primary>gimp_string_combo_box_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          gimp_string_combo_box_new           (<link linkend="GtkTreeModel">GtkTreeModel</link> *model,
 
93
                                                         <link linkend="gint">gint</link> id_column,
 
94
                                                         <link linkend="gint">gint</link> label_column);</programlisting>
 
95
<para>
 
96
</para>
 
97
<para>
 
98
 
 
99
</para><variablelist role="params">
 
100
<varlistentry><term><parameter>model</parameter>&nbsp;:</term>
 
101
<listitem><simpara>
 
102
</simpara></listitem></varlistentry>
 
103
<varlistentry><term><parameter>id_column</parameter>&nbsp;:</term>
 
104
<listitem><simpara>
 
105
</simpara></listitem></varlistentry>
 
106
<varlistentry><term><parameter>label_column</parameter>&nbsp;:</term>
 
107
<listitem><simpara>
 
108
</simpara></listitem></varlistentry>
 
109
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="GimpStringComboBox"><type>GimpStringComboBox</type></link>.
 
110
 
 
111
</simpara></listitem></varlistentry>
 
112
</variablelist><para role="since">Since  GIMP 2.4
 
113
</para></refsect2>
 
114
<refsect2>
 
115
<title><anchor id="gimp-string-combo-box-set-active" role="function" condition="since:GIMP 2.4"/>gimp_string_combo_box_set_active ()</title>
 
116
<indexterm role="GIMP 2.4"><primary>gimp_string_combo_box_set_active</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_string_combo_box_set_active    (<link linkend="GimpStringComboBox">GimpStringComboBox</link> *combo_box,
 
117
                                                         const <link linkend="gchar">gchar</link> *id);</programlisting>
 
118
<para>
 
119
Looks up the item that belongs to the given <parameter>id</parameter> and makes it the
 
120
selected item in the <parameter>combo_box</parameter>.</para>
 
121
<para>
 
122
 
 
123
</para><variablelist role="params">
 
124
<varlistentry><term><parameter>combo_box</parameter>&nbsp;:</term>
 
125
<listitem><simpara> a <link linkend="GimpStringComboBox"><type>GimpStringComboBox</type></link>
 
126
</simpara></listitem></varlistentry>
 
127
<varlistentry><term><parameter>id</parameter>&nbsp;:</term>
 
128
<listitem><simpara>
 
129
</simpara></listitem></varlistentry>
 
130
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> on success or <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> if there was no item for
 
131
              this value.
 
132
 
 
133
</simpara></listitem></varlistentry>
 
134
</variablelist><para role="since">Since  GIMP 2.4
 
135
</para></refsect2>
 
136
<refsect2>
 
137
<title><anchor id="gimp-string-combo-box-get-active" role="function" condition="since:GIMP 2.4"/>gimp_string_combo_box_get_active ()</title>
 
138
<indexterm role="GIMP 2.4"><primary>gimp_string_combo_box_get_active</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              gimp_string_combo_box_get_active    (<link linkend="GimpStringComboBox">GimpStringComboBox</link> *combo_box);</programlisting>
 
139
<para>
 
140
Retrieves the value of the selected (active) item in the <parameter>combo_box</parameter>.</para>
 
141
<para>
 
142
 
 
143
</para><variablelist role="params">
 
144
<varlistentry><term><parameter>combo_box</parameter>&nbsp;:</term>
 
145
<listitem><simpara> a <link linkend="GimpStringComboBox"><type>GimpStringComboBox</type></link>
 
146
</simpara></listitem></varlistentry>
 
147
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> newly allocated ID string or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if nothing was selected
 
148
 
 
149
</simpara></listitem></varlistentry>
 
150
</variablelist><para role="since">Since  GIMP 2.4
 
151
</para></refsect2>
 
152
 
 
153
</refsect1>
 
154
<refsect1 role="property_details">
 
155
<title role="property_details.title">Property Details</title>
 
156
<refsect2><title><anchor id="GimpStringComboBox--ellipsize"/>The &quot;<literal>ellipsize</literal>&quot; property</title>
 
157
<indexterm role="GIMP 2.4"><primary>GimpStringComboBox:ellipsize</primary></indexterm><programlisting>  &quot;ellipsize&quot;                <link linkend="PangoEllipsizeMode">PangoEllipsizeMode</link>    : Read / Write</programlisting>
 
158
<para>
 
159
Specifies the preferred place to ellipsize text in the combo-box,
 
160
if the cell renderer does not have enough room to display the
 
161
entire string.</para>
 
162
<para>
 
163
 
 
164
</para><para>Default value: PANGO_ELLIPSIZE_NONE</para>
 
165
<para>Since  GIMP 2.4
 
166
</para>
 
167
</refsect2>
 
168
<refsect2><title><anchor id="GimpStringComboBox--id-column"/>The &quot;<literal>id-column</literal>&quot; property</title>
 
169
<indexterm role="GIMP 2.4"><primary>GimpStringComboBox:id-column</primary></indexterm><programlisting>  &quot;id-column&quot;                <link linkend="gint">gint</link>                  : Read / Write / Construct Only</programlisting>
 
170
<para>
 
171
The column in the associated GtkTreeModel that holds strings to
 
172
be used as labels in the combo-box.</para>
 
173
<para>
 
174
 
 
175
</para><para>Allowed values: &gt;= 0</para>
 
176
<para>Default value: 0</para>
 
177
<para>Since  GIMP 2.4
 
178
</para>
 
179
</refsect2>
 
180
<refsect2><title><anchor id="GimpStringComboBox--label-column"/>The &quot;<literal>label-column</literal>&quot; property</title>
 
181
<indexterm><primary>GimpStringComboBox:label-column</primary></indexterm><programlisting>  &quot;label-column&quot;             <link linkend="gint">gint</link>                  : Read / Write / Construct Only</programlisting>
 
182
<para></para><para>Allowed values: &gt;= 0</para>
 
183
<para>Default value: 0</para>
 
184
</refsect2>
 
185
 
 
186
</refsect1>
 
187
 
 
188
 
 
189
 
 
190
 
 
191
</refentry>