/usr/share/gtk-doc/html/libinstpatch/libinstpatch-IpatchRange.html is in libinstpatch-doc 1.0.0-6.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>IpatchRange</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
<link rel="home" href="index.html" title="libinstpatch Reference Manual">
<link rel="up" href="ch02.html" title="Utility objects and functions">
<link rel="prev" href="libinstpatch-IpatchXmlObject.html" title="IpatchXmlObject">
<link rel="next" href="libinstpatch-md5.html" title="md5">
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="ch01.html" title="Base objects and functions">
<link rel="chapter" href="ch02.html" title="Utility objects and functions">
<link rel="chapter" href="ch03.html" title="Sample data objects and functions">
<link rel="chapter" href="ch04.html" title="DLS patches">
<link rel="chapter" href="ch05.html" title="SoundFont patches">
<link rel="chapter" href="ch06.html" title="GigaSampler patches">
<link rel="chapter" href="ch07.html" title="Virtual banks">
<link rel="chapter" href="object-tree.html" title="Object Hierarchy">
<link rel="index" href="api-index-full.html" title="API Index">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libinstpatch-IpatchXmlObject.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch02.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">libinstpatch Reference Manual</th>
<td><a accesskey="n" href="libinstpatch-md5.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libinstpatch-IpatchRange.synopsis" class="shortcut">Top</a>
|
<a href="#libinstpatch-IpatchRange.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="IpatchRange">
<a name="libinstpatch-IpatchRange"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libinstpatch-IpatchRange.top_of_page"></a>IpatchRange</span></h2>
<p>IpatchRange — A boxed type which defines a number range</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1" title="Stability Level">
<a name="libinstpatch-IpatchRange.stability-level"></a><h2>Stability Level</h2>
Stable, unless otherwise indicated
</div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="libinstpatch-IpatchRange.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
<a
href="../libinstpatch/libinstpatch-IpatchRange.html#IpatchRange"
>IpatchRange</a>;
<a
href="../libinstpatch/libinstpatch-IpatchRange.html#IpatchParamSpecRange"
>IpatchParamSpecRange</a>;
#define <a
href="../libinstpatch/libinstpatch-IpatchRange.html#IPATCH-TYPE-RANGE--CAPS"
>IPATCH_TYPE_RANGE</a>
#define <a
href="../libinstpatch/libinstpatch-IpatchRange.html#IPATCH-VALUE-HOLDS-RANGE--CAPS"
>IPATCH_VALUE_HOLDS_RANGE</a> (value)
#define <a
href="../libinstpatch/libinstpatch-IpatchRange.html#IPATCH-RANGE-SET-VALUES--CAPS"
>IPATCH_RANGE_SET_VALUES</a> (range, val1, val2)
#define <a
href="../libinstpatch/libinstpatch-IpatchRange.html#IPATCH-RANGE-SET-NULL--CAPS"
>IPATCH_RANGE_SET_NULL</a> (range)
<a
href="../libinstpatch/libinstpatch-IpatchRange.html#IpatchRange"
>IpatchRange</a> * <a
href="../libinstpatch/libinstpatch-IpatchRange.html#ipatch-range-new"
>ipatch_range_new</a> (int low,
int high);
<a
href="../libinstpatch/libinstpatch-IpatchRange.html#IpatchRange"
>IpatchRange</a> * <a
href="../libinstpatch/libinstpatch-IpatchRange.html#ipatch-range-copy"
>ipatch_range_copy</a> (<a
href="../libinstpatch/libinstpatch-IpatchRange.html#IpatchRange"
>IpatchRange</a> *range);
void <a
href="../libinstpatch/libinstpatch-IpatchRange.html#ipatch-range-free"
>ipatch_range_free</a> (<a
href="../libinstpatch/libinstpatch-IpatchRange.html#IpatchRange"
>IpatchRange</a> *range);
void <a
href="../libinstpatch/libinstpatch-IpatchRange.html#ipatch-value-set-range"
>ipatch_value_set_range</a> (<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"
>GValue</a> *value,
const <a
href="../libinstpatch/libinstpatch-IpatchRange.html#IpatchRange"
>IpatchRange</a> *range);
void <a
href="../libinstpatch/libinstpatch-IpatchRange.html#ipatch-value-set-static-range"
>ipatch_value_set_static_range</a> (<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"
>GValue</a> *value,
<a
href="../libinstpatch/libinstpatch-IpatchRange.html#IpatchRange"
>IpatchRange</a> *range);
<a
href="../libinstpatch/libinstpatch-IpatchRange.html#IpatchRange"
>IpatchRange</a> * <a
href="../libinstpatch/libinstpatch-IpatchRange.html#ipatch-value-get-range"
>ipatch_value_get_range</a> (const <a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"
>GValue</a> *value);
#define <a
href="../libinstpatch/libinstpatch-IpatchRange.html#IPATCH-TYPE-PARAM-RANGE--CAPS"
>IPATCH_TYPE_PARAM_RANGE</a>
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a> <a
href="../libinstpatch/libinstpatch-IpatchRange.html#ipatch-param-spec-range-get-type"
>ipatch_param_spec_range_get_type</a> (void);
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"
>GParamSpec</a> * <a
href="../libinstpatch/libinstpatch-IpatchRange.html#ipatch-param-spec-range"
>ipatch_param_spec_range</a> (const char *name,
const char *nick,
const char *blurb,
int min,
int max,
int default_low,
int default_high,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamFlags"
>GParamFlags</a> flags);
</pre>
</div>
<div class="refsect1" title="Description">
<a name="libinstpatch-IpatchRange.description"></a><h2>Description</h2>
<p>
Boxed type used for <a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"
><span class="type">GValue</span></a> and <a
href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"
><span class="type">GParamSpec</span></a> properties. Consists of a low
and a high integer value defining a range.</p>
</div>
<div class="refsect1" title="Details">
<a name="libinstpatch-IpatchRange.details"></a><h2>Details</h2>
<div class="refsect2" title="IpatchRange">
<a name="IpatchRange"></a><h3>IpatchRange</h3>
<pre class="programlisting">typedef struct {
int low; /* low endpoint of range or -1 if undefined */
int high; /* high endpoint of range or -1 if undefined */
} IpatchRange;
</pre>
</div>
<hr>
<div class="refsect2" title="IpatchParamSpecRange">
<a name="IpatchParamSpecRange"></a><h3>IpatchParamSpecRange</h3>
<pre class="programlisting">typedef struct {
GParamSpec parent_instance; /* derived from GParamSpec */
int min, max; /* min and max values for range endpoints */
int default_low, default_high; /* default vals for low and high endpoints */
} IpatchParamSpecRange;
</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_TYPE_RANGE">
<a name="IPATCH-TYPE-RANGE--CAPS"></a><h3>IPATCH_TYPE_RANGE</h3>
<pre class="programlisting">#define IPATCH_TYPE_RANGE (ipatch_range_get_type ())
</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_VALUE_HOLDS_RANGE()">
<a name="IPATCH-VALUE-HOLDS-RANGE--CAPS"></a><h3>IPATCH_VALUE_HOLDS_RANGE()</h3>
<pre class="programlisting">#define IPATCH_VALUE_HOLDS_RANGE(value)</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_RANGE_SET_VALUES()">
<a name="IPATCH-RANGE-SET-VALUES--CAPS"></a><h3>IPATCH_RANGE_SET_VALUES()</h3>
<pre class="programlisting">#define IPATCH_RANGE_SET_VALUES(range, val1, val2)</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_RANGE_SET_NULL()">
<a name="IPATCH-RANGE-SET-NULL--CAPS"></a><h3>IPATCH_RANGE_SET_NULL()</h3>
<pre class="programlisting">#define IPATCH_RANGE_SET_NULL(range)</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_range_new ()">
<a name="ipatch-range-new"></a><h3>ipatch_range_new ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/libinstpatch-IpatchRange.html#IpatchRange"
>IpatchRange</a> * ipatch_range_new (int low,
int high);</pre>
<p>
Create a new value range structure (to store an integer range).</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>low</code></em> :</span></p></td>
<td> Low value to initialize range to
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>high</code></em> :</span></p></td>
<td> High value to initialize range to
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Newly allocated integer range structure.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_range_copy ()">
<a name="ipatch-range-copy"></a><h3>ipatch_range_copy ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/libinstpatch-IpatchRange.html#IpatchRange"
>IpatchRange</a> * ipatch_range_copy (<a
href="../libinstpatch/libinstpatch-IpatchRange.html#IpatchRange"
>IpatchRange</a> *range);</pre>
<p>
Duplicates an integer range structure.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>range</code></em> :</span></p></td>
<td> Range structure to duplicate
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> New duplicate range structure.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_range_free ()">
<a name="ipatch-range-free"></a><h3>ipatch_range_free ()</h3>
<pre class="programlisting">void ipatch_range_free (<a
href="../libinstpatch/libinstpatch-IpatchRange.html#IpatchRange"
>IpatchRange</a> *range);</pre>
<p>
Free a range structure previously allocated with <a
href="../libinstpatch/libinstpatch-IpatchRange.html#ipatch-range-new"
><code class="function">ipatch_range_new()</code></a>.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>range</code></em> :</span></p></td>
<td> Integer range structure to free
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_value_set_range ()">
<a name="ipatch-value-set-range"></a><h3>ipatch_value_set_range ()</h3>
<pre class="programlisting">void ipatch_value_set_range (<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"
>GValue</a> *value,
const <a
href="../libinstpatch/libinstpatch-IpatchRange.html#IpatchRange"
>IpatchRange</a> *range);</pre>
<p>
Set the range values of a IPATCH_TYPE_RANGE GValue. The <em class="parameter"><code>range</code></em>
structure is copied.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td> a valid GValue of IPATCH_TYPE_RANGE boxed type
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>range</code></em> :</span></p></td>
<td> Range structure to assign to <em class="parameter"><code>value</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_value_set_static_range ()">
<a name="ipatch-value-set-static-range"></a><h3>ipatch_value_set_static_range ()</h3>
<pre class="programlisting">void ipatch_value_set_static_range (<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"
>GValue</a> *value,
<a
href="../libinstpatch/libinstpatch-IpatchRange.html#IpatchRange"
>IpatchRange</a> *range);</pre>
<p>
Set the range values of a IPATCH_TYPE_RANGE GValue. This function uses
<em class="parameter"><code>range</code></em> directly and so it should be static, use <a
href="../libinstpatch/libinstpatch-IpatchRange.html#ipatch-value-set-range"
><code class="function">ipatch_value_set_range()</code></a>
if the <em class="parameter"><code>range</code></em> value should be duplicated.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td> A valid GValue of IPATCH_TYPE_RANGE boxed type
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>range</code></em> :</span></p></td>
<td> Range structure to assign to <em class="parameter"><code>value</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_value_get_range ()">
<a name="ipatch-value-get-range"></a><h3>ipatch_value_get_range ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/libinstpatch-IpatchRange.html#IpatchRange"
>IpatchRange</a> * ipatch_value_get_range (const <a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"
>GValue</a> *value);</pre>
<p>
Get the range structure from a IPATCH_TYPE_RANGE GValue.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td> A valid GValue of IPATCH_TYPE_RANGE boxed type
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <a
href="../libinstpatch/libinstpatch-IpatchRange.html#IpatchRange"
><span class="type">IpatchRange</span></a> structure containing the range values of <em class="parameter"><code>value</code></em> or
<code class="literal">NULL</code> if not set. The returned structure is NOT duplicated and is the
same pointer used in <em class="parameter"><code>value</code></em>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="IPATCH_TYPE_PARAM_RANGE">
<a name="IPATCH-TYPE-PARAM-RANGE--CAPS"></a><h3>IPATCH_TYPE_PARAM_RANGE</h3>
<pre class="programlisting">#define IPATCH_TYPE_PARAM_RANGE (ipatch_param_spec_range_get_type ())
</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_param_spec_range_get_type ()">
<a name="ipatch-param-spec-range-get-type"></a><h3>ipatch_param_spec_range_get_type ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a> ipatch_param_spec_range_get_type (void);</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_param_spec_range ()">
<a name="ipatch-param-spec-range"></a><h3>ipatch_param_spec_range ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"
>GParamSpec</a> * ipatch_param_spec_range (const char *name,
const char *nick,
const char *blurb,
int min,
int max,
int default_low,
int default_high,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamFlags"
>GParamFlags</a> flags);</pre>
<p>
Create a parameter specification for IPATCH_TYPE_RANGE GValues.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td> Property name
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>nick</code></em> :</span></p></td>
<td> Property nick name
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>blurb</code></em> :</span></p></td>
<td> Property description blurb
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>min</code></em> :</span></p></td>
<td> Minimum value for range end points (can be -1 to allow undefined
ranges)
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>max</code></em> :</span></p></td>
<td> Maximum value for range end points
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>default_low</code></em> :</span></p></td>
<td> Default value for low endpoint of range
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>default_high</code></em> :</span></p></td>
<td> Default value for high endpoint of range
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
<td> Property flags
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> New range parameter specification.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.11</div>
</body>
</html>
|