← Back to branch summary

~ubuntu-branches/ubuntu/trusty/gimp/trusty

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Ari Pollak
  • Date: 2009-08-14 09:57:17 UTC
  • mto: (1.1.21 upstream) (0.1.5 squeeze)
  • mto: This revision was merged to the branch mainline in revision 48.
  • Revision ID: james.westby@ubuntu.com-20090814095717-37dh2xqy5t0rurpk
Import upstream version 2.6.7

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimpwidgets/xml/gimpunitmenu.xml
12
12
<refnamediv>
13
13
<refname>GimpUnitMenu</refname>
14
14
<refpurpose>Widget for selecting a <link linkend="GimpUnit"><type>GimpUnit</type></link>.</refpurpose>
15
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
16
15
</refnamediv>
17
16
 
18
17
<refsynopsisdiv id="GimpUnitMenu.synopsis" role="synopsis">
20
19
 
21
20
<synopsis>
22
21
                    <link linkend="GimpUnitMenu-struct">GimpUnitMenu</link>;
23
 
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="gimp-unit-menu-new">gimp_unit_menu_new</link>                  (const <link linkend="gchar">gchar</link> *format,
 
22
<link linkend="GtkWidget">GtkWidget</link> *         <link linkend="gimp-unit-menu-new">gimp_unit_menu_new</link>                  (const <link linkend="gchar">gchar</link> *format,
24
23
                                                         <link linkend="GimpUnit">GimpUnit</link> unit,
25
24
                                                         <link linkend="gboolean">gboolean</link> show_pixels,
26
25
                                                         <link linkend="gboolean">gboolean</link> show_percent,
47
46
                                       +----<link linkend="GtkOptionMenu">GtkOptionMenu</link>
48
47
                                             +----GimpUnitMenu
49
48
</synopsis>
50
 
 
51
49
</refsect1>
52
50
 
53
51
 
56
54
<title role="impl_interfaces.title">Implemented Interfaces</title>
57
55
<para>
58
56
GimpUnitMenu implements
59
 
 <link linkend="AtkImplementorIface">AtkImplementorIface</link> and  <link linkend="GtkBuildable">GtkBuildable</link>.</para>
60
 
 
 
57
 <link linkend="GtkBuildable">GtkBuildable</link>,  <link linkend="AtkImplementorIface">AtkImplementorIface</link> and  <link linkend="GtkActivatable">GtkActivatable</link>.</para>
61
58
</refsect1>
62
59
 
63
60
 
94
91
<title role="details.title">Details</title>
95
92
<refsect2 id="GimpUnitMenu-struct" role="struct">
96
93
<title>GimpUnitMenu</title>
97
 
<indexterm zone="GimpUnitMenu-struct"><primary>GimpUnitMenu</primary></indexterm><programlisting>typedef struct _GimpUnitMenu GimpUnitMenu;</programlisting>
 
94
<indexterm zone="GimpUnitMenu-struct"><primary sortas="GimpUnitMenu">GimpUnitMenu</primary></indexterm><programlisting>typedef struct _GimpUnitMenu GimpUnitMenu;</programlisting>
98
95
<para>
99
 
 
100
96
</para></refsect2>
101
97
<refsect2 id="gimp-unit-menu-new" role="function">
102
98
<title>gimp_unit_menu_new ()</title>
103
 
<indexterm zone="gimp-unit-menu-new"><primary>gimp_unit_menu_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          gimp_unit_menu_new                  (const <link linkend="gchar">gchar</link> *format,
 
99
<indexterm zone="gimp-unit-menu-new"><primary sortas="gimp_unit_menu_new">gimp_unit_menu_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> *         gimp_unit_menu_new                  (const <link linkend="gchar">gchar</link> *format,
104
100
                                                         <link linkend="GimpUnit">GimpUnit</link> unit,
105
101
                                                         <link linkend="gboolean">gboolean</link> show_pixels,
106
102
                                                         <link linkend="gboolean">gboolean</link> show_percent,
143
139
  </tgroup>
144
140
</informaltable></para>
145
141
<para>
146
 
 
147
142
</para><variablelist role="params">
148
 
<varlistentry><term><parameter>format</parameter>&nbsp;:</term>
 
143
<varlistentry><term><parameter>format</parameter>&#160;:</term>
149
144
<listitem><simpara>       A printf-like format string which is used to create the unit
150
145
               strings.
151
146
</simpara></listitem></varlistentry>
152
 
<varlistentry><term><parameter>unit</parameter>&nbsp;:</term>
 
147
<varlistentry><term><parameter>unit</parameter>&#160;:</term>
153
148
<listitem><simpara>         The initially selected unit.
154
149
</simpara></listitem></varlistentry>
155
 
<varlistentry><term><parameter>show_pixels</parameter>&nbsp;:</term>
156
 
<listitem><simpara>  <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the unit menu should contain an item for
 
150
<varlistentry><term><parameter>show_pixels</parameter>&#160;:</term>
 
151
<listitem><simpara>  <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the unit menu should contain an item for
157
152
               GIMP_UNIT_PIXEL.
158
153
</simpara></listitem></varlistentry>
159
 
<varlistentry><term><parameter>show_percent</parameter>&nbsp;:</term>
160
 
<listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> in the unit menu should contain an item for
 
154
<varlistentry><term><parameter>show_percent</parameter>&#160;:</term>
 
155
<listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> in the unit menu should contain an item for
161
156
               GIMP_UNIT_PERCENT.
162
157
</simpara></listitem></varlistentry>
163
 
<varlistentry><term><parameter>show_custom</parameter>&nbsp;:</term>
164
 
<listitem><simpara>  <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the unit menu should contain a "More..." item for
 
158
<varlistentry><term><parameter>show_custom</parameter>&#160;:</term>
 
159
<listitem><simpara>  <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the unit menu should contain a "More..." item for
165
160
               opening the user-defined-unit selection dialog.
166
161
</simpara></listitem></varlistentry>
167
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A pointer to the new <link linkend="GimpUnitMenu"><type>GimpUnitMenu</type></link> widget.
 
162
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A pointer to the new <link linkend="GimpUnitMenu"><type>GimpUnitMenu</type></link> widget.
168
163
</simpara></listitem></varlistentry>
169
164
</variablelist></refsect2>
170
165
<refsect2 id="gimp-unit-menu-set-unit" role="function">
171
166
<title>gimp_unit_menu_set_unit ()</title>
172
 
<indexterm zone="gimp-unit-menu-set-unit"><primary>gimp_unit_menu_set_unit</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_unit_menu_set_unit             (<link linkend="GimpUnitMenu">GimpUnitMenu</link> *menu,
 
167
<indexterm zone="gimp-unit-menu-set-unit"><primary sortas="gimp_unit_menu_set_unit">gimp_unit_menu_set_unit</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_unit_menu_set_unit             (<link linkend="GimpUnitMenu">GimpUnitMenu</link> *menu,
173
168
                                                         <link linkend="GimpUnit">GimpUnit</link> unit);</programlisting>
174
169
<para>
175
170
Sets a new <link linkend="GimpUnit"><type>GimpUnit</type></link> for the specified <link linkend="GimpUnitMenu"><type>GimpUnitMenu</type></link>.</para>
176
171
<para>
177
 
 
178
172
</para><variablelist role="params">
179
 
<varlistentry><term><parameter>menu</parameter>&nbsp;:</term>
 
173
<varlistentry><term><parameter>menu</parameter>&#160;:</term>
180
174
<listitem><simpara>  The unit menu you want to set the unit for.
181
175
</simpara></listitem></varlistentry>
182
 
<varlistentry><term><parameter>unit</parameter>&nbsp;:</term>
 
176
<varlistentry><term><parameter>unit</parameter>&#160;:</term>
183
177
<listitem><simpara> The new unit.
184
178
</simpara></listitem></varlistentry>
185
179
</variablelist></refsect2>
186
180
<refsect2 id="gimp-unit-menu-get-unit" role="function">
187
181
<title>gimp_unit_menu_get_unit ()</title>
188
 
<indexterm zone="gimp-unit-menu-get-unit"><primary>gimp_unit_menu_get_unit</primary></indexterm><programlisting><link linkend="GimpUnit">GimpUnit</link>            gimp_unit_menu_get_unit             (<link linkend="GimpUnitMenu">GimpUnitMenu</link> *menu);</programlisting>
 
182
<indexterm zone="gimp-unit-menu-get-unit"><primary sortas="gimp_unit_menu_get_unit">gimp_unit_menu_get_unit</primary></indexterm><programlisting><link linkend="GimpUnit">GimpUnit</link>            gimp_unit_menu_get_unit             (<link linkend="GimpUnitMenu">GimpUnitMenu</link> *menu);</programlisting>
189
183
<para>
190
184
Returns the <link linkend="GimpUnit"><type>GimpUnit</type></link> the user has selected from the <link linkend="GimpUnitMenu"><type>GimpUnitMenu</type></link>.</para>
191
185
<para>
192
 
 
193
186
</para><variablelist role="params">
194
 
<varlistentry><term><parameter>menu</parameter>&nbsp;:</term>
 
187
<varlistentry><term><parameter>menu</parameter>&#160;:</term>
195
188
<listitem><simpara> The unit menu you want to know the unit of.
196
189
</simpara></listitem></varlistentry>
197
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The unit the user has selected.
 
190
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The unit the user has selected.
198
191
</simpara></listitem></varlistentry>
199
192
</variablelist></refsect2>
200
193
<refsect2 id="gimp-unit-menu-get-pixel-digits" role="function">
201
194
<title>gimp_unit_menu_get_pixel_digits ()</title>
202
 
<indexterm zone="gimp-unit-menu-get-pixel-digits"><primary>gimp_unit_menu_get_pixel_digits</primary></indexterm><programlisting><link linkend="gint">gint</link>                gimp_unit_menu_get_pixel_digits     (<link linkend="GimpUnitMenu">GimpUnitMenu</link> *menu);</programlisting>
 
195
<indexterm zone="gimp-unit-menu-get-pixel-digits"><primary sortas="gimp_unit_menu_get_pixel_digits">gimp_unit_menu_get_pixel_digits</primary></indexterm><programlisting><link linkend="gint">gint</link>                gimp_unit_menu_get_pixel_digits     (<link linkend="GimpUnitMenu">GimpUnitMenu</link> *menu);</programlisting>
203
196
<para>
204
197
Retrieve the number of digits for a pixel size as set by
205
198
<link linkend="gimp-unit-set-pixel-digits"><function>gimp_unit_set_pixel_digits()</function></link>.</para>
206
199
<para>
207
 
 
208
200
</para><variablelist role="params">
209
 
<varlistentry><term><parameter>menu</parameter>&nbsp;:</term>
 
201
<varlistentry><term><parameter>menu</parameter>&#160;:</term>
210
202
<listitem><simpara> a <link linkend="GimpUnitMenu"><type>GimpUnitMenu</type></link>
211
203
</simpara></listitem></varlistentry>
212
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the configured number of digits for a pixel size
 
204
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the configured number of digits for a pixel size
213
205
</simpara></listitem></varlistentry>
214
206
</variablelist></refsect2>
215
207
<refsect2 id="gimp-unit-menu-set-pixel-digits" role="function">
216
208
<title>gimp_unit_menu_set_pixel_digits ()</title>
217
 
<indexterm zone="gimp-unit-menu-set-pixel-digits"><primary>gimp_unit_menu_set_pixel_digits</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_unit_menu_set_pixel_digits     (<link linkend="GimpUnitMenu">GimpUnitMenu</link> *menu,
 
209
<indexterm zone="gimp-unit-menu-set-pixel-digits"><primary sortas="gimp_unit_menu_set_pixel_digits">gimp_unit_menu_set_pixel_digits</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_unit_menu_set_pixel_digits     (<link linkend="GimpUnitMenu">GimpUnitMenu</link> *menu,
218
210
                                                         <link linkend="gint">gint</link> digits);</programlisting>
219
211
<para>
220
212
A GimpUnitMenu can be setup to control the number of digits shown
228
220
spinbuttons, specify the number of digits after the decimal point
229
221
here. You should do this after attaching your spinbuttons.</para>
230
222
<para>
231
 
 
232
223
</para><variablelist role="params">
233
 
<varlistentry><term><parameter>menu</parameter>&nbsp;:</term>
 
224
<varlistentry><term><parameter>menu</parameter>&#160;:</term>
234
225
<listitem><simpara> a <link linkend="GimpUnitMenu"><type>GimpUnitMenu</type></link>
235
226
</simpara></listitem></varlistentry>
236
 
<varlistentry><term><parameter>digits</parameter>&nbsp;:</term>
 
227
<varlistentry><term><parameter>digits</parameter>&#160;:</term>
237
228
<listitem><simpara> the number of digits to display for a pixel size
238
229
</simpara></listitem></varlistentry>
239
230
</variablelist></refsect2>
242
233
 
243
234
<refsect1 id="GimpUnitMenu.signal-details" role="signals">
244
235
<title role="signals.title">Signal Details</title>
245
 
<refsect2 id="GimpUnitMenu-unit-changed"><title>The <literal>&quot;unit-changed&quot;</literal> signal</title>
246
 
<indexterm zone="GimpUnitMenu-unit-changed"><primary>GimpUnitMenu::unit-changed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GimpUnitMenu">GimpUnitMenu</link> *arg0,
 
236
<refsect2 id="GimpUnitMenu-unit-changed" role="signal"><title>The <literal>&quot;unit-changed&quot;</literal> signal</title>
 
237
<indexterm zone="GimpUnitMenu-unit-changed"><primary sortas="GimpUnitMenu::unit-changed">GimpUnitMenu::unit-changed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GimpUnitMenu">GimpUnitMenu</link> *arg0,
247
238
                                                        <link linkend="gpointer">gpointer</link>      user_data)      : Run First</programlisting>
248
239
<para>
249
240
This signal is emitted whenever the user selects a <link linkend="GimpUnit"><type>GimpUnit</type></link> from
250
241
the <link linkend="GimpUnitMenu"><type>GimpUnitMenu</type></link>.</para>
251
242
<para>
252
 
 
253
243
</para><variablelist role="params">
254
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
244
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
255
245
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
256
246
</variablelist></refsect2>
257
247
</refsect1>