TWriter class

In unit Classes

Object to write component data to an arbitrary format.

Declaration

pascal

TWriter = class(TFiler)

Inheritance

TWriter
TFiler
TObject

Descends from it: TDelphiWriter

Description

The TWriter class is a writer class that implements generic component streaming capabilities, independent of the format of the data in the stream. It uses a driver class TAbstractObjectWriter to do the actual reading of data. The interface of the TWriter class should be identical to the interface in Delphi.

Note that the TWriter design is such that it will write a single component to a stream. It will write all children of this component, but it is not designed to write multiple components in succession to one stream.

It should never be necessary to create an instance of this class directly. Instead, the WriteComponent call should be used.

Properties

`RootAncestor`	public	Ancestor of root component.
`Driver`	public	Driver used when writing to the stream.
`PropertyPath`	public	Path to the property that is currently being written.
`DelphiCompatible`	public

Methods

`SetRoot`	protected	Sets the root component.
`WriteBinary`	protected	Writes binary data to the stream.
`WriteProperty`	protected	Writes one property to the stream.
`WriteProperties`	protected	Writes the published properties to the stream.
`WriteChildren`	protected
`CreateDriver`	protected
`Create`	public	Creates a new Writer with a stream and bufsize.
`Destroy`	public	Destroys the writer instance.
`FlushBuffer`	public	Flush the buffer
`DefineProperty`	public	Callback used when defining and streaming custom properties.
`DefineBinaryProperty`	public	Callback used when defining and streaming custom properties.
`Write`	public	Write raw data to stream.
`WriteBoolean`	public	Write boolean value to the stream.
`WriteCollection`	public	Write a collection to the stream.
`WriteComponent`	public	Stream a component to the stream.
`WriteChar`	public	Write a character to the stream.
`WriteWideChar`	public	Write widechar to stream.
`WriteDescendent`	public	Write descendent to stream.
`WriteFloat`	public	Write a float to the stream.
`WriteSingle`	public	Write a single-type real to the stream.
`WriteDouble`	public
`WriteDate`	public	Write a date to the stream.
`WriteCurrency`	public	Write a currency value to the stream.
`WriteIdent`	public	Write an identifier to the stream.
`WriteInteger`	public	Write an integer to the stream.
`WriteSet`	public	Write a set value to the stream.
`WriteListBegin`	public	Write a start-of-list marker to the stream.
`WriteListEnd`	public	Write an end-of-list marker to the stream.
`WriteSignature`	public	Write a signature to the stream.
`WriteRootComponent`	public	Write a root component to the stream.
`WriteString`	public	Write a string to the stream.
`WriteWideString`	public	Write a widestring value to the stream.
`WriteUnicodeString`	public	Write a Unicode string to the stream.
`WriteVariant`	public	Write a variant to the stream.

Events

`OnFindAncestor`	public	Event occurring when an ancestor component must be found.
`OnWriteMethodProperty`	public	Handler from writing method properties.
`OnWriteStringProperty`	public	Event handler for translating strings written to stream.

Inherited

From TFiler (4)

Ancestor IgnoreChildren LookupRoot Root

From TObject (40)

AfterConstruction BeforeDestruction CheckDisposed ClassInfo ClassName ClassNameIs ClassParent ClassType CleanupInstance DefaultHandler DefaultHandlerStr Dispatch DispatchStr Disposed DisposeOf Equals FieldAddress Free FreeInstance GetDisposed GetHashCode GetInterface GetInterfaceByStr GetInterfaceEntry GetInterfaceEntryByStr GetInterfaceTable GetInterfaceWeak GetLastCastErrorInfo InheritsFrom InitInstance InstanceSize MethodAddress MethodName newinstance QualifiedClassName SafeCallException StringMessageTable SystemHasExtendedRTTI ToString UnitName

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.