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
|
<?xml version="1.0" encoding="UTF-8"?>
<!--
Documentation for LCL (Lazarus Component Library) and LazUtils (Lazarus
Utilities) are published under the Creative Commons Attribution-ShareAlike 4.0
International public license.
https://creativecommons.org/licenses/by-sa/4.0/legalcode.txt
https://gitlab.com/freepascal.org/lazarus/lazarus/-/blob/main/docs/cc-by-sa-4-0.txt
Copyright (c) 1997-2025, by the Lazarus Development Team.
-->
<fpdoc-descriptions>
<package name="lazutils">
<!--
====================================================================
Laz_XMLStreaming
====================================================================
-->
<module name="Laz_XMLStreaming">
<short>
Contains classes, types, and routines used to implement an XML serialization
driver.
</short>
<descr>
<p>
Copyright (c) 2000 by Sebastian Guenther, sg@freepascal.org
</p>
<p>
Extended by Mattias Gaertner:
</p>
<ul>
<li>Reading/Writing children, all kinds of properties,</li>
<li>Custom properties (via DefineProperties).</li>
</ul>
<p>
<file>laz_xmlstreaming.pas</file> is part of the <file>LazUtils</file> package.
</p>
</descr>
<!-- unresolved external references -->
<element name="SysUtils"/>
<element name="Classes"/>
<element name="TypInfo"/>
<element name="Laz2_DOM"/>
<element name="Laz2_XMLWrite"/>
<element name="TXMLObjectWriterString">
<short>
Compiler version-specific alias for String values used in TXMLObjectWriter.
</short>
<descr>
<p>
<var>TXMLObjectWriterString</var> is the type passed as an argument to the
WriteString method in TXMLObjectWriter.
</p>
<p>
For FPC version 3.3.1 and later, it is an alias to the RawByteString type. For
previous FPC versions, it is an alias to the String type.
</p>
</descr>
<version>
Added in LazUtils version 3.0.
</version>
<seealso>
<link id="TXMLObjectWriter.WriteString"/>
</seealso>
</element>
<element name="TXMLObjectWriterStackElType">
<short>
Represents element types used in stack elements for an XML object writer.
</short>
<descr/>
<seealso>
<link id="TXMLObjectWriterStackEl.ElemType"/>
</seealso>
</element>
<element name="TXMLObjectWriterStackElType.elUnknown">
<short>Element is an unknown type.</short>
</element>
<element name="TXMLObjectWriterStackElType.elPropertyList">
<short>Element represents a property in a list of properties.</short>
</element>
<element name="TXMLObjectWriterStackElType.elChildrenList">
<short>
Element represents a child component in a list of child components.
</short>
</element>
<element name="TXMLObjectWriterStackEl">
<short>Represents a stack element for an XML object writer.</short>
<descr>
<p>
<var>TXMLObjectWriterStackEl</var> is a class used to represent an element
pushed onto the stack for an XML object writer. Members in the class instance
contain the <var>TDOMElement</var> instances for the stack element and its
<var>Parent</var>, the stack element type, an inner list of stack elements
which it contains, and the name of the property represented in the class
instance.
</p>
<p>
TXMLObjectWriterStackEl is used in the implementation of the
<var>TXMLObjectWriter</var> class to represent the current element being
processed in the XML object writer.
</p>
</descr>
<seealso>
<link id="TXMLObjectWriter"/>
</seealso>
</element>
<!-- public -->
<element name="TXMLObjectWriterStackEl.Element">
<short>
DOM Element which represents the component or property in the stack element.
</short>
<descr>
<p>
<var>Element</var> is a <var>TDOMElement</var> member used to store the
values from the property or component represented in the stack element.
Element is created and populated when <var>TXMLObjectWriter</var> processes
properties, components, collections, and lists in the class instance.
</p>
<p>
Use <var>PropertyName</var> to get the name of the property represented in
the stack element.
</p>
<p>
Use <var>ElemType</var> to determine whether the stack element represents a
property list, child component list, or other type.
</p>
<p>
Use <var>Parent</var> to access the TDOMElement which is the parent for the
current stack element.
</p>
</descr>
<seealso>
<link id="TXMLObjectWriterStackEl.PropertyName"/>
<link id="TXMLObjectWriterStackEl.ElemType"/>
<link id="TXMLObjectWriterStackEl.Parent"/>
<link id="TXMLObjectWriter"/>
<link id="#lazutils.laz2_dom.TDOMElement">TDOMElement</link>
</seealso>
</element>
<element name="TXMLObjectWriterStackEl.Parent">
<short>
Contains the TDOMElement that is the parent node for the stack element.
</short>
<descr/>
<seealso/>
</element>
<element name="TXMLObjectWriterStackEl.ElemType">
<short>Indicates the element type for the stack element.</short>
<descr/>
<seealso/>
</element>
<element name="TXMLObjectWriterStackEl.PropertyName">
<short>Name of the property represented in the stack element.</short>
<descr/>
<seealso/>
</element>
<element name="TXMLObjectWriter">
<short>Serializes an object instance using an XML storage format.</short>
<descr>
<p>
<var>TXMLObjectWriter</var> is a <var>TAbstractObjectWriter</var> descendant
which implements an object serialization writer using XML as the storage
format. TXMLObjectWriter implements abstract methods defined in the ancestor
class, and provides access to the DOM document and the DOM Node tree used to
store values generated in the class instance. It maintains an internal stack
used to capture and process the hierarchical node tree needed to represent a
class instance.
</p>
</descr>
<seealso>
<link id="TXMLObjectReader"/>
<link id="#rtl.classes.TAbstractObjectWriter">TAbstractObjectWriter</link>
</seealso>
</element>
<!-- private -->
<element name="TXMLObjectWriter.FDoc"/>
<element name="TXMLObjectWriter.FRootEl"/>
<element name="TXMLObjectWriter.FStack"/>
<element name="TXMLObjectWriter.StackEl"/>
<element name="TXMLObjectWriter.StackPush"/>
<element name="TXMLObjectWriter.StackPush.Element"/>
<element name="TXMLObjectWriter.StackPush.ElementType"/>
<element name="TXMLObjectWriter.StackPop"/>
<!-- protected -->
<element name="TXMLObjectWriter.GetPropertyElement">
<short>
Gets a TDOMElement used to serialize a property using the specified type name.
</short>
<descr>
<p>
<var>GetPropertyElement</var> returns a <var>TDOMElement</var> configured to
represent a property using the specified type.
</p>
<p>
The TagName in the element is set to the specified TypeName argument. The
property name is retrieved from the internal element stack in the class
instance and stored as the 'name' attribute in the element. If the property
name has not been assigned (''), the name attribute is omitted from the
element.
</p>
<p>
The TDomElement in the return value is appended as a child node to the element
stack.
</p>
<p>
GetPropertyElement is used in the implementation of write methods in the
object instance. Such as:
</p>
<ul>
<li>BeginCollection</li>
<li>WriteBinary</li>
<li>WriteBoolean</li>
<li>WriteFloat</li>
<li>WriteSingle</li>
<li>WriteCurrency</li>
<li>WriteInteger</li>
<li>WriteUInt64</li>
<li>WriteIdent</li>
<li>WriteDate</li>
<li>WriteMethodName</li>
<li>WriteSet</li>
<li>WriteString</li>
<li>WriteWideString</li>
<li>WriteUnicodeString</li>
<li>WriteVariant</li>
</ul>
<p>
These calling routines set the 'value' attribute for the element returned from
the method. Tehety may set set additional attribute values, like 'class', as
needed for a component or type.
</p>
</descr>
<errors>
Raises an Exception if the DOM elment already exists, and has therefore
already been saved.
</errors>
<seealso/>
</element>
<element name="TXMLObjectWriter.GetPropertyElement.Result">
<short>
TDOMElement used to represent the type and property name.
</short>
</element>
<element name="TXMLObjectWriter.GetPropertyElement.TypeName">
<short>Name for the type represented in the property element.</short>
</element>
<!-- public -->
<element name="TXMLObjectWriter.Create">
<short>Constructor for the class instance.</short>
<descr>
<p>
<var>Create</var> is the constructor for the class instance. It provides
arguments which identify the XML document where the XML content is stored, an
optional path to a node in the document where the content is stored, and a
flag to indicate the content is appended to or replaces the content for the
root node in the document.
</p>
</descr>
<seealso/>
</element>
<element name="TXMLObjectWriter.Create.ADoc">
<short>TDomDocument instance where the XML content is stored.</short>
</element>
<element name="TXMLObjectWriter.Create.APath">
<short>Path expression to the node where the XML content is stored.</short>
</element>
<element name="TXMLObjectWriter.Create.Append">
<short>
True to append the content to the root node in the document, False to replace
it.
</short>
</element>
<element name="TXMLObjectWriter.BeginCollection">
<short>
Starts serialization of a Collection using the XML format for the writer.
</short>
<descr/>
<seealso/>
</element>
<element name="TXMLObjectWriter.BeginComponent">
<short>
Starts serialization of a Component using the XML format for object writer.
</short>
<descr/>
<seealso/>
</element>
<element name="TXMLObjectWriter.BeginComponent.Component">
<short>The component instance written in the method.</short>
</element>
<element name="TXMLObjectWriter.BeginComponent.Flags">
<short>Not used in the current LCL implementation.</short>
</element>
<element name="TXMLObjectWriter.BeginComponent.ChildPos">
<short>Not used in the current LCL implementation.</short>
</element>
<element name="TXMLObjectWriter.BeginList">
<short>
Starts serialization of a list using the XML format for the writer.
</short>
<descr/>
<seealso/>
</element>
<element name="TXMLObjectWriter.EndList">
<short>
Finishes serialization of a list using the XML format for the writer.
</short>
<descr/>
<seealso/>
</element>
<element name="TXMLObjectWriter.BeginProperty">
<short>
Starts serialization for a property using the XML format for the object
writer.
</short>
<descr/>
<seealso/>
</element>
<element name="TXMLObjectWriter.BeginProperty.PropName">
<short>
Name for the property used as the value for the name attribute in the element.
</short>
</element>
<element name="TXMLObjectWriter.EndProperty">
<short>
Ends serialization for a property using the XML format for the writer.
</short>
<descr/>
<seealso/>
</element>
<element name="TXMLObjectWriter.WriteBinary">
<short>Serializes a binary value from the specified buffer. </short>
<descr>
<p>
WriteBinary calls GetPropertyElement to create the DOM element used to
serialize the property. The content in Buffer is converted to a String type
and stored in the 'value' attribute for the DOM element.
</p>
</descr>
<seealso/>
</element>
<element name="TXMLObjectWriter.WriteBinary.Buffer">
<short>
Untyped buffer with the binary value serialized in the method.
</short>
</element>
<element name="TXMLObjectWriter.WriteBinary.Count">
<short>
Number of bytes in the untyped buffer.
</short>
</element>
<element name="TXMLObjectWriter.WriteBoolean">
<short>Serializes a Boolean value using the XML format for the writer.</short>
<descr/>
<seealso/>
</element>
<element name="TXMLObjectWriter.WriteBoolean.Value">
<short>Boolean value written in the method.</short>
</element>
<element name="TXMLObjectWriter.WriteFloat">
<short>
Serializes a floating point value using the XML format for the writer.
</short>
<descr/>
<seealso/>
</element>
<element name="TXMLObjectWriter.WriteFloat.Value">
<short>Floating point value written in the method.</short>
</element>
<element name="TXMLObjectWriter.WriteSingle">
<short>Serializes a Single value using the XML format for the writer.</short>
<descr/>
<seealso/>
</element>
<element name="TXMLObjectWriter.WriteSingle.Value">
<short>Single value written in the method.</short>
</element>
<element name="TXMLObjectWriter.WriteCurrency">
<short>
Serializes a Currency value using the XML format for the writer.
</short>
<descr/>
<seealso/>
</element>
<element name="TXMLObjectWriter.WriteCurrency.Value">
<short>Currency value written in the method.</short>
</element>
<element name="TXMLObjectWriter.WriteDate">
<short>
Serializes a TDateTime value using the XML format for the writer.
</short>
<descr/>
<seealso/>
</element>
<element name="TXMLObjectWriter.WriteDate.Value">
<short>TDateTime value written in the method.</short>
</element>
<element name="TXMLObjectWriter.WriteIdent">
<short>Serializes an Identifier using the XML format for the writer.</short>
<descr/>
<seealso/>
</element>
<element name="TXMLObjectWriter.WriteIdent.Ident">
<short>String with the identifier written in the method.</short>
</element>
<element name="TXMLObjectWriter.WriteInteger">
<short>
Serializes an Integer value using the XML format for the object writer.
</short>
<descr/>
<seealso/>
</element>
<element name="TXMLObjectWriter.WriteInteger.Value">
<short>Integer value written in the method.</short>
</element>
<element name="TXMLObjectWriter.WriteMethodName">
<short>
Serializes the specified method name using the XML format for the object
writer.
</short>
<descr/>
<seealso/>
</element>
<element name="TXMLObjectWriter.WriteMethodName.Name">
<short>Method name written in the method.</short>
</element>
<element name="TXMLObjectWriter.WriteSet">
<short>
Serializes a set values from the specified type using the XML format for the
object writer.
</short>
<descr/>
<seealso/>
</element>
<element name="TXMLObjectWriter.WriteSet.Value">
<short>LongInt with the bit values for the set type.</short>
</element>
<element name="TXMLObjectWriter.WriteSet.SetType">
<short>Pointer to the type for the set.</short>
</element>
<element name="TXMLObjectWriter.WriteString">
<short>
Serializes a string value using the XML format for the object writer.
</short>
<descr>
<p>
<var>WriteString</var> is an overridden method in <var>TXMLObjectWriter</var>
used to store the specified string value to the XML storage format used in the
writer class. WriteString calls GetPropertyElement to get or create a
TDOMElement stack entry where the Value argument is stored. In the
TDOMElement, the string value is stored in a tag with the name 'string' using
the 'value' attribute to store the passed value.
</p>
<p>
WriteString implements the abstract virtual method defined in
TAbstractObjectWriter.
</p>
</descr>
<version>
Modified in LazUtils version 3.0 to use the TXMLObjectWriterString type
instead of the String type in the Value argument.
</version>
<seealso>
<link id="#rtl.classes.TAbstractObjectWriter">TAbstractObjectWriter</link>
</seealso>
</element>
<element name="TXMLObjectWriter.WriteString.Value">
<short>String value stored in the method.</short>
</element>
<element name="TXMLObjectWriter.WriteWideString">
<short>
Serializes a wide string value using the XML format for the object writer.
</short>
<descr/>
<seealso/>
</element>
<element name="TXMLObjectWriter.WriteWideString.Value">
<short>WideString value written in the method.</short>
</element>
<element name="TXMLObjectWriter.WriteSignature">
<short>Not needed for the XML format used in TXMLObjectWriter.</short>
<descr>
<p>
Contains an empty implementation in <var>TXMLObjectWriter</var>.
</p>
</descr>
<seealso/>
</element>
<element name="TXMLObjectWriter.WriteUInt64">
<short>
Serializes an Int64 value using the XML format for the object writer.
</short>
<descr>
<p>
Included when USE_NEW_READER_WRITER has been defined in the LCL.
</p>
</descr>
<seealso/>
</element>
<element name="TXMLObjectWriter.WriteUInt64.Value">
<short>
Unsigned 64-bit Integer (QWord) value serialized in the method.
</short>
</element>
<element name="TXMLObjectWriter.WriteUnicodeString">
<short>
Serializes an UnicodeString value using the XML format for the object writer.
</short>
<descr>
<p>
Included when USE_NEW_READER_WRITER has been defined in the LCL.
</p>
</descr>
<seealso/>
</element>
<element name="TXMLObjectWriter.WriteUnicodeString.Value">
<short>
UnicodeString value serialized in the method. Converted to UTF-8 encoding.
</short>
</element>
<element name="TXMLObjectWriter.WriteVariant">
<short>
Serializes a Variant value using the XML format for the object writer.
</short>
<descr>
<p>
Supports the following variant types:
</p>
<dl>
<dt>varEmpty</dt>
<dd>Stores 'nil' in the value attribute.</dd>
<dt>varNull</dt>
<dd>Stores 'null' in the value attribute.</dd>
<dt>varShortInt, varSmallInt, varInteger, varInt64</dt>
<dd>Calls WriteInteger to store the value attribute.</dd>
<dt>varQWord</dt>
<dd>Calls WriteUInt64 to store the value attribute.</dd>
<dt>varBoolean</dt>
<dd>Calls WriteBoolean to store the value attribute.</dd>
<dt>varCurrency</dt>
<dd>Calls WriteCurrency to store the value attribute.</dd>
<dt>varSingle</dt>
<dd>Calls WriteSingle to store the value attribute.</dd>
<dt>varDouble</dt>
<dd>Calls WriteFloat to store the value attribute.</dd>
<dt>varDate</dt>
<dd>Calls WriteDate to store the value attribute.</dd>
<dt>varOleStr, varString</dt>
<dd>Calls WriteWideString to store the value attribute.</dd>
</dl>
<p>
Raises an EWriteError exception if any other variant type is encountered in
the method.
</p>
<p>
Included when USE_NEW_READER_WRITER has been defined in the LCL.
</p>
</descr>
<errors>
Raises an EWriteError exception if any other variant type is encountered in
the method.
</errors>
<seealso/>
</element>
<element name="TXMLObjectWriter.WriteVariant.VarValue">
<short>
Variant value serialized in the method.
</short>
</element>
<element name="TXMLObjectWriter.Write">
<short>Raises an exception in the current LCL version.</short>
<descr>
<p>
Raises an Exception when <var>HasReadWriteBuf</var> has been defined in the
LCL.
</p>
</descr>
<seealso/>
</element>
<element name="TXMLObjectWriter.Write.Buffer">
<short>
Untyped buffer with the value written in the method.
</short>
</element>
<element name="TXMLObjectWriter.Write.Count">
<short>
Number of bytes in the untyped buffer.
</short>
</element>
<element name="TXMLObjectWriter.Doc">
<short>
TDOMDocument used to create and store elements in the XML object writer.
</short>
<descr>
<p>
<var>Doc</var> is a read-only <var>TDOMDocument</var> property which contains
the DOM document used to create and store the DOM elements written in XML
object writer. The value in Doc is assigned in the <var>Create</var>
constructor, and uses the TDOMDocument instance passed as an argument to the
constructor.
</p>
</descr>
<seealso/>
</element>
<element name="TXMLObjectWriterClass">
<short>
Class type used to create new instances of the XML object writer.
</short>
<descr/>
<seealso/>
</element>
<element name="TXMLObjectReader">
<short>De-serializes an object instance from its XML storage format.</short>
<descr/>
<seealso>
<link id="TXMLObjectWriter"/>
<link id="#rtl.classes.TAbstractObjectReader">TAbstractObjectReader</link>
</seealso>
</element>
<!-- private -->
<element name="TXMLObjectReader.FDoc"/>
<element name="TXMLObjectReader.FElement"/>
<element name="TXMLObjectReader.FElementPosition"/>
<element name="TXMLObjectReader.FRootEl"/>
<element name="TXMLObjectReader.ReadNextValue"/>
<element name="TXMLObjectReader.ReadNextValue.Result"/>
<element name="TXMLObjectReader.ReadNextValue.Stay"/>
<!-- public -->
<element name="TXMLObjectReader.Create">
<short>Constructor for the class instance.</short>
<descr>
<p>
<var>Create</var> is the constructor for the object instance. It uses values
passed in the <var>ADoc</var> and <var>APath</var> arguments to access the
DOM document and node(s) where the XML content for the object reader is
stored.
</p>
<p>
ADoc is assigned to the <var>Doc</var> property in the class instance, and
its <var>DocumentElement</var> is used to access nodes in the DOM tree.
</p>
<p>
<var>APath</var> contains an expression used to locate the DOM node with the
content for the object reader. It provides the hierarchy of DOM nodes used to
access the XML content for the class instance.
</p>
<remark>
Create raises an Exception in the constructor if a node cannot be located
using the path in APath, or when the node is not a valid
<var>TDOMElement</var> instance. Use exception handling when calling the
method.
</remark>
</descr>
<seealso>
<link id="TXMLObjectReader.Doc"/>
<link id="TXMLObjectReader.Element"/>
<link id="#lazutils.laz2_dom.TDOMNode">TDOMNode</link>
<link id="#lazutils.laz2_dom.TDOMElement">TDOMElement</link>
<link id="#lazutils.laz2_dom.TDOMDocument">TDOMDocument</link>
</seealso>
</element>
<element name="TXMLObjectReader.Create.ADoc">
<short>
TDOMDocument instance with the values read in the object reader.
</short>
</element>
<element name="TXMLObjectReader.Create.APath">
<short>Path to the node in ADoc where the object instance is stored.</short>
</element>
<element name="TXMLObjectReader.Destroy">
<short>Destructor for the class instance.</short>
<descr>
<p>
Calls the inherited destructor on entry.
</p>
</descr>
<seealso/>
</element>
<element name="TXMLObjectReader.GetRootClassName">
<short>
Gets the class name from the node which is the root element for the object
instance.
</short>
<descr>
<p>
GetRootClassName raises an Exception if a component node cannot be located in
the root element, or the node is not a valid TDOMElement instance.
</p>
</descr>
<seealso/>
</element>
<element name="TXMLObjectReader.GetRootClassName.Result">
<short>Value from the class attribute in the element.</short>
</element>
<element name="TXMLObjectReader.GetRootClassName.IsInherited">
<short>Not used in the current LCL implementation.</short>
</element>
<element name="TXMLObjectReader.NextValue">
<short>Reads the value type for the next element in the XML DOM tree.</short>
<descr/>
<seealso>
<link id="#rtl.classes.TValueType">TValueType</link>
</seealso>
</element>
<element name="TXMLObjectReader.NextValue.Result">
<short>
TValueType for the next element in the DOM tree, or vaNull when a value type
cannot be determined.
</short>
</element>
<element name="TXMLObjectReader.ReadValue">
<short>
Reads the value for the next element in the XML DOM tree after the value type
has been read.
</short>
<descr/>
<seealso/>
</element>
<element name="TXMLObjectReader.ReadValue.Result">
<short>
TValueType for the element read from the DOM tree, or vaNull when a value type
cannot be determined.
</short>
</element>
<element name="TXMLObjectReader.BeginRootComponent">
<short>Locates the DOM node for the component in the document element.</short>
<descr>
<p>
Raises an Exception if Element has not been assigned, or a node using a
"component" tag is not found in the Element.
</p>
</descr>
<seealso/>
</element>
<element name="TXMLObjectReader.BeginComponent">
<short>
Gets the DOM element for the component, gets the class type and component
name, and sets Element to the properties node.
</short>
<descr/>
<seealso/>
</element>
<element name="TXMLObjectReader.BeginComponent.Flags">
<short>
TFilerFlag values. Not used in the current implementation.
</short>
</element>
<element name="TXMLObjectReader.BeginComponent.AChildPos">
<short>
Not used in the current implementation.
</short>
</element>
<element name="TXMLObjectReader.BeginComponent.CompClassName">
<short>
Returns the value from the 'class' attribute in the DOM Element.
</short>
</element>
<element name="TXMLObjectReader.BeginComponent.CompName">
<short>
Returns the value from the 'name' attribute in the DOM Element.
</short>
</element>
<element name="TXMLObjectReader.BeginProperty">
<short>
Reads the property name from Element and prepares for the property value(s).
</short>
<descr/>
<seealso/>
</element>
<element name="TXMLObjectReader.BeginProperty.Result">
<short>Name for the property read from the XML content in the Element.</short>
</element>
<element name="TXMLObjectReader.ReadBinary">
<short>
Reads a binary value from Element and stores it in the specified stream.
</short>
<descr/>
<seealso/>
</element>
<element name="TXMLObjectReader.ReadBinary.DestData">
<short>TMemoryStream instance where the binary value is stored.</short>
</element>
<element name="TXMLObjectReader.ReadFloat">
<short>
Reads a string value from Element and converts it to a floating point value.
</short>
<descr/>
<seealso/>
</element>
<element name="TXMLObjectReader.ReadFloat.Result">
<short>
Floating point value converted in the method, or 0 as the default.
</short>
</element>
<element name="TXMLObjectReader.ReadSingle">
<short>Converts a string value in Element to a Single data type.</short>
<descr/>
<seealso/>
</element>
<element name="TXMLObjectReader.ReadSingle.Result">
<short>Single value converted in the method, or 0 as the default.</short>
</element>
<element name="TXMLObjectReader.ReadCurrency">
<short>Converts a string value in Element to a Currency data type.</short>
<descr/>
<seealso/>
</element>
<element name="TXMLObjectReader.ReadCurrency.Result">
<short>Currency value converted in the method, or 0 as the default.</short>
</element>
<element name="TXMLObjectReader.ReadDate">
<short>Reads a TDateTime value from the DOM Element.</short>
<descr/>
<seealso/>
</element>
<element name="TXMLObjectReader.ReadDate.Result">
<short>
TDateTime value from the 'value' attribute in the DOM Element.
</short>
</element>
<element name="TXMLObjectReader.ReadIdent">
<short>Reads an Identifier from Element.</short>
<descr/>
<seealso/>
</element>
<element name="TXMLObjectReader.ReadIdent.Result">
<short>
String with content from the 'value' attribute in the DOM Element.
</short>
</element>
<element name="TXMLObjectReader.ReadIdent.ValueType">
<short>
Not used in the current implementation.
</short>
</element>
<element name="TXMLObjectReader.ReadInt8">
<short>Reads a ShortInt value from Element.</short>
<descr/>
<seealso/>
</element>
<element name="TXMLObjectReader.ReadInt8.Result">
<short>
ShortInt value for the 'value' attribute in the DOM Element.
</short>
</element>
<element name="TXMLObjectReader.ReadInt16">
<short>Reads a SmallInt value from Element.</short>
<descr/>
<seealso/>
</element>
<element name="TXMLObjectReader.ReadInt16.Result">
<short>
SmallInt value for the 'value' attribute in the DOM Element.
</short>
</element>
<element name="TXMLObjectReader.ReadInt32">
<short>Reads a LongInt value from Element.</short>
<descr/>
<seealso/>
</element>
<element name="TXMLObjectReader.ReadInt32.Result">
<short>
LongInt value for the 'value' attribute in the DOM Element.
</short></element>
<element name="TXMLObjectReader.ReadInt64">
<short>Reads an Int64 type from Element.</short>
<descr/>
<seealso/>
</element>
<element name="TXMLObjectReader.ReadInt64.Result">
<short>
Int64 value for the 'value' attribute in the DOM Element.
</short></element>
<element name="TXMLObjectReader.ReadSet">
<short>Reads values for a set type from Element.</short>
<descr/>
<seealso/>
</element>
<element name="TXMLObjectReader.ReadSet.Result">
<short>
Integer value representing the OR-ed enumeration values for the set type.
</short>
</element>
<element name="TXMLObjectReader.ReadSet.SetType">
<short>
Pointer to the RTTI Type with the enumeration values handled in the method.
</short>
</element>
<element name="TXMLObjectReader.ReadStr">
<short>Reads a String value from Element.</short>
<descr/>
<seealso/>
</element>
<element name="TXMLObjectReader.ReadStr.Result">
<short>
String representing the 'value' attribute in the DOM Element.
</short>
</element>
<element name="TXMLObjectReader.ReadString">
<short>Reads a string value from Element.</short>
<descr/>
<notes>
<note>Why the exception when the string has more than 255 characters?</note>
</notes>
<seealso/>
</element>
<element name="TXMLObjectReader.ReadString.Result">
<short>
String representing the 'value' attribute in the DOM Element.
</short>
</element>
<element name="TXMLObjectReader.ReadString.StringType">
<short>
TValueType for the string type handled in the method. vaString is limited to
255 characters.
</short>
</element>
<element name="TXMLObjectReader.ReadWideString">
<short>Reads a WideString value from Element.</short>
<descr>
<p>
Converts the UTF-8-encoded content in Element to the WideString type used in
the return value.
</p>
</descr>
<seealso/>
</element>
<element name="TXMLObjectReader.ReadWideString.Result">
<short>
WideString value for the 'value' attribute in the DOM element.
</short>
</element>
<element name="TXMLObjectReader.ReadSignature">
<short>Not implemented and not needed in TXMLObjectReader.</short>
<descr/>
<seealso/>
</element>
<element name="TXMLObjectReader.ReadUnicodeString">
<short>Reads a UnicodeString value from Element.</short>
<descr>
<p>
Converts the UTF-8-encoded value in Element to the UnicodeString type used in
the return value.
</p>
</descr>
<seealso/>
</element>
<element name="TXMLObjectReader.ReadUnicodeString.Result">
<short>UnicodeString value read in the method.</short>
</element>
<element name="TXMLObjectReader.SkipComponent">
<short>Positions the reader to the next sibling DOM node in Element.</short>
<descr/>
<seealso/>
</element>
<element name="TXMLObjectReader.SkipComponent.SkipComponentInfos">
<short>
Not used in the current implementation.
</short>
</element>
<element name="TXMLObjectReader.SkipValue">
<short>Reads and discards the value in Element.</short>
<descr/>
<seealso/>
</element>
<element name="TXMLObjectReader.Read">
<short>Raises an exception in the current LCL implementation.</short>
<descr/>
<seealso/>
</element>
<element name="TXMLObjectReader.Read.Buf">
<short>
Untyped buffer where the values read in the method are stored.
</short>
</element>
<element name="TXMLObjectReader.Read.Count">
<short>
Number of bytes to read and store in the buffer.
</short>
</element>
<element name="TXMLObjectReader.Doc">
<short>
TDomDocument instance with the XML content read in the object reader.
</short>
<descr/>
<seealso/>
</element>
<element name="TXMLObjectReader.Element">
<short>
Contains the DOM element currently being processed in the XML object reader.
</short>
<descr/>
<seealso/>
</element>
<element name="TXMLObjectReader.ElementPosition">
<short>
Indicates whether the object reader is processing an element name or its
value.
</short>
<descr>
<p>
0 indicates that the element name is being processed. 1 indicates that the
name processing has been completed, and the value(s) in the element are being
processed.
</p>
</descr>
<seealso/>
</element>
<element name="TXMLObjectReaderClass">
<short>
Class type used to create new instances of the XML object reader.
</short>
<descr/>
<seealso/>
</element>
<element name="WriteComponentToXMLStream">
<short>
Serializes the specified component to a stream using an XML object writer.
</short>
<descr/>
<seealso/>
</element>
<element name="WriteComponentToXMLStream.AComponent">
<short>Component with values written to the stream.</short>
</element>
<element name="WriteComponentToXMLStream.AStream">
<short>TStream instance where the XML content is stored.</short>
</element>
</module>
<!-- Laz_XMLStreaming -->
</package>
</fpdoc-descriptions>
|