This file is indexed.

/usr/share/libphat-dev/html/phat/phat-PhatKnob.html is in libphat-tools 0.4.1-5.

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
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>PhatKnob</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.70.1">
<link rel="start" href="index.html" title="PHAT Reference Manual">
<link rel="up" href="phatwidgets.html" title="Part&#160;II.&#160;PHAT Widgets">
<link rel="prev" href="PhatVKeyboard.html" title="PhatVKeyboard">
<link rel="next" href="PhatVFanSlider.html" title="PhatVFanSlider">
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="phat.html" title="Part&#160;I.&#160;PHAT Overview">
<link rel="part" href="phatwidgets.html" title="Part&#160;II.&#160;PHAT Widgets">
</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="PhatVKeyboard.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="phatwidgets.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">PHAT Reference Manual</th>
<td><a accesskey="n" href="PhatVFanSlider.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id319177" class="shortcut">Top</a>
                  &#160;|&#160;
                  <a href="#id347248" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="phat-PhatKnob"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id319177"></a><span class="refentrytitle">PhatKnob</span>
</h2>
<p>PhatKnob &#8212; </p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">



            <a href="phat-PhatKnob.html#PhatKnob">PhatKnob</a>;
<a
href="../gtk/GtkWidget.html"
>GtkWidget</a>*  <a href="phat-PhatKnob.html#phat-knob-new">phat_knob_new</a>                   (<a
href="../gtk/GtkAdjustment.html"
>GtkAdjustment</a> *adjustment);
<a
href="../gtk/GtkWidget.html"
>GtkWidget</a>*  <a href="phat-PhatKnob.html#phat-knob-new-with-range">phat_knob_new_with_range</a>        (double value,
                                             double lower,
                                             double upper,
                                             double step);
<a
href="../gtk/GtkAdjustment.html"
>GtkAdjustment</a>* <a href="phat-PhatKnob.html#phat-knob-get-adjustment">phat_knob_get_adjustment</a>     (<a href="phat-PhatKnob.html#PhatKnob">PhatKnob</a> *knob);
double      <a href="phat-PhatKnob.html#phat-knob-get-value">phat_knob_get_value</a>             (<a href="phat-PhatKnob.html#PhatKnob">PhatKnob</a> *knob);
void        <a href="phat-PhatKnob.html#phat-knob-set-value">phat_knob_set_value</a>             (<a href="phat-PhatKnob.html#PhatKnob">PhatKnob</a> *knob,
                                             double value);
void        <a href="phat-PhatKnob.html#phat-knob-set-range">phat_knob_set_range</a>             (<a href="phat-PhatKnob.html#PhatKnob">PhatKnob</a> *knob,
                                             double lower,
                                             double upper);
void        <a href="phat-PhatKnob.html#phat-knob-set-update-policy">phat_knob_set_update_policy</a>     (<a href="phat-PhatKnob.html#PhatKnob">PhatKnob</a> *knob,
                                             <a
href="../gtk/gtk-Standard-Enumerations.html#GtkUpdateType"
>GtkUpdateType</a> policy);
void        <a href="phat-PhatKnob.html#phat-knob-set-adjustment">phat_knob_set_adjustment</a>        (<a href="phat-PhatKnob.html#PhatKnob">PhatKnob</a> *knob,
                                             <a
href="../gtk/GtkAdjustment.html"
>GtkAdjustment</a> *adjustment);
void        <a href="phat-PhatKnob.html#phat-knob-set-log">phat_knob_set_log</a>               (<a href="phat-PhatKnob.html#PhatKnob">PhatKnob</a> *knob,
                                             <a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> is_log);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a>    <a href="phat-PhatKnob.html#phat-knob-is-log">phat_knob_is_log</a>                (<a href="phat-PhatKnob.html#PhatKnob">PhatKnob</a> *knob);

</pre>
</div>
<div class="refsect1" lang="en">
<a name="id347248"></a><h2>Description</h2>
<p>

</p>
</div>
<div class="refsect1" lang="en">
<a name="id347264"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id347275"></a><h3>
<a name="PhatKnob"></a>PhatKnob</h3>
<a class="indexterm" name="id347287"></a><pre class="programlisting">typedef struct {
    GtkWidget widget;
    /* The adjustment object that stores the data for this knob */
    GtkAdjustment *adjustment;
    GtkAdjustment* adjustment_prv;


    /* update policy (GTK_UPDATE_[CONTINUOUS/DELAYED/DISCONTINUOUS]) */
    guint policy : 2;
    gboolean is_log;

    /* State of widget (to do with user interaction) */
    guint8 state;
    gint saved_x, saved_y;

    /* ID of update timer, or 0 if none */
    guint32 timer;

    /* Pixmap for knob */
    GdkPixbuf *pixbuf;
    GdkBitmap *mask;
    GdkGC *mask_gc;
    GdkGC *red_gc;

    /* Old values from adjustment stored so we know when something changes */
    gfloat old_value;
    gfloat old_lower;
    gfloat old_upper;
} PhatKnob;
</pre>
<p>

</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id340768"></a><h3>
<a name="phat-knob-new"></a>phat_knob_new ()</h3>
<a class="indexterm" name="id332185"></a><pre class="programlisting"><a
href="../gtk/GtkWidget.html"
>GtkWidget</a>*  phat_knob_new                   (<a
href="../gtk/GtkAdjustment.html"
>GtkAdjustment</a> *adjustment);</pre>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>adjustment</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>


</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id322322"></a><h3>
<a name="phat-knob-new-with-range"></a>phat_knob_new_with_range ()</h3>
<a class="indexterm" name="id322334"></a><pre class="programlisting"><a
href="../gtk/GtkWidget.html"
>GtkWidget</a>*  phat_knob_new_with_range        (double value,
                                             double lower,
                                             double upper,
                                             double step);</pre>
<p>
Creates a new <a href="phat-PhatKnob.html#PhatKnob"><span class="type">PhatKnob</span></a>.  The knob will create a new
<a
href="../gtk/GtkAdjustment.html"
><span class="type">GtkAdjustment</span></a> from <em class="parameter"><code>value</code></em>, <em class="parameter"><code>lower</code></em>, <em class="parameter"><code>upper</code></em>, and <em class="parameter"><code>step</code></em>.  If these
parameters represent a bogus configuration, the program will
terminate.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>value</code></em>&#160;:</span></td>
<td> the initial value the new knob should have
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>lower</code></em>&#160;:</span></td>
<td> the lowest value the new knob will allow
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>upper</code></em>&#160;:</span></td>
<td> the highest value the new knob will allow
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>step</code></em>&#160;:</span></td>
<td> increment added or subtracted when turning
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> a newly created <a href="phat-PhatKnob.html#PhatKnob"><span class="type">PhatKnob</span></a>

</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id322498"></a><h3>
<a name="phat-knob-get-adjustment"></a>phat_knob_get_adjustment ()</h3>
<a class="indexterm" name="id322510"></a><pre class="programlisting"><a
href="../gtk/GtkAdjustment.html"
>GtkAdjustment</a>* phat_knob_get_adjustment     (<a href="phat-PhatKnob.html#PhatKnob">PhatKnob</a> *knob);</pre>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>knob</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>


</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id358357"></a><h3>
<a name="phat-knob-get-value"></a>phat_knob_get_value ()</h3>
<a class="indexterm" name="id358367"></a><pre class="programlisting">double      phat_knob_get_value             (<a href="phat-PhatKnob.html#PhatKnob">PhatKnob</a> *knob);</pre>
<p>
Retrieves the current value of the knob.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>knob</code></em>&#160;:</span></td>
<td> a <a href="phat-PhatKnob.html#PhatKnob"><span class="type">PhatKnob</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> current value of the knob

</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id358426"></a><h3>
<a name="phat-knob-set-value"></a>phat_knob_set_value ()</h3>
<a class="indexterm" name="id358436"></a><pre class="programlisting">void        phat_knob_set_value             (<a href="phat-PhatKnob.html#PhatKnob">PhatKnob</a> *knob,
                                             double value);</pre>
<p>
Sets the current value of the knob.  If the value is outside the
range of values allowed by <em class="parameter"><code>knob</code></em>, it will be clamped.  The knob
emits the "value-changed" signal if the value changes.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>knob</code></em>&#160;:</span></td>
<td> a <a href="phat-PhatKnob.html#PhatKnob"><span class="type">PhatKnob</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>value</code></em>&#160;:</span></td>
<td> a new value for the knob
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id358510"></a><h3>
<a name="phat-knob-set-range"></a>phat_knob_set_range ()</h3>
<a class="indexterm" name="id358520"></a><pre class="programlisting">void        phat_knob_set_range             (<a href="phat-PhatKnob.html#PhatKnob">PhatKnob</a> *knob,
                                             double lower,
                                             double upper);</pre>
<p>
Sets the range of allowable values for the knob, and clamps the
knob's current value to be between <em class="parameter"><code>lower</code></em> and <em class="parameter"><code>upper</code></em>.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>knob</code></em>&#160;:</span></td>
<td> a <a href="phat-PhatKnob.html#PhatKnob"><span class="type">PhatKnob</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>lower</code></em>&#160;:</span></td>
<td> lowest allowable value
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>upper</code></em>&#160;:</span></td>
<td> highest allowable value
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id358616"></a><h3>
<a name="phat-knob-set-update-policy"></a>phat_knob_set_update_policy ()</h3>
<a class="indexterm" name="id358627"></a><pre class="programlisting">void        phat_knob_set_update_policy     (<a href="phat-PhatKnob.html#PhatKnob">PhatKnob</a> *knob,
                                             <a
href="../gtk/gtk-Standard-Enumerations.html#GtkUpdateType"
>GtkUpdateType</a> policy);</pre>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>knob</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>policy</code></em>&#160;:</span></td>
<td>


</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id358684"></a><h3>
<a name="phat-knob-set-adjustment"></a>phat_knob_set_adjustment ()</h3>
<a class="indexterm" name="id358695"></a><pre class="programlisting">void        phat_knob_set_adjustment        (<a href="phat-PhatKnob.html#PhatKnob">PhatKnob</a> *knob,
                                             <a
href="../gtk/GtkAdjustment.html"
>GtkAdjustment</a> *adjustment);</pre>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>knob</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>adjustment</code></em>&#160;:</span></td>
<td>


</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id358752"></a><h3>
<a name="phat-knob-set-log"></a>phat_knob_set_log ()</h3>
<a class="indexterm" name="id358763"></a><pre class="programlisting">void        phat_knob_set_log               (<a href="phat-PhatKnob.html#PhatKnob">PhatKnob</a> *knob,
                                             <a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> is_log);</pre>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>knob</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>is_log</code></em>&#160;:</span></td>
<td>


</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id358820"></a><h3>
<a name="phat-knob-is-log"></a>phat_knob_is_log ()</h3>
<a class="indexterm" name="id358831"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a>    phat_knob_is_log                (<a href="phat-PhatKnob.html#PhatKnob">PhatKnob</a> *knob);</pre>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>knob</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>


</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</body>
</html>