Objects unit

This document documents the objects unit. The unit was implemented by many people, and was mainly taken from the FreeVision sources. It has been ported to all supported platforms.

The methods and fields that are in a Private part of an object declaration have been left out of this documentation.

Classes and records

LongRec	record	Record describing a longint (in Words).
PtrRec	record	Record describing a pointer to a memory location.
TBufStream	object	Buffered file stream.
TCollection	object	Manage a collection of pointers of objects.
TDosStream	object	DOS file stream.
TMemoryStream	object	Stream which keeps data in memory.
TObject	object	Basis of all objects.
TPoint	object	Record describing a point in a 2 dimensional plane.
TRect	object	Describes a rectangular region in a plane.
TResourceCollection	object	Collection of resource names.
TResourceFile	object	Resource file.
TSortedCollection	object	Abstract sorted collection.
TStrCollection	object	Collection of null-terminated strings.
TStream	object	Base stream class.
TStreamRec	record	Record used in streaming mechanism.
TStrIndexRec	record	Record type used in a to store the strings.
TStringCollection	object	Collection of pascal strings.
TStringList	object	Collection of strings.
TStrListMaker	object	Generate a stream with strings, readable by .
TUnSortedStrCollection	object	Unsorted string collection.
WordRec	record	Record describing a Word (in bytes).

Procedures and functions

Abstract	procedure	Abstract error handler.
CallPointerConstructor	function	Call a constructor with a pointer argument.
CallPointerLocal	function	Call a local nested function with a pointer argument.
CallPointerMethod	function	Call a method with a single pointer argument.
CallPointerMethodLocal	function	Call a local procedure of a method with a pointer argument.
CallVoidConstructor	function	Call a constructor with no arguments.
CallVoidLocal	function	Call a local nested procedure.
CallVoidMethod	function	Call an object method.
CallVoidMethodLocal	function	Call a local procedure of a method.
DisposeStr	procedure	Dispose of a shortstring which was allocated on the heap.
LongDiv	function	Overflow safe divide.
LongMul	function	Overflow safe multiply.
NewStr	function	Allocate a copy of a shortstring on the heap.
RegisterObjects	procedure	Register standard objects.
RegisterType	procedure	Register new object for streaming.
SetStr	procedure	Allocate a copy of a shortstring on the heap.

Types

AsciiZ	type	Filename - null terminated array of characters.
FNameStr	type	Filename - shortstring version.
PBufStream	type	Pointer to object.
PByteArray	type	Pointer to .
PCharSet	type	Pointer to .
PCollection	type	Pointer to object.
PDosStream	type	Pointer to object.
PItemList	type	Pointer to object.
PMemoryStream	type	Pointer to object.
PObject	type	Pointer to object.
PPoint	type	Pointer to record.
PPointerArray	type	Pointer to .
PRect	type	Pointer to object.
PResourceCollection	type	Pointer to object.
PResourceFile	type	Pointer to object.
PSortedCollection	type	Pointer to object.
PStrCollection	type	Pointer to object.
PStream	type	Pointer type to .
PStreamRec	type	Pointer to .
PStrIndex	type	Pointer to array.
PString	type	Pointer to a shortstring.
PStringCollection	type	Pointer to object.
PStringList	type	Pointer to object.
PStrListMaker	type	Pointer to object.
PUnSortedStrCollection	type	Pointer to object.
PWordArray	type	Pointer to .
Sw_Integer	type	Alias for longint.
Sw_Word	type	Alias for Cardinal.
TByteArray	type	Array with maximum allowed number of bytes.
TCallbackFun	type
TCallbackFunBool	type
TCallbackFunBoolParam	type
TCallbackFunParam	type
TCallbackProc	type
TCallbackProcParam	type
TCharSet	set	Generic set of characters type.
TItemList	type	Pointer array type used in a .
TPointerArray	type	Array with maximum allowed number of pointers.
TStrIndex	type	Pointer array type used in a .
TWordArray	type	Array with maximum allowed number of words.

Constants

coIndexError	constant	Collection list error: Index out of range.
coOverflow	constant	Collection list error: Overflow.
DefaultTPCompatible	constant	Default value for tstream.tpcompatible.
MaxBytes	constant	Maximum data size (in bytes).
MaxCollectionSize	constant	Maximum collection size (in items).
MaxPtrs	constant	Maximum data size (in pointers).
MaxReadBytes	constant	Maximum data that can be read from a stream (not used).
MaxTPCompatibleCollectionSize	constant	Maximum collection size (in items, same value as in TP).
MaxWords	constant	Maximum data size (in words).
RCollection	constant	Default stream record for the object.
RStrCollection	constant	Default stream record for the object.
RStringCollection	constant	Default stream record for the object.
RStringList	constant	Default stream record for the object.
RStrListMaker	constant	Default stream record for the object.
stCreate	constant	Stream initialization mode: Create new file.
stError	constant	Stream error codes: Access error.
stGetError	constant	Stream error codes: Get object error.
stInitError	constant	Stream error codes: Initialize error.
stOk	constant	Stream error codes: No error.
stOpen	constant	Stream initialization mode: Read/write access.
stOpenError	constant	Stream error codes: Error opening stream.
stOpenRead	constant	Stream initialization mode: Read access only.
stOpenWrite	constant	Stream initialization mode: Write access only.
stPutError	constant	Stream error codes: Put object error.
stReadError	constant	Stream error codes: Stream read error.
StreamError	constant	Pointer to default stream error handler.
stSeekError	constant	Stream error codes: Seek error in stream.
stWriteError	constant	Stream error codes: Stream write error.
vmtHeaderSize	constant	Size of the VMT header in an object (not used).

Variables

invalidhandle

variable

Value for invalid handle. Initial value for file stream handles or when the stream is closed.