/usr/share/gtk-doc/html/libmokoui2/MokoFingerScroll.html is in libmokoui2-doc 0.3+bzr20080630-0ubuntu5.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>MokoFingerScroll</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="libmokoui Reference Manual">
<link rel="up" href="ch01.html" title="libmokoui2">
<link rel="prev" href="MokoHintEntry.html" title="MokoHintEntry">
<link rel="next" href="MokoSearchBar.html" title="MokoSearchBar">
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</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="MokoHintEntry.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.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">libmokoui Reference Manual</th>
<td><a accesskey="n" href="MokoSearchBar.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#MokoFingerScroll.synopsis" class="shortcut">Top</a>
|
<a href="#MokoFingerScroll.description" class="shortcut">Description</a>
|
<a href="#MokoFingerScroll.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#MokoFingerScroll.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
<a href="#MokoFingerScroll.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="MokoFingerScroll"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="MokoFingerScroll.top_of_page"></a>MokoFingerScroll</span></h2>
<p>MokoFingerScroll — A scrolling widget designed for touch screens</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="MokoFingerScroll.synopsis"></a><h2>Synopsis</h2>
<a name="MokoFingerScrollMode"></a><a name="MokoFingerScrollIndicatorMode"></a><pre class="synopsis">struct <a class="link" href="MokoFingerScroll.html#MokoFingerScroll-struct" title="struct MokoFingerScroll">MokoFingerScroll</a>;
struct <a class="link" href="MokoFingerScroll.html#MokoFingerScrollClass" title="struct MokoFingerScrollClass">MokoFingerScrollClass</a>;
enum <a class="link" href="MokoFingerScroll.html#MokoFingerScrollMode-enum" title="enum MokoFingerScrollMode">MokoFingerScrollMode</a>;
enum <a class="link" href="MokoFingerScroll.html#MokoFingerScrollIndicatorMode-enum" title="enum MokoFingerScrollIndicatorMode">MokoFingerScrollIndicatorMode</a>;
<span class="returnvalue">GtkWidget</span> * <a class="link" href="MokoFingerScroll.html#moko-finger-scroll-new" title="moko_finger_scroll_new ()">moko_finger_scroll_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">GtkWidget</span> * <a class="link" href="MokoFingerScroll.html#moko-finger-scroll-new-full" title="moko_finger_scroll_new_full ()">moko_finger_scroll_new_full</a> (<em class="parameter"><code><span class="type">gint</span> mode</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> enabled</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> vel_min</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> vel_max</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> decel</code></em>,
<em class="parameter"><code><span class="type">guint</span> sps</code></em>);
<span class="returnvalue">void</span> <a class="link" href="MokoFingerScroll.html#moko-finger-scroll-add-with-viewport" title="moko_finger_scroll_add_with_viewport ()">moko_finger_scroll_add_with_viewport</a>
(<em class="parameter"><code><a class="link" href="MokoFingerScroll.html" title="MokoFingerScroll"><span class="type">MokoFingerScroll</span></a> *scroll</code></em>,
<em class="parameter"><code><span class="type">GtkWidget</span> *child</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="MokoFingerScroll.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----GInitiallyUnowned
+----GtkObject
+----GtkWidget
+----GtkContainer
+----GtkBin
+----GtkEventBox
+----MokoFingerScroll
</pre>
<pre class="synopsis">
GEnum
+----MokoFingerScrollMode
</pre>
<pre class="synopsis">
GEnum
+----MokoFingerScrollIndicatorMode
</pre>
</div>
<div class="refsect1">
<a name="MokoFingerScroll.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
MokoFingerScroll implements
AtkImplementorIface and GtkBuildable.</p>
</div>
<div class="refsect1">
<a name="MokoFingerScroll.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="MokoFingerScroll.html#MokoFingerScroll--deceleration" title='The "deceleration" property'>deceleration</a>" <span class="type">gdouble</span> : Read / Write / Construct
"<a class="link" href="MokoFingerScroll.html#MokoFingerScroll--enabled" title='The "enabled" property'>enabled</a>" <span class="type">gboolean</span> : Read / Write / Construct
"<a class="link" href="MokoFingerScroll.html#MokoFingerScroll--hindicator-mode" title='The "hindicator-mode" property'>hindicator-mode</a>" <a class="link" href="MokoFingerScroll.html#MokoFingerScrollIndicatorMode"><span class="type">MokoFingerScrollIndicatorMode</span></a> : Read / Write / Construct
"<a class="link" href="MokoFingerScroll.html#MokoFingerScroll--mode" title='The "mode" property'>mode</a>" <a class="link" href="MokoFingerScroll.html#MokoFingerScrollMode"><span class="type">MokoFingerScrollMode</span></a> : Read / Write / Construct
"<a class="link" href="MokoFingerScroll.html#MokoFingerScroll--spring-color" title='The "spring-color" property'>spring-color</a>" <span class="type">guint</span> : Read / Write / Construct
"<a class="link" href="MokoFingerScroll.html#MokoFingerScroll--spring-speed" title='The "spring-speed" property'>spring-speed</a>" <span class="type">gdouble</span> : Read / Write / Construct
"<a class="link" href="MokoFingerScroll.html#MokoFingerScroll--sps" title='The "sps" property'>sps</a>" <span class="type">guint</span> : Read / Write / Construct
"<a class="link" href="MokoFingerScroll.html#MokoFingerScroll--velocity-max" title='The "velocity-max" property'>velocity-max</a>" <span class="type">gdouble</span> : Read / Write / Construct
"<a class="link" href="MokoFingerScroll.html#MokoFingerScroll--velocity-min" title='The "velocity-min" property'>velocity-min</a>" <span class="type">gdouble</span> : Read / Write / Construct
"<a class="link" href="MokoFingerScroll.html#MokoFingerScroll--vindicator-mode" title='The "vindicator-mode" property'>vindicator-mode</a>" <a class="link" href="MokoFingerScroll.html#MokoFingerScrollIndicatorMode"><span class="type">MokoFingerScrollIndicatorMode</span></a> : Read / Write / Construct
</pre>
</div>
<div class="refsect1">
<a name="MokoFingerScroll.description"></a><h2>Description</h2>
<p>
<a class="link" href="MokoFingerScroll.html" title="MokoFingerScroll"><span class="type">MokoFingerScroll</span></a> implements a scrolled window designed to be used with a
touch screen interface. The user scrolls the child widget by activating the
pointing device and dragging it over the widget.
</p>
</div>
<div class="refsect1">
<a name="MokoFingerScroll.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="MokoFingerScroll-struct"></a><h3>struct MokoFingerScroll</h3>
<pre class="programlisting">struct MokoFingerScroll;</pre>
<p>
MokoFingerScroll has no publicly accessible fields
</p>
</div>
<hr>
<div class="refsect2">
<a name="MokoFingerScrollClass"></a><h3>struct MokoFingerScrollClass</h3>
<pre class="programlisting">struct MokoFingerScrollClass {
GtkEventBoxClass parent_class;
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="MokoFingerScrollMode-enum"></a><h3>enum MokoFingerScrollMode</h3>
<pre class="programlisting">typedef enum {
MOKO_FINGER_SCROLL_MODE_PUSH,
MOKO_FINGER_SCROLL_MODE_ACCEL,
MOKO_FINGER_SCROLL_MODE_AUTO
} MokoFingerScrollMode;
</pre>
<p>
Used to change the behaviour of the finger scrolling
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="MOKO-FINGER-SCROLL-MODE-PUSH:CAPS"></a><span class="term"><code class="literal">MOKO_FINGER_SCROLL_MODE_PUSH</code></span></p></td>
<td>Scrolling follows pointer
</td>
</tr>
<tr>
<td><p><a name="MOKO-FINGER-SCROLL-MODE-ACCEL:CAPS"></a><span class="term"><code class="literal">MOKO_FINGER_SCROLL_MODE_ACCEL</code></span></p></td>
<td>Scrolling uses physics to "spin" the widget
</td>
</tr>
<tr>
<td><p><a name="MOKO-FINGER-SCROLL-MODE-AUTO:CAPS"></a><span class="term"><code class="literal">MOKO_FINGER_SCROLL_MODE_AUTO</code></span></p></td>
<td>Automatically chooses between push and accel
modes, depending on input.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="MokoFingerScrollIndicatorMode-enum"></a><h3>enum MokoFingerScrollIndicatorMode</h3>
<pre class="programlisting">typedef enum {
MOKO_FINGER_SCROLL_INDICATOR_MODE_AUTO,
MOKO_FINGER_SCROLL_INDICATOR_MODE_SHOW,
MOKO_FINGER_SCROLL_INDICATOR_MODE_HIDE
} MokoFingerScrollIndicatorMode;
</pre>
<p>
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="MOKO-FINGER-SCROLL-INDICATOR-MODE-AUTO:CAPS"></a><span class="term"><code class="literal">MOKO_FINGER_SCROLL_INDICATOR_MODE_AUTO</code></span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><a name="MOKO-FINGER-SCROLL-INDICATOR-MODE-SHOW:CAPS"></a><span class="term"><code class="literal">MOKO_FINGER_SCROLL_INDICATOR_MODE_SHOW</code></span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><a name="MOKO-FINGER-SCROLL-INDICATOR-MODE-HIDE:CAPS"></a><span class="term"><code class="literal">MOKO_FINGER_SCROLL_INDICATOR_MODE_HIDE</code></span></p></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="moko-finger-scroll-new"></a><h3>moko_finger_scroll_new ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * moko_finger_scroll_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Create a new finger scroll widget
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the newly created <a class="link" href="MokoFingerScroll.html" title="MokoFingerScroll"><span class="type">MokoFingerScroll</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="moko-finger-scroll-new-full"></a><h3>moko_finger_scroll_new_full ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * moko_finger_scroll_new_full (<em class="parameter"><code><span class="type">gint</span> mode</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> enabled</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> vel_min</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> vel_max</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> decel</code></em>,
<em class="parameter"><code><span class="type">guint</span> sps</code></em>);</pre>
<p>
Create a new <a class="link" href="MokoFingerScroll.html" title="MokoFingerScroll"><span class="type">MokoFingerScroll</span></a> widget and set various properties
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>mode</code></em> :</span></p></td>
<td><a class="link" href="MokoFingerScroll.html#MokoFingerScrollMode"><span class="type">MokoFingerScrollMode</span></a></td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>enabled</code></em> :</span></p></td>
<td>Value for the enabled property</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>vel_min</code></em> :</span></p></td>
<td>Value for the velocity-min property</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>vel_max</code></em> :</span></p></td>
<td>Value for the velocity-max property</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>decel</code></em> :</span></p></td>
<td>Value for the deceleration property</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>sps</code></em> :</span></p></td>
<td>Value for the sps property</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the newly create <span class="type">MokoFingerScrull</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="moko-finger-scroll-add-with-viewport"></a><h3>moko_finger_scroll_add_with_viewport ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> moko_finger_scroll_add_with_viewport
(<em class="parameter"><code><a class="link" href="MokoFingerScroll.html" title="MokoFingerScroll"><span class="type">MokoFingerScroll</span></a> *scroll</code></em>,
<em class="parameter"><code><span class="type">GtkWidget</span> *child</code></em>);</pre>
<p>
Convenience function used to add a child to a <span class="type">GtkViewport</span>, and add the
viewport to the scrolled window.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>scroll</code></em> :</span></p></td>
<td>A <a class="link" href="MokoFingerScroll.html" title="MokoFingerScroll"><span class="type">MokoFingerScroll</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>child</code></em> :</span></p></td>
<td>Child widget to add to the viewport</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="MokoFingerScroll.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="MokoFingerScroll--deceleration"></a><h3>The <code class="literal">"deceleration"</code> property</h3>
<pre class="programlisting"> "deceleration" <span class="type">gdouble</span> : Read / Write / Construct</pre>
<p>The multiplier used when decelerating when in acceleration scrolling mode.</p>
<p>Allowed values: [0,1]</p>
<p>Default value: 0.95</p>
</div>
<hr>
<div class="refsect2">
<a name="MokoFingerScroll--enabled"></a><h3>The <code class="literal">"enabled"</code> property</h3>
<pre class="programlisting"> "enabled" <span class="type">gboolean</span> : Read / Write / Construct</pre>
<p>Enable or disable finger-scroll.</p>
<p>Default value: TRUE</p>
</div>
<hr>
<div class="refsect2">
<a name="MokoFingerScroll--hindicator-mode"></a><h3>The <code class="literal">"hindicator-mode"</code> property</h3>
<pre class="programlisting"> "hindicator-mode" <a class="link" href="MokoFingerScroll.html#MokoFingerScrollIndicatorMode"><span class="type">MokoFingerScrollIndicatorMode</span></a> : Read / Write / Construct</pre>
<p>Mode of the horizontal scrolling indicator.</p>
<p>Default value: MOKO_FINGER_SCROLL_INDICATOR_MODE_AUTO</p>
</div>
<hr>
<div class="refsect2">
<a name="MokoFingerScroll--mode"></a><h3>The <code class="literal">"mode"</code> property</h3>
<pre class="programlisting"> "mode" <a class="link" href="MokoFingerScroll.html#MokoFingerScrollMode"><span class="type">MokoFingerScrollMode</span></a> : Read / Write / Construct</pre>
<p>Change the finger-scrolling mode.</p>
<p>Default value: MOKO_FINGER_SCROLL_MODE_AUTO</p>
</div>
<hr>
<div class="refsect2">
<a name="MokoFingerScroll--spring-color"></a><h3>The <code class="literal">"spring-color"</code> property</h3>
<pre class="programlisting"> "spring-color" <span class="type">guint</span> : Read / Write / Construct</pre>
<p>spring area color.</p>
<p>Default value: 4294967295</p>
</div>
<hr>
<div class="refsect2">
<a name="MokoFingerScroll--spring-speed"></a><h3>The <code class="literal">"spring-speed"</code> property</h3>
<pre class="programlisting"> "spring-speed" <span class="type">gdouble</span> : Read / Write / Construct</pre>
<p>The multiplier used when decelerating when in spring.</p>
<p>Allowed values: [0,1]</p>
<p>Default value: 0.85</p>
</div>
<hr>
<div class="refsect2">
<a name="MokoFingerScroll--sps"></a><h3>The <code class="literal">"sps"</code> property</h3>
<pre class="programlisting"> "sps" <span class="type">guint</span> : Read / Write / Construct</pre>
<p>Amount of scroll events to generate per second.</p>
<p>Default value: 15</p>
</div>
<hr>
<div class="refsect2">
<a name="MokoFingerScroll--velocity-max"></a><h3>The <code class="literal">"velocity-max"</code> property</h3>
<pre class="programlisting"> "velocity-max" <span class="type">gdouble</span> : Read / Write / Construct</pre>
<p>Maximum distance the child widget should scroll per 'frame', in pixels.</p>
<p>Allowed values: >= 0</p>
<p>Default value: 48</p>
</div>
<hr>
<div class="refsect2">
<a name="MokoFingerScroll--velocity-min"></a><h3>The <code class="literal">"velocity-min"</code> property</h3>
<pre class="programlisting"> "velocity-min" <span class="type">gdouble</span> : Read / Write / Construct</pre>
<p>Minimum distance the child widget should scroll per 'frame', in pixels.</p>
<p>Allowed values: >= 0</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="MokoFingerScroll--vindicator-mode"></a><h3>The <code class="literal">"vindicator-mode"</code> property</h3>
<pre class="programlisting"> "vindicator-mode" <a class="link" href="MokoFingerScroll.html#MokoFingerScrollIndicatorMode"><span class="type">MokoFingerScrollIndicatorMode</span></a> : Read / Write / Construct</pre>
<p>Mode of the vertical scrolling indicator.</p>
<p>Default value: MOKO_FINGER_SCROLL_INDICATOR_MODE_AUTO</p>
</div>
</div>
<div class="refsect1">
<a name="MokoFingerScroll.see-also"></a><h2>See Also</h2>
<span class="type">GtkScrolledWindow</span>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|