/usr/share/gtk-doc/html/clutter/ClutterClickAction.html is in libclutter-1.0-doc 1.20.0-1.
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 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Clutter Reference Manual: ClutterClickAction</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Clutter Reference Manual">
<link rel="up" href="ch04.html" title="Actions">
<link rel="prev" href="ch04.html" title="Actions">
<link rel="next" href="ClutterDragAction.html" title="ClutterDragAction">
<meta name="generator" content="GTK-Doc V1.21 (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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#ClutterClickAction.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#ClutterClickAction.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#ClutterClickAction.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#ClutterClickAction.signals" class="shortcut">Signals</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch04.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ch04.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ClutterDragAction.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="ClutterClickAction"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="ClutterClickAction.top_of_page"></a>ClutterClickAction</span></h2>
<p>ClutterClickAction — Action for clickable actors</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="ClutterClickAction.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="ClutterAction.html" title="ClutterAction"><span class="returnvalue">ClutterAction</span></a> *
</td>
<td class="function_name">
<a class="link" href="ClutterClickAction.html#clutter-click-action-new" title="clutter_click_action_new ()">clutter_click_action_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">guint</span>
</td>
<td class="function_name">
<a class="link" href="ClutterClickAction.html#clutter-click-action-get-button" title="clutter_click_action_get_button ()">clutter_click_action_get_button</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="clutter-Events.html#ClutterModifierType" title="enum ClutterModifierType"><span class="returnvalue">ClutterModifierType</span></a>
</td>
<td class="function_name">
<a class="link" href="ClutterClickAction.html#clutter-click-action-get-state" title="clutter_click_action_get_state ()">clutter_click_action_get_state</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterClickAction.html#clutter-click-action-get-coords" title="clutter_click_action_get_coords ()">clutter_click_action_get_coords</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterClickAction.html#clutter-click-action-release" title="clutter_click_action_release ()">clutter_click_action_release</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterClickAction.properties"></a><h2>Properties</h2>
<div class="informaltable"><table border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="ClutterClickAction.html#ClutterClickAction--held" title="The “held” property">held</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type"><span class="type">gint</span></td>
<td class="property_name"><a class="link" href="ClutterClickAction.html#ClutterClickAction--long-press-duration" title="The “long-press-duration” property">long-press-duration</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gint</span></td>
<td class="property_name"><a class="link" href="ClutterClickAction.html#ClutterClickAction--long-press-threshold" title="The “long-press-threshold” property">long-press-threshold</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="ClutterClickAction.html#ClutterClickAction--pressed" title="The “pressed” property">pressed</a></td>
<td class="property_flags">Read</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterClickAction.signals"></a><h2>Signals</h2>
<div class="informaltable"><table border="0">
<colgroup>
<col width="150px" class="signals_return">
<col width="300px" class="signals_name">
<col width="200px" class="signals_flags">
</colgroup>
<tbody>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="ClutterClickAction.html#ClutterClickAction-clicked" title="The “clicked” signal">clicked</a></td>
<td class="signal_flags">Run Last</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">gboolean</span></td>
<td class="signal_name"><a class="link" href="ClutterClickAction.html#ClutterClickAction-long-press" title="The “long-press” signal">long-press</a></td>
<td class="signal_flags">Run Last</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterClickAction.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="ClutterClickAction.html#ClutterClickAction-struct" title="struct ClutterClickAction">ClutterClickAction</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="ClutterClickAction.html#ClutterClickActionClass" title="struct ClutterClickActionClass">ClutterClickActionClass</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="ClutterClickAction.html#ClutterLongPressState" title="enum ClutterLongPressState">ClutterLongPressState</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterClickAction.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> GInitiallyUnowned
<span class="lineart">╰──</span> <a class="link" href="ClutterActorMeta.html" title="ClutterActorMeta">ClutterActorMeta</a>
<span class="lineart">╰──</span> <a class="link" href="ClutterAction.html" title="ClutterAction">ClutterAction</a>
<span class="lineart">╰──</span> ClutterClickAction
</pre>
</div>
<div class="refsect1">
<a name="ClutterClickAction.description"></a><h2>Description</h2>
<p><a class="link" href="ClutterClickAction.html" title="ClutterClickAction"><span class="type">ClutterClickAction</span></a> is a sub-class of <a class="link" href="ClutterAction.html" title="ClutterAction"><span class="type">ClutterAction</span></a> that implements
the logic for clickable actors, by using the low level events of
<a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>, such as <a class="link" href="ClutterActor.html#ClutterActor-button-press-event" title="The “button-press-event” signal"><span class="type">“button-press-event”</span></a> and
<a class="link" href="ClutterActor.html#ClutterActor-button-release-event" title="The “button-release-event” signal"><span class="type">“button-release-event”</span></a>, to synthesize the high level
<a class="link" href="ClutterClickAction.html#ClutterClickAction-clicked" title="The “clicked” signal"><span class="type">“clicked”</span></a> signal.</p>
<p>To use <a class="link" href="ClutterClickAction.html" title="ClutterClickAction"><span class="type">ClutterClickAction</span></a> you just need to apply it to a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>
using <a class="link" href="ClutterActor.html#clutter-actor-add-action" title="clutter_actor_add_action ()"><code class="function">clutter_actor_add_action()</code></a> and connect to the
<a class="link" href="ClutterClickAction.html#ClutterClickAction-clicked" title="The “clicked” signal"><span class="type">“clicked”</span></a> signal:</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4
5</pre></td>
<td class="listing_code"><pre class="programlisting">ClutterAction <span class="gtkdoc opt">*</span>action <span class="gtkdoc opt">=</span> <span class="function"><a href="ClutterClickAction.html#clutter-click-action-new">clutter_click_action_new</a></span> <span class="gtkdoc opt">();</span>
<span class="function"><a href="ClutterActor.html#clutter-actor-add-action">clutter_actor_add_action</a></span> <span class="gtkdoc opt">(</span>actor<span class="gtkdoc opt">,</span> action<span class="gtkdoc opt">);</span>
<span class="function">g_signal_connect</span> <span class="gtkdoc opt">(</span>action<span class="gtkdoc opt">,</span> <span class="string">"clicked"</span><span class="gtkdoc opt">,</span> <span class="function">G_CALLBACK</span> <span class="gtkdoc opt">(</span>on_clicked<span class="gtkdoc opt">),</span> NULL<span class="gtkdoc opt">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p></p>
<p><a class="link" href="ClutterClickAction.html" title="ClutterClickAction"><span class="type">ClutterClickAction</span></a> also supports long press gestures: a long press is
activated if the pointer remains pressed within a certain threshold (as
defined by the <a class="link" href="ClutterClickAction.html#ClutterClickAction--long-press-threshold" title="The “long-press-threshold” property"><span class="type">“long-press-threshold”</span></a> property) for a
minimum amount of time (as the defined by the
<a class="link" href="ClutterClickAction.html#ClutterClickAction--long-press-duration" title="The “long-press-duration” property"><span class="type">“long-press-duration”</span></a> property).
The <a class="link" href="ClutterClickAction.html#ClutterClickAction-long-press" title="The “long-press” signal"><span class="type">“long-press”</span></a> signal is emitted multiple times,
using different <a class="link" href="ClutterClickAction.html#ClutterLongPressState" title="enum ClutterLongPressState"><span class="type">ClutterLongPressState</span></a> values; to handle long presses
you should connect to the <a class="link" href="ClutterClickAction.html#ClutterClickAction-long-press" title="The “long-press” signal"><span class="type">“long-press”</span></a> signal and
handle the different states:</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>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</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="gtkdoc kwb">static</span> gboolean
<span class="function">on_long_press</span> <span class="gtkdoc opt">(</span>ClutterClickAction <span class="gtkdoc opt">*</span>action<span class="gtkdoc opt">,</span>
ClutterActor <span class="gtkdoc opt">*</span>actor<span class="gtkdoc opt">,</span>
ClutterLongPressState state<span class="gtkdoc opt">)</span>
<span class="gtkdoc opt">{</span>
<span class="keyword">switch</span> <span class="gtkdoc opt">(</span>state<span class="gtkdoc opt">)</span>
<span class="gtkdoc opt">{</span>
<span class="keyword">case</span> CLUTTER_LONG_PRESS_QUERY<span class="gtkdoc opt">:</span>
<span class="comment">/* return TRUE if the actor should support long press</span>
<span class="comment"> * gestures, and FALSE otherwise; this state will be</span>
<span class="comment"> * emitted on button presses</span>
<span class="comment"> */</span>
<span class="keyword">return</span> TRUE<span class="gtkdoc opt">;</span>
<span class="keyword">case</span> CLUTTER_LONG_PRESS_ACTIVATE<span class="gtkdoc opt">:</span>
<span class="comment">/* this state is emitted if the minimum duration has</span>
<span class="comment"> * been reached without the gesture being cancelled.</span>
<span class="comment"> * the return value is not used</span>
<span class="comment"> */</span>
<span class="keyword">return</span> TRUE<span class="gtkdoc opt">;</span>
<span class="keyword">case</span> CLUTTER_LONG_PRESS_CANCEL<span class="gtkdoc opt">:</span>
<span class="comment">/* this state is emitted if the long press was cancelled;</span>
<span class="comment"> * for instance, the pointer went outside the actor or the</span>
<span class="comment"> * allowed threshold, or the button was released before</span>
<span class="comment"> * the minimum duration was reached. the return value is</span>
<span class="comment"> * not used</span>
<span class="comment"> */</span>
<span class="keyword">return</span> FALSE<span class="gtkdoc opt">;</span>
<span class="gtkdoc opt">}</span>
<span class="gtkdoc opt">}</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p></p>
<p><a class="link" href="ClutterClickAction.html" title="ClutterClickAction"><span class="type">ClutterClickAction</span></a> is available since Clutter 1.4</p>
</div>
<div class="refsect1">
<a name="ClutterClickAction.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="clutter-click-action-new"></a><h3>clutter_click_action_new ()</h3>
<pre class="programlisting"><a class="link" href="ClutterAction.html" title="ClutterAction"><span class="returnvalue">ClutterAction</span></a> *
clutter_click_action_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a new <a class="link" href="ClutterClickAction.html" title="ClutterClickAction"><span class="type">ClutterClickAction</span></a> instance</p>
<div class="refsect3">
<a name="id-1.5.5.2.9.2.5"></a><h4>Returns</h4>
<p> the newly created <a class="link" href="ClutterClickAction.html" title="ClutterClickAction"><span class="type">ClutterClickAction</span></a></p>
<p></p>
</div>
<p class="since">Since 1.4</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-click-action-get-button"></a><h3>clutter_click_action_get_button ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
clutter_click_action_get_button (<em class="parameter"><code><a class="link" href="ClutterClickAction.html" title="ClutterClickAction"><span class="type">ClutterClickAction</span></a> *action</code></em>);</pre>
<p>Retrieves the button that was pressed.</p>
<div class="refsect3">
<a name="id-1.5.5.2.9.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>action</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterClickAction.html" title="ClutterClickAction"><span class="type">ClutterClickAction</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.5.2.9.3.6"></a><h4>Returns</h4>
<p> the button value</p>
<p></p>
</div>
<p class="since">Since 1.4</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-click-action-get-state"></a><h3>clutter_click_action_get_state ()</h3>
<pre class="programlisting"><a class="link" href="clutter-Events.html#ClutterModifierType" title="enum ClutterModifierType"><span class="returnvalue">ClutterModifierType</span></a>
clutter_click_action_get_state (<em class="parameter"><code><a class="link" href="ClutterClickAction.html" title="ClutterClickAction"><span class="type">ClutterClickAction</span></a> *action</code></em>);</pre>
<p>Retrieves the modifier state of the click action.</p>
<div class="refsect3">
<a name="id-1.5.5.2.9.4.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>action</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterClickAction.html" title="ClutterClickAction"><span class="type">ClutterClickAction</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.5.2.9.4.6"></a><h4>Returns</h4>
<p> the modifier state parameter, or 0</p>
<p></p>
</div>
<p class="since">Since 1.6</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-click-action-get-coords"></a><h3>clutter_click_action_get_coords ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_click_action_get_coords (<em class="parameter"><code><a class="link" href="ClutterClickAction.html" title="ClutterClickAction"><span class="type">ClutterClickAction</span></a> *action</code></em>,
<em class="parameter"><code><span class="type">gfloat</span> *press_x</code></em>,
<em class="parameter"><code><span class="type">gfloat</span> *press_y</code></em>);</pre>
<p>Retrieves the screen coordinates of the button press.</p>
<div class="refsect3">
<a name="id-1.5.5.2.9.5.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>action</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterClickAction.html" title="ClutterClickAction"><span class="type">ClutterClickAction</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>press_x</p></td>
<td class="parameter_description"><p> return location for the X coordinate, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>press_y</p></td>
<td class="parameter_description"><p> return location for the Y coordinate, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since 1.8</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-click-action-release"></a><h3>clutter_click_action_release ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_click_action_release (<em class="parameter"><code><a class="link" href="ClutterClickAction.html" title="ClutterClickAction"><span class="type">ClutterClickAction</span></a> *action</code></em>);</pre>
<p>Emulates a release of the pointer button, which ungrabs the pointer
and unsets the <a class="link" href="ClutterClickAction.html#ClutterClickAction--pressed" title="The “pressed” property"><span class="type">“pressed”</span></a> state.</p>
<p>This function will also cancel the long press gesture if one was
initiated.</p>
<p>This function is useful to break a grab, for instance after a certain
amount of time has passed.</p>
<div class="refsect3">
<a name="id-1.5.5.2.9.6.7"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>action</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterClickAction.html" title="ClutterClickAction"><span class="type">ClutterClickAction</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since 1.4</p>
</div>
</div>
<div class="refsect1">
<a name="ClutterClickAction.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="ClutterClickAction-struct"></a><h3>struct ClutterClickAction</h3>
<pre class="programlisting">struct ClutterClickAction;</pre>
<p>The <a class="link" href="ClutterClickAction.html" title="ClutterClickAction"><span class="type">ClutterClickAction</span></a> structure contains
only private data and should be accessed using the provided API</p>
<p class="since">Since 1.4</p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterClickActionClass"></a><h3>struct ClutterClickActionClass</h3>
<pre class="programlisting">struct ClutterClickActionClass {
void (* clicked) (ClutterClickAction *action,
ClutterActor *actor);
gboolean (* long_press) (ClutterClickAction *action,
ClutterActor *actor,
ClutterLongPressState state);
};
</pre>
<p>The <a class="link" href="ClutterClickAction.html#ClutterClickActionClass" title="struct ClutterClickActionClass"><span class="type">ClutterClickActionClass</span></a> structure
contains only private data</p>
<div class="refsect3">
<a name="id-1.5.5.2.10.3.5"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterClickActionClass.clicked"></a>clicked</code></em> ()</p></td>
<td class="struct_member_description"><p>class handler for the <a class="link" href="ClutterClickAction.html#ClutterClickAction-clicked" title="The “clicked” signal"><span class="type">“clicked”</span></a> signal</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterClickActionClass.long-press"></a>long_press</code></em> ()</p></td>
<td class="struct_member_description"><p>class handler for the <a class="link" href="ClutterClickAction.html#ClutterClickAction-long-press" title="The “long-press” signal"><span class="type">“long-press”</span></a> signal</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since 1.4</p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterLongPressState"></a><h3>enum ClutterLongPressState</h3>
<p>The states for the <a class="link" href="ClutterClickAction.html#ClutterClickAction-long-press" title="The “long-press” signal"><span class="type">“long-press”</span></a> signal.</p>
<div class="refsect3">
<a name="id-1.5.5.2.10.4.4"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="CLUTTER-LONG-PRESS-QUERY:CAPS"></a>CLUTTER_LONG_PRESS_QUERY</p></td>
<td class="enum_member_description">
<p>Queries the action whether it supports
long presses</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="CLUTTER-LONG-PRESS-ACTIVATE:CAPS"></a>CLUTTER_LONG_PRESS_ACTIVATE</p></td>
<td class="enum_member_description">
<p>Activates the action on a long press</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="CLUTTER-LONG-PRESS-CANCEL:CAPS"></a>CLUTTER_LONG_PRESS_CANCEL</p></td>
<td class="enum_member_description">
<p>The long press was cancelled</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since 1.8</p>
</div>
</div>
<div class="refsect1">
<a name="ClutterClickAction.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="ClutterClickAction--held"></a><h3>The <code class="literal">“held”</code> property</h3>
<pre class="programlisting"> “held” <span class="type">gboolean</span></pre>
<p>Whether the clickable actor has the pointer grabbed</p>
<p>Flags: Read</p>
<p>Default value: FALSE</p>
<p class="since">Since 1.4</p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterClickAction--long-press-duration"></a><h3>The <code class="literal">“long-press-duration”</code> property</h3>
<pre class="programlisting"> “long-press-duration” <span class="type">gint</span></pre>
<p>The minimum duration of a press for it to be recognized as a long
press gesture, in milliseconds.</p>
<p>A value of -1 will make the <a class="link" href="ClutterClickAction.html" title="ClutterClickAction"><span class="type">ClutterClickAction</span></a> use the value of
the <a class="link" href="ClutterSettings.html#ClutterSettings--long-press-duration" title="The “long-press-duration” property"><span class="type">“long-press-duration”</span></a> property.</p>
<p>Flags: Read / Write</p>
<p>Allowed values: >= -1</p>
<p>Default value: -1</p>
<p class="since">Since 1.8</p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterClickAction--long-press-threshold"></a><h3>The <code class="literal">“long-press-threshold”</code> property</h3>
<pre class="programlisting"> “long-press-threshold” <span class="type">gint</span></pre>
<p>The maximum allowed distance that can be covered (on both axes) before
a long press gesture is cancelled, in pixels.</p>
<p>A value of -1 will make the <a class="link" href="ClutterClickAction.html" title="ClutterClickAction"><span class="type">ClutterClickAction</span></a> use the value of
the <a class="link" href="ClutterSettings.html#ClutterSettings--dnd-drag-threshold" title="The “dnd-drag-threshold” property"><span class="type">“dnd-drag-threshold”</span></a> property.</p>
<p>Flags: Read / Write</p>
<p>Allowed values: >= -1</p>
<p>Default value: -1</p>
<p class="since">Since 1.8</p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterClickAction--pressed"></a><h3>The <code class="literal">“pressed”</code> property</h3>
<pre class="programlisting"> “pressed” <span class="type">gboolean</span></pre>
<p>Whether the clickable actor should be in "pressed" state</p>
<p>Flags: Read</p>
<p>Default value: FALSE</p>
<p class="since">Since 1.4</p>
</div>
</div>
<div class="refsect1">
<a name="ClutterClickAction.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="ClutterClickAction-clicked"></a><h3>The <code class="literal">“clicked”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="ClutterClickAction.html" title="ClutterClickAction"><span class="type">ClutterClickAction</span></a> *action,
<a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *actor,
<span class="type">gpointer</span> user_data)</pre>
<p>The ::clicked signal is emitted when the <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> to which
a <a class="link" href="ClutterClickAction.html" title="ClutterClickAction"><span class="type">ClutterClickAction</span></a> has been applied should respond to a
pointer button press and release events</p>
<div class="refsect3">
<a name="id-1.5.5.2.12.2.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>action</p></td>
<td class="parameter_description"><p>the <a class="link" href="ClutterClickAction.html" title="ClutterClickAction"><span class="type">ClutterClickAction</span></a> that emitted the signal</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>actor</p></td>
<td class="parameter_description"><p>the <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> attached to the <em class="parameter"><code>action</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
<p class="since">Since 1.4</p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterClickAction-long-press"></a><h3>The <code class="literal">“long-press”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
user_function (<a class="link" href="ClutterClickAction.html" title="ClutterClickAction"><span class="type">ClutterClickAction</span></a> *action,
<a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *actor,
<a class="link" href="ClutterClickAction.html#ClutterLongPressState" title="enum ClutterLongPressState"><span class="type">ClutterLongPressState</span></a> state,
<span class="type">gpointer</span> user_data)</pre>
<p>The ::long-press signal is emitted during the long press gesture
handling.</p>
<p>This signal can be emitted multiple times with different states.</p>
<p>The <a class="link" href="ClutterClickAction.html#CLUTTER-LONG-PRESS-QUERY:CAPS"><code class="literal">CLUTTER_LONG_PRESS_QUERY</code></a> state will be emitted on button presses,
and its return value will determine whether the long press handling
should be initiated. If the signal handlers will return <code class="literal">TRUE</code>, the
<a class="link" href="ClutterClickAction.html#CLUTTER-LONG-PRESS-QUERY:CAPS"><code class="literal">CLUTTER_LONG_PRESS_QUERY</code></a> state will be followed either by a signal
emission with the <a class="link" href="ClutterClickAction.html#CLUTTER-LONG-PRESS-ACTIVATE:CAPS"><code class="literal">CLUTTER_LONG_PRESS_ACTIVATE</code></a> state if the long press
constraints were respected, or by a signal emission with the
<a class="link" href="ClutterClickAction.html#CLUTTER-LONG-PRESS-CANCEL:CAPS"><code class="literal">CLUTTER_LONG_PRESS_CANCEL</code></a> state if the long press was cancelled.</p>
<p>It is possible to forcibly cancel a long press detection using
<a class="link" href="ClutterClickAction.html#clutter-click-action-release" title="clutter_click_action_release ()"><code class="function">clutter_click_action_release()</code></a>.</p>
<div class="refsect3">
<a name="id-1.5.5.2.12.3.8"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>action</p></td>
<td class="parameter_description"><p>the <a class="link" href="ClutterClickAction.html" title="ClutterClickAction"><span class="type">ClutterClickAction</span></a> that emitted the signal</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>actor</p></td>
<td class="parameter_description"><p>the <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> attached to the <em class="parameter"><code>action</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>state</p></td>
<td class="parameter_description"><p>the long press state</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.5.2.12.3.9"></a><h4>Returns</h4>
<p> Only the <a class="link" href="ClutterClickAction.html#CLUTTER-LONG-PRESS-QUERY:CAPS"><code class="literal">CLUTTER_LONG_PRESS_QUERY</code></a> state uses the
returned value of the handler; other states will ignore it</p>
<p></p>
</div>
<p>Flags: Run Last</p>
<p class="since">Since 1.8</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.21</div>
</body>
</html>
|