/usr/share/gtk-doc/html/clutter/ClutterState.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 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 | <!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: ClutterState</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="deprecated.html" title="Part IX. Deprecated Classes">
<link rel="prev" href="clutter-Shaders.html" title="Shaders">
<link rel="next" href="ClutterTableLayout.html" title="ClutterTableLayout">
<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="#ClutterState.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#ClutterState.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#ClutterState.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#ClutterState.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#ClutterState.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="deprecated.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="clutter-Shaders.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ClutterTableLayout.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="ClutterState"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="ClutterState.top_of_page"></a>ClutterState</span></h2>
<p>ClutterState — State machine with animated transitions</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="ClutterState.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="ClutterState.html" title="ClutterState"><span class="returnvalue">ClutterState</span></a> *
</td>
<td class="function_name">
<a class="link" href="ClutterState.html#clutter-state-new" title="clutter_state_new ()">clutter_state_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="returnvalue">ClutterTimeline</span></a> *
</td>
<td class="function_name">
<a class="link" href="ClutterState.html#clutter-state-set-state" title="clutter_state_set_state ()">clutter_state_set_state</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="ClutterState.html#clutter-state-get-state" title="clutter_state_get_state ()">clutter_state_get_state</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="returnvalue">ClutterTimeline</span></a> *
</td>
<td class="function_name">
<a class="link" href="ClutterState.html#clutter-state-warp-to-state" title="clutter_state_warp_to_state ()">clutter_state_warp_to_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="ClutterState.html#clutter-state-set" title="clutter_state_set ()">clutter_state_set</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="ClutterState.html" title="ClutterState"><span class="returnvalue">ClutterState</span></a> *
</td>
<td class="function_name">
<a class="link" href="ClutterState.html#clutter-state-set-key" title="clutter_state_set_key ()">clutter_state_set_key</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="ClutterState.html#clutter-state-set-duration" title="clutter_state_set_duration ()">clutter_state_set_duration</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="ClutterState.html#clutter-state-get-duration" title="clutter_state_get_duration ()">clutter_state_get_duration</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GList</span> *
</td>
<td class="function_name">
<a class="link" href="ClutterState.html#clutter-state-get-states" title="clutter_state_get_states ()">clutter_state_get_states</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GList</span> *
</td>
<td class="function_name">
<a class="link" href="ClutterState.html#clutter-state-get-keys" title="clutter_state_get_keys ()">clutter_state_get_keys</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="ClutterState.html#clutter-state-remove-key" title="clutter_state_remove_key ()">clutter_state_remove_key</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="returnvalue">ClutterTimeline</span></a> *
</td>
<td class="function_name">
<a class="link" href="ClutterState.html#clutter-state-get-timeline" title="clutter_state_get_timeline ()">clutter_state_get_timeline</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="ClutterState.html#clutter-state-set-animator" title="clutter_state_set_animator ()">clutter_state_set_animator</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="returnvalue">ClutterAnimator</span></a> *
</td>
<td class="function_name">
<a class="link" href="ClutterState.html#clutter-state-get-animator" title="clutter_state_get_animator ()">clutter_state_get_animator</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="ClutterState.html#clutter-state-key-get-source-state-name" title="clutter_state_key_get_source_state_name ()">clutter_state_key_get_source_state_name</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="ClutterState.html#clutter-state-key-get-target-state-name" title="clutter_state_key_get_target_state_name ()">clutter_state_key_get_target_state_name</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GObject</span> *
</td>
<td class="function_name">
<a class="link" href="ClutterState.html#clutter-state-key-get-object" title="clutter_state_key_get_object ()">clutter_state_key_get_object</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="ClutterState.html#clutter-state-key-get-property-name" title="clutter_state_key_get_property_name ()">clutter_state_key_get_property_name</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gulong</span>
</td>
<td class="function_name">
<a class="link" href="ClutterState.html#clutter-state-key-get-mode" title="clutter_state_key_get_mode ()">clutter_state_key_get_mode</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="ClutterState.html#clutter-state-key-get-value" title="clutter_state_key_get_value ()">clutter_state_key_get_value</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GType</span>
</td>
<td class="function_name">
<a class="link" href="ClutterState.html#clutter-state-key-get-property-type" title="clutter_state_key_get_property_type ()">clutter_state_key_get_property_type</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gdouble</span>
</td>
<td class="function_name">
<a class="link" href="ClutterState.html#clutter-state-key-get-pre-delay" title="clutter_state_key_get_pre_delay ()">clutter_state_key_get_pre_delay</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gdouble</span>
</td>
<td class="function_name">
<a class="link" href="ClutterState.html#clutter-state-key-get-post-delay" title="clutter_state_key_get_post_delay ()">clutter_state_key_get_post_delay</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterState.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">guint</span></td>
<td class="property_name"><a class="link" href="ClutterState.html#ClutterState--duration" title="The “duration” property">duration</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="ClutterState.html#ClutterState--state" title="The “state” property">state</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterState.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="ClutterState.html#ClutterState-completed" title="The “completed” signal">completed</a></td>
<td class="signal_flags">Run Last</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterState.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"> </td>
<td class="function_name"><a class="link" href="ClutterState.html#ClutterState-struct" title="ClutterState">ClutterState</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="ClutterState.html#ClutterStateClass" title="struct ClutterStateClass">ClutterStateClass</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey">ClutterStateKey</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterState.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> ClutterState
</pre>
</div>
<div class="refsect1">
<a name="ClutterState.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
ClutterState implements
<a class="link" href="ClutterScriptable.html" title="ClutterScriptable">ClutterScriptable</a>.</p>
</div>
<div class="refsect1">
<a name="ClutterState.description"></a><h2>Description</h2>
<p><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> is an object controlling the tweening of properties on
multiple actors between a set of named states. <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a><!-- -->s
define how the properties are animated. If the source_state_name for a key
is NULL it is used for transition to the target state unless a specific key
exists for transitioning from the current state to the requested state.</p>
<p><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> is available since Clutter 1.4.</p>
<p><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> has been deprecated in Clutter 1.12.</p>
<div class="refsect3">
<a name="id-1.10.18.9.5"></a><h4>Using ClutterState</h4>
<p>The following example defines a "base" and a "hover" state in a
<a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> instance.</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</pre></td>
<td class="listing_code"><pre class="programlisting">ClutterState <span class="gtkdoc opt">*</span>state <span class="gtkdoc opt">=</span> <span class="function"><a href="ClutterState.html#clutter-state-new">clutter_state_new</a></span> <span class="gtkdoc opt">();</span>
ClutterColor color <span class="gtkdoc opt">= {</span> <span class="number">0</span><span class="gtkdoc opt">, };</span>
<span class="gtkdoc slc">// transition from any state to the "base" state</span>
<span class="function"><a href="clutter-Colors.html#clutter-color-from-string">clutter_color_from_string</a></span> <span class="gtkdoc opt">(&</span>color<span class="gtkdoc opt">,</span> <span class="string">"rgb(255, 0, 0)"</span><span class="gtkdoc opt">);</span>
<span class="function"><a href="ClutterState.html#clutter-state-set">clutter_state_set</a></span> <span class="gtkdoc opt">(</span>state<span class="gtkdoc opt">,</span> NULL<span class="gtkdoc opt">,</span> <span class="string">"base"</span><span class="gtkdoc opt">,</span>
actor<span class="gtkdoc opt">,</span> <span class="string">"color"</span><span class="gtkdoc opt">,</span> CLUTTER_LINEAR<span class="gtkdoc opt">, &</span>color<span class="gtkdoc opt">,</span>
actor<span class="gtkdoc opt">,</span> <span class="string">"scale-x"</span><span class="gtkdoc opt">,</span> CLUTTER_EASE_IN_BOUNCE<span class="gtkdoc opt">,</span> <span class="number">1.0</span><span class="gtkdoc opt">,</span>
actor<span class="gtkdoc opt">,</span> <span class="string">"scale-y"</span><span class="gtkdoc opt">,</span> CLUTTER_EASE_IN_BOUNCE<span class="gtkdoc opt">,</span> <span class="number">1.0</span><span class="gtkdoc opt">,</span>
NULL<span class="gtkdoc opt">);</span>
<span class="gtkdoc slc">// transition from the "base" state to the "hover" state</span>
<span class="function"><a href="clutter-Colors.html#clutter-color-from-string">clutter_color_from_string</a></span> <span class="gtkdoc opt">(&</span>color<span class="gtkdoc opt">,</span> <span class="string">"rgb(0, 0, 255)"</span><span class="gtkdoc opt">);</span>
<span class="function"><a href="ClutterState.html#clutter-state-set">clutter_state_set</a></span> <span class="gtkdoc opt">(</span>state<span class="gtkdoc opt">,</span> <span class="string">"base"</span><span class="gtkdoc opt">,</span> <span class="string">"hover"</span><span class="gtkdoc opt">,</span>
actor<span class="gtkdoc opt">,</span> <span class="string">"color"</span><span class="gtkdoc opt">,</span> CLUTTER_LINEAR<span class="gtkdoc opt">, &</span>color<span class="gtkdoc opt">,</span>
actor<span class="gtkdoc opt">,</span> <span class="string">"scale-x"</span><span class="gtkdoc opt">,</span> CLUTTER_EASE_OUT_BOUNCE<span class="gtkdoc opt">,</span> <span class="number">1.7</span><span class="gtkdoc opt">,</span>
actor<span class="gtkdoc opt">,</span> <span class="string">"scale-y"</span><span class="gtkdoc opt">,</span> CLUTTER_EASE_OUT_BOUNCE<span class="gtkdoc opt">,</span> <span class="number">1.7</span><span class="gtkdoc opt">,</span>
NULL<span class="gtkdoc opt">);</span>
<span class="gtkdoc slc">// the default duration of any transition</span>
<span class="function"><a href="ClutterState.html#clutter-state-set-duration">clutter_state_set_duration</a></span> <span class="gtkdoc opt">(</span>state<span class="gtkdoc opt">,</span> NULL<span class="gtkdoc opt">,</span> NULL<span class="gtkdoc opt">,</span> <span class="number">500</span><span class="gtkdoc opt">);</span>
<span class="gtkdoc slc">// set "base" as the initial state</span>
<span class="function"><a href="ClutterState.html#clutter-state-warp-to-state">clutter_state_warp_to_state</a></span> <span class="gtkdoc opt">(</span>state<span class="gtkdoc opt">,</span> <span class="string">"base"</span><span class="gtkdoc opt">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p></p>
<p>The actor then uses the <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> to animate through the
two states using callbacks for the <a class="link" href="ClutterActor.html#ClutterActor-enter-event" title="The “enter-event” signal"><span class="type">“enter-event”</span></a> and
<a class="link" href="ClutterActor.html#ClutterActor-leave-event" title="The “leave-event” signal"><span class="type">“leave-event”</span></a> signals.</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</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="gtkdoc kwb">static</span> gboolean
<span class="function">on_enter</span> <span class="gtkdoc opt">(</span>ClutterActor <span class="gtkdoc opt">*</span>actor<span class="gtkdoc opt">,</span>
ClutterEvent <span class="gtkdoc opt">*</span>event<span class="gtkdoc opt">,</span>
ClutterState <span class="gtkdoc opt">*</span>state<span class="gtkdoc opt">)</span>
<span class="gtkdoc opt">{</span>
<span class="function"><a href="ClutterState.html#clutter-state-set-state">clutter_state_set_state</a></span> <span class="gtkdoc opt">(</span>state<span class="gtkdoc opt">,</span> <span class="string">"hover"</span><span class="gtkdoc opt">);</span>
<span class="keyword">return</span> CLUTTER_EVENT_STOP<span class="gtkdoc opt">;</span>
<span class="gtkdoc opt">}</span>
<span class="gtkdoc kwb">static</span> gboolean
<span class="function">on_leave</span> <span class="gtkdoc opt">(</span>ClutterActor <span class="gtkdoc opt">*</span>actor<span class="gtkdoc opt">,</span>
ClutterEvent <span class="gtkdoc opt">*</span>event<span class="gtkdoc opt">,</span>
ClutterState <span class="gtkdoc opt">*</span>state<span class="gtkdoc opt">)</span>
<span class="gtkdoc opt">{</span>
<span class="function"><a href="ClutterState.html#clutter-state-set-state">clutter_state_set_state</a></span> <span class="gtkdoc opt">(</span>state<span class="gtkdoc opt">,</span> <span class="string">"base"</span><span class="gtkdoc opt">);</span>
<span class="keyword">return</span> CLUTTER_EVENT_STOP<span class="gtkdoc opt">;</span>
<span class="gtkdoc opt">}</span></pre></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="refsect3">
<a name="id-1.10.18.9.6"></a><h4>ClutterState description for ClutterScript</h4>
<p><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> defines a custom <code class="literal">transitions</code> JSON object member which
allows describing the states.</p>
<p>The <code class="literal">transitions</code> property has the following syntax:</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
32
33</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="gtkdoc opt">{</span>
<span class="string">"transitions"</span> <span class="gtkdoc opt">: [</span>
<span class="gtkdoc opt">{</span>
<span class="string">"source"</span> <span class="gtkdoc opt">:</span> <span class="string">"source-state"</span><span class="gtkdoc opt">,</span>
<span class="string">"target"</span> <span class="gtkdoc opt">:</span> <span class="string">"target-state"</span><span class="gtkdoc opt">,</span>
<span class="string">"duration"</span> <span class="gtkdoc opt">:</span> milliseconds<span class="gtkdoc opt">,</span>
<span class="string">"keys"</span> <span class="gtkdoc opt">: [</span>
<span class="gtkdoc opt">[</span>
<span class="string">"object-id"</span><span class="gtkdoc opt">,</span>
<span class="string">"property-name"</span><span class="gtkdoc opt">,</span>
<span class="string">"easing-mode"</span><span class="gtkdoc opt">,</span>
<span class="string">"final-value"</span><span class="gtkdoc opt">,</span>
<span class="gtkdoc opt">],</span>
<span class="gtkdoc opt">[</span>
<span class="string">"object-id"</span><span class="gtkdoc opt">,</span>
<span class="string">"property-name"</span><span class="gtkdoc opt">,</span>
<span class="string">"easing-mode"</span><span class="gtkdoc opt">,</span>
<span class="string">"final-value"</span><span class="gtkdoc opt">,</span>
pre<span class="gtkdoc opt">-</span>delay<span class="gtkdoc opt">,</span>
post<span class="gtkdoc opt">-</span>delay<span class="gtkdoc opt">;</span>
<span class="gtkdoc opt">],</span>
<span class="gtkdoc opt">...</span>
<span class="gtkdoc opt">]</span>
<span class="gtkdoc opt">},</span>
<span class="gtkdoc opt">{</span>
<span class="string">"source"</span> <span class="gtkdoc opt">:</span> <span class="string">"source-state"</span><span class="gtkdoc opt">,</span>
<span class="string">"target"</span> <span class="gtkdoc opt">:</span> <span class="string">"target-state"</span><span class="gtkdoc opt">,</span>
<span class="string">"duration"</span> <span class="gtkdoc opt">:</span> milliseconds<span class="gtkdoc opt">,</span>
<span class="string">"animator"</span> <span class="gtkdoc opt">:</span> <span class="string">"animator-definition"</span>
<span class="gtkdoc opt">},</span>
<span class="gtkdoc opt">...</span>
<span class="gtkdoc opt">]</span>
<span class="gtkdoc opt">}</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p></p>
<p>Each element of the transitions array follows the same rules and order
as <a class="link" href="ClutterState.html#clutter-state-set-key" title="clutter_state_set_key ()"><code class="function">clutter_state_set_key()</code></a> function arguments.</p>
<p>The source and target values control the source and target state of the
transition. The key and animator properties are mutually exclusive.</p>
<p>The pre-delay and post-delay values are optional.</p>
<p>The example below is a translation into a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> definition of
the code in the <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> example above.</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</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="gtkdoc opt">{</span>
<span class="string">"id"</span> <span class="gtkdoc opt">:</span> <span class="string">"button-state"</span><span class="gtkdoc opt">,</span>
<span class="string">"type"</span> <span class="gtkdoc opt">:</span> <span class="string">"ClutterState"</span><span class="gtkdoc opt">,</span>
<span class="string">"duration"</span> <span class="gtkdoc opt">:</span> <span class="number">500</span><span class="gtkdoc opt">,</span>
<span class="string">"transitions"</span> <span class="gtkdoc opt">: [</span>
<span class="gtkdoc opt">{</span>
<span class="string">"source"</span> <span class="gtkdoc opt">:</span> <span class="string">"*"</span><span class="gtkdoc opt">,</span>
<span class="string">"target"</span> <span class="gtkdoc opt">:</span> <span class="string">"base"</span><span class="gtkdoc opt">,</span>
<span class="string">"keys"</span> <span class="gtkdoc opt">: [</span>
<span class="gtkdoc opt">[</span> <span class="string">"button"</span><span class="gtkdoc opt">,</span> <span class="string">"color"</span><span class="gtkdoc opt">,</span> <span class="string">"linear"</span><span class="gtkdoc opt">,</span> <span class="string">"rgb(255, 0, 0)"</span> <span class="gtkdoc opt">],</span>
<span class="gtkdoc opt">[</span> <span class="string">"button"</span><span class="gtkdoc opt">,</span> <span class="string">"scale-x"</span><span class="gtkdoc opt">,</span> <span class="string">"easeInBounce"</span><span class="gtkdoc opt">,</span> <span class="number">1.0</span> <span class="gtkdoc opt">],</span>
<span class="gtkdoc opt">[</span> <span class="string">"button"</span><span class="gtkdoc opt">,</span> <span class="string">"scale-y"</span><span class="gtkdoc opt">,</span> <span class="string">"easeInBounce"</span><span class="gtkdoc opt">,</span> <span class="number">1.0</span> <span class="gtkdoc opt">]</span>
<span class="gtkdoc opt">]</span>
<span class="gtkdoc opt">},</span>
<span class="gtkdoc opt">{</span>
<span class="string">"source"</span> <span class="gtkdoc opt">:</span> <span class="string">"base"</span><span class="gtkdoc opt">,</span>
<span class="string">"target"</span> <span class="gtkdoc opt">:</span> <span class="string">"hover"</span><span class="gtkdoc opt">,</span>
<span class="string">"keys"</span> <span class="gtkdoc opt">: [</span>
<span class="gtkdoc opt">[</span> <span class="string">"button"</span><span class="gtkdoc opt">,</span> <span class="string">"color"</span><span class="gtkdoc opt">,</span> <span class="string">"linear"</span><span class="gtkdoc opt">,</span> <span class="string">"rgb(0, 0, 255)"</span> <span class="gtkdoc opt">],</span>
<span class="gtkdoc opt">[</span> <span class="string">"button"</span><span class="gtkdoc opt">,</span> <span class="string">"scale-x"</span><span class="gtkdoc opt">,</span> <span class="string">"easeOutBounce"</span><span class="gtkdoc opt">,</span> <span class="number">1.7</span> <span class="gtkdoc opt">],</span>
<span class="gtkdoc opt">[</span> <span class="string">"button"</span><span class="gtkdoc opt">,</span> <span class="string">"scale-y"</span><span class="gtkdoc opt">,</span> <span class="string">"easeOutBounce"</span><span class="gtkdoc opt">,</span> <span class="number">1.7</span> <span class="gtkdoc opt">]</span>
<span class="gtkdoc opt">]</span>
<span class="gtkdoc opt">}</span>
<span class="gtkdoc opt">]</span>
<span class="gtkdoc opt">}</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p></p>
</div>
</div>
<div class="refsect1">
<a name="ClutterState.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="clutter-state-new"></a><h3>clutter_state_new ()</h3>
<pre class="programlisting"><a class="link" href="ClutterState.html" title="ClutterState"><span class="returnvalue">ClutterState</span></a> *
clutter_state_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_state_new</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
</div>
<p>Creates a new <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a></p>
<div class="refsect3">
<a name="id-1.10.18.10.2.7"></a><h4>Returns</h4>
<p> the newly create <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> instance</p>
<p></p>
</div>
<p class="since">Since 1.4</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-state-set-state"></a><h3>clutter_state_set_state ()</h3>
<pre class="programlisting"><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="returnvalue">ClutterTimeline</span></a> *
clutter_state_set_state (<em class="parameter"><code><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> *state</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *target_state_name</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_state_set_state</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
</div>
<p>Change the current state of <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> to <em class="parameter"><code>target_state_name</code></em>
.</p>
<p>The state will animate during its transition, see
<a class="link" href="ClutterState.html#clutter-state-warp-to-state" title="clutter_state_warp_to_state ()"><span class="type">clutter_state_warp_to_state</span></a> for animation-free state switching.</p>
<p>Setting a <code class="literal">NULL</code> state will stop the current animation and unset
the current state, but keys will be left intact.</p>
<div class="refsect3">
<a name="id-1.10.18.10.3.9"></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>state</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>target_state_name</p></td>
<td class="parameter_description"><p>the state to transition to</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.10.18.10.3.10"></a><h4>Returns</h4>
<p> the <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> that drives the
state transition. The returned timeline is owned by the <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a>
and it should not be unreferenced. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since 1.4</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-state-get-state"></a><h3>clutter_state_get_state ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
clutter_state_get_state (<em class="parameter"><code><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> *state</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_state_get_state</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
</div>
<p>Queries the currently set target state.</p>
<p>During a transition this function will return the target of the transition.</p>
<p>This function is useful when called from handlers of the
<a class="link" href="ClutterState.html#ClutterState-completed" title="The “completed” signal"><span class="type">“completed”</span></a> signal.</p>
<div class="refsect3">
<a name="id-1.10.18.10.4.9"></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>state</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.10.18.10.4.10"></a><h4>Returns</h4>
<p> a string containing the target state. The returned string
is owned by the <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> and should not be modified or freed</p>
<p></p>
</div>
<p class="since">Since 1.4</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-state-warp-to-state"></a><h3>clutter_state_warp_to_state ()</h3>
<pre class="programlisting"><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="returnvalue">ClutterTimeline</span></a> *
clutter_state_warp_to_state (<em class="parameter"><code><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> *state</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *target_state_name</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_state_warp_to_state</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
</div>
<p>Change to the specified target state immediately with no animation.</p>
<p>See <a class="link" href="ClutterState.html#clutter-state-set-state" title="clutter_state_set_state ()"><code class="function">clutter_state_set_state()</code></a>.</p>
<div class="refsect3">
<a name="id-1.10.18.10.5.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>state</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>target_state_name</p></td>
<td class="parameter_description"><p>the state to transition to</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.10.18.10.5.9"></a><h4>Returns</h4>
<p> the <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> that drives the
state transition. The returned timeline is owned by the <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a>
and it should not be unreferenced. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since 1.4</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-state-set"></a><h3>clutter_state_set ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_state_set (<em class="parameter"><code><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> *state</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *source_state_name</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *target_state_name</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> first_object</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *first_property_name</code></em>,
<em class="parameter"><code><span class="type">gulong</span> first_mode</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_state_set</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
</div>
<p>Adds multiple keys to a named state of a <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> instance, specifying
the easing mode and value a given property of an object should have at a
given progress of the animation.</p>
<p>The mode specified is the easing mode used when going to from the previous
key to the specified key.</p>
<p>For instance, the code below:</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"><span class="function"><a href="ClutterState.html#clutter-state-set">clutter_state_set</a></span> <span class="gtkdoc opt">(</span>state<span class="gtkdoc opt">,</span> NULL<span class="gtkdoc opt">,</span> <span class="string">"hover"</span><span class="gtkdoc opt">,</span>
button<span class="gtkdoc opt">,</span> <span class="string">"opacity"</span><span class="gtkdoc opt">,</span> CLUTTER_LINEAR<span class="gtkdoc opt">,</span> <span class="number">255</span><span class="gtkdoc opt">,</span>
button<span class="gtkdoc opt">,</span> <span class="string">"scale-x"</span><span class="gtkdoc opt">,</span> CLUTTER_EASE_OUT_CUBIC<span class="gtkdoc opt">,</span> <span class="number">1.2</span><span class="gtkdoc opt">,</span>
button<span class="gtkdoc opt">,</span> <span class="string">"scale-y"</span><span class="gtkdoc opt">,</span> CLUTTER_EASE_OUT_CUBIC<span class="gtkdoc opt">,</span> <span class="number">1.2</span><span class="gtkdoc opt">,</span>
NULL<span class="gtkdoc opt">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p></p>
<p>will create a transition from any state (a <em class="parameter"><code>source_state_name</code></em>
or NULL is
treated as a wildcard) and a state named "hover"; the
button object will have the <a class="link" href="ClutterActor.html#ClutterActor--opacity" title="The “opacity” property"><span class="type">“opacity”</span></a>
property animated to a value of 255 using <a class="link" href="ClutterTimeline.html#CLUTTER-LINEAR:CAPS"><code class="literal">CLUTTER_LINEAR</code></a> as the animation
mode, and the <a class="link" href="ClutterActor.html#ClutterActor--scale-x" title="The “scale-x” property"><span class="type">“scale-x”</span></a> and <a class="link" href="ClutterActor.html#ClutterActor--scale-y" title="The “scale-y” property"><span class="type">“scale-y”</span></a> properties
animated to a value of 1.2 using <a class="link" href="ClutterTimeline.html#CLUTTER-EASE-OUT-CUBIC:CAPS"><code class="literal">CLUTTER_EASE_OUT_CUBIC</code></a> as the animation
mode. To change the state (and start the transition) you can use the
<a class="link" href="ClutterState.html#clutter-state-set-state" title="clutter_state_set_state ()"><code class="function">clutter_state_set_state()</code></a> function:</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="function"><a href="ClutterState.html#clutter-state-set-state">clutter_state_set_state</a></span> <span class="gtkdoc opt">(</span>state<span class="gtkdoc opt">,</span> <span class="string">"hover"</span><span class="gtkdoc opt">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p></p>
<p>If a given object, state_name, property tuple already exist in the
<a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> instance, then the mode and value will be replaced with
the new specified values.</p>
<p>If a property name is prefixed with "delayed::" two additional
arguments per key are expected: a value relative to the full state time
to pause before transitioning and a similar value to pause after
transitioning, e.g.:</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</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="function"><a href="ClutterState.html#clutter-state-set">clutter_state_set</a></span> <span class="gtkdoc opt">(</span>state<span class="gtkdoc opt">,</span> <span class="string">"hover"</span><span class="gtkdoc opt">,</span> <span class="string">"toggled"</span><span class="gtkdoc opt">,</span>
button<span class="gtkdoc opt">,</span> <span class="string">"delayed::scale-x"</span><span class="gtkdoc opt">,</span> CLUTTER_LINEAR<span class="gtkdoc opt">,</span> <span class="number">1.0</span><span class="gtkdoc opt">,</span> <span class="number">0.2</span><span class="gtkdoc opt">,</span> <span class="number">0.2</span><span class="gtkdoc opt">,</span>
button<span class="gtkdoc opt">,</span> <span class="string">"delayed::scale-y"</span><span class="gtkdoc opt">,</span> CLUTTER_LINEAR<span class="gtkdoc opt">,</span> <span class="number">1.0</span><span class="gtkdoc opt">,</span> <span class="number">0.2</span><span class="gtkdoc opt">,</span> <span class="number">0.2</span><span class="gtkdoc opt">,</span>
NULL<span class="gtkdoc opt">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p></p>
<p>will pause for 20% of the duration of the transition before animating,
and 20% of the duration after animating.</p>
<div class="refsect3">
<a name="id-1.10.18.10.6.19"></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>state</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> instance.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>source_state_name</p></td>
<td class="parameter_description"><p> the name of the source state keys are being added for. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>target_state_name</p></td>
<td class="parameter_description"><p>the name of the target state keys are being added for</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>first_object</p></td>
<td class="parameter_description"><p>a <span class="type">GObject</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>first_property_name</p></td>
<td class="parameter_description"><p>a property of <em class="parameter"><code>first_object</code></em>
to specify a key for</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>first_mode</p></td>
<td class="parameter_description"><p>the id of the alpha function to use</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p>the value <em class="parameter"><code>first_property_name</code></em>
should have in <em class="parameter"><code>target_state_name</code></em>
,
followed by object, property name, mode, value tuples, terminated
by <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since 1.4</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-state-set-key"></a><h3>clutter_state_set_key ()</h3>
<pre class="programlisting"><a class="link" href="ClutterState.html" title="ClutterState"><span class="returnvalue">ClutterState</span></a> *
clutter_state_set_key (<em class="parameter"><code><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> *state</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *source_state_name</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *target_state_name</code></em>,
<em class="parameter"><code><span class="type">GObject</span> *object</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>,
<em class="parameter"><code><span class="type">guint</span> mode</code></em>,
<em class="parameter"><code>const <span class="type">GValue</span> *value</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> pre_delay</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> post_delay</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_state_set_key</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
</div>
<p>Sets one specific end key for a state name, <em class="parameter"><code>object</code></em>
, <em class="parameter"><code>property_name</code></em>
combination.</p>
<div class="refsect3">
<a name="id-1.10.18.10.7.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>state</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> instance.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>source_state_name</p></td>
<td class="parameter_description"><p> the source transition to specify
transition for, or <code class="literal">NULL</code> to specify the default fallback when a
more specific source state doesn't exist. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>target_state_name</p></td>
<td class="parameter_description"><p>the name of the transition to set a key value for.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>object</p></td>
<td class="parameter_description"><p>the <span class="type">GObject</span> to set a key for</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>property_name</p></td>
<td class="parameter_description"><p>the property to set a key for</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>mode</p></td>
<td class="parameter_description"><p>the id of the alpha function to use</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>value</p></td>
<td class="parameter_description"><p>the value for property_name of object in state_name</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>pre_delay</p></td>
<td class="parameter_description"><p>relative time of the transition to be idle in the beginning
of the transition</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>post_delay</p></td>
<td class="parameter_description"><p>relative time of the transition to be idle in the end of
the transition</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.10.18.10.7.8"></a><h4>Returns</h4>
<p> the <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> instance, allowing
chaining of multiple calls. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since 1.4</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-state-set-duration"></a><h3>clutter_state_set_duration ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_state_set_duration (<em class="parameter"><code><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> *state</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *source_state_name</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *target_state_name</code></em>,
<em class="parameter"><code><span class="type">guint</span> duration</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_state_set_duration</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
</div>
<p>Sets the duration of a transition.</p>
<p>If both state names are <code class="literal">NULL</code> the default duration for <em class="parameter"><code>state</code></em>
is set.</p>
<p>If only <em class="parameter"><code>target_state_name</code></em>
is specified, the passed <em class="parameter"><code>duration</code></em>
becomes
the default duration for transitions to the target state.</p>
<p>If both states names are specified, the passed <em class="parameter"><code>duration</code></em>
only applies
to the specified transition.</p>
<div class="refsect3">
<a name="id-1.10.18.10.8.10"></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>state</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>source_state_name</p></td>
<td class="parameter_description"><p> the name of the source state, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>target_state_name</p></td>
<td class="parameter_description"><p> the name of the target state, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>duration</p></td>
<td class="parameter_description"><p>the duration of the transition, in milliseconds</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since 1.4</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-state-get-duration"></a><h3>clutter_state_get_duration ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
clutter_state_get_duration (<em class="parameter"><code><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> *state</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *source_state_name</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *target_state_name</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_state_get_duration</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
</div>
<p>Queries the duration used for transitions between a source and
target state pair</p>
<p>The semantics for the query are the same as the semantics used for
setting the duration with <a class="link" href="ClutterState.html#clutter-state-set-duration" title="clutter_state_set_duration ()"><code class="function">clutter_state_set_duration()</code></a></p>
<div class="refsect3">
<a name="id-1.10.18.10.9.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>state</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>source_state_name</p></td>
<td class="parameter_description"><p> the name of the source state to
get the duration of, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>target_state_name</p></td>
<td class="parameter_description"><p> the name of the source state to
get the duration of, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.10.18.10.9.9"></a><h4>Returns</h4>
<p> the duration, in milliseconds</p>
<p></p>
</div>
<p class="since">Since 1.4</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-state-get-states"></a><h3>clutter_state_get_states ()</h3>
<pre class="programlisting"><span class="returnvalue">GList</span> *
clutter_state_get_states (<em class="parameter"><code><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> *state</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_state_get_states</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
</div>
<p>Gets a list of all the state names managed by this <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a>.</p>
<div class="refsect3">
<a name="id-1.10.18.10.10.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>state</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> instance.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.10.18.10.10.8"></a><h4>Returns</h4>
<p> a newly allocated
<span class="type">GList</span> of state names. The contents of the returned <span class="type">GList</span> are owned
by the <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> and should not be modified or freed. Use
<code class="function">g_list_free()</code> to free the resources allocated by the returned list when
done using it. </p>
<p><span class="annotation">[<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8]</span></p>
</div>
<p class="since">Since 1.4</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-state-get-keys"></a><h3>clutter_state_get_keys ()</h3>
<pre class="programlisting"><span class="returnvalue">GList</span> *
clutter_state_get_keys (<em class="parameter"><code><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> *state</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *source_state_name</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *target_state_name</code></em>,
<em class="parameter"><code><span class="type">GObject</span> *object</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_state_get_keys</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
</div>
<p>Returns a list of pointers to opaque structures with accessor functions
that describe the keys added to an animator.</p>
<div class="refsect3">
<a name="id-1.10.18.10.11.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>state</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> instance.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>source_state_name</p></td>
<td class="parameter_description"><p> the source transition name to query,
or <code class="literal">NULL</code> for all source states. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>target_state_name</p></td>
<td class="parameter_description"><p> the target transition name to query,
or <code class="literal">NULL</code> for all target states. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>object</p></td>
<td class="parameter_description"><p> the specific object instance to list keys for,
or <code class="literal">NULL</code> for all managed objects. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>property_name</p></td>
<td class="parameter_description"><p> the property name to search for, or <code class="literal">NULL</code>
for all properties. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.10.18.10.11.8"></a><h4>Returns</h4>
<p> a
newly allocated <span class="type">GList</span> of <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a><!-- -->s. The contents of
the returned list are owned by the <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> and should not be
modified or freed. Use <code class="function">g_list_free()</code> to free the resources allocated
by the returned list when done using it. </p>
<p><span class="annotation">[<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> Clutter.StateKey]</span></p>
</div>
<p class="since">Since 1.4</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-state-remove-key"></a><h3>clutter_state_remove_key ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_state_remove_key (<em class="parameter"><code><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> *state</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *source_state_name</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *target_state_name</code></em>,
<em class="parameter"><code><span class="type">GObject</span> *object</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_state_remove_key</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
</div>
<p>Removes all keys matching the search criteria passed in arguments.</p>
<div class="refsect3">
<a name="id-1.10.18.10.12.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>state</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> instance.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>source_state_name</p></td>
<td class="parameter_description"><p> the source state name to query,
or <code class="literal">NULL</code> for all source states. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>target_state_name</p></td>
<td class="parameter_description"><p> the target state name to query,
or <code class="literal">NULL</code> for all target states. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>object</p></td>
<td class="parameter_description"><p> the specific object instance to list keys for,
or <code class="literal">NULL</code> for all managed objects. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>property_name</p></td>
<td class="parameter_description"><p> the property name to search for,
or <code class="literal">NULL</code> for all properties. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since 1.4</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-state-get-timeline"></a><h3>clutter_state_get_timeline ()</h3>
<pre class="programlisting"><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="returnvalue">ClutterTimeline</span></a> *
clutter_state_get_timeline (<em class="parameter"><code><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> *state</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_state_get_timeline</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
</div>
<p>Gets the timeline driving the <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a></p>
<div class="refsect3">
<a name="id-1.10.18.10.13.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>state</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.10.18.10.13.8"></a><h4>Returns</h4>
<p> the <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> that drives
the state change animations. The returned timeline is owned
by the <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> and it should not be unreferenced directly. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since 1.4</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-state-set-animator"></a><h3>clutter_state_set_animator ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_state_set_animator (<em class="parameter"><code><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> *state</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *source_state_name</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *target_state_name</code></em>,
<em class="parameter"><code><a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> *animator</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_state_set_animator</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
</div>
<p>Specifies a <a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> to be used when transitioning between
the two named states.</p>
<p>The <em class="parameter"><code>animator</code></em>
allows specifying a transition between the state that is
more elaborate than the basic transitions allowed by the tweening of
properties defined in the <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> keys.</p>
<p>If <em class="parameter"><code>animator</code></em>
is <code class="literal">NULL</code> it will unset an existing animator.</p>
<p><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> will take a reference on the passed <em class="parameter"><code>animator</code></em>
, if any</p>
<div class="refsect3">
<a name="id-1.10.18.10.14.10"></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>state</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> instance.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>source_state_name</p></td>
<td class="parameter_description"><p>the name of a source state</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>target_state_name</p></td>
<td class="parameter_description"><p>the name of a target state</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>animator</p></td>
<td class="parameter_description"><p> a <a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> instance, or <code class="literal">NULL</code> to
unset an existing <a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since 1.4</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-state-get-animator"></a><h3>clutter_state_get_animator ()</h3>
<pre class="programlisting"><a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="returnvalue">ClutterAnimator</span></a> *
clutter_state_get_animator (<em class="parameter"><code><a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> *state</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *source_state_name</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *target_state_name</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_state_get_animator</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
</div>
<p>Retrieves the <a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> that is being used for transitioning
between the two states, if any has been set</p>
<div class="refsect3">
<a name="id-1.10.18.10.15.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>state</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> instance.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>source_state_name</p></td>
<td class="parameter_description"><p>the name of a source state</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>target_state_name</p></td>
<td class="parameter_description"><p>the name of a target state</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.10.18.10.15.8"></a><h4>Returns</h4>
<p> a <a class="link" href="ClutterAnimator.html" title="ClutterAnimator"><span class="type">ClutterAnimator</span></a> instance, or <code class="literal">NULL</code>. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since 1.4</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-state-key-get-source-state-name"></a><h3>clutter_state_key_get_source_state_name ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
clutter_state_key_get_source_state_name
(<em class="parameter"><code>const <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a> *state_key</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_state_key_get_source_state_name</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
</div>
<p>Retrieves the name of the source state of the <em class="parameter"><code>state_key</code></em>
</p>
<div class="refsect3">
<a name="id-1.10.18.10.16.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>state_key</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.10.18.10.16.8"></a><h4>Returns</h4>
<p> the name of the source state for this key, or <code class="literal">NULL</code>
if this is the generic state key for the given property when
transitioning to the target state. The returned string is owned
by the <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a> and should never be modified or freed</p>
<p></p>
</div>
<p class="since">Since 1.4</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-state-key-get-target-state-name"></a><h3>clutter_state_key_get_target_state_name ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
clutter_state_key_get_target_state_name
(<em class="parameter"><code>const <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a> *state_key</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_state_key_get_target_state_name</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
</div>
<p>Get the name of the source state this <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a> contains,
or NULL if this is the generic state key for the given property
when transitioning to the target state.</p>
<div class="refsect3">
<a name="id-1.10.18.10.17.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>state_key</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.10.18.10.17.8"></a><h4>Returns</h4>
<p> the name of the source state for this key, or NULL if
the key is generic</p>
<p></p>
</div>
<p class="since">Since 1.4</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-state-key-get-object"></a><h3>clutter_state_key_get_object ()</h3>
<pre class="programlisting"><span class="returnvalue">GObject</span> *
clutter_state_key_get_object (<em class="parameter"><code>const <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a> *state_key</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_state_key_get_object</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
</div>
<p>Retrieves the object instance this <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a> applies to.</p>
<div class="refsect3">
<a name="id-1.10.18.10.18.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>state_key</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.10.18.10.18.8"></a><h4>Returns</h4>
<p> the object this state key applies to. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since 1.4</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-state-key-get-property-name"></a><h3>clutter_state_key_get_property_name ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
clutter_state_key_get_property_name (<em class="parameter"><code>const <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a> *state_key</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_state_key_get_property_name</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
</div>
<p>Retrieves the name of the property this <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a> applies to</p>
<div class="refsect3">
<a name="id-1.10.18.10.19.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>state_key</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.10.18.10.19.8"></a><h4>Returns</h4>
<p> the name of the property. The returned string is owned
by the <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a> and should never be modified or freed</p>
<p></p>
</div>
<p class="since">Since 1.4</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-state-key-get-mode"></a><h3>clutter_state_key_get_mode ()</h3>
<pre class="programlisting"><span class="returnvalue">gulong</span>
clutter_state_key_get_mode (<em class="parameter"><code>const <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a> *state_key</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_state_key_get_mode</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
</div>
<p>Retrieves the easing mode used for <em class="parameter"><code>state_key</code></em>
.</p>
<div class="refsect3">
<a name="id-1.10.18.10.20.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>state_key</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.10.18.10.20.8"></a><h4>Returns</h4>
<p> the mode of a <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a></p>
<p></p>
</div>
<p class="since">Since 1.4</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-state-key-get-value"></a><h3>clutter_state_key_get_value ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
clutter_state_key_get_value (<em class="parameter"><code>const <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a> *state_key</code></em>,
<em class="parameter"><code><span class="type">GValue</span> *value</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_state_key_get_value</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
</div>
<p>Retrieves a copy of the value for a <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a>.</p>
<p>The <span class="type">GValue</span> needs to be already initialized for the value type
of the property or to a type that allow transformation from the value
type of the key.</p>
<p>Use <code class="function">g_value_unset()</code> when done.</p>
<div class="refsect3">
<a name="id-1.10.18.10.21.9"></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>state_key</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>value</p></td>
<td class="parameter_description"><p>a <span class="type">GValue</span> initialized with the correct type for the <em class="parameter"><code>state_key</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.10.18.10.21.10"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the value was successfully retrieved,
and <code class="literal">FALSE</code> otherwise</p>
<p></p>
</div>
<p class="since">Since 1.4</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-state-key-get-property-type"></a><h3>clutter_state_key_get_property_type ()</h3>
<pre class="programlisting"><span class="returnvalue">GType</span>
clutter_state_key_get_property_type (<em class="parameter"><code>const <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a> *key</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_state_key_get_property_type</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
</div>
<p>Retrieves the <span class="type">GType</span> of the property a key applies to</p>
<p>You can use this type to initialize the <span class="type">GValue</span> to pass to
<a class="link" href="ClutterState.html#clutter-state-key-get-value" title="clutter_state_key_get_value ()"><code class="function">clutter_state_key_get_value()</code></a></p>
<div class="refsect3">
<a name="id-1.10.18.10.22.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>key</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.10.18.10.22.9"></a><h4>Returns</h4>
<p> the <span class="type">GType</span> of the property</p>
<p></p>
</div>
<p class="since">Since 1.4</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-state-key-get-pre-delay"></a><h3>clutter_state_key_get_pre_delay ()</h3>
<pre class="programlisting"><span class="returnvalue">gdouble</span>
clutter_state_key_get_pre_delay (<em class="parameter"><code>const <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a> *state_key</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_state_key_get_pre_delay</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
</div>
<p>Retrieves the pause before transitioning starts as a fraction of
the total transition time.</p>
<div class="refsect3">
<a name="id-1.10.18.10.23.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>state_key</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.10.18.10.23.8"></a><h4>Returns</h4>
<p> the pre delay used before starting the transition.</p>
<p></p>
</div>
<p class="since">Since 1.4</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-state-key-get-post-delay"></a><h3>clutter_state_key_get_post_delay ()</h3>
<pre class="programlisting"><span class="returnvalue">gdouble</span>
clutter_state_key_get_post_delay (<em class="parameter"><code>const <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a> *state_key</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_state_key_get_post_delay</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
</div>
<p>Retrieves the duration of the pause after transitioning is complete
as a fraction of the total transition time.</p>
<div class="refsect3">
<a name="id-1.10.18.10.24.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>state_key</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.10.18.10.24.8"></a><h4>Returns</h4>
<p> the post delay, used after doing the transition.</p>
<p></p>
</div>
<p class="since">Since 1.4</p>
</div>
</div>
<div class="refsect1">
<a name="ClutterState.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="ClutterState-struct"></a><h3>ClutterState</h3>
<pre class="programlisting">typedef struct _ClutterState ClutterState;</pre>
<p>The <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</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="ClutterStateClass"></a><h3>struct ClutterStateClass</h3>
<pre class="programlisting">struct ClutterStateClass {
void (* completed) (ClutterState *state);
};
</pre>
<div class="warning"><p><code class="literal">ClutterStateClass</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p></div>
<p>The <a class="link" href="ClutterState.html#ClutterStateClass" title="struct ClutterStateClass"><span class="type">ClutterStateClass</span></a> structure contains
only private data</p>
<div class="refsect3">
<a name="id-1.10.18.11.3.7"></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="ClutterStateClass.completed"></a>completed</code></em> ()</p></td>
<td class="struct_member_description"><p>class handler for the <a class="link" href="ClutterState.html#ClutterState-completed" title="The “completed” signal"><span class="type">“completed”</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="ClutterStateKey"></a><h3>ClutterStateKey</h3>
<pre class="programlisting">typedef struct _ClutterStateKey ClutterStateKey;</pre>
<p><a class="link" href="ClutterState.html#ClutterStateKey" title="ClutterStateKey"><span class="type">ClutterStateKey</span></a> is an opaque structure whose
members cannot be accessed directly</p>
<p class="since">Since 1.4</p>
</div>
</div>
<div class="refsect1">
<a name="ClutterState.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="ClutterState--duration"></a><h3>The <code class="literal">“duration”</code> property</h3>
<pre class="programlisting"> “duration” <span class="type">guint</span></pre>
<p>Default duration used if an duration has not been specified for a specific
source/target state pair. The values is in milliseconds.</p>
<div class="warning">
<p><code class="literal">ClutterState:duration</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
</div>
<p>Flags: Read / Write</p>
<p>Allowed values: <= 86400000</p>
<p>Default value: 1000</p>
<p class="since">Since 1.4</p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterState--state"></a><h3>The <code class="literal">“state”</code> property</h3>
<pre class="programlisting"> “state” <span class="type">gchar</span> *</pre>
<p>The currently set target state, setting it causes the
state machine to transition to the new state, use
<a class="link" href="ClutterState.html#clutter-state-warp-to-state" title="clutter_state_warp_to_state ()"><code class="function">clutter_state_warp_to_state()</code></a> to change state without
a transition.</p>
<div class="warning">
<p><code class="literal">ClutterState:state</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
</div>
<p>Flags: Read / Write</p>
<p>Default value: NULL</p>
<p class="since">Since 1.4</p>
</div>
</div>
<div class="refsect1">
<a name="ClutterState.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="ClutterState-completed"></a><h3>The <code class="literal">“completed”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> *state,
<span class="type">gpointer</span> user_data)</pre>
<p>The ::completed signal is emitted when a <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> reaches
the target state specified by <a class="link" href="ClutterState.html#clutter-state-set-state" title="clutter_state_set_state ()"><code class="function">clutter_state_set_state()</code></a> or
<a class="link" href="ClutterState.html#clutter-state-warp-to-state" title="clutter_state_warp_to_state ()"><code class="function">clutter_state_warp_to_state()</code></a>.</p>
<div class="warning">
<p><code class="literal">ClutterState::completed</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> and
<a class="link" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup"><span class="type">ClutterTransitionGroup</span></a> instead</p>
</div>
<div class="refsect3">
<a name="id-1.10.18.13.2.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>state</p></td>
<td class="parameter_description"><p>the <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> that emitted the signal</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>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.21</div>
</body>
</html>
|