← 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/gimpzoommodel.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/gimpzoommodel.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="GimpZoomModel">
 
6
<refmeta>
 
7
<refentrytitle role="top_of_page">GimpZoomModel</refentrytitle>
 
8
<manvolnum>3</manvolnum>
 
9
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
 
10
</refmeta>
 
11
 
 
12
<refnamediv>
 
13
<refname>GimpZoomModel</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="GimpZoomModel-struct">GimpZoomModel</link>;
 
26
enum                <link linkend="GimpZoomType">GimpZoomType</link>;
 
27
<link linkend="GimpZoomModel">GimpZoomModel</link>*      <link linkend="gimp-zoom-model-new">gimp_zoom_model_new</link>                 (void);
 
28
<link linkend="void">void</link>                <link linkend="gimp-zoom-model-set-range">gimp_zoom_model_set_range</link>           (<link linkend="GimpZoomModel">GimpZoomModel</link> *model,
 
29
                                                         <link linkend="gdouble">gdouble</link> min,
 
30
                                                         <link linkend="gdouble">gdouble</link> max);
 
31
<link linkend="void">void</link>                <link linkend="gimp-zoom-model-zoom">gimp_zoom_model_zoom</link>                (<link linkend="GimpZoomModel">GimpZoomModel</link> *model,
 
32
                                                         <link linkend="GimpZoomType">GimpZoomType</link> zoom_type,
 
33
                                                         <link linkend="gdouble">gdouble</link> scale);
 
34
<link linkend="gdouble">gdouble</link>             <link linkend="gimp-zoom-model-get-factor">gimp_zoom_model_get_factor</link>          (<link linkend="GimpZoomModel">GimpZoomModel</link> *model);
 
35
<link linkend="void">void</link>                <link linkend="gimp-zoom-model-get-fraction">gimp_zoom_model_get_fraction</link>        (<link linkend="GimpZoomModel">GimpZoomModel</link> *model,
 
36
                                                         <link linkend="gint">gint</link> *numerator,
 
37
                                                         <link linkend="gint">gint</link> *denominator);
 
38
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="gimp-zoom-button-new">gimp_zoom_button_new</link>                (<link linkend="GimpZoomModel">GimpZoomModel</link> *model,
 
39
                                                         <link linkend="GimpZoomType">GimpZoomType</link> zoom_type,
 
40
                                                         <link linkend="GtkIconSize">GtkIconSize</link> icon_size);
 
41
<link linkend="gdouble">gdouble</link>             <link linkend="gimp-zoom-model-zoom-step">gimp_zoom_model_zoom_step</link>           (<link linkend="GimpZoomType">GimpZoomType</link> zoom_type,
 
42
                                                         <link linkend="gdouble">gdouble</link> scale);
 
43
 
 
44
</synopsis>
 
45
</refsynopsisdiv>
 
46
 
 
47
<refsect1 role="object_hierarchy">
 
48
<title role="object_hierarchy.title">Object Hierarchy</title>
 
49
<synopsis>
 
50
 
 
51
  <link linkend="GObject">GObject</link>
 
52
   +----GimpZoomModel
 
53
</synopsis>
 
54
 
 
55
</refsect1>
 
56
 
 
57
 
 
58
 
 
59
 
 
60
 
 
61
<refsect1 role="properties">
 
62
<title role="properties.title">Properties</title>
 
63
<synopsis>
 
64
 
 
65
  &quot;<link linkend="GimpZoomModel--fraction">fraction</link>&quot;                 <link linkend="gchararray">gchararray</link>            : Read
 
66
  &quot;<link linkend="GimpZoomModel--maximum">maximum</link>&quot;                  <link linkend="gdouble">gdouble</link>               : Read / Write
 
67
  &quot;<link linkend="GimpZoomModel--minimum">minimum</link>&quot;                  <link linkend="gdouble">gdouble</link>               : Read / Write
 
68
  &quot;<link linkend="GimpZoomModel--percentage">percentage</link>&quot;               <link linkend="gchararray">gchararray</link>            : Read
 
69
  &quot;<link linkend="GimpZoomModel--value">value</link>&quot;                    <link linkend="gdouble">gdouble</link>               : Read / Write
 
70
</synopsis>
 
71
</refsect1>
 
72
 
 
73
<refsect1 role="signal_proto">
 
74
<title role="signal_proto.title">Signals</title>
 
75
<synopsis>
 
76
 
 
77
  &quot;<link linkend="GimpZoomModel-zoomed">zoomed</link>&quot;                                         : Run Last
 
78
</synopsis>
 
79
</refsect1>
 
80
 
 
81
 
 
82
<refsect1 role="desc">
 
83
<title role="desc.title">Description</title>
 
84
<para>
 
85
 
 
86
</para>
 
87
</refsect1>
 
88
 
 
89
<refsect1 role="details">
 
90
<title role="details.title">Details</title>
 
91
<refsect2>
 
92
<title><anchor id="GimpZoomModel-struct" role="struct"/>GimpZoomModel</title>
 
93
<indexterm><primary>GimpZoomModel</primary></indexterm><programlisting>typedef struct _GimpZoomModel GimpZoomModel;</programlisting>
 
94
<para>
 
95
 
 
96
</para></refsect2>
 
97
<refsect2>
 
98
<title><anchor id="GimpZoomType" role="enum"/>enum GimpZoomType</title>
 
99
<indexterm><primary>GimpZoomType</primary></indexterm><programlisting>typedef enum
 
100
{
 
101
  GIMP_ZOOM_IN,        /*&lt; desc="Zoom in"  &gt;*/
 
102
  GIMP_ZOOM_OUT,       /*&lt; desc="Zoom out" &gt;*/
 
103
  GIMP_ZOOM_IN_MORE,   /*&lt; skip &gt;*/
 
104
  GIMP_ZOOM_OUT_MORE,  /*&lt; skip &gt;*/
 
105
  GIMP_ZOOM_IN_MAX,    /*&lt; skip &gt;*/
 
106
  GIMP_ZOOM_OUT_MAX,   /*&lt; skip &gt;*/
 
107
  GIMP_ZOOM_TO         /*&lt; skip &gt;*/
 
108
} GimpZoomType;
 
109
</programlisting>
 
110
<para>
 
111
 
 
112
</para></refsect2>
 
113
<refsect2>
 
114
<title><anchor id="gimp-zoom-model-new" role="function"/>gimp_zoom_model_new ()</title>
 
115
<indexterm><primary>gimp_zoom_model_new</primary></indexterm><programlisting><link linkend="GimpZoomModel">GimpZoomModel</link>*      gimp_zoom_model_new                 (void);</programlisting>
 
116
<para>
 
117
Creates a new <link linkend="GimpZoomModel"><type>GimpZoomModel</type></link>.</para>
 
118
<para>
 
119
 
 
120
</para><variablelist role="params">
 
121
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="GimpZoomModel"><type>GimpZoomModel</type></link>.
 
122
 
 
123
Since GIMP 2.4
 
124
</simpara></listitem></varlistentry>
 
125
</variablelist></refsect2>
 
126
<refsect2>
 
127
<title><anchor id="gimp-zoom-model-set-range" role="function"/>gimp_zoom_model_set_range ()</title>
 
128
<indexterm><primary>gimp_zoom_model_set_range</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_zoom_model_set_range           (<link linkend="GimpZoomModel">GimpZoomModel</link> *model,
 
129
                                                         <link linkend="gdouble">gdouble</link> min,
 
130
                                                         <link linkend="gdouble">gdouble</link> max);</programlisting>
 
131
<para>
 
132
Sets the allowed range of the <parameter>model</parameter>.
 
133
</para>
 
134
<para>
 
135
Since GIMP 2.4</para>
 
136
<para>
 
137
 
 
138
</para><variablelist role="params">
 
139
<varlistentry><term><parameter>model</parameter>&nbsp;:</term>
 
140
<listitem><simpara> a <link linkend="GimpZoomModel"><type>GimpZoomModel</type></link>
 
141
</simpara></listitem></varlistentry>
 
142
<varlistentry><term><parameter>min</parameter>&nbsp;:</term>
 
143
<listitem><simpara> new lower limit for zoom factor
 
144
</simpara></listitem></varlistentry>
 
145
<varlistentry><term><parameter>max</parameter>&nbsp;:</term>
 
146
<listitem><simpara> new upper limit for zoom factor
 
147
</simpara></listitem></varlistentry>
 
148
</variablelist></refsect2>
 
149
<refsect2>
 
150
<title><anchor id="gimp-zoom-model-zoom" role="function"/>gimp_zoom_model_zoom ()</title>
 
151
<indexterm><primary>gimp_zoom_model_zoom</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_zoom_model_zoom                (<link linkend="GimpZoomModel">GimpZoomModel</link> *model,
 
152
                                                         <link linkend="GimpZoomType">GimpZoomType</link> zoom_type,
 
153
                                                         <link linkend="gdouble">gdouble</link> scale);</programlisting>
 
154
<para>
 
155
Since GIMP 2.4</para>
 
156
<para>
 
157
 
 
158
</para><variablelist role="params">
 
159
<varlistentry><term><parameter>model</parameter>&nbsp;:</term>
 
160
<listitem><simpara>     a <link linkend="GimpZoomModel"><type>GimpZoomModel</type></link>
 
161
</simpara></listitem></varlistentry>
 
162
<varlistentry><term><parameter>zoom_type</parameter>&nbsp;:</term>
 
163
<listitem><simpara> the <link linkend="GimpZoomType"><type>GimpZoomType</type></link>
 
164
</simpara></listitem></varlistentry>
 
165
<varlistentry><term><parameter>scale</parameter>&nbsp;:</term>
 
166
<listitem><simpara>     ignored unless <parameter>zoom_type</parameter> == <link linkend="GIMP-ZOOM-TO:CAPS"><literal>GIMP_ZOOM_TO</literal></link>
 
167
</simpara></listitem></varlistentry>
 
168
</variablelist></refsect2>
 
169
<refsect2>
 
170
<title><anchor id="gimp-zoom-model-get-factor" role="function"/>gimp_zoom_model_get_factor ()</title>
 
171
<indexterm><primary>gimp_zoom_model_get_factor</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link>             gimp_zoom_model_get_factor          (<link linkend="GimpZoomModel">GimpZoomModel</link> *model);</programlisting>
 
172
<para>
 
173
Retrieves the current zoom factor of <parameter>model</parameter>.</para>
 
174
<para>
 
175
 
 
176
</para><variablelist role="params">
 
177
<varlistentry><term><parameter>model</parameter>&nbsp;:</term>
 
178
<listitem><simpara> a <link linkend="GimpZoomModel"><type>GimpZoomModel</type></link>
 
179
</simpara></listitem></varlistentry>
 
180
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the current scale factor
 
181
 
 
182
Since GIMP 2.4
 
183
</simpara></listitem></varlistentry>
 
184
</variablelist></refsect2>
 
185
<refsect2>
 
186
<title><anchor id="gimp-zoom-model-get-fraction" role="function"/>gimp_zoom_model_get_fraction ()</title>
 
187
<indexterm><primary>gimp_zoom_model_get_fraction</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_zoom_model_get_fraction        (<link linkend="GimpZoomModel">GimpZoomModel</link> *model,
 
188
                                                         <link linkend="gint">gint</link> *numerator,
 
189
                                                         <link linkend="gint">gint</link> *denominator);</programlisting>
 
190
<para>
 
191
Retrieves the current zoom factor of <parameter>model</parameter> as a fraction.
 
192
</para>
 
193
<para>
 
194
Since GIMP 2.4</para>
 
195
<para>
 
196
 
 
197
</para><variablelist role="params">
 
198
<varlistentry><term><parameter>model</parameter>&nbsp;:</term>
 
199
<listitem><simpara>       a <link linkend="GimpZoomModel"><type>GimpZoomModel</type></link>
 
200
</simpara></listitem></varlistentry>
 
201
<varlistentry><term><parameter>numerator</parameter>&nbsp;:</term>
 
202
<listitem><simpara>   return location for numerator
 
203
</simpara></listitem></varlistentry>
 
204
<varlistentry><term><parameter>denominator</parameter>&nbsp;:</term>
 
205
<listitem><simpara> return location for denominator
 
206
</simpara></listitem></varlistentry>
 
207
</variablelist></refsect2>
 
208
<refsect2>
 
209
<title><anchor id="gimp-zoom-button-new" role="function"/>gimp_zoom_button_new ()</title>
 
210
<indexterm><primary>gimp_zoom_button_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          gimp_zoom_button_new                (<link linkend="GimpZoomModel">GimpZoomModel</link> *model,
 
211
                                                         <link linkend="GimpZoomType">GimpZoomType</link> zoom_type,
 
212
                                                         <link linkend="GtkIconSize">GtkIconSize</link> icon_size);</programlisting>
 
213
<para>
 
214
</para>
 
215
<para>
 
216
 
 
217
</para><variablelist role="params">
 
218
<varlistentry><term><parameter>model</parameter>&nbsp;:</term>
 
219
<listitem><simpara>     a <link linkend="GimpZoomModel"><type>GimpZoomModel</type></link>
 
220
</simpara></listitem></varlistentry>
 
221
<varlistentry><term><parameter>zoom_type</parameter>&nbsp;:</term>
 
222
<listitem><simpara>
 
223
</simpara></listitem></varlistentry>
 
224
<varlistentry><term><parameter>icon_size</parameter>&nbsp;:</term>
 
225
<listitem><simpara> use 0 for a button with text labels
 
226
</simpara></listitem></varlistentry>
 
227
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a newly created GtkButton
 
228
 
 
229
Since GIMP 2.4
 
230
</simpara></listitem></varlistentry>
 
231
</variablelist></refsect2>
 
232
<refsect2>
 
233
<title><anchor id="gimp-zoom-model-zoom-step" role="function"/>gimp_zoom_model_zoom_step ()</title>
 
234
<indexterm><primary>gimp_zoom_model_zoom_step</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link>             gimp_zoom_model_zoom_step           (<link linkend="GimpZoomType">GimpZoomType</link> zoom_type,
 
235
                                                         <link linkend="gdouble">gdouble</link> scale);</programlisting>
 
236
<para>
 
237
Utility function to calculate a new scale factor.</para>
 
238
<para>
 
239
 
 
240
</para><variablelist role="params">
 
241
<varlistentry><term><parameter>zoom_type</parameter>&nbsp;:</term>
 
242
<listitem><simpara>
 
243
</simpara></listitem></varlistentry>
 
244
<varlistentry><term><parameter>scale</parameter>&nbsp;:</term>
 
245
<listitem><simpara>     ignored unless <parameter>zoom_type</parameter> == <link linkend="GIMP-ZOOM-TO:CAPS"><literal>GIMP_ZOOM_TO</literal></link>
 
246
</simpara></listitem></varlistentry>
 
247
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the new scale factor
 
248
 
 
249
Since GIMP 2.4
 
250
</simpara></listitem></varlistentry>
 
251
</variablelist></refsect2>
 
252
 
 
253
</refsect1>
 
254
<refsect1 role="property_details">
 
255
<title role="property_details.title">Property Details</title>
 
256
<refsect2><title><anchor id="GimpZoomModel--fraction"/>The &quot;<literal>fraction</literal>&quot; property</title>
 
257
<indexterm><primary>GimpZoomModel:fraction</primary></indexterm><programlisting>  &quot;fraction&quot;                 <link linkend="gchararray">gchararray</link>            : Read</programlisting>
 
258
<para></para><para>Default value: "1:1"</para>
 
259
</refsect2>
 
260
<refsect2><title><anchor id="GimpZoomModel--maximum"/>The &quot;<literal>maximum</literal>&quot; property</title>
 
261
<indexterm><primary>GimpZoomModel:maximum</primary></indexterm><programlisting>  &quot;maximum&quot;                  <link linkend="gdouble">gdouble</link>               : Read / Write</programlisting>
 
262
<para></para><para>Allowed values: [0.00390625,256]</para>
 
263
<para>Default value: 256</para>
 
264
</refsect2>
 
265
<refsect2><title><anchor id="GimpZoomModel--minimum"/>The &quot;<literal>minimum</literal>&quot; property</title>
 
266
<indexterm><primary>GimpZoomModel:minimum</primary></indexterm><programlisting>  &quot;minimum&quot;                  <link linkend="gdouble">gdouble</link>               : Read / Write</programlisting>
 
267
<para></para><para>Allowed values: [0.00390625,256]</para>
 
268
<para>Default value: 0.00390625</para>
 
269
</refsect2>
 
270
<refsect2><title><anchor id="GimpZoomModel--percentage"/>The &quot;<literal>percentage</literal>&quot; property</title>
 
271
<indexterm><primary>GimpZoomModel:percentage</primary></indexterm><programlisting>  &quot;percentage&quot;               <link linkend="gchararray">gchararray</link>            : Read</programlisting>
 
272
<para></para><para>Default value: "100%"</para>
 
273
</refsect2>
 
274
<refsect2><title><anchor id="GimpZoomModel--value"/>The &quot;<literal>value</literal>&quot; property</title>
 
275
<indexterm><primary>GimpZoomModel:value</primary></indexterm><programlisting>  &quot;value&quot;                    <link linkend="gdouble">gdouble</link>               : Read / Write</programlisting>
 
276
<para></para><para>Allowed values: [0.00390625,256]</para>
 
277
<para>Default value: 1</para>
 
278
</refsect2>
 
279
 
 
280
</refsect1>
 
281
 
 
282
<refsect1 role="signals">
 
283
<title role="signals.title">Signal Details</title>
 
284
<refsect2><title><anchor id="GimpZoomModel-zoomed"/>The &quot;zoomed&quot; signal</title>
 
285
<indexterm><primary>GimpZoomModel::zoomed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GimpZoomModel">GimpZoomModel</link> *model,
 
286
                                                        <link linkend="gdouble">gdouble</link>        old_factor,
 
287
                                                        <link linkend="gdouble">gdouble</link>        new_factor,
 
288
                                                        <link linkend="gpointer">gpointer</link>       user_data)       : Run Last</programlisting>
 
289
<para>
 
290
Emitted when the zoom factor of the zoom model changes.</para>
 
291
<para>
 
292
 
 
293
</para><variablelist role="params">
 
294
<varlistentry><term><parameter>model</parameter>&nbsp;:</term>
 
295
<listitem><simpara> the object that received the signal
 
296
</simpara></listitem></varlistentry>
 
297
<varlistentry><term><parameter>old_factor</parameter>&nbsp;:</term>
 
298
<listitem><simpara> the zoom factor before it changes
 
299
</simpara></listitem></varlistentry>
 
300
<varlistentry><term><parameter>new_factor</parameter>&nbsp;:</term>
 
301
<listitem><simpara> the zoom factor after it has changed.
 
302
</simpara></listitem></varlistentry>
 
303
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
304
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
 
305
</variablelist></refsect2>
 
306
</refsect1>
 
307
 
 
308
 
 
309
 
 
310
</refentry>