← Back to branch summary

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

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Robert Ancell
  • Date: 2009-08-31 10:24:10 UTC
  • mfrom: (1.1.21 upstream) (0.1.5 squeeze)
  • Revision ID: james.westby@ubuntu.com-20090831102410-eqawgw6fhdyi91ee
Tags: 2.6.7-1ubuntu1
https://launchpad.net/bugs/419593
* Merge with Debian unstable (LP: #419593), remaining changes:
  - debian/patches/02_help-message.patch,
    debian/patches/03_gimp.desktop.in.in.patch:
    + updated some strings for ubuntu
  - debian/rules:
    + updated translation templates
  - debian/control:
    + Drop webkit build dependency. gimp is the only thing pulling in webkit
      for the desktop CDs, and makes them explode. Without the webkit help
      browser plugin, help will just be displayed in the default browser.
* debian/patches/01_debian-gimprc.patch:
  - Updated
* debian/control:
  - Added a BZR link

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimpwidgets/xml/gimpstringcombobox.xml
12
12
<refnamediv>
13
13
<refname>GimpStringComboBox</refname>
14
14
<refpurpose></refpurpose>
15
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
16
15
</refnamediv>
17
16
 
18
17
<refsynopsisdiv id="GimpStringComboBox.synopsis" role="synopsis">
20
19
 
21
20
<synopsis>
22
21
                    <link linkend="GimpStringComboBox-struct">GimpStringComboBox</link>;
23
 
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="gimp-string-combo-box-new">gimp_string_combo_box_new</link>           (<link linkend="GtkTreeModel">GtkTreeModel</link> *model,
 
22
<link linkend="GtkWidget">GtkWidget</link> *         <link linkend="gimp-string-combo-box-new">gimp_string_combo_box_new</link>           (<link linkend="GtkTreeModel">GtkTreeModel</link> *model,
24
23
                                                         <link linkend="gint">gint</link> id_column,
25
24
                                                         <link linkend="gint">gint</link> label_column);
26
25
<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,
27
26
                                                         const <link linkend="gchar">gchar</link> *id);
28
 
<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);
 
27
<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);
29
28
</synopsis>
30
29
</refsynopsisdiv>
31
30
 
41
40
                                 +----<link linkend="GtkComboBox">GtkComboBox</link>
42
41
                                       +----GimpStringComboBox
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
GimpStringComboBox 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
 
69
66
<refsect1 id="GimpStringComboBox.description" role="desc">
70
67
<title role="desc.title">Description</title>
71
68
<para>
72
 
 
73
69
</para>
74
70
</refsect1>
75
71
 
77
73
<title role="details.title">Details</title>
78
74
<refsect2 id="GimpStringComboBox-struct" role="struct">
79
75
<title>GimpStringComboBox</title>
80
 
<indexterm zone="GimpStringComboBox-struct"><primary>GimpStringComboBox</primary></indexterm><programlisting>typedef struct _GimpStringComboBox GimpStringComboBox;</programlisting>
 
76
<indexterm zone="GimpStringComboBox-struct"><primary sortas="GimpStringComboBox">GimpStringComboBox</primary></indexterm><programlisting>typedef struct _GimpStringComboBox GimpStringComboBox;</programlisting>
81
77
<para>
82
 
 
83
78
</para></refsect2>
84
79
<refsect2 id="gimp-string-combo-box-new" role="function" condition="since:GIMP 2.4">
85
80
<title>gimp_string_combo_box_new ()</title>
86
 
<indexterm zone="gimp-string-combo-box-new" 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,
 
81
<indexterm zone="gimp-string-combo-box-new" role="GIMP 2.4"><primary sortas="gimp_string_combo_box_new">gimp_string_combo_box_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> *         gimp_string_combo_box_new           (<link linkend="GtkTreeModel">GtkTreeModel</link> *model,
87
82
                                                         <link linkend="gint">gint</link> id_column,
88
83
                                                         <link linkend="gint">gint</link> label_column);</programlisting>
89
84
<para>
90
85
</para>
91
86
<para>
92
 
 
93
87
</para><variablelist role="params">
94
 
<varlistentry><term><parameter>model</parameter>&nbsp;:</term>
95
 
<listitem><simpara>
96
 
</simpara></listitem></varlistentry>
97
 
<varlistentry><term><parameter>id_column</parameter>&nbsp;:</term>
98
 
<listitem><simpara>
99
 
</simpara></listitem></varlistentry>
100
 
<varlistentry><term><parameter>label_column</parameter>&nbsp;:</term>
101
 
<listitem><simpara>
102
 
</simpara></listitem></varlistentry>
103
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="GimpStringComboBox"><type>GimpStringComboBox</type></link>.
 
88
<varlistentry><term><parameter>model</parameter>&#160;:</term>
 
89
<listitem><simpara>
 
90
</simpara></listitem></varlistentry>
 
91
<varlistentry><term><parameter>id_column</parameter>&#160;:</term>
 
92
<listitem><simpara>
 
93
</simpara></listitem></varlistentry>
 
94
<varlistentry><term><parameter>label_column</parameter>&#160;:</term>
 
95
<listitem><simpara>
 
96
</simpara></listitem></varlistentry>
 
97
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="GimpStringComboBox"><type>GimpStringComboBox</type></link>.
104
98
 
105
99
</simpara></listitem></varlistentry>
106
 
</variablelist><para role="since">Since  GIMP 2.4
107
 
</para></refsect2>
 
100
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
108
101
<refsect2 id="gimp-string-combo-box-set-active" role="function" condition="since:GIMP 2.4">
109
102
<title>gimp_string_combo_box_set_active ()</title>
110
 
<indexterm zone="gimp-string-combo-box-set-active" 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,
 
103
<indexterm zone="gimp-string-combo-box-set-active" role="GIMP 2.4"><primary sortas="gimp_string_combo_box_set_active">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,
111
104
                                                         const <link linkend="gchar">gchar</link> *id);</programlisting>
112
105
<para>
113
106
Looks up the item that belongs to the given <parameter>id</parameter> and makes it the
114
107
selected item in the <parameter>combo_box</parameter>.</para>
115
108
<para>
116
 
 
117
109
</para><variablelist role="params">
118
 
<varlistentry><term><parameter>combo_box</parameter>&nbsp;:</term>
 
110
<varlistentry><term><parameter>combo_box</parameter>&#160;:</term>
119
111
<listitem><simpara> a <link linkend="GimpStringComboBox"><type>GimpStringComboBox</type></link>
120
112
</simpara></listitem></varlistentry>
121
 
<varlistentry><term><parameter>id</parameter>&nbsp;:</term>
 
113
<varlistentry><term><parameter>id</parameter>&#160;:</term>
122
114
<listitem><simpara>
123
115
</simpara></listitem></varlistentry>
124
 
<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
 
116
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</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
125
117
              this value.
126
118
 
127
119
</simpara></listitem></varlistentry>
128
 
</variablelist><para role="since">Since  GIMP 2.4
129
 
</para></refsect2>
 
120
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
130
121
<refsect2 id="gimp-string-combo-box-get-active" role="function" condition="since:GIMP 2.4">
131
122
<title>gimp_string_combo_box_get_active ()</title>
132
 
<indexterm zone="gimp-string-combo-box-get-active" 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>
 
123
<indexterm zone="gimp-string-combo-box-get-active" role="GIMP 2.4"><primary sortas="gimp_string_combo_box_get_active">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>
133
124
<para>
134
125
Retrieves the value of the selected (active) item in the <parameter>combo_box</parameter>.</para>
135
126
<para>
136
 
 
137
127
</para><variablelist role="params">
138
 
<varlistentry><term><parameter>combo_box</parameter>&nbsp;:</term>
 
128
<varlistentry><term><parameter>combo_box</parameter>&#160;:</term>
139
129
<listitem><simpara> a <link linkend="GimpStringComboBox"><type>GimpStringComboBox</type></link>
140
130
</simpara></listitem></varlistentry>
141
 
<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
 
131
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> newly allocated ID string or <link linkend="NULL--CAPS"><literal>NULL</literal></link> if nothing was selected
142
132
 
143
133
</simpara></listitem></varlistentry>
144
 
</variablelist><para role="since">Since  GIMP 2.4
145
 
</para></refsect2>
 
134
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
146
135
 
147
136
</refsect1>
148
137
<refsect1 id="GimpStringComboBox.property-details" role="property_details">
149
138
<title role="property_details.title">Property Details</title>
150
 
<refsect2 id="GimpStringComboBox--ellipsize"><title>The <literal>&quot;ellipsize&quot;</literal> property</title>
151
 
<indexterm zone="GimpStringComboBox--ellipsize" role="GIMP 2.4"><primary>GimpStringComboBox:ellipsize</primary></indexterm><programlisting>  &quot;ellipsize&quot;                <link linkend="PangoEllipsizeMode">PangoEllipsizeMode</link>    : Read / Write</programlisting>
 
139
<refsect2 id="GimpStringComboBox--ellipsize" role="property"><title>The <literal>&quot;ellipsize&quot;</literal> property</title>
 
140
<indexterm zone="GimpStringComboBox--ellipsize" role="GIMP 2.4"><primary sortas="GimpStringComboBox:ellipsize">GimpStringComboBox:ellipsize</primary></indexterm><programlisting>  &quot;ellipsize&quot;                <link linkend="PangoEllipsizeMode">PangoEllipsizeMode</link>    : Read / Write</programlisting>
152
141
<para>
153
142
Specifies the preferred place to ellipsize text in the combo-box,
154
143
if the cell renderer does not have enough room to display the
155
144
entire string.</para>
156
145
<para>
157
 
 
158
146
</para><para>Default value: PANGO_ELLIPSIZE_NONE</para>
159
 
<para>Since  GIMP 2.4
160
 
</para>
 
147
<para>Since GIMP 2.4</para>
161
148
</refsect2>
162
 
<refsect2 id="GimpStringComboBox--id-column"><title>The <literal>&quot;id-column&quot;</literal> property</title>
163
 
<indexterm zone="GimpStringComboBox--id-column" 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>
 
149
<refsect2 id="GimpStringComboBox--id-column" role="property"><title>The <literal>&quot;id-column&quot;</literal> property</title>
 
150
<indexterm zone="GimpStringComboBox--id-column" role="GIMP 2.4"><primary sortas="GimpStringComboBox:id-column">GimpStringComboBox:id-column</primary></indexterm><programlisting>  &quot;id-column&quot;                <link linkend="gint">gint</link>                  : Read / Write / Construct Only</programlisting>
164
151
<para>
165
152
The column in the associated GtkTreeModel that holds strings to
166
153
be used as labels in the combo-box.</para>
167
154
<para>
168
 
 
169
155
</para><para>Allowed values: &gt;= 0</para>
170
156
<para>Default value: 0</para>
171
 
<para>Since  GIMP 2.4
172
 
</para>
 
157
<para>Since GIMP 2.4</para>
173
158
</refsect2>
174
 
<refsect2 id="GimpStringComboBox--label-column"><title>The <literal>&quot;label-column&quot;</literal> property</title>
175
 
<indexterm zone="GimpStringComboBox--label-column"><primary>GimpStringComboBox:label-column</primary></indexterm><programlisting>  &quot;label-column&quot;             <link linkend="gint">gint</link>                  : Read / Write / Construct Only</programlisting>
 
159
<refsect2 id="GimpStringComboBox--label-column" role="property"><title>The <literal>&quot;label-column&quot;</literal> property</title>
 
160
<indexterm zone="GimpStringComboBox--label-column"><primary sortas="GimpStringComboBox:label-column">GimpStringComboBox:label-column</primary></indexterm><programlisting>  &quot;label-column&quot;             <link linkend="gint">gint</link>                  : Read / Write / Construct Only</programlisting>
176
161
<para></para><para>Allowed values: &gt;= 0</para>
177
162
<para>Default value: 0</para>
178
163
</refsect2>
179
 
 
180
164
</refsect1>
181
165
 
182
166