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
/*! DOM access methods via the [`dom::Element`](struct.Element.html). ## Introduction. Let’s assume you have already integrated Sciter in your application and so you have Sciter window with loaded content. From Sciter's point of view the loaded document is a tree of DOM elements (elements of Document Object Model). Sciter builds this tree while loading/parsing of input HTML. As a rule each tag in source HTML gets matching DOM element (there are exceptions, see below). You can change text, attributes, state flags of DOM elements; add new or remove existing DOM elemdoents. You can also attach your own DOM event handlers to DOM elements to receive events and notifications. Therefore your UI in Sciter is a collection of uniform DOM elements that can be styled by CSS and manipulated by native or script code. ## Basic operations To access the DOM tree we need to get reference of its root element (the root element is the element representing the `<html>` tag in HTML source). ```rust,no_run # use sciter::dom::Element; # let hwnd = ::std::ptr::null_mut(); let root = Element::from_window(hwnd).unwrap(); assert_eq!(root.get_tag(), "html"); ``` *TBD:* Other ways to access DOM tree. By having a root element reference we are able to access any other element in the tree using various access and search functions like `SciterGetNthChild`, `SciterSelectElements`, … All of them are wrapped into methods of `dom::Element`. Here is how you would get reference to first `<div>` element with class "sidebar" using CSS selectors: ```rust,no_run # let root = sciter::dom::Element::from(::std::ptr::null_mut()); let sidebar = root.find_first("div.sidebar").unwrap(); ``` The same in script: ```tiscript var sidebar = self.select("div.sidebar"); // or var sidebar = self.$(div.sidebar); // using a stringizer variant of select() ``` *TBD:* Other select methods. ## DOM element operations You can change the **text** or HTML of a DOM element: ```rust,no_run # let root = sciter::dom::Element::from(::std::ptr::null_mut()); if let Some(mut el) = root.find_first("#cancel").unwrap() { el.set_text("Abort!"); el.set_html(br##"<img src="http://lorempixel.com/32/32/cats/" alt="some cat"/>"##, None); } ``` The same but in script: ```tiscript var el = ...; el.text = "Hello world"; // text el.html = "Hello <b>wrold</b>!"; // inner html ``` You can also get or set DOM **attributes** of any DOM element: ```rust,no_run # let mut el = sciter::dom::Element::from(::std::ptr::null_mut()); let val = el.get_attribute("class").unwrap(); el.set_attribute("class", "new-class"); ``` To **remove** an existing DOM element (to detach it from the DOM) you will do this: ```rust,no_run # let mut el = sciter::dom::Element::from(::std::ptr::null_mut()); el.detach(); ``` and when code will leave the scope where the `el` variable is defined, the DOM element will be destroyed. Creation and population of DOM elements looks like this: ```rust,no_run # use sciter::dom::Element; # let mut el = sciter::dom::Element::from(::std::ptr::null_mut()); let p = Element::with_text("p", "Hello").unwrap(); // create <p> element el.append(&p); // append it to existing element, or use insert() ... ``` And in script: ```tiscript var p = new Element("p", "Hello"); el.append(p); ``` To change runtime state flags of a DOM element we do something like this: ```rust,ignore # let mut el = sciter::dom::Element::from(::std::ptr::null_mut()); el.set_state(ELEMENT_STATE_BITS::STATE_VISITED); ``` And in script: ```tiscript el.state.visited = true; ``` (after such call the element will match `:visited` CSS selector) ## Getting and setting values of DOM elements. By default a value of a DOM element is its text but some DOM elements may have so called behaviors attached to them (see below). `<input>`’s elements, for example, are plain DOM elements but each input type has its own behavior assigned to the element. The behavior, among other things, is responsible for providing and setting the value of the element. For example, value of an `input type=checkbox>` is boolean – _true_ or _false_, and value of a `<form>` element is a collection (name/value map) of all named inputs on the form. In native code values are represented by `sciter::Value` objects. `sciter::Value` is a structure that can hold different types of values: numbers, strings, arrays, objects, etc (see [documentation](https://sciter.com/docs/content/script/language/Types.htm)). Here is how to set a numeric value of a DOM element in native code: ```rust,no_run # use sciter::Value; # let root = sciter::dom::Element::from(::std::ptr::null_mut()); if let Some(mut num) = root.find_first("input[type=number]").unwrap() { num.set_value( Value::from(12) ); // sciter::Value with T_INT type (i32 in Rust) num.set_value(12); // equivalent but with implicit conversion } ``` In script the same will look like: ```tiscript if (var num = self.select("input[type=number]")) { num.value = 12; } ``` . */ use ::{_API}; use capi::sctypes::*; use value::Value; use capi::scbehavior::{CLICK_REASON, BEHAVIOR_EVENTS, BEHAVIOR_EVENT_PARAMS}; pub use capi::scdom::{SCDOM_RESULT, HELEMENT, SET_ELEMENT_HTML, ELEMENT_AREAS, ELEMENT_STATE_BITS}; pub use dom::event::{EventHandler, EventReason}; /// A specialized `Result` type for DOM operations. pub type Result<T> = ::std::result::Result<T, SCDOM_RESULT>; /// Initialize HELEMENT by nullptr. macro_rules! HELEMENT { () => { ::std::ptr::null_mut() } } macro_rules! ok_or { ($rv:expr, $ok:ident) => { if $ok == SCDOM_RESULT::OK { Ok($rv) } else { Err($ok) } }; // for DOM access not_handled is ok // for calling function operation_failed is also ok ($rv:expr, $ok:ident, $skip_not_handled:expr) => { if $ok == SCDOM_RESULT::OK || ($ok == $skip_not_handled) { Ok($rv) } else { Err($ok) } }; } trait ElementVisitor { fn on_element(&mut self, el: Element) -> bool; fn result(&self) -> Vec<Element>; } #[derive(Default)] struct FindFirstElement { all: Vec<Element>, } impl ElementVisitor for FindFirstElement { fn on_element(&mut self, el: Element) -> bool { self.all.push(el); return true; // stop enumeration } fn result(&self) -> Vec<Element> { self.all.clone() } } #[derive(Default)] struct FindAllElements { all: Vec<Element>, } impl ElementVisitor for FindAllElements { fn on_element(&mut self, el: Element) -> bool { self.all.push(el); return false; // continue enumeration } fn result(&self) -> Vec<Element> { self.all.clone() } } /// DOM element wrapper. See the module-level documentation also. #[derive(PartialEq)] pub struct Element { he: HELEMENT, } /// `sciter::Element` can be transferred across thread boundaries. unsafe impl Send for Element {} /// It is safe to share `sciter::Element` between threads - underlaying API is thread-safe. unsafe impl Sync for Element {} impl Element { //\name Creation /// Construct Element object from `HELEMENT` handle. pub fn from(he: HELEMENT) -> Element { Element { he: Element::use_or(he) } } /// Create new element, it is disconnected initially from the DOM. pub fn create(tag: &str) -> Result<Element> { let mut e = Element { he: HELEMENT!() }; let (tag,_) = s2u!(tag); let text = 0 as LPCWSTR; let ok = (_API.SciterCreateElement)(tag.as_ptr(), text, &mut e.he); ok_or!(e, ok) } /// Create new element as child of `parent`. pub fn with_parent(tag: &str, parent: &mut Element) -> Result<Element> { let mut e = Element { he: HELEMENT!() }; let (tag,_) = s2u!(tag); let text = 0 as LPCWSTR; (_API.SciterCreateElement)(tag.as_ptr(), text, &mut e.he); let ok = parent.append(&e); ok.map(|_| e) } /// Create new element as child of `parent`. Deprecated. #[deprecated(since="0.5.0", note="please use `Element::with_parent()` instead.")] pub fn create_at(tag: &str, parent: &mut Element) -> Result<Element> { Element::with_parent(tag, parent) } /// Create new element with specified `text`, it is disconnected initially from the DOM. pub fn with_text(tag: &str, text: &str) -> Result<Element> { let mut e = Element { he: HELEMENT!() }; let (tag,_) = s2u!(tag); let (text,_) = s2w!(text); let ok = (_API.SciterCreateElement)(tag.as_ptr(), text.as_ptr(), &mut e.he); ok_or!(e, ok) } /// Create new element with specified `type`, which is useful for controls and widgets (initially disconnected). pub fn with_type(tag: &str, el_type: &str) -> Result<Element> { let mut e = Element { he: HELEMENT!() }; let (tag,_) = s2u!(tag); let text = 0 as LPCWSTR; let ok = (_API.SciterCreateElement)(tag.as_ptr(), text, &mut e.he); if ok == SCDOM_RESULT::OK { let r = e.set_attribute("type", el_type); r.map(|_| e) } else { Err(ok) } } /// Get root DOM element of the Sciter document. pub fn from_window(hwnd: HWINDOW) -> Result<Element> { let mut p = HELEMENT!(); let ok = (_API.SciterGetRootElement)(hwnd, &mut p); ok_or!(Element::from(p), ok) } /// Get focus DOM element of the Sciter document. pub fn from_focus(hwnd: HWINDOW) -> Result<Element> { let mut p = HELEMENT!(); let ok = (_API.SciterGetFocusElement)(hwnd, &mut p); ok_or!(Element::from(p), ok) } /// Get highlighted element. pub fn from_highlighted(hwnd: HWINDOW) -> Result<Element> { let mut p = HELEMENT!(); let ok = (_API.SciterGetHighlightedElement)(hwnd, &mut p); ok_or!(Element::from(p), ok) } /// Find DOM element of the Sciter document by coordinates. pub fn from_point(hwnd: HWINDOW, pt: POINT) -> Result<Element> { let mut p = HELEMENT!(); let ok = (_API.SciterFindElement)(hwnd, pt, &mut p); ok_or!(Element::from(p), ok) } /// Get element handle by its UID. pub fn from_uid(hwnd: HWINDOW, uid: u32) -> Result<Element> { let mut p = HELEMENT!(); let ok = (_API.SciterGetElementByUID)(hwnd, uid, &mut p); ok_or!(Element::from(p), ok) } fn use_or(he: HELEMENT) -> HELEMENT { let ok = (_API.Sciter_UseElement)(he); if ok == SCDOM_RESULT::OK { he } else { HELEMENT!() } } //\name Common methods /// Access element pointer. pub fn as_ptr(&self) -> HELEMENT { self.he } /// Get element UID - identifier suitable for storage. pub fn get_uid(&self) -> u32 { let mut n = 0; (_API.SciterGetElementUID)(self.he, &mut n); return n; } /// Return element tag as string (e.g. 'div', 'body'). pub fn get_tag(&self) -> String { let mut s = String::new(); (_API.SciterGetElementTypeCB)(self.he, store_astr, &mut s as *mut String as LPVOID); return s; } /// Get inner text of the element as string. pub fn get_text(&self) -> String { let mut s = String::new(); (_API.SciterGetElementTextCB)(self.he, store_wstr, &mut s as *mut String as LPVOID); return s; } /// Set inner text of the element. pub fn set_text(&mut self, text: &str) -> Result<()> { let (s,n) = s2w!(text); let ok = (_API.SciterSetElementText)(self.he, s.as_ptr(), n); ok_or!((), ok) } /// Get html representation of the element as utf-8 bytes. pub fn get_html(&self, with_outer_html: bool) -> Vec<u8> { let mut s = Vec::new(); (_API.SciterGetElementHtmlCB)(self.he, with_outer_html as BOOL, store_bstr, &mut s as *mut Vec<u8> as LPVOID); return s; } /// Set inner or outer html of the element. pub fn set_html(&mut self, html: &[u8], how: Option<SET_ELEMENT_HTML>) -> Result<()> { if html.is_empty() { return self.clear(); } let ok = (_API.SciterSetElementHtml)(self.he, html.as_ptr(), html.len() as UINT, how.unwrap_or(SET_ELEMENT_HTML::SIH_REPLACE_CONTENT) as UINT); ok_or!((), ok) } /// Get value of the element. pub fn get_value(&self) -> Value { let mut rv = Value::new(); (_API.SciterGetValue)(self.he, rv.as_ptr()); return rv; } /// Set value of the element. pub fn set_value<T: Into<Value>>(&mut self, val: T) -> Result<()> { let ok = (_API.SciterSetValue)(self.he, val.into().as_cptr()); ok_or!((), ok) } /// Checks if particular UI state bits are set in the element. pub fn get_state(&self) -> ELEMENT_STATE_BITS { let mut rv = 0u32; (_API.SciterGetElementState)(self.he, &mut rv as *mut _); let state = unsafe { ::std::mem::transmute(rv) }; return state; } /// Set UI state of the element with optional view update. pub fn set_state(&mut self, set: ELEMENT_STATE_BITS, clear: Option<ELEMENT_STATE_BITS>, update: bool) -> Result<()> { let clear = clear.unwrap_or(ELEMENT_STATE_BITS::STATE_NONE); let ok = (_API.SciterSetElementState)(self.he, set as UINT, clear as UINT, update as BOOL); ok_or!((), ok) } /// Get `HWINDOW` of containing window. pub fn get_hwnd(&self, for_root: bool) -> HWINDOW { let mut hwnd: HWINDOW = ::std::ptr::null_mut(); (_API.SciterGetElementHwnd)(self.he, &mut hwnd as *mut HWINDOW, for_root as BOOL); return hwnd; } /// Get bounding rectangle of the element. See the [`ELEMENT_AREAS`](enum.ELEMENT_AREAS.html) enum for `kind` flags. pub fn get_location(&self, kind: u32) -> Result<RECT> { let mut rc = RECT::default(); let ok = (_API.SciterGetElementLocation)(self.he, &mut rc as *mut _, kind as u32); ok_or!(rc, ok) } // TODO: request_data, request_html // TODO: send_request /// Sends sinking/bubbling event to the child/parent chain of element. pub fn send_event(&self, code: BEHAVIOR_EVENTS, reason: Option<CLICK_REASON>, source: Option<HELEMENT>) -> Result<bool> { let mut handled = false as BOOL; let r = reason.unwrap_or(CLICK_REASON::SYNTHESIZED); let s = source.unwrap_or(self.he); let ok = (_API.SciterSendEvent)(self.he, code as u32, s, r as UINT_PTR, &mut handled); ok_or!(handled != 0, ok) } /// Post asynchronously a sinking/bubbling event to the child/parent chain of element. pub fn post_event(&self, code: BEHAVIOR_EVENTS, reason: Option<CLICK_REASON>, source: Option<HELEMENT>) -> Result<()> { let r = reason.unwrap_or(CLICK_REASON::SYNTHESIZED); let s = source.unwrap_or(self.he); let ok = (_API.SciterPostEvent)(self.he, code as u32, s, r as UINT_PTR); ok_or!((), ok) } /// Send or posts event to the child/parent chain of element. pub fn fire_event(&self, code: BEHAVIOR_EVENTS, reason: Option<CLICK_REASON>, source: Option<HELEMENT>, post: bool, data: Option<Value>) -> Result<bool> { let mut handled = false as BOOL; let mut params = BEHAVIOR_EVENT_PARAMS { cmd: code as UINT, reason: reason.unwrap_or(CLICK_REASON::SYNTHESIZED) as UINT_PTR, he: source.unwrap_or(self.he), heTarget: self.he, data: Default::default(), name: 0 as LPCWSTR, }; if data.is_some() { data.unwrap().pack_to(&mut params.data); } let ok = (_API.SciterFireEvent)(¶ms, post as BOOL, &mut handled); ok_or!(handled != 0, ok) } /// Send or posts event with specified params to the child/parent chain of element. pub fn fire_event_params(evt: &BEHAVIOR_EVENT_PARAMS, post: bool) -> Result<bool> { let mut handled = false as BOOL; let ok = (_API.SciterFireEvent)(evt, post as BOOL, &mut handled); ok_or!(handled != 0, ok) } /// Evaluate the given script in context of the element. pub fn eval_script(&self, script: &str) -> Result<Value> { let mut rv = Value::new(); let (s,n) = s2w!(script); let ok = (_API.SciterEvalElementScript)(self.he, s.as_ptr(), n, rv.as_ptr()); return ok_or!(rv, ok, SCDOM_RESULT::OPERATION_FAILED); } /// Call scripting function defined in the namespace of the element (a.k.a. global function). /// /// You can use the [`make_args!(args...)`](../macro.make_args.html) macro which helps you /// to construct script arguments from Rust types. pub fn call_function(&self, name: &str, args: &[Value]) -> Result<Value> { let mut rv = Value::new(); let (name,_) = s2u!(name); let argv = Value::pack_args(args); let ok = (_API.SciterCallScriptingFunction)(self.he, name.as_ptr(), argv.as_ptr(), argv.len() as UINT, rv.as_ptr()); return ok_or!(rv, ok, SCDOM_RESULT::OPERATION_FAILED); } /// Call scripting method defined for the element. /// /// You can use the [`make_args!(args...)`](../macro.make_args.html) macro which helps you /// to construct script arguments from Rust types. pub fn call_method(&self, name: &str, args: &[Value]) -> Result<Value> { let mut rv = Value::new(); let (name,_) = s2u!(name); let argv = Value::pack_args(args); let ok = (_API.SciterCallScriptingMethod)(self.he, name.as_ptr(), argv.as_ptr(), argv.len() as UINT, rv.as_ptr()); return ok_or!(rv, ok, SCDOM_RESULT::OPERATION_FAILED); } /// Call behavior specific method. pub fn call_behavior_method(&self, params: event::MethodParams) -> Result<()> { let call = |p| { (_API.SciterCallBehaviorMethod)(self.he, p) }; use capi::scbehavior::{METHOD_PARAMS, VALUE_PARAMS, IS_EMPTY_PARAMS}; use capi::scbehavior::BEHAVIOR_METHOD_IDENTIFIERS::*; let ok = match params { event::MethodParams::Click => { let mut p = METHOD_PARAMS { method: DO_CLICK as u32, }; call(&mut p as *mut _) }, event::MethodParams::SetValue(v) => { let mut p = VALUE_PARAMS { method: SET_VALUE as u32, value: Default::default(), }; v.pack_to(&mut p.value); call(&mut p as *mut _ as *mut METHOD_PARAMS) }, event::MethodParams::GetValue(retv) => { let mut p = VALUE_PARAMS { method: SET_VALUE as u32, value: Default::default(), }; let ok = call(&mut p as *mut _ as *mut METHOD_PARAMS); if ok != SCDOM_RESULT::OK { return Err(ok); } *retv = Value::from(&p.value); ok }, event::MethodParams::IsEmpty(retv) => { let mut p = IS_EMPTY_PARAMS { method: IS_EMPTY as u32, is_empty: Default::default(), }; let ok = call(&mut p as *mut _ as *mut METHOD_PARAMS); if ok != SCDOM_RESULT::OK { return Err(ok); } *retv = p.is_empty != 0; ok }, _ => { // Can't handle `MethodParams::Custom` yet. SCDOM_RESULT::INVALID_PARAMETER }, }; ok_or!((), ok) } //\name Attributes /// Get number of the attributes. pub fn attribute_count(&self) -> usize { let mut n = 0u32; (_API.SciterGetAttributeCount)(self.he, &mut n); return n as usize; } /// Get attribute name by its index. pub fn attribute_name(&self, index: usize) -> String { let mut s = String::new(); (_API.SciterGetNthAttributeNameCB)(self.he, index as UINT, store_astr, &mut s as *mut String as LPVOID); return s; } /// Get attribute value by its index. pub fn attribute(&self, index: usize) -> String { let mut s = String::new(); (_API.SciterGetNthAttributeValueCB)(self.he, index as UINT, store_wstr, &mut s as *mut String as LPVOID); return s; } /// Get attribute value by its name. pub fn get_attribute(&self, name: &str) -> Option<String> { let mut s = String::new(); let (name,_) = s2u!(name); let ok = (_API.SciterGetAttributeByNameCB)(self.he, name.as_ptr(), store_wstr, &mut s as *mut String as LPVOID); match ok { SCDOM_RESULT::OK => Some(s), // SCDOM_RESULT::OK_NOT_HANDLED => None, _ => None, } } /// Add or replace attribute. pub fn set_attribute(&mut self, name: &str, value: &str) -> Result<()> { let (name,_) = s2u!(name); let (value,_) = s2w!(value); let ok = (_API.SciterSetAttributeByName)(self.he, name.as_ptr(), value.as_ptr()); ok_or!((), ok) } /// Remove attribute. pub fn remove_attribute(&mut self, name: &str) -> Result<()> { let (name,_) = s2u!(name); let value = ::std::ptr::null(); let ok = (_API.SciterSetAttributeByName)(self.he, name.as_ptr(), value); ok_or!((), ok) } /// Toggle attribute. pub fn toggle_attribute(&mut self, name: &str, isset: bool, value: Option<&str>) -> Result<()> { if isset { self.set_attribute(name, value.unwrap()) } else { self.remove_attribute(name) } } /// Remove all attributes from the element. pub fn clear_attributes(&mut self) -> Result<()> { let ok = (_API.SciterClearAttributes)(self.he); ok_or!((), ok) } //\name Style Attributes /// Get [style attribute](https://sciter.com/docs/content/sciter/Style.htm) of the element by its name. pub fn get_style_attribute(&self, name: &str) -> String { let mut s = String::new(); let (name,_) = s2u!(name); (_API.SciterGetStyleAttributeCB)(self.he, name.as_ptr(), store_wstr, &mut s as *mut String as LPVOID); return s; } /// Set [style attribute](https://sciter.com/docs/content/sciter/Style.htm). pub fn set_style_attribute(&mut self, name: &str, value: &str) -> Result<()> { let (name,_) = s2u!(name); let (value,_) = s2w!(value); let ok = (_API.SciterSetStyleAttribute)(self.he, name.as_ptr(), value.as_ptr()); ok_or!((), ok) } //\name State methods //\name DOM tree access /// Get index of this element in its parent collection. pub fn index(&self) -> usize { let mut n = 0u32; (_API.SciterGetElementIndex)(self.he, &mut n as *mut UINT); return n as usize; } /// Get root of the element. pub fn root(&self) -> Element { if let Some(dad) = self.parent() { dad.root() } else { self.clone() } } /// Get parent element. pub fn parent(&self) -> Option<Element> { let mut p = HELEMENT!(); (_API.SciterGetParentElement)(self.he, &mut p); if p.is_null() { None } else { Some(Element::from(p)) } } /// Get first sibling element. pub fn first_sibling(&self) -> Option<Element> { if let Some(dad) = self.parent() { let count = dad.len(); if count > 0 { return dad.child(0); } } None } /// Get last sibling element. pub fn last_sibling(&self) -> Option<Element> { if let Some(dad) = self.parent() { let count = dad.len(); if count > 0 { return dad.child(count - 1); } } None } /// Get next sibling element. pub fn next_sibling(&self) -> Option<Element> { let idx = self.index() + 1; if let Some(dad) = self.parent() { let count = dad.len(); if idx < count { return dad.child(idx); } } None } /// Get previous sibling element. pub fn prev_sibling(&self) -> Option<Element> { let idx = self.index(); if let Some(dad) = self.parent() { let count = dad.len(); if idx > 0 && (idx - 1) < count { return dad.child(idx - 1); } } None } /// Get first child element. pub fn first_child(&self) -> Option<Element> { return self.child(0); } /// Get last child element. pub fn last_child(&self) -> Option<Element> { let count = self.len(); if count > 0 { return self.child(count - 1); } None } /// Get element's child at specified index. pub fn get(&self, index: usize) -> Option<Element> { return self.child(index); } /// An iterator over the direct children of a DOM element. pub fn children(&self) -> Children { Children { base: self, index: 0, count: self.children_count(), } } /// Get element's child at specified index. pub fn child(&self, index: usize) -> Option<Element> { let mut p = HELEMENT!(); let ok = (_API.SciterGetNthChild)(self.he, index as UINT, &mut p); match ok { SCDOM_RESULT::OK => Some(Element::from(p)), _ => None } } /// Get number of child elements. pub fn children_count(&self) -> usize { let mut n = 0u32; (_API.SciterGetChildrenCount)(self.he, &mut n as *mut UINT); return n as usize; } /// Get number of child elements. pub fn len(&self) -> usize { return self.children_count(); } /// Returns `true` is `self` has zero elements. pub fn is_empty(&self) -> bool { self.len() == 0 } /// Clear content of the element. pub fn clear(&mut self) -> Result<()> { let ok = (_API.SciterSetElementText)(self.he, ::std::ptr::null(), 0); ok_or!((), ok) } /// Create new element as copy of existing element. /// /// The new element is a full (deep) copy of the element and is initially disconnected from the DOM. /// Note that `Element.clone()` does not clone DOM element, just increments its reference count. pub fn clone_element(&self) -> Element { let mut e = Element { he: HELEMENT!() }; (_API.SciterCloneElement)(self.he, &mut e.he); return e; } /// Insert element at `index` position of this element. /// /// Note that we cannot follow Rust semantic here /// because the newly created `Element` is unusable before it will be inserted at DOM. pub fn insert(&mut self, index: usize, child: &Element) -> Result<()> { let ok = (_API.SciterInsertElement)(child.he, self.he, index as UINT); ok_or!((), ok) } /// Append element as last child of this element. pub fn append(&mut self, child: &Element) -> Result<()> { self.insert(0x7FFF_FFFF, child) } /// Append element as last child of this element. #[allow(clippy::needless_pass_by_value)] pub fn push(&mut self, element: Element) { self.append(&element).expect("Could not append element."); } /// Remove the last child from this element and returns it, or `None` if this element is empty. pub fn pop(&mut self) -> Option<Element> { let count = self.len(); if count > 0 { if let Some(mut child) = self.get(count - 1) { child.detach().expect("Could not detach element."); return Some(child); } } return None; } /// Take element out of its container (and DOM tree). pub fn detach(&mut self) -> Result<()> { let ok = (_API.SciterDetachElement)(self.he); ok_or!((), ok) } /// Take element out of its container (and DOM tree) and force destruction of all behaviors. pub fn destroy(&mut self) -> Result<()> { let mut p = HELEMENT!(); ::std::mem::swap(&mut self.he, &mut p); let ok = (_API.SciterDeleteElement)(p); ok_or!((), ok) } /// Swap element positions. pub fn swap(&mut self, other: &mut Element) -> Result<()> { let ok = (_API.SciterSwapElements)(self.he, other.he); ok_or!((), ok) } //\name Selectors /// Test this element against CSS selector(s). pub fn test(&self, selector: &str) -> bool { let mut p = HELEMENT!(); let (s,_) = s2u!(selector); (_API.SciterSelectParent)(self.he, s.as_ptr(), 1, &mut p); return !p.is_null(); } /// Call specified function for every element in a DOM that meets specified CSS selectors. fn select_elements<T: ElementVisitor>(&self, selector: &str, callback: T) -> Result<Vec<Element>> { extern "system" fn inner<T: ElementVisitor>(he: HELEMENT, param: LPVOID) -> BOOL { let p = param as *mut T; let obj = unsafe { &mut *p }; let e = Element::from(he); let stop = obj.on_element(e); return stop as BOOL; } let (s,_) = s2u!(selector); let handler = Box::new(callback); let param = Box::into_raw(handler); let ok = (_API.SciterSelectElements)(self.he, s.as_ptr(), inner::<T>, param as LPVOID); let handler = unsafe { Box::from_raw(param) }; if ok != SCDOM_RESULT::OK { return Err(ok); } return Ok(handler.result()); } /// Will find first parent element starting from this satisfying given css selector(s). pub fn find_nearest_parent(&self, selector: &str) -> Result<Option<Element>> { let mut p = HELEMENT!(); let (s,_) = s2u!(selector); let ok = (_API.SciterSelectParent)(self.he, s.as_ptr(), 0, &mut p); if ok != SCDOM_RESULT::OK { return Err(ok); } if p.is_null() { Ok(None) } else { Ok(Some(Element::from(p))) } } /// Will find first element starting from this satisfying given css selector(s). pub fn find_first(&self, selector: &str) -> Result<Option<Element>> { let cb = FindFirstElement::default(); let all = self.select_elements(selector, cb); all.map(|mut x| { x.pop() }) } /// Will find all elements starting from this satisfying given css selector(s). pub fn find_all(&self, selector: &str) -> Result<Option<Vec<Element>>> { let cb = FindAllElements::default(); let all = self.select_elements(selector, cb); all.map(Some) } //\name Scroll methods: //\name Other methods: /// Apply changes and refresh element area in its window. pub fn update(&self, render_now: bool) -> Result<()> { let ok = (_API.SciterUpdateElement)(self.he, render_now as BOOL); ok_or!((), ok) } /// Refresh element area in its window. /// /// If the element has drawing behavior attached it will receive [`on_draw`](event/trait.EventHandler.html#method.on_draw) call after that. pub fn refresh(&self) -> Result<()> { let rect = self.get_location(ELEMENT_AREAS::self_content())?; let ok = (_API.SciterRefreshElementArea)(self.he, rect); ok_or!((), ok) } /// Start Timer for the element. /// /// Element will receive [`on_timer`](event/trait.EventHandler.html#method.on_timer) events. /// /// Note that timer events are not bubbling, so you need attach handler to the target element directly. pub fn start_timer(&self, period_ms: u32, timer_id: u64) -> Result<()> { let ok = (_API.SciterSetTimer)(self.he, period_ms as UINT, timer_id as ::capi::sctypes::UINT_PTR); ok_or!((), ok) } /// Stop Timer for the element. pub fn stop_timer(&self, timer_id: u64) -> Result<()> { if !self.he.is_null() { let ok = (_API.SciterSetTimer)(self.he, 0 as UINT, timer_id as ::capi::sctypes::UINT_PTR); ok_or!((), ok) } else { Ok(()) } } /// Attach the native event handler to this element. pub fn attach_handler<Handler: EventHandler>(&mut self, handler: Handler) -> Result<u64> { // make native handler let boxed = Box::new(handler); let ptr = Box::into_raw(boxed); // dropped in `_event_handler_proc` let token = ptr as usize as u64; let ok = (_API.SciterAttachEventHandler)(self.he, ::eventhandler::_event_handler_proc::<Handler>, ptr as LPVOID); ok_or!(token, ok) } /// Detach your handler from the element. Handlers identified by `token` from `attach_handler()` result. pub fn detach_handler<Handler: EventHandler>(&mut self, token: u64) -> Result<()> { let ptr = token as usize as *mut Handler; let ok = (_API.SciterDetachEventHandler)(self.he, ::eventhandler::_event_handler_proc::<Handler>, ptr as LPVOID); ok_or!((), ok) } } /// Release element pointer. impl Drop for Element { fn drop(&mut self) { (_API.Sciter_UnuseElement)(self.he); self.he = HELEMENT!(); } } /// Increment reference count of the dom element. impl Clone for Element { fn clone(&self) -> Self { Element::from(self.he) } } /// Human element representation. impl ::std::fmt::Display for Element { fn fmt(&self, f: &mut ::std::fmt::Formatter) -> ::std::fmt::Result { if self.he.is_null() { return f.write_str("None"); } // "tag#id.class|type(name)" // "tag#id.class" let tag = self.get_tag(); f.write_str(&tag)?; if let Some(i) = self.get_attribute("id") { write!(f, "#{}", i)?; } if let Some(c) = self.get_attribute("class") { write!(f, ".{}", c)?; } if let Some(t) = self.get_attribute("type") { write!(f, "|{}", t)?; } if let Some(n) = self.get_attribute("name") { write!(f, "({})", n)?; } return Ok(()); } } /// Machine-like element visualization (`{:?}` and `{:#?}`). impl ::std::fmt::Debug for Element { fn fmt(&self, f: &mut ::std::fmt::Formatter) -> ::std::fmt::Result { if f.alternate() { use ::std::mem; fn state_name(value: &ELEMENT_STATE_BITS) -> &'static str { match *value { ELEMENT_STATE_BITS::STATE_LINK => "link", ELEMENT_STATE_BITS::STATE_HOVER => "hover", ELEMENT_STATE_BITS::STATE_ACTIVE => "active", ELEMENT_STATE_BITS::STATE_VISITED => "visited", ELEMENT_STATE_BITS::STATE_FOCUS => "focus", ELEMENT_STATE_BITS::STATE_POPUP => "popup", ELEMENT_STATE_BITS::STATE_CURRENT => "current", ELEMENT_STATE_BITS::STATE_CHECKED => "checked", ELEMENT_STATE_BITS::STATE_EXPANDED => "expanded", ELEMENT_STATE_BITS::STATE_COLLAPSED => "collapsed", ELEMENT_STATE_BITS::STATE_DISABLED => "disabled", ELEMENT_STATE_BITS::STATE_INCOMPLETE => "incomplete", ELEMENT_STATE_BITS::STATE_BUSY => "busy", ELEMENT_STATE_BITS::STATE_ANIMATING => "animating", ELEMENT_STATE_BITS::STATE_FOCUSABLE => "", ELEMENT_STATE_BITS::STATE_READONLY => "readonly", ELEMENT_STATE_BITS::STATE_EMPTY => "empty", ELEMENT_STATE_BITS::STATE_ANCHOR => "anchor", ELEMENT_STATE_BITS::STATE_SYNTHETIC => "synthetic", ELEMENT_STATE_BITS::STATE_OWNS_POPUP => "owns_popup", ELEMENT_STATE_BITS::STATE_TABFOCUS => "tabfocus", ELEMENT_STATE_BITS::STATE_IS_RTL => "is_rtl", ELEMENT_STATE_BITS::STATE_IS_LTR => "is_ltr", ELEMENT_STATE_BITS::STATE_DRAG_OVER => "drag_over", ELEMENT_STATE_BITS::STATE_DROP_TARGET => "drop_target", ELEMENT_STATE_BITS::STATE_MOVING => "moving", ELEMENT_STATE_BITS::STATE_COPYING => "copying", ELEMENT_STATE_BITS::STATE_DRAG_SOURCE => "drag_source", ELEMENT_STATE_BITS::STATE_DROP_MARKER => "drop_marker", ELEMENT_STATE_BITS::STATE_READY => "", ELEMENT_STATE_BITS::STATE_PRESSED => "pressed", ELEMENT_STATE_BITS::STATE_NONE => "", } } // "tag#id.class:state1:state2..." let state = self.get_state() as u32; write!(f, "{{{}", self)?; for i in 0..31 { let bit = state & (1 << i); if bit != 0 { let state_bit: ELEMENT_STATE_BITS = unsafe { mem::transmute(bit) }; let name = state_name(&state_bit); if !name.is_empty() { write!(f, ":{}", name)?; } } } write!(f, "}}") } else { // "tag#id.class(name):0xdfdfdf" write!(f, "{{{}:{:?}}}", self, self.he) } } } /// An iterator over the direct children of a DOM element. pub struct Children<'a> { base: &'a Element, index: usize, count: usize, } /// Allows `for child in el.children() {}` enumeration. impl<'a> ::std::iter::Iterator for Children<'a> { type Item = Element; fn next(&mut self) -> Option<Element> { if self.index < self.count { let pos = self.index; self.index += 1; self.base.child(pos) } else { None } } fn size_hint(&self) -> (usize, Option<usize>) { let remain = self.count - self.index; (remain, Some(remain)) } fn count(self) -> usize { self.count } } impl<'a> ::std::iter::DoubleEndedIterator for Children<'a> { fn next_back(&mut self) -> Option<Element> { if self.index == self.count || self.count == 0 { None } else { self.count -= 1; self.base.child(self.count) } } } /// Allows `for child in &el {}` enumeration. impl<'a> ::std::iter::IntoIterator for &'a Element { type Item = Element; type IntoIter = Children<'a>; fn into_iter(self) -> Children<'a> { self.children() } } use ::utf; /// Convert an incoming UTF-16 to `String`. extern "system" fn store_wstr(szstr: LPCWSTR, str_length: UINT, param: LPVOID) { let s = utf::w2sn(szstr, str_length as usize); let out = param as *mut String; unsafe { *out = s }; } /// Convert an incoming UTF-8 to `String`. extern "system" fn store_astr(szstr: LPCSTR, str_length: UINT, param: LPVOID) { let s = utf::u2sn(szstr, str_length as usize); let out = param as *mut String; unsafe { *out = s }; } /// Convert an incoming html string (UTF-8 in fact) to `String`. extern "system" fn store_bstr(szstr: LPCBYTE, str_length: UINT, param: LPVOID) { let s = unsafe { ::std::slice::from_raw_parts(szstr, str_length as usize) }; let pout = param as *mut Vec<u8>; let out = unsafe {&mut *pout}; out.extend_from_slice(s); } /* Not implemented yet or not used APIs: SciterAttachHwndToElement SciterCallBehaviorMethod SciterCombineURL SciterControlGetType SciterGetElementIntrinsicHeight SciterGetElementIntrinsicWidths SciterGetElementLocation SciterGetElementNamespace SciterGetElementType SciterGetExpando SciterGetObject SciterGetScrollInfo SciterHidePopup SciterHttpRequest SciterIsElementEnabled SciterIsElementVisible SciterReleaseCapture SciterRequestElementData SciterScrollToView SciterSetCapture SciterSetHighlightedElement SciterSetScrollPos SciterShowPopup SciterShowPopupAt SciterSortElements SciterTraverseUIEvent SciterCreateCommentNode SciterCreateTextNode SciterNodeAddRef SciterNodeCastFromElement SciterNodeCastToElement SciterNodeChildrenCount SciterNodeFirstChild SciterNodeGetText SciterNodeInsert SciterNodeLastChild SciterNodeNextSibling SciterNodeNthChild SciterNodeParent SciterNodePrevSibling SciterNodeRelease SciterNodeRemove SciterNodeSetText SciterNodeType */ pub mod event { //! //! Behaviors support (a.k.a windowless controls). //! /*! # Behaviors and event handling. Primary goal of User Interface (UI) as a subsystem is to present some information to the user and generate some events according to user’s actions. Your application handles UI events and acts accordingly executing its functions. To be able to handle events in native code you will need to attach instance of `sciter::EventHandler` to existing DOM element or to the window itself. In the `EventHandler` you will receive all events dispatched to the element and its children as before children (in `PHASE_MASK::SINKING` phase) as after them (`PHASE_MASK::BUBBLING` event phase), see [Events Propagation](https://sciter.com/developers/for-native-gui-programmers/#events-propagation). `EventHandler` attached to the window will receive all DOM events no matter which element they are targeted to. `EventHandler` contains various methods – receivers of events of various types. You can override any of these methods in order to receive events you are interested in your implementation of `sciter::EventHandler` class. To attach native event handler to DOM element or to the window you can do one of these: * "Manually", to Sciter window: `sciter::Window.event_handler(your_event_handler)` * "Manually", to arbitrary DOM element: `sciter::dom::Element.attach_handler(your_event_handler)` * To group of DOM elements by declaration in CSS: `selector { behavior:your-behavior-name }` You also can assign events handlers defined in script code: * "Manually", individual events: if you have reference `el` of some element then to handle mouse events you can do this for example: ```tiscript el.onMouse = function(evt) { ... } ``` * "Manually", by assigning behavior class to the [Element](https://sciter.com/docs/content/sciter/Element.htm): ```tiscript class MyEventsHandler: Element { ... } // your behavior class which inherits sciter's Element class el.prototype = MyEventsHandler; // "sub-class" the element. ``` * By declaration in CSS to all elements satisfying some CSS selector: ```css selector { prototype: MyEventsHandler; } ``` In this case `MyEventsHandler` class should be defined in one of script files loaded by your HTML. See the **Behavior attributes** section of [Sciter CSS property map](https://sciter.com/docs/content/css/cssmap.html) and [this blog article](http://www.terrainformatica.com/2014/07/sciter-declarative-behavior-assignment-by-css-prototype-and-aspect-properties/) which covers Behaviors, Prototypes and Aspects of Sciter CSS behavior assignment. # Script and native code interaction In Sciter you may want to define native functions that can be called by script. At the same time you may need to call script functions from native code. Sciter supports such interaction providing set of simple API functions: ## Evaluating scripts and invoking script functions from native code You can use one of these methods to call scripts from code of your application: * To evaluate arbitrary script in context of current document loaded into the window: ```rust,no_run # use sciter::dom::Element; # use sciter::Value; # let hwnd = ::std::ptr::null_mut(); let root = Element::from_window(hwnd).unwrap(); let result: Value = root.eval_script("... script ...").unwrap(); ``` * To call global function defined in script using its full name (may include name of namespaces where it resides): ```ignore # #[macro_use] extern crate sciter; # use sciter::Value; # let root = sciter::dom::Element::from(::std::ptr::null_mut()); let result: Value = root.call_function("namespace.name", &make_args!(1, "2", 3.0)).unwrap(); ``` parameters – `&[Value]` slice. * To call method (function) defined in script for particular DOM element: ```ignore # #[macro_use] extern crate sciter; # use sciter::Value; # let root = sciter::dom::Element::from(::std::ptr::null_mut()); if let Some(el) = root.find_first("input").unwrap() { let result: Value = el.call_method("canUndo", &make_args!()).unwrap(); } ``` ## Calling native code from script If needed your application may expose some [native] functions to be called by script code. Usually this is made by implementing your own `EventHandler` and overriding its `on_script_call` method. If you will do this then you can invoke this callback from script as: * "global" native functions: `var r = view.funcName( p0, p1, ... );` – calling `on_script_call` of `EventHandler` instance **attached to the window**. * As element’s methods: `var r = el.funcName( p0, p1, ... );` – calling `on_script_call` of `EventHandler` instance (native behavior) attached to the **element**. This way you can establish interaction between scipt and native code inside your application. */ pub use capi::scbehavior::{EVENT_GROUPS, BEHAVIOR_EVENTS, PHASE_MASK}; pub use capi::scbehavior::{CLICK_REASON, EDIT_CHANGED_REASON, DRAW_EVENTS}; use capi::sctypes::*; use capi::scdom::HELEMENT; use capi::scgraphics::HGFX; use value::Value; /// Default subscription events /// /// Default is `HANDLE_BEHAVIOR_EVENT | HANDLE_SCRIPTING_METHOD_CALL` which covers behavior events /// (like `document_complete` or `button_click`) and script calls to native window. pub fn default_events() -> EVENT_GROUPS { return EVENT_GROUPS::HANDLE_BEHAVIOR_EVENT | EVENT_GROUPS::HANDLE_SCRIPTING_METHOD_CALL; } /// UI action causing change. #[derive(Debug)] pub enum EventReason { /// General event source triggers (by mouse, key or synthesized). General(CLICK_REASON), /// Edit control change trigger. EditChanged(EDIT_CHANGED_REASON), /// `<video>` request for frame source binding. /// /// See the [`sciter::video`](../../video/index.html) module for more reference. VideoBind(LPVOID), } /// Behavior method params. /// /// Sciter sends these events to native behaviors. #[derive(Debug)] pub enum MethodParams<'a> { /// Click event (either from mouse or code). Click, /// Get current [`:empty`](https://sciter.com/docs/content/sciter/States.htm) state, /// i.e. if behavior has no children and no text. IsEmpty(&'a mut bool), /// Get the current value of the behavior. GetValue(&'a mut Value), /// Set the current value of the behavior. SetValue(Value), /// Custom methods, unknown for engine. Sciter will not intrepret it and will do just dispatching. Custom(u32, LPVOID), } /// DOM event handler which can be attached to any DOM element. /// /// In notifications: /// /// * `root` means the DOM element to which we attached (`<html>` for `Window` event handler). /// * `target` contains reference to the notification target DOM element. /// * `source` element e.g. in `SELECTION_CHANGED` it is new selected `<option>`, in `MENU_ITEM_CLICK` it is menu item (`<li>`) element. /// /// For example, if we attached to `<body>` element, we will receive `document_complete` with `target` set to `<html>`. /// #[allow(unused_variables)] pub trait EventHandler { /// Return list of event groups this event handler is subscribed to. /// /// Default is `HANDLE_BEHAVIOR_EVENT | HANDLE_SCRIPTING_METHOD_CALL`. /// See also [`default_events()`](fn.default_events.html). fn get_subscription(&mut self) -> Option<EVENT_GROUPS> { return Some(default_events()); } /// Called when handler was attached to element or window. /// `root` is `NULL` if attaching to window without loaded document. /// /// **Subscription**: always. fn attached(&mut self, root: HELEMENT) {} /// Called when handler was detached from element or window. /// /// **Subscription**: always. fn detached(&mut self, root: HELEMENT) {} /// Notification that document finishes its loading - all requests for external resources are finished. /// /// **Subscription**: requires [`HANDLE_BEHAVIOR_EVENT`](enum.EVENT_GROUPS.html), /// but will be sent only for the root element (`<html>`). fn document_complete(&mut self, root: HELEMENT, target: HELEMENT) {} /// The last notification before document removal from the DOM. /// /// **Subscription**: requires [`HANDLE_BEHAVIOR_EVENT`](enum.EVENT_GROUPS.html), /// but will be sent only for the root element (`<html>`). fn document_close(&mut self, root: HELEMENT, target: HELEMENT) {} /// Behavior method calls from script or other behaviors. /// /// Return `false` to skip this event. /// /// **Subscription**: requires [`HANDLE_METHOD_CALL`](enum.EVENT_GROUPS.html). fn on_method_call(&mut self, root: HELEMENT, params: MethodParams) -> bool { return false } /// Script calls from CSSS! script and TIScript. /// /// Return `None` to skip this event. /// /// **Subscription**: requires [`HANDLE_SCRIPTING_METHOD_CALL`](enum.EVENT_GROUPS.html). fn on_script_call(&mut self, root: HELEMENT, name: &str, args: &[Value]) -> Option<Value> { return self.dispatch_script_call(root, name, args); } /// Autogenerated dispatcher for script calls. #[doc(hidden)] fn dispatch_script_call(&mut self, root: HELEMENT, name: &str, args: &[Value]) -> Option<Value> { return None; } /// Notification event from builtin behaviors. /// /// Return `false` to skip this event. /// /// **Subscription**: requires [`HANDLE_BEHAVIOR_EVENT`](enum.EVENT_GROUPS.html). fn on_event(&mut self, root: HELEMENT, source: HELEMENT, target: HELEMENT, code: BEHAVIOR_EVENTS, phase: PHASE_MASK, reason: EventReason) -> bool { return false; } /// Timer event from attached element. /// /// Return `false` to skip this event. /// /// **Subscription**: requires [`HANDLE_TIMER`](enum.EVENT_GROUPS.html). fn on_timer(&mut self, root: HELEMENT, timer_id: u64) -> bool { return false; } /// Drawing request event. /// /// It allows to intercept drawing events of an `Element` and to manually draw its content, background and foreground layers. /// /// Return `false` to skip this event. /// /// **Subscription**: requires [`HANDLE_DRAW`](enum.EVENT_GROUPS.html). fn on_draw(&mut self, root: HELEMENT, gfx: HGFX, area: &RECT, layer: DRAW_EVENTS) -> bool { return false; } /// Size changed event. /// /// **Subscription**: requires [`HANDLE_SIZE`](enum.EVENT_GROUPS.html). fn on_size(&mut self, root: HELEMENT) {} } }