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