← 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/gimpratioentry.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/gimpratioentry.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="GimpRatioEntry">
 
6
<refmeta>
 
7
<refentrytitle role="top_of_page">GimpRatioEntry</refentrytitle>
 
8
<manvolnum>3</manvolnum>
 
9
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
 
10
</refmeta>
 
11
 
 
12
<refnamediv>
 
13
<refname>GimpRatioEntry</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="GimpRatioEntry-struct">GimpRatioEntry</link>;
 
26
enum                <link linkend="GimpAspectType">GimpAspectType</link>;
 
27
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="gimp-ratio-entry-new">gimp_ratio_entry_new</link>                (void);
 
28
<link linkend="void">void</link>                <link linkend="gimp-ratio-entry-set-fraction">gimp_ratio_entry_set_fraction</link>       (<link linkend="GimpRatioEntry">GimpRatioEntry</link> *entry,
 
29
                                                         <link linkend="gdouble">gdouble</link> numerator,
 
30
                                                         <link linkend="gdouble">gdouble</link> denominator);
 
31
<link linkend="void">void</link>                <link linkend="gimp-ratio-entry-get-fraction">gimp_ratio_entry_get_fraction</link>       (<link linkend="GimpRatioEntry">GimpRatioEntry</link> *entry,
 
32
                                                         <link linkend="gdouble">gdouble</link> *numerator,
 
33
                                                         <link linkend="gdouble">gdouble</link> *denominator);
 
34
<link linkend="void">void</link>                <link linkend="gimp-ratio-entry-set-ratio">gimp_ratio_entry_set_ratio</link>          (<link linkend="GimpRatioEntry">GimpRatioEntry</link> *entry,
 
35
                                                         <link linkend="gdouble">gdouble</link> ratio);
 
36
<link linkend="gdouble">gdouble</link>             <link linkend="gimp-ratio-entry-get-ratio">gimp_ratio_entry_get_ratio</link>          (<link linkend="GimpRatioEntry">GimpRatioEntry</link> *entry);
 
37
<link linkend="void">void</link>                <link linkend="gimp-ratio-entry-set-aspect">gimp_ratio_entry_set_aspect</link>         (<link linkend="GimpRatioEntry">GimpRatioEntry</link> *entry,
 
38
                                                         <link linkend="GimpAspectType">GimpAspectType</link> aspect);
 
39
<link linkend="GimpAspectType">GimpAspectType</link>      <link linkend="gimp-ratio-entry-get-aspect">gimp_ratio_entry_get_aspect</link>         (<link linkend="GimpRatioEntry">GimpRatioEntry</link> *entry);
 
40
 
 
41
</synopsis>
 
42
</refsynopsisdiv>
 
43
 
 
44
<refsect1 role="object_hierarchy">
 
45
<title role="object_hierarchy.title">Object Hierarchy</title>
 
46
<synopsis>
 
47
 
 
48
  <link linkend="GObject">GObject</link>
 
49
   +----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
 
50
         +----<link linkend="GtkObject">GtkObject</link>
 
51
               +----<link linkend="GtkWidget">GtkWidget</link>
 
52
                     +----<link linkend="GtkEntry">GtkEntry</link>
 
53
                           +----GimpRatioEntry
 
54
</synopsis>
 
55
 
 
56
</refsect1>
 
57
 
 
58
 
 
59
 
 
60
<refsect1 role="impl_interfaces">
 
61
<title role="impl_interfaces.title">Implemented Interfaces</title>
 
62
<para>
 
63
GimpRatioEntry implements
 
64
 <link linkend="AtkImplementorIface">AtkImplementorIface</link>,  <link linkend="GtkEditable">GtkEditable</link> and  <link linkend="GtkCellEditable">GtkCellEditable</link>.</para>
 
65
 
 
66
</refsect1>
 
67
 
 
68
 
 
69
<refsect1 role="properties">
 
70
<title role="properties.title">Properties</title>
 
71
<synopsis>
 
72
 
 
73
  &quot;<link linkend="GimpRatioEntry--aspect">aspect</link>&quot;                   <link linkend="GimpAspectType">GimpAspectType</link>        : Read / Write
 
74
  &quot;<link linkend="GimpRatioEntry--denominator">denominator</link>&quot;              <link linkend="gdouble">gdouble</link>               : Read / Write
 
75
  &quot;<link linkend="GimpRatioEntry--numerator">numerator</link>&quot;                <link linkend="gdouble">gdouble</link>               : Read / Write
 
76
  &quot;<link linkend="GimpRatioEntry--ratio">ratio</link>&quot;                    <link linkend="gdouble">gdouble</link>               : Read / Write
 
77
</synopsis>
 
78
</refsect1>
 
79
 
 
80
<refsect1 role="signal_proto">
 
81
<title role="signal_proto.title">Signals</title>
 
82
<synopsis>
 
83
 
 
84
  &quot;<link linkend="GimpRatioEntry-ratio-changed">ratio-changed</link>&quot;                                  : Run First
 
85
</synopsis>
 
86
</refsect1>
 
87
 
 
88
 
 
89
<refsect1 role="desc">
 
90
<title role="desc.title">Description</title>
 
91
<para>
 
92
 
 
93
</para>
 
94
</refsect1>
 
95
 
 
96
<refsect1 role="details">
 
97
<title role="details.title">Details</title>
 
98
<refsect2>
 
99
<title><anchor id="GimpRatioEntry-struct" role="struct"/>GimpRatioEntry</title>
 
100
<indexterm><primary>GimpRatioEntry</primary></indexterm><programlisting>typedef struct _GimpRatioEntry GimpRatioEntry;</programlisting>
 
101
<para>
 
102
 
 
103
</para></refsect2>
 
104
<refsect2>
 
105
<title><anchor id="GimpAspectType" role="enum"/>enum GimpAspectType</title>
 
106
<indexterm><primary>GimpAspectType</primary></indexterm><programlisting>typedef enum
 
107
{
 
108
  GIMP_ASPECT_SQUARE,    /*&lt; desc="Square"    &gt;*/
 
109
  GIMP_ASPECT_PORTRAIT,  /*&lt; desc="Portrait"  &gt;*/
 
110
  GIMP_ASPECT_LANDSCAPE  /*&lt; desc="Landscape" &gt;*/
 
111
} GimpAspectType;
 
112
</programlisting>
 
113
<para>
 
114
 
 
115
</para></refsect2>
 
116
<refsect2>
 
117
<title><anchor id="gimp-ratio-entry-new" role="function" condition="since:GIMP 2.4"/>gimp_ratio_entry_new ()</title>
 
118
<indexterm role="GIMP 2.4"><primary>gimp_ratio_entry_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          gimp_ratio_entry_new                (void);</programlisting>
 
119
<para>
 
120
</para>
 
121
<para>
 
122
 
 
123
</para><variablelist role="params">
 
124
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="GimpRatioEntry"><type>GimpRatioEntry</type></link> widget
 
125
 
 
126
</simpara></listitem></varlistentry>
 
127
</variablelist><para role="since">Since  GIMP 2.4
 
128
</para></refsect2>
 
129
<refsect2>
 
130
<title><anchor id="gimp-ratio-entry-set-fraction" role="function" condition="since:GIMP 2.4"/>gimp_ratio_entry_set_fraction ()</title>
 
131
<indexterm role="GIMP 2.4"><primary>gimp_ratio_entry_set_fraction</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_ratio_entry_set_fraction       (<link linkend="GimpRatioEntry">GimpRatioEntry</link> *entry,
 
132
                                                         <link linkend="gdouble">gdouble</link> numerator,
 
133
                                                         <link linkend="gdouble">gdouble</link> denominator);</programlisting>
 
134
<para>
 
135
Sets the fraction displayed by a <link linkend="GimpRatioEntry"><type>GimpRatioEntry</type></link>. If the resulting
 
136
ratio is different to the previously set ratio, the "ratio-changed"
 
137
signal is emitted.
 
138
</para>
 
139
<para>
 
140
If the denominator is zero, the <link linkend="GimpRatioEntry"><type>GimpRatioEntry</type></link> will silently
 
141
convert it to 1.0.</para>
 
142
<para>
 
143
 
 
144
</para><variablelist role="params">
 
145
<varlistentry><term><parameter>entry</parameter>&nbsp;:</term>
 
146
<listitem><simpara> a <link linkend="GimpRatioEntry"><type>GimpRatioEntry</type></link> widget
 
147
</simpara></listitem></varlistentry>
 
148
<varlistentry><term><parameter>numerator</parameter>&nbsp;:</term>
 
149
<listitem><simpara> numerator of the fraction to set in the widget
 
150
</simpara></listitem></varlistentry>
 
151
<varlistentry><term><parameter>denominator</parameter>&nbsp;:</term>
 
152
<listitem><simpara> denominator of the fraction to set in the widget
 
153
</simpara></listitem></varlistentry>
 
154
</variablelist><para role="since">Since  GIMP 2.4
 
155
</para></refsect2>
 
156
<refsect2>
 
157
<title><anchor id="gimp-ratio-entry-get-fraction" role="function" condition="since:GIMP 2.4"/>gimp_ratio_entry_get_fraction ()</title>
 
158
<indexterm role="GIMP 2.4"><primary>gimp_ratio_entry_get_fraction</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_ratio_entry_get_fraction       (<link linkend="GimpRatioEntry">GimpRatioEntry</link> *entry,
 
159
                                                         <link linkend="gdouble">gdouble</link> *numerator,
 
160
                                                         <link linkend="gdouble">gdouble</link> *denominator);</programlisting>
 
161
<para>
 
162
Gets the fraction displayed by a <link linkend="GimpRatioEntry"><type>GimpRatioEntry</type></link>.
 
163
</para>
 
164
<para>
 
165
The denominator may be zero if the <link linkend="GimpRatioEntry"><type>GimpRatioEntry</type></link> shows just a single
 
166
value. You can use <link linkend="gimp-ratio-entry-get-ratio"><type>gimp_ratio_entry_get_ratio</type></link> to retrieve the ratio
 
167
as a single decimal value.</para>
 
168
<para>
 
169
 
 
170
</para><variablelist role="params">
 
171
<varlistentry><term><parameter>entry</parameter>&nbsp;:</term>
 
172
<listitem><simpara> a <link linkend="GimpRatioEntry"><type>GimpRatioEntry</type></link> widget
 
173
</simpara></listitem></varlistentry>
 
174
<varlistentry><term><parameter>numerator</parameter>&nbsp;:</term>
 
175
<listitem><simpara> pointer to store the numerator of the fraction
 
176
</simpara></listitem></varlistentry>
 
177
<varlistentry><term><parameter>denominator</parameter>&nbsp;:</term>
 
178
<listitem><simpara> pointer to store the denominator of the fraction
 
179
</simpara></listitem></varlistentry>
 
180
</variablelist><para role="since">Since  GIMP 2.4
 
181
</para></refsect2>
 
182
<refsect2>
 
183
<title><anchor id="gimp-ratio-entry-set-ratio" role="function" condition="since:GIMP 2.4"/>gimp_ratio_entry_set_ratio ()</title>
 
184
<indexterm role="GIMP 2.4"><primary>gimp_ratio_entry_set_ratio</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_ratio_entry_set_ratio          (<link linkend="GimpRatioEntry">GimpRatioEntry</link> *entry,
 
185
                                                         <link linkend="gdouble">gdouble</link> ratio);</programlisting>
 
186
<para>
 
187
Sets the ratio displayed by a <link linkend="GimpRatioEntry"><type>GimpRatioEntry</type></link>. If the new ratio is
 
188
different than the previous ratio, the "ratio-changed" signal is
 
189
emitted.
 
190
</para>
 
191
<para>
 
192
An attempt is made to convert the decimal number into a fraction with
 
193
numerator and denominator &lt; 1000.</para>
 
194
<para>
 
195
 
 
196
</para><variablelist role="params">
 
197
<varlistentry><term><parameter>entry</parameter>&nbsp;:</term>
 
198
<listitem><simpara> a <link linkend="GimpRatioEntry"><type>GimpRatioEntry</type></link> widget
 
199
</simpara></listitem></varlistentry>
 
200
<varlistentry><term><parameter>ratio</parameter>&nbsp;:</term>
 
201
<listitem><simpara> ratio to set in the widget
 
202
</simpara></listitem></varlistentry>
 
203
</variablelist><para role="since">Since  GIMP 2.4
 
204
</para></refsect2>
 
205
<refsect2>
 
206
<title><anchor id="gimp-ratio-entry-get-ratio" role="function" condition="since:GIMP 2.4"/>gimp_ratio_entry_get_ratio ()</title>
 
207
<indexterm role="GIMP 2.4"><primary>gimp_ratio_entry_get_ratio</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link>             gimp_ratio_entry_get_ratio          (<link linkend="GimpRatioEntry">GimpRatioEntry</link> *entry);</programlisting>
 
208
<para>
 
209
Retrieves the ratio value displayed by a <link linkend="GimpRatioEntry"><type>GimpRatioEntry</type></link>.</para>
 
210
<para>
 
211
 
 
212
</para><variablelist role="params">
 
213
<varlistentry><term><parameter>entry</parameter>&nbsp;:</term>
 
214
<listitem><simpara> a <link linkend="GimpRatioEntry"><type>GimpRatioEntry</type></link> widget
 
215
</simpara></listitem></varlistentry>
 
216
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The ratio value.
 
217
 
 
218
</simpara></listitem></varlistentry>
 
219
</variablelist><para role="since">Since  GIMP 2.4
 
220
</para></refsect2>
 
221
<refsect2>
 
222
<title><anchor id="gimp-ratio-entry-set-aspect" role="function" condition="since:GIMP 2.4"/>gimp_ratio_entry_set_aspect ()</title>
 
223
<indexterm role="GIMP 2.4"><primary>gimp_ratio_entry_set_aspect</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_ratio_entry_set_aspect         (<link linkend="GimpRatioEntry">GimpRatioEntry</link> *entry,
 
224
                                                         <link linkend="GimpAspectType">GimpAspectType</link> aspect);</programlisting>
 
225
<para>
 
226
Sets the aspect of the ratio by swapping the numerator and denominator
 
227
(or setting them to 1.0 in case that <parameter>aspect</parameter> is <link linkend="GIMP-ASPECT-SQUARE:CAPS"><literal>GIMP_ASPECT_SQUARE</literal></link>).</para>
 
228
<para>
 
229
 
 
230
</para><variablelist role="params">
 
231
<varlistentry><term><parameter>entry</parameter>&nbsp;:</term>
 
232
<listitem><simpara> a <link linkend="GimpRatioEntry"><type>GimpRatioEntry</type></link> widget
 
233
</simpara></listitem></varlistentry>
 
234
<varlistentry><term><parameter>aspect</parameter>&nbsp;:</term>
 
235
<listitem><simpara> the new aspect
 
236
</simpara></listitem></varlistentry>
 
237
</variablelist><para role="since">Since  GIMP 2.4
 
238
</para></refsect2>
 
239
<refsect2>
 
240
<title><anchor id="gimp-ratio-entry-get-aspect" role="function" condition="since:GIMP 2.4"/>gimp_ratio_entry_get_aspect ()</title>
 
241
<indexterm role="GIMP 2.4"><primary>gimp_ratio_entry_get_aspect</primary></indexterm><programlisting><link linkend="GimpAspectType">GimpAspectType</link>      gimp_ratio_entry_get_aspect         (<link linkend="GimpRatioEntry">GimpRatioEntry</link> *entry);</programlisting>
 
242
<para>
 
243
Gets the aspect of the ratio displayed by a <link linkend="GimpRatioEntry"><type>GimpRatioEntry</type></link>.</para>
 
244
<para>
 
245
 
 
246
</para><variablelist role="params">
 
247
<varlistentry><term><parameter>entry</parameter>&nbsp;:</term>
 
248
<listitem><simpara> a <link linkend="GimpRatioEntry"><type>GimpRatioEntry</type></link> widget
 
249
</simpara></listitem></varlistentry>
 
250
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The entry's current aspect.
 
251
 
 
252
</simpara></listitem></varlistentry>
 
253
</variablelist><para role="since">Since  GIMP 2.4
 
254
</para></refsect2>
 
255
 
 
256
</refsect1>
 
257
<refsect1 role="property_details">
 
258
<title role="property_details.title">Property Details</title>
 
259
<refsect2><title><anchor id="GimpRatioEntry--aspect"/>The &quot;<literal>aspect</literal>&quot; property</title>
 
260
<indexterm><primary>GimpRatioEntry:aspect</primary></indexterm><programlisting>  &quot;aspect&quot;                   <link linkend="GimpAspectType">GimpAspectType</link>        : Read / Write</programlisting>
 
261
<para></para><para>Default value: GIMP_ASPECT_SQUARE</para>
 
262
</refsect2>
 
263
<refsect2><title><anchor id="GimpRatioEntry--denominator"/>The &quot;<literal>denominator</literal>&quot; property</title>
 
264
<indexterm><primary>GimpRatioEntry:denominator</primary></indexterm><programlisting>  &quot;denominator&quot;              <link linkend="gdouble">gdouble</link>               : Read / Write</programlisting>
 
265
<para></para><para>Allowed values: &gt;= G_MINDOUBLE</para>
 
266
<para>Default value: 1</para>
 
267
</refsect2>
 
268
<refsect2><title><anchor id="GimpRatioEntry--numerator"/>The &quot;<literal>numerator</literal>&quot; property</title>
 
269
<indexterm><primary>GimpRatioEntry:numerator</primary></indexterm><programlisting>  &quot;numerator&quot;                <link linkend="gdouble">gdouble</link>               : Read / Write</programlisting>
 
270
<para></para><para>Allowed values: &gt;= G_MINDOUBLE</para>
 
271
<para>Default value: 1</para>
 
272
</refsect2>
 
273
<refsect2><title><anchor id="GimpRatioEntry--ratio"/>The &quot;<literal>ratio</literal>&quot; property</title>
 
274
<indexterm><primary>GimpRatioEntry:ratio</primary></indexterm><programlisting>  &quot;ratio&quot;                    <link linkend="gdouble">gdouble</link>               : Read / Write</programlisting>
 
275
<para></para><para>Allowed values: &gt;= G_MINDOUBLE</para>
 
276
<para>Default value: 1</para>
 
277
</refsect2>
 
278
 
 
279
</refsect1>
 
280
 
 
281
<refsect1 role="signals">
 
282
<title role="signals.title">Signal Details</title>
 
283
<refsect2><title><anchor id="GimpRatioEntry-ratio-changed"/>The &quot;ratio-changed&quot; signal</title>
 
284
<indexterm><primary>GimpRatioEntry::ratio-changed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GimpRatioEntry">GimpRatioEntry</link> *gimpratioentry,
 
285
                                                        <link linkend="gpointer">gpointer</link>        user_data)           : Run First</programlisting>
 
286
<para>
 
287
 
 
288
</para><variablelist role="params">
 
289
<varlistentry><term><parameter>gimpratioentry</parameter>&nbsp;:</term>
 
290
<listitem><simpara>the object which received the signal.
 
291
 
 
292
</simpara></listitem></varlistentry>
 
293
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
294
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
 
295
</variablelist></refsect2>
 
296
</refsect1>
 
297
 
 
298
 
 
299
 
 
300
</refentry>