diff --git a/docs/xml/lcl/graphics.xml b/docs/xml/lcl/graphics.xml index dd768ac907..09cbba5d4a 100644 --- a/docs/xml/lcl/graphics.xml +++ b/docs/xml/lcl/graphics.xml @@ -1685,32 +1685,36 @@ Since FPC 2.0 the LCL uses TFPCanvasHelper as ancestor. - + + TFontHandleCacheDescriptor - descriptor for items in Font Handle Cache - + + LogFont - a font used (especially in Windows) for logs - + + LongFontName - he long name for the Font - + + TFontHandleCache - a resource cache for font handles - + @@ -1721,14 +1725,14 @@ Since FPC 2.0 the LCL uses TFPCanvasHelper as ancestor. - + - + @@ -1752,7 +1756,8 @@ Since FPC 2.0 the LCL uses TFPCanvasHelper as ancestor. - + + FindFont - returns the Font specified by its handle as a cache item from the FontHandleCache @@ -1767,7 +1772,9 @@ Since FPC 2.0 the LCL uses TFPCanvasHelper as ancestor. - + + FindFontDesc - returns the descriptor for the FontHandle using its LogName and its LongFontName + @@ -1786,7 +1793,8 @@ Since FPC 2.0 the LCL uses TFPCanvasHelper as ancestor. - + + Add the Font specified by its handle, LogFont and LongFontName, and returns a descriptor @@ -1942,7 +1950,8 @@ Since FPC 2.0 the LCL uses TFPCanvasHelper as ancestor. - + + SetName - specify the name of the Font @@ -1953,7 +1962,8 @@ Since FPC 2.0 the LCL uses TFPCanvasHelper as ancestor. - + + SetSize - specify the size of Font @@ -1964,14 +1974,16 @@ Since FPC 2.0 the LCL uses TFPCanvasHelper as ancestor. - + + Changed - method to signify that a change has occurred - + + GetCharSet - returns the Character Set to be used for this Font @@ -1993,7 +2005,8 @@ Since FPC 2.0 the LCL uses TFPCanvasHelper as ancestor. - + + GetHeight - returns the height of the Font @@ -2004,7 +2017,8 @@ Since FPC 2.0 the LCL uses TFPCanvasHelper as ancestor. - + + GetName - returns the name of the Font @@ -2015,7 +2029,8 @@ Since FPC 2.0 the LCL uses TFPCanvasHelper as ancestor. - + + GetPitch - returns the pitch of the Font @@ -2026,7 +2041,8 @@ Since FPC 2.0 the LCL uses TFPCanvasHelper as ancestor. - + + GetSize - returns the size of the Font @@ -2037,8 +2053,9 @@ Since FPC 2.0 the LCL uses TFPCanvasHelper as ancestor. - - + + GetStyle - returns the style of the Font + Bold, Italic, StrikeOut, Underline @@ -2048,7 +2065,8 @@ Since FPC 2.0 the LCL uses TFPCanvasHelper as ancestor. - + + SetCharSet - specify the character set @@ -2059,7 +2077,8 @@ Since FPC 2.0 the LCL uses TFPCanvasHelper as ancestor. - + + SetColor - specify the colour for the font @@ -2081,7 +2100,8 @@ Since FPC 2.0 the LCL uses TFPCanvasHelper as ancestor. - + + SetHeight - specify the height of the Font @@ -2092,7 +2112,8 @@ Since FPC 2.0 the LCL uses TFPCanvasHelper as ancestor. - + + SetPitch - specify the pitch for the Font @@ -2103,7 +2124,8 @@ Since FPC 2.0 the LCL uses TFPCanvasHelper as ancestor. - + + SetStyle - specify which style to use @@ -2114,8 +2136,9 @@ Since FPC 2.0 the LCL uses TFPCanvasHelper as ancestor. - - + + SetQuality - specify the quality + Default, Draft, Proof, NonAntialiased, Antialiased @@ -2326,13 +2349,14 @@ psSolid, psDash, psDot, psDashDot, psDashDotDot, psinsideFrame, psPattern,psClea - + + TPenHandleCache - Resource Cache for Pen Handles - + @@ -2343,7 +2367,7 @@ psSolid, psDash, psDot, psDashDot, psDashDotDot, psinsideFrame, psPattern,psClea - + @@ -8934,14 +8958,16 @@ Checks for the presence of a valid Lazarus Resource, then uses - + + DoAllocateResources - method for allocating resources - + + DoCopyProps - method for copying property data from another Font @@ -8952,7 +8978,8 @@ Checks for the presence of a valid Lazarus Resource, then uses - + + DoDeAllocateResources - method for freeing resources @@ -8967,7 +8994,8 @@ Checks for the presence of a valid Lazarus Resource, then uses - + + SetFlags - specify which (Indexed) flags are to be set @@ -8982,7 +9010,8 @@ Checks for the presence of a valid Lazarus Resource, then uses - + + SetFPColor - specify the colour using the FreePascal list @@ -11937,7 +11966,8 @@ This function checks that the value in - + + GetSharedImageClass - returns the class of Shared Raster Image @@ -13056,9 +13086,7 @@ This function checks that the value in - - - GetSharedImageClass - returns the class of Shared Raster Image + @@ -13098,9 +13126,7 @@ This function checks that the value in - - - GetSharedImageClass - returns the class of Shared Raster Image + @@ -13166,9 +13192,7 @@ This function checks that the value in - - - GetSharedImageClass - returns the class of Shared Raster Image + @@ -13208,9 +13232,7 @@ This function checks that the value in - - - GetSharedImageClass - returns the class of Shared Raster Image + @@ -13646,9 +13668,7 @@ This function checks that the value in - - - GetSharedImageClass - returns the class of Shared Raster Image + @@ -14113,7 +14133,7 @@ This function checks that the value in - + @@ -14213,9 +14233,7 @@ This function checks that the value in - - - GetSharedImageClass - returns the class of Shared Raster Image + @@ -14336,6 +14354,7 @@ be carefull with this, modify only within a begin/endupdate + diff --git a/docs/xml/lcl/lclrescache.xml b/docs/xml/lcl/lclrescache.xml index 74cf58836e..9875eec311 100644 --- a/docs/xml/lcl/lclrescache.xml +++ b/docs/xml/lcl/lclrescache.xml @@ -1,964 +1,721 @@ - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + Types and methods to cache interface resources + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + TResourceCacheItem - an item in a list (TResourceCache) + + + + + + + + FDestroying - local boolean variable to store Destroying status + + + + + + + FReferenceCount - local variable to store Reference Count + + + + + + + Handle for Cache Item - use TLCLHandle instead of THandle since THandle = longint under 64bit linux + + + + + + The Resource Cache to which this Cache Item belongs + + + + + + + FirstDescriptor - the descriptor for the first item in the list + + + + + + + LastDescriptor - the descriptor for the last item in the list + + + + + + The Next item in the list + + + + + + + Prev - the previous item in the list + + + + + + + + + + + + + + + + + + + + + + + + + + + + + IncreaseRefCount - increment the reference count + + + + + + + + DecreaseRefCount - decrement the reference count + + + + + + + + AddToList - add an item to the cache list specified by First, Last + + + + + + + + + + + + + + + + + RemoveFromList - remove an item from the cache list specified by First, Last + + + + + + + + + + + + + + + + + WarnReferenceHigh - issue a warning if the number of references gets too high + + + + + + + + ReferenceCount - the number of references to this Item + + + + + + + + + + + + + TResourceCacheDescriptor - a class of descriptors for ResourceCache Items + + + + + + + + FDestroying - local boolean variable to store Destroying status + + + + + + + Item - the Resource Cache Item to which this descriptor refers + + + + + + + Cache - the resource Cache to which this Item belongs + + + + + + The Next descriptor in the list + + + + + + + Prev - the Previous descriptor in the list + + + + + + + + + + + + + + + + + + + + + + + + + + + + + AddToList - add a descriptor to the list specified by First, Last + + + + + + + + + + + + + + + + + RemoveFromList - remove a descriptor from the list specified by First, Last + + + + + + + + + + + + + + + + + + + + + + + TResourceCache - a cache (linked list) for storing Resources + + + + + + + + + + + + + + + + + + + + FDestroying - local boolean variable to store Destroying status + + + + + + + FResourceCacheDescriptorClass - local variable for holding the class of the current descriptor + + + + + + + FResourceCacheItemClass - local variable for holding the class of the current cache item + + + + + + + FMaxUnusedItem - how many freed resources to keep + + + + + + + FFirstUnusedItem - local variable storing location of first free item + + + + + + + FLastUnusedItem - ocal variable storing location of last free item + + + + + + + FUnUsedItemCount - local variable with count of free items + + + + + + + RemoveItem from CacheItem list + + + + + + + + + + + + RemoveDescriptor from Cache Descriptor list + + + + + + + + + + + + ItemUsed - method for signalling that the specified Item is being used + + + + + + + + + + + + ItemUnused - method for signalling that the specified Item is unused + + + + + + + + + + + + ItemIsUsed - returns True if specified Item is being used + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + CompareItems - returns 0 if items are equal, -1 if Item1 is less, 1 if Item1 is greater + + + + + + + + + + + + + + + + + + + + + + + + CompareDescriptors - returns 0 if descriptors are equal, -1 if Desc1 is less, 1 if Desc1 is greater + + + + + + + + + + + + + + + + + + + + + + + + ConsistencyCheck - checks that Items have valid descriptors + + + + + + + + MaxUnusedItem - the largest permitted number of unused items + + + + + + + ResourceCacheItemClass - the Class of the current Cache Item + + + + + + + ResourceCacheDescriptorClass - the class of the current cache item descriptor + + + + + + + THandleResourceCache - a Resource Cache for Handles + + + + + + + + FindItem - locate the item with the specified Handle + + + + + + + + + + + + + + + + TBlockResourceCacheDescriptor - descriptor for a Block Resource Cache + + + + + + + Pointer to the Data + + + + + + + + + + + + + + + TBlockResourceCache - a cache for Block resources + + + + + + + + + + + + + + FOnCompareDescPtrWithDescriptor - local variable to hold the result of a comparison between a descriptor pointer and the descriptor itself + + + + + + + + + + + + + + + + + + FindDescriptor - returns the descriptor whose pointer is given + + + + + + + + + + + + + + + + AddResource - inserts a Block resource into the list, referenced by a handle and a descriptor pointer, and returns the Block Resource Cache descriptor + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + DataSize - thetotal size of the data in the Block Resource + + + + + + + OnCompareDescPtrWithDescriptor - the result of a comparison between a descriptor pointer and the descriptor itself + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Clear the current Resource Cache + + + +