mirror of
https://gitlab.com/freepascal.org/lazarus/lazarus.git
synced 2025-08-14 10:39:18 +02:00
Docs: LazUtils/laz_xmlstreaming. Adds and updates topics for changes in cbf9d30ddf
.
* TXMLObjectWriterString * TXMLObjectWriter.WriteString
This commit is contained in:
parent
89aefec06a
commit
a50d7d1dba
@ -34,6 +34,28 @@ Extended by Mattias Gaertner:
|
|||||||
<element name="Laz2_DOM"/>
|
<element name="Laz2_DOM"/>
|
||||||
<element name="Laz2_XMLWrite"/>
|
<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">
|
<element name="TXMLObjectWriterStackElType">
|
||||||
<short>
|
<short>
|
||||||
Represents element types used in stack elements for an XML object writer.
|
Represents element types used in stack elements for an XML object writer.
|
||||||
@ -438,11 +460,30 @@ object writer.
|
|||||||
<short>
|
<short>
|
||||||
Serializes a string value using the XML format for the object writer.
|
Serializes a string value using the XML format for the object writer.
|
||||||
</short>
|
</short>
|
||||||
<descr/>
|
<descr>
|
||||||
<seealso/>
|
<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>
|
||||||
<element name="TXMLObjectWriter.WriteString.Value">
|
<element name="TXMLObjectWriter.WriteString.Value">
|
||||||
<short>String value written in the method.</short>
|
<short>String value stored in the method.</short>
|
||||||
</element>
|
</element>
|
||||||
|
|
||||||
<element name="TXMLObjectWriter.WriteWideString">
|
<element name="TXMLObjectWriter.WriteWideString">
|
||||||
@ -479,7 +520,7 @@ Included when USE_NEW_READER_WRITER has been defined in the LCL.
|
|||||||
</element>
|
</element>
|
||||||
<element name="TXMLObjectWriter.WriteUInt64.Value">
|
<element name="TXMLObjectWriter.WriteUInt64.Value">
|
||||||
<short>
|
<short>
|
||||||
Unsigned 64-bit Integer (QWord) value serialized in the method.
|
Unsigned 64-bit Integer (QWord) value serialized in the method.
|
||||||
</short>
|
</short>
|
||||||
</element>
|
</element>
|
||||||
|
|
||||||
@ -696,7 +737,7 @@ the root element, or the node is not a valid TDOMElement instance.
|
|||||||
<element name="TXMLObjectReader.NextValue.Result">
|
<element name="TXMLObjectReader.NextValue.Result">
|
||||||
<short>
|
<short>
|
||||||
TValueType for the next element in the DOM tree, or vaNull when a value type
|
TValueType for the next element in the DOM tree, or vaNull when a value type
|
||||||
cannot be determined.
|
cannot be determined.
|
||||||
</short>
|
</short>
|
||||||
</element>
|
</element>
|
||||||
|
|
||||||
@ -711,8 +752,8 @@ has been read.
|
|||||||
<element name="TXMLObjectReader.ReadValue.Result">
|
<element name="TXMLObjectReader.ReadValue.Result">
|
||||||
<short>
|
<short>
|
||||||
TValueType for the element read from the DOM tree, or vaNull when a value type
|
TValueType for the element read from the DOM tree, or vaNull when a value type
|
||||||
cannot be determined.
|
cannot be determined.
|
||||||
</short>
|
</short>
|
||||||
</element>
|
</element>
|
||||||
|
|
||||||
<element name="TXMLObjectReader.BeginRootComponent">
|
<element name="TXMLObjectReader.BeginRootComponent">
|
||||||
@ -746,12 +787,12 @@ Not used in the current implementation.
|
|||||||
</element>
|
</element>
|
||||||
<element name="TXMLObjectReader.BeginComponent.CompClassName">
|
<element name="TXMLObjectReader.BeginComponent.CompClassName">
|
||||||
<short>
|
<short>
|
||||||
Returns the value from the 'class' attribute in the DOM Element.
|
Returns the value from the 'class' attribute in the DOM Element.
|
||||||
</short>
|
</short>
|
||||||
</element>
|
</element>
|
||||||
<element name="TXMLObjectReader.BeginComponent.CompName">
|
<element name="TXMLObjectReader.BeginComponent.CompName">
|
||||||
<short>
|
<short>
|
||||||
Returns the value from the 'name' attribute in the DOM Element.
|
Returns the value from the 'name' attribute in the DOM Element.
|
||||||
</short>
|
</short>
|
||||||
</element>
|
</element>
|
||||||
|
|
||||||
@ -885,7 +926,7 @@ Int64 value for the 'value' attribute in the DOM Element.
|
|||||||
<element name="TXMLObjectReader.ReadSet.Result">
|
<element name="TXMLObjectReader.ReadSet.Result">
|
||||||
<short>
|
<short>
|
||||||
Integer value representing the OR-ed enumeration values for the set type.
|
Integer value representing the OR-ed enumeration values for the set type.
|
||||||
</short>
|
</short>
|
||||||
</element>
|
</element>
|
||||||
<element name="TXMLObjectReader.ReadSet.SetType">
|
<element name="TXMLObjectReader.ReadSet.SetType">
|
||||||
<short>
|
<short>
|
||||||
@ -936,7 +977,7 @@ the return value.
|
|||||||
</element>
|
</element>
|
||||||
<element name="TXMLObjectReader.ReadWideString.Result">
|
<element name="TXMLObjectReader.ReadWideString.Result">
|
||||||
<short>
|
<short>
|
||||||
WideString value for the 'value' attribute in the DOM element.
|
WideString value for the 'value' attribute in the DOM element.
|
||||||
</short>
|
</short>
|
||||||
</element>
|
</element>
|
||||||
|
|
||||||
@ -984,7 +1025,7 @@ Not used in the current implementation.
|
|||||||
</element>
|
</element>
|
||||||
<element name="TXMLObjectReader.Read.Buf">
|
<element name="TXMLObjectReader.Read.Buf">
|
||||||
<short>
|
<short>
|
||||||
Untyped buffer where the values read in the method are stored.
|
Untyped buffer where the values read in the method are stored.
|
||||||
</short>
|
</short>
|
||||||
</element>
|
</element>
|
||||||
<element name="TXMLObjectReader.Read.Count">
|
<element name="TXMLObjectReader.Read.Count">
|
||||||
|
Loading…
Reference in New Issue
Block a user