/usr/share/gtk-doc/html/clutter/ClutterScript.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 | <!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: ClutterScript</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="ch11.html" title="User interface definition">
<link rel="prev" href="ch11.html" title="User interface definition">
<link rel="next" href="ClutterScriptable.html" title="ClutterScriptable">
<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="#ClutterScript.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#ClutterScript.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#ClutterScript.properties" class="shortcut">Properties</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="ch11.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ch11.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ClutterScriptable.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="ClutterScript"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="ClutterScript.top_of_page"></a>ClutterScript</span></h2>
<p>ClutterScript — Loads a scene from UI definition data</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="ClutterScript.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="ClutterScript.html" title="ClutterScript"><span class="returnvalue">ClutterScript</span></a> *
</td>
<td class="function_name">
<a class="link" href="ClutterScript.html#clutter-script-new" title="clutter_script_new ()">clutter_script_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">guint</span>
</td>
<td class="function_name">
<a class="link" href="ClutterScript.html#clutter-script-load-from-data" title="clutter_script_load_from_data ()">clutter_script_load_from_data</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="ClutterScript.html#clutter-script-load-from-file" title="clutter_script_load_from_file ()">clutter_script_load_from_file</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="ClutterScript.html#clutter-script-load-from-resource" title="clutter_script_load_from_resource ()">clutter_script_load_from_resource</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="ClutterScript.html#clutter-script-add-search-paths" title="clutter_script_add_search_paths ()">clutter_script_add_search_paths</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="ClutterScript.html#clutter-script-lookup-filename" title="clutter_script_lookup_filename ()">clutter_script_lookup_filename</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="ClutterScript.html#clutter-script-get-object" title="clutter_script_get_object ()">clutter_script_get_object</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gint</span>
</td>
<td class="function_name">
<a class="link" href="ClutterScript.html#clutter-script-get-objects" title="clutter_script_get_objects ()">clutter_script_get_objects</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="ClutterScript.html#clutter-script-unmerge-objects" title="clutter_script_unmerge_objects ()">clutter_script_unmerge_objects</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="ClutterScript.html#clutter-script-ensure-objects" title="clutter_script_ensure_objects ()">clutter_script_ensure_objects</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="ClutterScript.html#clutter-script-list-objects" title="clutter_script_list_objects ()">clutter_script_list_objects</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="ClutterScript.html#ClutterScriptConnectFunc" title="ClutterScriptConnectFunc ()">*ClutterScriptConnectFunc</a><span class="c_punctuation">)</span> <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="ClutterScript.html#clutter-script-connect-signals" title="clutter_script_connect_signals ()">clutter_script_connect_signals</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="ClutterScript.html#clutter-script-connect-signals-full" title="clutter_script_connect_signals_full ()">clutter_script_connect_signals_full</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="ClutterScript.html#clutter-script-add-states" title="clutter_script_add_states ()">clutter_script_add_states</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="ClutterScript.html#clutter-script-get-states" title="clutter_script_get_states ()">clutter_script_get_states</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="ClutterScript.html#clutter-script-get-type-from-name" title="clutter_script_get_type_from_name ()">clutter_script_get_type_from_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="ClutterScript.html#clutter-get-script-id" title="clutter_get_script_id ()">clutter_get_script_id</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="ClutterScript.html#clutter-script-get-translation-domain" title="clutter_script_get_translation_domain ()">clutter_script_get_translation_domain</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="ClutterScript.html#clutter-script-set-translation-domain" title="clutter_script_set_translation_domain ()">clutter_script_set_translation_domain</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterScript.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">gchar</span> *</td>
<td class="property_name"><a class="link" href="ClutterScript.html#ClutterScript--filename" title="The “filename” property">filename</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="ClutterScript.html#ClutterScript--filename-set" title="The “filename-set” property">filename-set</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="ClutterScript.html#ClutterScript--translation-domain" title="The “translation-domain” property">translation-domain</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterScript.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="ClutterScript.html#ClutterScript-struct" title="struct ClutterScript">ClutterScript</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="ClutterScript.html#ClutterScriptClass" title="struct ClutterScriptClass">ClutterScriptClass</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="ClutterScript.html#ClutterScriptError" title="enum ClutterScriptError">ClutterScriptError</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterScript.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> ClutterScript
</pre>
</div>
<div class="refsect1">
<a name="ClutterScript.description"></a><h2>Description</h2>
<p><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> is an object used for loading and building parts or a
complete scenegraph from external definition data in forms of string
buffers or files.</p>
<p>The UI definition format is JSON, the JavaScript Object Notation as
described by RFC 4627. <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> can load a JSON data stream,
parse it and build all the objects defined into it. Each object must
have an "id" and a "type" properties defining the name to be used
to retrieve it from <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> with <a class="link" href="ClutterScript.html#clutter-script-get-object" title="clutter_script_get_object ()"><code class="function">clutter_script_get_object()</code></a>,
and the class type to be instanciated. Every other attribute will
be mapped to the class properties.</p>
<p>A <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> holds a reference on every object it creates from
the definition data, except for the stage. Every non-actor object
will be finalized when the <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> instance holding it will
be finalized, so they need to be referenced using <code class="function">g_object_ref()</code> in
order for them to survive.</p>
<p>A simple object might be defined as:</p>
<p><informalexample><programlisting><![CDATA[
{
"id" : "red-button",
"type" : "ClutterRectangle",
"width" : 100,
"height" : 100,
"color" : "#ff0000ff"
}
]]></programlisting></informalexample></p>
<p>This will produce a red <a class="link" href="ClutterRectangle.html" title="ClutterRectangle"><span class="type">ClutterRectangle</span></a>, 100x100 pixels wide, and
with a ClutterScript id of "red-button"; it can be retrieved by calling:</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</pre></td>
<td class="listing_code"><pre class="programlisting">ClutterActor <span class="gtkdoc opt">*</span>red_button<span class="gtkdoc opt">;</span>
red_button <span class="gtkdoc opt">=</span> <span class="function">CLUTTER_ACTOR</span> <span class="gtkdoc opt">(</span><span class="function"><a href="ClutterScript.html#clutter-script-get-object">clutter_script_get_object</a></span> <span class="gtkdoc opt">(</span>script<span class="gtkdoc opt">,</span> <span class="string">"red-button"</span><span class="gtkdoc opt">));</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p></p>
<p>and then manipulated with the Clutter API. For every object created
using ClutterScript it is possible to check the id by calling
<a class="link" href="ClutterScript.html#clutter-get-script-id" title="clutter_get_script_id ()"><code class="function">clutter_get_script_id()</code></a>.</p>
<p>Packing can be represented using the "children" member, and passing an
array of objects or ids of objects already defined (but not packed: the
packing rules of Clutter still apply, and an actor cannot be packed
in multiple containers without unparenting it in between).</p>
<p>Behaviours and timelines can also be defined inside a UI definition
buffer:</p>
<p><informalexample><programlisting><![CDATA[
{
"id" : "rotate-behaviour",
"type" : "ClutterBehaviourRotate",
"angle-start" : 0.0,
"angle-end" : 360.0,
"axis" : "z-axis",
"alpha" : {
"timeline" : { "duration" : 4000, "loop" : true },
"mode" : "easeInSine"
}
}
]]></programlisting></informalexample></p>
<p>And then to apply a defined behaviour to an actor defined inside the
definition of an actor, the "behaviour" member can be used:</p>
<p><informalexample><programlisting><![CDATA[
{
"id" : "my-rotating-actor",
"type" : "ClutterTexture",
...
"behaviours" : [ "rotate-behaviour" ]
}
]]></programlisting></informalexample></p>
<p>A <a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a> belonging to a <a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour"><span class="type">ClutterBehaviour</span></a> can only be defined
implicitly like in the example above, or explicitly by setting the
"alpha" property to point to a previously defined <a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a>, e.g.:</p>
<p><informalexample><programlisting><![CDATA[
{
"id" : "rotate-behaviour",
"type" : "ClutterBehaviourRotate",
"angle-start" : 0.0,
"angle-end" : 360.0,
"axis" : "z-axis",
"alpha" : {
"id" : "rotate-alpha",
"type" : "ClutterAlpha",
"timeline" : {
"id" : "rotate-timeline",
"type : "ClutterTimeline",
"duration" : 4000,
"loop" : true
},
"function" : "custom_sine_alpha"
}
}
]]></programlisting></informalexample></p>
<p>Implicitely defined <a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a><!-- -->s and <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a><!-- -->s
can omit the <varname>id</varname> member, as well as the
<varname>type</varname> member, but will not be available using
<a class="link" href="ClutterScript.html#clutter-script-get-object" title="clutter_script_get_object ()"><code class="function">clutter_script_get_object()</code></a> (they can, however, be extracted using the
<a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour"><span class="type">ClutterBehaviour</span></a> and <a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a> API respectively).</p>
<p>Signal handlers can be defined inside a Clutter UI definition file and
then autoconnected to their respective signals using the
<a class="link" href="ClutterScript.html#clutter-script-connect-signals" title="clutter_script_connect_signals ()"><code class="function">clutter_script_connect_signals()</code></a> function:</p>
<p><informalexample><programlisting><![CDATA[
...
"signals" : [
{ "name" : "button-press-event", "handler" : "on_button_press" },
{
"name" : "foo-signal",
"handler" : "after_foo",
"after" : true
},
],
...
]]></programlisting></informalexample></p>
<p>Signal handler definitions must have a "name" and a "handler" members;
they can also have the "after" and "swapped" boolean members (for the
signal connection flags <code class="literal">G_CONNECT_AFTER</code> and <code class="literal">G_CONNECT_SWAPPED</code>
respectively) and the "object" string member for calling
<code class="function">g_signal_connect_object()</code> instead of <code class="function">g_signal_connect()</code>.</p>
<p>Signals can also be directly attached to a specific state defined
inside a <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> instance, for 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
25</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="gtkdoc opt">...</span>
<span class="string">"signals"</span> <span class="gtkdoc opt">: [</span>
<span class="gtkdoc opt">{</span>
<span class="string">"name"</span> <span class="gtkdoc opt">:</span> <span class="string">"enter-event"</span><span class="gtkdoc opt">,</span>
<span class="string">"states"</span> <span class="gtkdoc opt">:</span> <span class="string">"button-states"</span><span class="gtkdoc opt">,</span>
<span class="string">"target-state"</span> <span class="gtkdoc opt">:</span> <span class="string">"hover"</span>
<span class="gtkdoc opt">},</span>
<span class="gtkdoc opt">{</span>
<span class="string">"name"</span> <span class="gtkdoc opt">:</span> <span class="string">"leave-event"</span><span class="gtkdoc opt">,</span>
<span class="string">"states"</span> <span class="gtkdoc opt">:</span> <span class="string">"button-states"</span><span class="gtkdoc opt">,</span>
<span class="string">"target-state"</span> <span class="gtkdoc opt">:</span> <span class="string">"base"</span>
<span class="gtkdoc opt">},</span>
<span class="gtkdoc opt">{</span>
<span class="string">"name"</span> <span class="gtkdoc opt">:</span> <span class="string">"button-press-event"</span><span class="gtkdoc opt">,</span>
<span class="string">"states"</span> <span class="gtkdoc opt">:</span> <span class="string">"button-states"</span><span class="gtkdoc opt">,</span>
<span class="string">"target-state"</span> <span class="gtkdoc opt">:</span> <span class="string">"active"</span><span class="gtkdoc opt">,</span>
<span class="gtkdoc opt">},</span>
<span class="gtkdoc opt">{</span>
<span class="string">"name"</span> <span class="gtkdoc opt">:</span> <span class="string">"key-press-event"</span><span class="gtkdoc opt">,</span>
<span class="string">"states"</span> <span class="gtkdoc opt">:</span> <span class="string">"button-states"</span><span class="gtkdoc opt">,</span>
<span class="string">"target-state"</span> <span class="gtkdoc opt">:</span> <span class="string">"key-focus"</span><span class="gtkdoc opt">,</span>
<span class="string">"warp"</span> <span class="gtkdoc opt">:</span> <span class="keyword">true</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>The "states" key defines the <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> instance to be used to
resolve the "target-state" key; it can be either a script id for a
<a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> built by the same <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> instance, or to a
<a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> built in code and associated to the <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a>
instance through the <a class="link" href="ClutterScript.html#clutter-script-add-states" title="clutter_script_add_states ()"><code class="function">clutter_script_add_states()</code></a> function. If no
"states" key is present, then the default <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> associated to
the <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> instance will be used; the default <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a>
can be set using <a class="link" href="ClutterScript.html#clutter-script-add-states" title="clutter_script_add_states ()"><code class="function">clutter_script_add_states()</code></a> using a <code class="literal">NULL</code> name. The
"warp" key can be used to warp to a specific state instead of
animating to it. State changes on signal emission will not affect
the signal emission chain.</p>
<p>Clutter reserves the following names, so classes defining properties
through the usual GObject registration process should avoid using these
names to avoid collisions:</p>
<p><programlisting><![CDATA[
"id" := the unique name of a ClutterScript object
"type" := the class literal name, also used to infer the type
function
"type_func" := the GType function name, for non-standard classes
"children" := an array of names or objects to add as children
"behaviours" := an array of names or objects to apply to an actor
"signals" := an array of signal definitions to connect to an object
"is-default" := a boolean flag used when defining the <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>;
if set to "true" the default stage will be used instead
of creating a new <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> instance
]]></programlisting></p>
<p><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> is available since Clutter 0.6</p>
</div>
<div class="refsect1">
<a name="ClutterScript.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="clutter-script-new"></a><h3>clutter_script_new ()</h3>
<pre class="programlisting"><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="returnvalue">ClutterScript</span></a> *
clutter_script_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a new <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> instance. <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> can be used
to load objects definitions for scenegraph elements, like actors,
or behavioural elements, like behaviours and timelines. The
definitions must be encoded using the JavaScript Object Notation (JSON)
language.</p>
<div class="refsect3">
<a name="id-1.7.3.2.8.2.5"></a><h4>Returns</h4>
<p> the newly created <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> instance. Use
<code class="function">g_object_unref()</code> when done.</p>
<p></p>
</div>
<p class="since">Since 0.6</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-script-load-from-data"></a><h3>clutter_script_load_from_data ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
clutter_script_load_from_data (<em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *data</code></em>,
<em class="parameter"><code><span class="type">gssize</span> length</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Loads the definitions from <em class="parameter"><code>data</code></em>
into <em class="parameter"><code>script</code></em>
and merges with
the currently loaded ones, if any.</p>
<div class="refsect3">
<a name="id-1.7.3.2.8.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>script</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>a buffer containing the definitions</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>length</p></td>
<td class="parameter_description"><p>the length of the buffer, or -1 if <em class="parameter"><code>data</code></em>
is a NUL-terminated
buffer</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.3.2.8.3.6"></a><h4>Returns</h4>
<p> on error, zero is returned and <em class="parameter"><code>error</code></em>
is set
accordingly. On success, the merge id for the UI definitions is
returned. You can use the merge id with <a class="link" href="ClutterScript.html#clutter-script-unmerge-objects" title="clutter_script_unmerge_objects ()"><code class="function">clutter_script_unmerge_objects()</code></a>.</p>
<p></p>
</div>
<p class="since">Since 0.6</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-script-load-from-file"></a><h3>clutter_script_load_from_file ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
clutter_script_load_from_file (<em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Loads the definitions from <em class="parameter"><code>filename</code></em>
into <em class="parameter"><code>script</code></em>
and merges with
the currently loaded ones, if any.</p>
<div class="refsect3">
<a name="id-1.7.3.2.8.4.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>script</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>the full path to the definition file</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.3.2.8.4.6"></a><h4>Returns</h4>
<p> on error, zero is returned and <em class="parameter"><code>error</code></em>
is set
accordingly. On success, the merge id for the UI definitions is
returned. You can use the merge id with <a class="link" href="ClutterScript.html#clutter-script-unmerge-objects" title="clutter_script_unmerge_objects ()"><code class="function">clutter_script_unmerge_objects()</code></a>.</p>
<p></p>
</div>
<p class="since">Since 0.6</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-script-load-from-resource"></a><h3>clutter_script_load_from_resource ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
clutter_script_load_from_resource (<em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *resource_path</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Loads the definitions from a resource file into <em class="parameter"><code>script</code></em>
and merges with
the currently loaded ones, if any.</p>
<div class="refsect3">
<a name="id-1.7.3.2.8.5.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>script</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>resource_path</p></td>
<td class="parameter_description"><p>the resource path of the file to parse</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.3.2.8.5.6"></a><h4>Returns</h4>
<p> on error, zero is returned and <em class="parameter"><code>error</code></em>
is set
accordingly. On success, the merge id for the UI definitions is
returned. You can use the merge id with <a class="link" href="ClutterScript.html#clutter-script-unmerge-objects" title="clutter_script_unmerge_objects ()"><code class="function">clutter_script_unmerge_objects()</code></a>.</p>
<p></p>
</div>
<p class="since">Since 1.10</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-script-add-search-paths"></a><h3>clutter_script_add_search_paths ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_script_add_search_paths (<em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> * const paths[]</code></em>,
<em class="parameter"><code><span class="type">gsize</span> n_paths</code></em>);</pre>
<p>Adds <em class="parameter"><code>paths</code></em>
to the list of search paths held by <em class="parameter"><code>script</code></em>
.</p>
<p>The search paths are used by <a class="link" href="ClutterScript.html#clutter-script-lookup-filename" title="clutter_script_lookup_filename ()"><code class="function">clutter_script_lookup_filename()</code></a>, which
can be used to define search paths for the textures source file name
or other custom, file-based properties.</p>
<div class="refsect3">
<a name="id-1.7.3.2.8.6.6"></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>script</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>paths</p></td>
<td class="parameter_description"><p> an array of strings containing
different search paths. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_paths]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>n_paths</p></td>
<td class="parameter_description"><p>the length of the passed array</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since 0.8</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-script-lookup-filename"></a><h3>clutter_script_lookup_filename ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
clutter_script_lookup_filename (<em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>);</pre>
<p>Looks up <em class="parameter"><code>filename</code></em>
inside the search paths of <em class="parameter"><code>script</code></em>
. If <em class="parameter"><code>filename</code></em>
is found, its full path will be returned .</p>
<div class="refsect3">
<a name="id-1.7.3.2.8.7.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>script</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>the name of the file to lookup</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.3.2.8.7.6"></a><h4>Returns</h4>
<p> the full path of <em class="parameter"><code>filename</code></em>
or <code class="literal">NULL</code> if no path was
found.</p>
<p></p>
</div>
<p class="since">Since 0.8</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-script-get-object"></a><h3>clutter_script_get_object ()</h3>
<pre class="programlisting"><span class="returnvalue">GObject</span> *
clutter_script_get_object (<em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<p>Retrieves the object bound to <em class="parameter"><code>name</code></em>
. This function does not increment
the reference count of the returned object.</p>
<div class="refsect3">
<a name="id-1.7.3.2.8.8.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>script</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>the name of the object to retrieve</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.3.2.8.8.6"></a><h4>Returns</h4>
<p> the named object, or <code class="literal">NULL</code> if no object
with the given name was available. </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 0.6</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-script-get-objects"></a><h3>clutter_script_get_objects ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span>
clutter_script_get_objects (<em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *first_name</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Retrieves a list of objects for the given names. After <em class="parameter"><code>script</code></em>
, object
names/return location pairs should be listed, with a <code class="literal">NULL</code> pointer
ending the list, like:</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</pre></td>
<td class="listing_code"><pre class="programlisting">GObject <span class="gtkdoc opt">*</span>my_label<span class="gtkdoc opt">, *</span>a_button<span class="gtkdoc opt">, *</span>main_timeline<span class="gtkdoc opt">;</span>
<span class="function"><a href="ClutterScript.html#clutter-script-get-objects">clutter_script_get_objects</a></span> <span class="gtkdoc opt">(</span>script<span class="gtkdoc opt">,</span>
<span class="string">"my-label"</span><span class="gtkdoc opt">, &</span>my_label<span class="gtkdoc opt">,</span>
<span class="string">"a-button"</span><span class="gtkdoc opt">, &</span>a_button<span class="gtkdoc opt">,</span>
<span class="string">"main-timeline"</span><span class="gtkdoc opt">, &</span>main_timeline<span class="gtkdoc opt">,</span>
NULL<span class="gtkdoc opt">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p></p>
<p>Note: This function does not increment the reference count of the
returned objects.</p>
<div class="refsect3">
<a name="id-1.7.3.2.8.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>script</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>first_name</p></td>
<td class="parameter_description"><p>the name of the first object to retrieve</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p>return location for a <span class="type">GObject</span>, then additional names, ending
with <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.3.2.8.9.9"></a><h4>Returns</h4>
<p> the number of objects returned.</p>
<p></p>
</div>
<p class="since">Since 0.6</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-script-unmerge-objects"></a><h3>clutter_script_unmerge_objects ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_script_unmerge_objects (<em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>,
<em class="parameter"><code><span class="type">guint</span> merge_id</code></em>);</pre>
<p>Unmerges the objects identified by <em class="parameter"><code>merge_id</code></em>
.</p>
<div class="refsect3">
<a name="id-1.7.3.2.8.10.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>script</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>merge_id</p></td>
<td class="parameter_description"><p>merge id returned when loading a UI definition</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since 0.6</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-script-ensure-objects"></a><h3>clutter_script_ensure_objects ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_script_ensure_objects (<em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>);</pre>
<p>Ensure that every object defined inside <em class="parameter"><code>script</code></em>
is correctly
constructed. You should rarely need to use this function.</p>
<div class="refsect3">
<a name="id-1.7.3.2.8.11.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>script</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since 0.6</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-script-list-objects"></a><h3>clutter_script_list_objects ()</h3>
<pre class="programlisting"><span class="returnvalue">GList</span> *
clutter_script_list_objects (<em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>);</pre>
<p>Retrieves all the objects created by <em class="parameter"><code>script</code></em>
.</p>
<p>Note: this function does not increment the reference count of the
objects it returns.</p>
<div class="refsect3">
<a name="id-1.7.3.2.8.12.6"></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>script</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.3.2.8.12.7"></a><h4>Returns</h4>
<p> a list
of <span class="type">GObject</span><!-- -->s, or <code class="literal">NULL</code>. The objects are owned by the
<a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> instance. Use <code class="function">g_list_free()</code> on the returned list when
done. </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> GObject.Object]</span></p>
</div>
<p class="since">Since 0.8.2</p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterScriptConnectFunc"></a><h3>ClutterScriptConnectFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*ClutterScriptConnectFunc<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>,
<em class="parameter"><code><span class="type">GObject</span> *object</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *signal_name</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *handler_name</code></em>,
<em class="parameter"><code><span class="type">GObject</span> *connect_object</code></em>,
<em class="parameter"><code><span class="type">GConnectFlags</span> flags</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p>This is the signature of a function used to connect signals. It is used
by the <a class="link" href="ClutterScript.html#clutter-script-connect-signals-full" title="clutter_script_connect_signals_full ()"><code class="function">clutter_script_connect_signals_full()</code></a> function. It is mainly
intended for interpreted language bindings, but could be useful where the
programmer wants more control over the signal connection process.</p>
<div class="refsect3">
<a name="id-1.7.3.2.8.13.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>script</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>object</p></td>
<td class="parameter_description"><p>the object to connect</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>signal_name</p></td>
<td class="parameter_description"><p>the name of the signal</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>handler_name</p></td>
<td class="parameter_description"><p>the name of the signal handler</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>connect_object</p></td>
<td class="parameter_description"><p>the object to connect the signal to, or <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>flags</p></td>
<td class="parameter_description"><p>signal connection flags</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 to pass to the signal handler</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since 0.6</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-script-connect-signals"></a><h3>clutter_script_connect_signals ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_script_connect_signals (<em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p>Connects all the signals defined into a UI definition file to their
handlers.</p>
<p>This method invokes <a class="link" href="ClutterScript.html#clutter-script-connect-signals-full" title="clutter_script_connect_signals_full ()"><code class="function">clutter_script_connect_signals_full()</code></a> internally
and uses <span class="type">GModule</span>'s introspective features (by opening the current
module's scope) to look at the application's symbol table.</p>
<p>Note that this function will not work if <span class="type">GModule</span> is not supported by
the platform Clutter is running on.</p>
<div class="refsect3">
<a name="id-1.7.3.2.8.14.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>script</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>data to be passed to the signal handlers, or <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since 0.6</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-script-connect-signals-full"></a><h3>clutter_script_connect_signals_full ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_script_connect_signals_full (<em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>,
<em class="parameter"><code><a class="link" href="ClutterScript.html#ClutterScriptConnectFunc" title="ClutterScriptConnectFunc ()"><span class="type">ClutterScriptConnectFunc</span></a> func</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p>Connects all the signals defined into a UI definition file to their
handlers.</p>
<p>This function allows to control how the signal handlers are
going to be connected to their respective signals. It is meant
primarily for language bindings to allow resolving the function
names using the native API, but it can also be used on platforms
that do not support GModule.</p>
<p>Applications should use <a class="link" href="ClutterScript.html#clutter-script-connect-signals" title="clutter_script_connect_signals ()"><code class="function">clutter_script_connect_signals()</code></a>.</p>
<div class="refsect3">
<a name="id-1.7.3.2.8.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>script</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>func</p></td>
<td class="parameter_description"><p> signal connection function. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid only during the call to the method."><span class="acronym">scope call</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>data to be passed to the signal handlers, or <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since 0.6</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-script-add-states"></a><h3>clutter_script_add_states ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_script_add_states (<em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<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_script_add_states</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p></div>
<p>Associates a <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> to the <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> instance using the given
name.</p>
<p>The <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> instance will use <em class="parameter"><code>state</code></em>
to resolve target states when
connecting signal handlers.</p>
<p>The <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> instance will take a reference on the <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a>
passed to this function.</p>
<div class="refsect3">
<a name="id-1.7.3.2.8.16.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>script</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p> a name for the <em class="parameter"><code>state</code></em>
, or <code class="literal">NULL</code> to
set the default <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</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>
<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>
<p class="since">Since 1.8</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-script-get-states"></a><h3>clutter_script_get_states ()</h3>
<pre class="programlisting"><a class="link" href="ClutterState.html" title="ClutterState"><span class="returnvalue">ClutterState</span></a> *
clutter_script_get_states (<em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<div class="warning"><p><code class="literal">clutter_script_get_states</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p></div>
<p>Retrieves the <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> for the given <em class="parameter"><code>state_name</code></em>
.</p>
<p>If <em class="parameter"><code>name</code></em>
is <code class="literal">NULL</code>, this function will return the default
<a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> instance.</p>
<div class="refsect3">
<a name="id-1.7.3.2.8.17.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>script</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p> the name of the <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a>, 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.7.3.2.8.17.9"></a><h4>Returns</h4>
<p> a pointer to the <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> for the
given name. The <a class="link" href="ClutterState.html" title="ClutterState"><span class="type">ClutterState</span></a> is owned by the <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> instance
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.8</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-script-get-type-from-name"></a><h3>clutter_script_get_type_from_name ()</h3>
<pre class="programlisting"><span class="returnvalue">GType</span>
clutter_script_get_type_from_name (<em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *type_name</code></em>);</pre>
<p>Looks up a type by name, using the virtual function that
<a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> has for that purpose. This function should
rarely be used.</p>
<div class="refsect3">
<a name="id-1.7.3.2.8.18.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>script</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>type_name</p></td>
<td class="parameter_description"><p>name of the type to look up</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.3.2.8.18.6"></a><h4>Returns</h4>
<p> the type for the requested type name, or
<code class="literal">G_TYPE_INVALID</code> if not corresponding type was found.</p>
<p></p>
</div>
<p class="since">Since 0.6</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-get-script-id"></a><h3>clutter_get_script_id ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
clutter_get_script_id (<em class="parameter"><code><span class="type">GObject</span> *gobject</code></em>);</pre>
<p>Retrieves the Clutter script id, if any.</p>
<div class="refsect3">
<a name="id-1.7.3.2.8.19.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>gobject</p></td>
<td class="parameter_description"><p>a <span class="type">GObject</span></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.3.2.8.19.6"></a><h4>Returns</h4>
<p> the script id, or <code class="literal">NULL</code> if <em class="parameter"><code>object</code></em>
was not defined inside
a UI definition file. The returned string is owned by the object and
should never be modified or freed.</p>
<p></p>
</div>
<p class="since">Since 0.6</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-script-get-translation-domain"></a><h3>clutter_script_get_translation_domain ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
clutter_script_get_translation_domain (<em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>);</pre>
<p>Retrieves the translation domain set using
<a class="link" href="ClutterScript.html#clutter-script-set-translation-domain" title="clutter_script_set_translation_domain ()"><code class="function">clutter_script_set_translation_domain()</code></a>.</p>
<div class="refsect3">
<a name="id-1.7.3.2.8.20.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>script</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.3.2.8.20.6"></a><h4>Returns</h4>
<p> the translation domain, if any is set,
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.10</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-script-set-translation-domain"></a><h3>clutter_script_set_translation_domain ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_script_set_translation_domain (<em class="parameter"><code><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> *script</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *domain</code></em>);</pre>
<p>Sets the translation domain for <em class="parameter"><code>script</code></em>
.</p>
<div class="refsect3">
<a name="id-1.7.3.2.8.21.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>script</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>domain</p></td>
<td class="parameter_description"><p> the translation domain, 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>
<p class="since">Since 1.10</p>
</div>
</div>
<div class="refsect1">
<a name="ClutterScript.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="ClutterScript-struct"></a><h3>struct ClutterScript</h3>
<pre class="programlisting">struct ClutterScript;</pre>
<p>The <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> structure contains only private data
and should be accessed using the provided API</p>
<p class="since">Since 0.6</p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterScriptClass"></a><h3>struct ClutterScriptClass</h3>
<pre class="programlisting">struct ClutterScriptClass {
GType (* get_type_from_name) (ClutterScript *script,
const gchar *type_name);
};
</pre>
<p>The <a class="link" href="ClutterScript.html#ClutterScriptClass" title="struct ClutterScriptClass"><span class="type">ClutterScriptClass</span></a> structure contains only private data</p>
<div class="refsect3">
<a name="id-1.7.3.2.9.3.5"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody><tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterScriptClass.get-type-from-name"></a>get_type_from_name</code></em> ()</p></td>
<td class="struct_member_description"><p>virtual function used to map a type name
to a <span class="type">GType</span>. This function should only be overridden by
language bindings in order to map native types to <span class="type">GType</span>.
The default implementation is equivalent to <code class="function">g_type_from_name()</code></p></td>
<td class="struct_member_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since 0.6</p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterScriptError"></a><h3>enum ClutterScriptError</h3>
<p><a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> error enumeration.</p>
<div class="refsect3">
<a name="id-1.7.3.2.9.4.4"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="CLUTTER-SCRIPT-ERROR-INVALID-TYPE-FUNCTION:CAPS"></a>CLUTTER_SCRIPT_ERROR_INVALID_TYPE_FUNCTION</p></td>
<td class="enum_member_description">
<p>Type function not found
or invalid</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="CLUTTER-SCRIPT-ERROR-INVALID-PROPERTY:CAPS"></a>CLUTTER_SCRIPT_ERROR_INVALID_PROPERTY</p></td>
<td class="enum_member_description">
<p>Property not found or invalid</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="CLUTTER-SCRIPT-ERROR-INVALID-VALUE:CAPS"></a>CLUTTER_SCRIPT_ERROR_INVALID_VALUE</p></td>
<td class="enum_member_description">
<p>Invalid value</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since 0.6</p>
</div>
</div>
<div class="refsect1">
<a name="ClutterScript.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="ClutterScript--filename"></a><h3>The <code class="literal">“filename”</code> property</h3>
<pre class="programlisting"> “filename” <span class="type">gchar</span> *</pre>
<p>The path of the currently parsed file. If <a class="link" href="ClutterScript.html#ClutterScript--filename-set" title="The “filename-set” property"><span class="type">“filename-set”</span></a>
is <code class="literal">FALSE</code> then the value of this property is undefined.</p>
<p>Flags: Read</p>
<p>Default value: NULL</p>
<p class="since">Since 0.6</p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterScript--filename-set"></a><h3>The <code class="literal">“filename-set”</code> property</h3>
<pre class="programlisting"> “filename-set” <span class="type">gboolean</span></pre>
<p>Whether the <a class="link" href="ClutterScript.html#ClutterScript--filename" title="The “filename” property"><span class="type">“filename”</span></a> property is set. If this property
is <code class="literal">TRUE</code> then the currently parsed data comes from a file, and the
file name is stored inside the <a class="link" href="ClutterScript.html#ClutterScript--filename" title="The “filename” property"><span class="type">“filename”</span></a> property.</p>
<p>Flags: Read</p>
<p>Default value: FALSE</p>
<p class="since">Since 0.6</p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterScript--translation-domain"></a><h3>The <code class="literal">“translation-domain”</code> property</h3>
<pre class="programlisting"> “translation-domain” <span class="type">gchar</span> *</pre>
<p>The translation domain, used to localize strings marked as translatable
inside a UI definition.</p>
<p>If <a class="link" href="ClutterScript.html#ClutterScript--translation-domain" title="The “translation-domain” property"><span class="type">“translation-domain”</span></a> is set to <code class="literal">NULL</code>, <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a>
will use <code class="function">gettext()</code>, otherwise <code class="function">g_dgettext()</code> will be used.</p>
<p>Flags: Read / Write</p>
<p>Default value: NULL</p>
<p class="since">Since 1.10</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.21</div>
</body>
</html>
|