FCL Reference Guide
Total Page:16
File Type:pdf, Size:1020Kb
Free Component Library (FCL) : Reference guide. Reference guide for FCL units. Document version 1.9 May 2003 Michaël Van Canneyt Contents 1 Reference for unit ’Classes’ 21 1.1 Used units ........................................ 21 1.2 Overview ........................................ 21 1.3 Constants, types and variables ............................. 21 Constants ........................................ 21 Types .......................................... 23 Variables ........................................ 30 1.4 Procedures and functions ................................ 31 BeginGlobalLoading .................................. 31 Bounds ......................................... 32 CollectionsEqual .................................... 32 EndGlobalLoading ................................... 32 FindClass ........................................ 32 FindNestedComponent ................................. 32 GetClass ......................................... 33 GetFixupInstanceNames ................................ 33 GetFixupReferenceNames ............................... 33 GlobalFixupReferences ................................. 34 IdentToInt ........................................ 34 InitComponentRes ................................... 34 InitInheritedComponent ................................. 34 IntToIdent ........................................ 35 LineStart ........................................ 35 NotifyGlobalLoading .................................. 35 ObjectBinaryToText ................................... 35 ObjectResourceToText ................................. 35 ObjectTextToBinary ................................... 36 ObjectTextToResource ................................. 36 Point ........................................... 36 ReadComponentRes .................................. 36 1 CONTENTS ReadComponentResEx ................................. 37 ReadComponentResFile ................................ 37 Rect ........................................... 37 RedirectFixupReferences ................................ 37 RegisterClass ...................................... 38 RegisterClassAlias ................................... 38 RegisterClasses ..................................... 38 RegisterComponents .................................. 38 RegisterIntegerConsts .................................. 39 RegisterNoIcon ..................................... 39 RegisterNonActiveX .................................. 39 RemoveFixupReferences ................................ 39 RemoveFixups ..................................... 40 SmallPoint ........................................ 40 UnRegisterClass .................................... 40 UnRegisterClasses ................................... 40 UnRegisterModuleClasses ............................... 41 WriteComponentResFile ................................ 41 1.5 EBitsError ........................................ 41 Description ....................................... 41 1.6 EClassNotFound .................................... 41 Description ....................................... 41 1.7 EComponentError .................................... 41 Description ....................................... 41 1.8 EFCreateError ...................................... 42 Description ....................................... 42 1.9 EFilerError ....................................... 42 Description ....................................... 42 1.10 EFOpenError ...................................... 42 Description ....................................... 42 1.11 EInvalidImage ...................................... 42 Description ....................................... 42 1.12 EInvalidOperation .................................... 42 Description ....................................... 42 1.13 EListError ........................................ 42 Description ....................................... 42 1.14 EMethodNotFound ................................... 43 Description ....................................... 43 1.15 EOutOfResources .................................... 43 Description ....................................... 43 2 CONTENTS 1.16 EParserError ...................................... 43 Description ....................................... 43 1.17 EReadError ....................................... 43 Description ....................................... 43 1.18 EResNotFound ..................................... 43 Description ....................................... 43 1.19 EStreamError ...................................... 43 Description ....................................... 43 1.20 EStringListError .................................... 44 Description ....................................... 44 1.21 EThread ......................................... 44 Description ....................................... 44 1.22 EWriteError ....................................... 44 Description ....................................... 44 1.23 IInterfaceList ...................................... 45 Method overview .................................... 45 Property overview .................................... 45 IInterfaceList.Get .................................... 45 IInterfaceList.GetCapacity ............................... 45 IInterfaceList.GetCount ................................. 45 IInterfaceList.Put .................................... 45 IInterfaceList.SetCapacity ............................... 46 IInterfaceList.SetCount ................................. 46 IInterfaceList.Clear ................................... 46 IInterfaceList.Delete .................................. 46 IInterfaceList.Exchange ................................. 46 IInterfaceList.First ................................... 46 IInterfaceList.IndexOf ................................. 46 IInterfaceList.Add .................................... 46 IInterfaceList.Insert ................................... 46 IInterfaceList.Last .................................... 47 IInterfaceList.Remove ................................. 47 IInterfaceList.Lock ................................... 47 IInterfaceList.Unlock .................................. 47 IInterfaceList.Capacity ................................. 47 IInterfaceList.Count ................................... 47 IInterfaceList.Items ................................... 47 1.24 IStreamPersist ...................................... 47 Method overview .................................... 47 IStreamPersist.LoadFromStream ............................ 48 3 CONTENTS IStreamPersist.SaveToStream .............................. 48 1.25 IStringsAdapter ..................................... 48 Description ....................................... 48 1.26 IUnknown ........................................ 48 Description ....................................... 48 1.27 TAbstractObjectReader ................................. 48 Description ....................................... 48 Method overview .................................... 49 TAbstractObjectReader.NextValue ........................... 49 TAbstractObjectReader.ReadValue ........................... 49 TAbstractObjectReader.BeginRootComponent ..................... 49 TAbstractObjectReader.BeginComponent ....................... 50 TAbstractObjectReader.BeginProperty ......................... 50 TAbstractObjectReader.ReadBinary .......................... 50 TAbstractObjectReader.ReadFloat ........................... 51 TAbstractObjectReader.ReadSingle .......................... 51 TAbstractObjectReader.ReadDate ........................... 51 TAbstractObjectReader.ReadIdent ........................... 52 TAbstractObjectReader.ReadInt8 ............................ 52 TAbstractObjectReader.ReadInt16 ........................... 52 TAbstractObjectReader.ReadInt32 ........................... 53 TAbstractObjectReader.ReadInt64 ........................... 53 TAbstractObjectReader.ReadSet ............................ 53 TAbstractObjectReader.ReadStr ............................ 54 TAbstractObjectReader.ReadString ........................... 54 TAbstractObjectReader.SkipComponent ........................ 54 TAbstractObjectReader.SkipValue ........................... 55 1.28 TAbstractObjectWriter ................................. 55 Description ....................................... 55 Method overview .................................... 55 TAbstractObjectWriter.BeginCollection ........................ 55 TAbstractObjectWriter.BeginComponent ........................ 55 TAbstractObjectWriter.BeginList ............................ 56 TAbstractObjectWriter.EndList ............................. 56 TAbstractObjectWriter.BeginProperty ......................... 56 TAbstractObjectWriter.EndProperty .......................... 56 TAbstractObjectWriter.WriteBinary .......................... 56 TAbstractObjectWriter.WriteBoolean ......................... 57 TAbstractObjectWriter.WriteFloat ........................... 57 TAbstractObjectWriter.WriteSingle .......................... 57 4 CONTENTS TAbstractObjectWriter.WriteDate ........................... 57 TAbstractObjectWriter.WriteIdent ........................... 57 TAbstractObjectWriter.WriteInteger .......................... 57 TAbstractObjectWriter.WriteMethodName ....................... 58 TAbstractObjectWriter.WriteSet ............................ 58 TAbstractObjectWriter.WriteString ........................... 58 1.29 TBasicAction ...................................... 58 Description ....................................... 58 Method overview .................................... 58 Property overview ...................................