92
88
<title role="details.title">Details</title>
93
89
<refsect2 id="GimpRuler-struct" role="struct">
94
90
<title>GimpRuler</title>
95
<indexterm zone="GimpRuler-struct"><primary>GimpRuler</primary></indexterm><programlisting>typedef struct _GimpRuler GimpRuler;</programlisting>
91
<indexterm zone="GimpRuler-struct"><primary sortas="GimpRuler">GimpRuler</primary></indexterm><programlisting>typedef struct _GimpRuler GimpRuler;</programlisting>
99
94
<refsect2 id="gimp-ruler-new" role="function" condition="since:GIMP 2.8">
100
95
<title>gimp_ruler_new ()</title>
101
<indexterm zone="gimp-ruler-new" role="GIMP 2.8"><primary>gimp_ruler_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_ruler_new (<link linkend="GtkOrientation">GtkOrientation</link> orientation);</programlisting>
96
<indexterm zone="gimp-ruler-new" role="GIMP 2.8"><primary sortas="gimp_ruler_new">gimp_ruler_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> * gimp_ruler_new (<link linkend="GtkOrientation">GtkOrientation</link> orientation);</programlisting>
103
98
Creates a new ruler.</para>
106
100
</para><variablelist role="params">
107
<varlistentry><term><parameter>orientation</parameter> :</term>
101
<varlistentry><term><parameter>orientation</parameter> :</term>
108
102
<listitem><simpara> the ruler's orientation.
109
103
</simpara></listitem></varlistentry>
110
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="GimpRuler"><type>GimpRuler</type></link> widget.
104
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="GimpRuler"><type>GimpRuler</type></link> widget.
112
106
</simpara></listitem></varlistentry>
113
</variablelist><para role="since">Since GIMP 2.8
107
</variablelist><para role="since">Since GIMP 2.8</para></refsect2>
115
108
<refsect2 id="gimp-ruler-set-unit" role="function">
116
109
<title>gimp_ruler_set_unit ()</title>
117
<indexterm zone="gimp-ruler-set-unit"><primary>gimp_ruler_set_unit</primary></indexterm><programlisting><link linkend="void">void</link> gimp_ruler_set_unit (<link linkend="GimpRuler">GimpRuler</link> *ruler,
110
<indexterm zone="gimp-ruler-set-unit"><primary sortas="gimp_ruler_set_unit">gimp_ruler_set_unit</primary></indexterm><programlisting><link linkend="void">void</link> gimp_ruler_set_unit (<link linkend="GimpRuler">GimpRuler</link> *ruler,
118
111
<link linkend="GimpUnit">GimpUnit</link> unit);</programlisting>
121
113
</para><variablelist role="params">
122
<varlistentry><term><parameter>ruler</parameter> :</term>
114
<varlistentry><term><parameter>ruler</parameter> :</term>
123
115
<listitem><simpara>
124
116
</simpara></listitem></varlistentry>
125
<varlistentry><term><parameter>unit</parameter> :</term>
117
<varlistentry><term><parameter>unit</parameter> :</term>
126
118
<listitem><simpara>
129
119
</simpara></listitem></varlistentry>
130
120
</variablelist></refsect2>
131
121
<refsect2 id="gimp-ruler-get-unit" role="function" condition="since:GIMP 2.8">
132
122
<title>gimp_ruler_get_unit ()</title>
133
<indexterm zone="gimp-ruler-get-unit" role="GIMP 2.8"><primary>gimp_ruler_get_unit</primary></indexterm><programlisting><link linkend="GimpUnit">GimpUnit</link> gimp_ruler_get_unit (<link linkend="GimpRuler">GimpRuler</link> *ruler);</programlisting>
123
<indexterm zone="gimp-ruler-get-unit" role="GIMP 2.8"><primary sortas="gimp_ruler_get_unit">gimp_ruler_get_unit</primary></indexterm><programlisting><link linkend="GimpUnit">GimpUnit</link> gimp_ruler_get_unit (<link linkend="GimpRuler">GimpRuler</link> *ruler);</programlisting>
138
127
</para><variablelist role="params">
139
<varlistentry><term><parameter>ruler</parameter> :</term>
128
<varlistentry><term><parameter>ruler</parameter> :</term>
140
129
<listitem><simpara> a <link linkend="GimpRuler"><type>GimpRuler</type></link>
141
130
</simpara></listitem></varlistentry>
142
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the unit currently used in the <parameter>ruler</parameter> widget.
131
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the unit currently used in the <parameter>ruler</parameter> widget.
144
133
</simpara></listitem></varlistentry>
145
</variablelist><para role="since">Since GIMP 2.8
134
</variablelist><para role="since">Since GIMP 2.8</para></refsect2>
147
135
<refsect2 id="gimp-ruler-set-position" role="function" condition="since:GIMP 2.8">
148
136
<title>gimp_ruler_set_position ()</title>
149
<indexterm zone="gimp-ruler-set-position" role="GIMP 2.8"><primary>gimp_ruler_set_position</primary></indexterm><programlisting><link linkend="void">void</link> gimp_ruler_set_position (<link linkend="GimpRuler">GimpRuler</link> *ruler,
137
<indexterm zone="gimp-ruler-set-position" role="GIMP 2.8"><primary sortas="gimp_ruler_set_position">gimp_ruler_set_position</primary></indexterm><programlisting><link linkend="void">void</link> gimp_ruler_set_position (<link linkend="GimpRuler">GimpRuler</link> *ruler,
150
138
<link linkend="gdouble">gdouble</link> position);</programlisting>
152
140
This sets the position of the ruler.</para>
155
142
</para><variablelist role="params">
156
<varlistentry><term><parameter>ruler</parameter> :</term>
143
<varlistentry><term><parameter>ruler</parameter> :</term>
157
144
<listitem><simpara> a <link linkend="GimpRuler"><type>GimpRuler</type></link>
158
145
</simpara></listitem></varlistentry>
159
<varlistentry><term><parameter>position</parameter> :</term>
146
<varlistentry><term><parameter>position</parameter> :</term>
160
147
<listitem><simpara> the position to set the ruler to
161
148
</simpara></listitem></varlistentry>
162
</variablelist><para role="since">Since GIMP 2.8
149
</variablelist><para role="since">Since GIMP 2.8</para></refsect2>
164
150
<refsect2 id="gimp-ruler-get-position" role="function" condition="since:GIMP 2.8">
165
151
<title>gimp_ruler_get_position ()</title>
166
<indexterm zone="gimp-ruler-get-position" role="GIMP 2.8"><primary>gimp_ruler_get_position</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link> gimp_ruler_get_position (<link linkend="GimpRuler">GimpRuler</link> *ruler);</programlisting>
152
<indexterm zone="gimp-ruler-get-position" role="GIMP 2.8"><primary sortas="gimp_ruler_get_position">gimp_ruler_get_position</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link> gimp_ruler_get_position (<link linkend="GimpRuler">GimpRuler</link> *ruler);</programlisting>
171
156
</para><variablelist role="params">
172
<varlistentry><term><parameter>ruler</parameter> :</term>
157
<varlistentry><term><parameter>ruler</parameter> :</term>
173
158
<listitem><simpara> a <link linkend="GimpRuler"><type>GimpRuler</type></link>
174
159
</simpara></listitem></varlistentry>
175
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the current position of the <parameter>ruler</parameter> widget.
160
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the current position of the <parameter>ruler</parameter> widget.
177
162
</simpara></listitem></varlistentry>
178
</variablelist><para role="since">Since GIMP 2.8
163
</variablelist><para role="since">Since GIMP 2.8</para></refsect2>
180
164
<refsect2 id="gimp-ruler-set-range" role="function" condition="since:GIMP 2.8">
181
165
<title>gimp_ruler_set_range ()</title>
182
<indexterm zone="gimp-ruler-set-range" role="GIMP 2.8"><primary>gimp_ruler_set_range</primary></indexterm><programlisting><link linkend="void">void</link> gimp_ruler_set_range (<link linkend="GimpRuler">GimpRuler</link> *ruler,
166
<indexterm zone="gimp-ruler-set-range" role="GIMP 2.8"><primary sortas="gimp_ruler_set_range">gimp_ruler_set_range</primary></indexterm><programlisting><link linkend="void">void</link> gimp_ruler_set_range (<link linkend="GimpRuler">GimpRuler</link> *ruler,
183
167
<link linkend="gdouble">gdouble</link> lower,
184
168
<link linkend="gdouble">gdouble</link> upper,
185
169
<link linkend="gdouble">gdouble</link> max_size);</programlisting>
187
171
This sets the range of the ruler.</para>
190
173
</para><variablelist role="params">
191
<varlistentry><term><parameter>ruler</parameter> :</term>
174
<varlistentry><term><parameter>ruler</parameter> :</term>
192
175
<listitem><simpara> a <link linkend="GimpRuler"><type>GimpRuler</type></link>
193
176
</simpara></listitem></varlistentry>
194
<varlistentry><term><parameter>lower</parameter> :</term>
177
<varlistentry><term><parameter>lower</parameter> :</term>
195
178
<listitem><simpara> the lower limit of the ruler
196
179
</simpara></listitem></varlistentry>
197
<varlistentry><term><parameter>upper</parameter> :</term>
180
<varlistentry><term><parameter>upper</parameter> :</term>
198
181
<listitem><simpara> the upper limit of the ruler
199
182
</simpara></listitem></varlistentry>
200
<varlistentry><term><parameter>max_size</parameter> :</term>
183
<varlistentry><term><parameter>max_size</parameter> :</term>
201
184
<listitem><simpara> the maximum size of the ruler used when calculating the space to
202
185
leave for the text
203
186
</simpara></listitem></varlistentry>
204
</variablelist><para role="since">Since GIMP 2.8
187
</variablelist><para role="since">Since GIMP 2.8</para></refsect2>
206
188
<refsect2 id="gimp-ruler-get-range" role="function" condition="since:GIMP 2.8">
207
189
<title>gimp_ruler_get_range ()</title>
208
<indexterm zone="gimp-ruler-get-range" role="GIMP 2.8"><primary>gimp_ruler_get_range</primary></indexterm><programlisting><link linkend="void">void</link> gimp_ruler_get_range (<link linkend="GimpRuler">GimpRuler</link> *ruler,
190
<indexterm zone="gimp-ruler-get-range" role="GIMP 2.8"><primary sortas="gimp_ruler_get_range">gimp_ruler_get_range</primary></indexterm><programlisting><link linkend="void">void</link> gimp_ruler_get_range (<link linkend="GimpRuler">GimpRuler</link> *ruler,
209
191
<link linkend="gdouble">gdouble</link> *lower,
210
192
<link linkend="gdouble">gdouble</link> *upper,
211
193
<link linkend="gdouble">gdouble</link> *max_size);</programlisting>
213
195
Retrieves values indicating the range and current position of a <link linkend="GimpRuler"><type>GimpRuler</type></link>.
214
196
See <link linkend="gimp-ruler-set-range"><function>gimp_ruler_set_range()</function></link>.</para>
217
198
</para><variablelist role="params">
218
<varlistentry><term><parameter>ruler</parameter> :</term>
199
<varlistentry><term><parameter>ruler</parameter> :</term>
219
200
<listitem><simpara> a <link linkend="GimpRuler"><type>GimpRuler</type></link>
220
201
</simpara></listitem></varlistentry>
221
<varlistentry><term><parameter>lower</parameter> :</term>
222
<listitem><simpara> location to store lower limit of the ruler, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
223
</simpara></listitem></varlistentry>
224
<varlistentry><term><parameter>upper</parameter> :</term>
225
<listitem><simpara> location to store upper limit of the ruler, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
226
</simpara></listitem></varlistentry>
227
<varlistentry><term><parameter>max_size</parameter> :</term>
202
<varlistentry><term><parameter>lower</parameter> :</term>
203
<listitem><simpara> location to store lower limit of the ruler, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
204
</simpara></listitem></varlistentry>
205
<varlistentry><term><parameter>upper</parameter> :</term>
206
<listitem><simpara> location to store upper limit of the ruler, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
207
</simpara></listitem></varlistentry>
208
<varlistentry><term><parameter>max_size</parameter> :</term>
228
209
<listitem><simpara> location to store the maximum size of the ruler used when
229
calculating the space to leave for the text, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>.
210
calculating the space to leave for the text, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>.
230
211
</simpara></listitem></varlistentry>
231
</variablelist><para role="since">Since GIMP 2.8
212
</variablelist><para role="since">Since GIMP 2.8</para></refsect2>
235
215
<refsect1 id="GimpRuler.property-details" role="property_details">
236
216
<title role="property_details.title">Property Details</title>
237
<refsect2 id="GimpRuler--lower"><title>The <literal>"lower"</literal> property</title>
238
<indexterm zone="GimpRuler--lower"><primary>GimpRuler:lower</primary></indexterm><programlisting> "lower" <link linkend="gdouble">gdouble</link> : Read / Write</programlisting>
217
<refsect2 id="GimpRuler--lower" role="property"><title>The <literal>"lower"</literal> property</title>
218
<indexterm zone="GimpRuler--lower"><primary sortas="GimpRuler:lower">GimpRuler:lower</primary></indexterm><programlisting> "lower" <link linkend="gdouble">gdouble</link> : Read / Write</programlisting>
239
219
<para>Lower limit of ruler.</para><para>Default value: 0</para>
241
<refsect2 id="GimpRuler--max-size"><title>The <literal>"max-size"</literal> property</title>
242
<indexterm zone="GimpRuler--max-size"><primary>GimpRuler:max-size</primary></indexterm><programlisting> "max-size" <link linkend="gdouble">gdouble</link> : Read / Write</programlisting>
221
<refsect2 id="GimpRuler--max-size" role="property"><title>The <literal>"max-size"</literal> property</title>
222
<indexterm zone="GimpRuler--max-size"><primary sortas="GimpRuler:max-size">GimpRuler:max-size</primary></indexterm><programlisting> "max-size" <link linkend="gdouble">gdouble</link> : Read / Write</programlisting>
243
223
<para>Maximum size of the ruler.</para><para>Default value: 0</para>
245
<refsect2 id="GimpRuler--orientation"><title>The <literal>"orientation"</literal> property</title>
246
<indexterm zone="GimpRuler--orientation"><primary>GimpRuler:orientation</primary></indexterm><programlisting> "orientation" <link linkend="GtkOrientation">GtkOrientation</link> : Read / Write</programlisting>
225
<refsect2 id="GimpRuler--orientation" role="property"><title>The <literal>"orientation"</literal> property</title>
226
<indexterm zone="GimpRuler--orientation"><primary sortas="GimpRuler:orientation">GimpRuler:orientation</primary></indexterm><programlisting> "orientation" <link linkend="GtkOrientation">GtkOrientation</link> : Read / Write</programlisting>
247
227
<para>The orientation of the ruler.</para><para>Default value: GTK_ORIENTATION_HORIZONTAL</para>
249
<refsect2 id="GimpRuler--position"><title>The <literal>"position"</literal> property</title>
250
<indexterm zone="GimpRuler--position"><primary>GimpRuler:position</primary></indexterm><programlisting> "position" <link linkend="gdouble">gdouble</link> : Read / Write</programlisting>
229
<refsect2 id="GimpRuler--position" role="property"><title>The <literal>"position"</literal> property</title>
230
<indexterm zone="GimpRuler--position"><primary sortas="GimpRuler:position">GimpRuler:position</primary></indexterm><programlisting> "position" <link linkend="gdouble">gdouble</link> : Read / Write</programlisting>
251
231
<para>Position of mark on the ruler.</para><para>Default value: 0</para>
253
<refsect2 id="GimpRuler--unit"><title>The <literal>"unit"</literal> property</title>
254
<indexterm zone="GimpRuler--unit"><primary>GimpRuler:unit</primary></indexterm><programlisting> "unit" <link linkend="GimpUnit">GimpUnit</link> : Read / Write</programlisting>
233
<refsect2 id="GimpRuler--unit" role="property"><title>The <literal>"unit"</literal> property</title>
234
<indexterm zone="GimpRuler--unit"><primary sortas="GimpRuler:unit">GimpRuler:unit</primary></indexterm><programlisting> "unit" <link linkend="GimpUnit">GimpUnit</link> : Read / Write</programlisting>
255
235
<para>Unit of ruler.</para><para>Allowed values: [0,65535]</para>
256
236
<para>Default value: 0</para>
258
<refsect2 id="GimpRuler--upper"><title>The <literal>"upper"</literal> property</title>
259
<indexterm zone="GimpRuler--upper"><primary>GimpRuler:upper</primary></indexterm><programlisting> "upper" <link linkend="gdouble">gdouble</link> : Read / Write</programlisting>
238
<refsect2 id="GimpRuler--upper" role="property"><title>The <literal>"upper"</literal> property</title>
239
<indexterm zone="GimpRuler--upper"><primary sortas="GimpRuler:upper">GimpRuler:upper</primary></indexterm><programlisting> "upper" <link linkend="gdouble">gdouble</link> : Read / Write</programlisting>
260
240
<para>Upper limit of ruler.</para><para>Default value: 0</para>
264
243
<refsect1 id="GimpRuler.style-property-details" role="style_properties_details">
265
244
<title role="style_properties_details.title">Style Property Details</title>
266
<refsect2 id="GimpRuler--font-scale"><title>The <literal>"font-scale"</literal> style property</title>
267
<indexterm zone="GimpRuler--font-scale"><primary>GimpRuler:font-scale</primary></indexterm><programlisting> "font-scale" <link linkend="gdouble">gdouble</link> : Read</programlisting>
245
<refsect2 id="GimpRuler--s-font-scale" role="property"><title>The <literal>"font-scale"</literal> style property</title>
246
<indexterm zone="GimpRuler--s-font-scale"><primary sortas="GimpRuler:font-scale">GimpRuler:font-scale</primary></indexterm><programlisting> "font-scale" <link linkend="gdouble">gdouble</link> : Read</programlisting>
268
247
<para></para><para>Allowed values: >= 0</para>
269
248
<para>Default value: 0.833333</para>