paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-11-04 10:19:52 +01:00
Code Issues Packages Projects Releases Wiki Activity

FPDoc - descriptions added for various 'shared' classes in graphics.xml

Browse Source 
git-svn-id: trunk@15608 -
This commit is contained in:
kirkpatc 2008-06-29 14:14:38 +00:00
parent c1b02e4ddd
commit d1a77fbb55
1 changed files with 65 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

97
docs/xml/lcl/graphics.xml
View File

@ -11606,7 +11606,7 @@ This function checks that the value in
<!-- property Visibility: public --> <!-- property Visibility: public -->
<element name="TSharedRasterImage.SaveStream"> <element name="TSharedRasterImage.SaveStream">
<short> <short>
<var>SaveStream</var> - the mamory sgtream to be used for saving this image</short> <var>SaveStream</var> - the memory stream to be used for saving this image</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
@ -12871,7 +12871,8 @@ This function checks that the value in
</element> </element>
<!-- class Visibility: default --> <!-- class Visibility: default -->
<element name="TSharedBitmap"> <element name="TSharedBitmap">
<short/> <short>
<var>TSharedBitmap</var> - a reference counted Bitmap graphic</short>
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso/>
@ -12952,7 +12953,8 @@ This function checks that the value in
</element> </element>
<!-- class Visibility: default --> <!-- class Visibility: default -->
<element name="TSharedPixmap"> <element name="TSharedPixmap">
<short/> <short>
<var>TSharedPixmap</var> - a reference counted Pixmap graphic</short>
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso/>
@ -13100,7 +13102,8 @@ This function checks that the value in
</element> </element>
<!-- class Visibility: default --> <!-- class Visibility: default -->
<element name="TIconImage"> <element name="TIconImage">
<short/> <short>
<var>TIconImage</var> - a primitive Icon class with handles for the Bitmap, Mask and Palette</short>
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso/>
@ -13287,7 +13290,8 @@ This function checks that the value in
</element> </element>
<!-- function Visibility: public --> <!-- function Visibility: public -->
<element name="TIconImage.ReleaseHandle"> <element name="TIconImage.ReleaseHandle">
<short/> <short>
<var>ReleaseHandle</var> - returns Bitmap handle to Operating system</short>
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso/>
@ -13298,7 +13302,8 @@ This function checks that the value in
</element> </element>
<!-- function Visibility: public --> <!-- function Visibility: public -->
<element name="TIconImage.ReleaseMaskHandle"> <element name="TIconImage.ReleaseMaskHandle">
<short/> <short>
<var>ReleaseMaskHandle</var> - returns mask Bitmap handle to operating system</short>
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso/>
@ -13309,7 +13314,8 @@ This function checks that the value in
</element> </element>
<!-- function Visibility: public --> <!-- function Visibility: public -->
<element name="TIconImage.ReleasePalette"> <element name="TIconImage.ReleasePalette">
<short/> <short>
<var>ReleasePalette</var> - returns Palette handle to operating system</short>
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso/>
@ -13320,7 +13326,8 @@ This function checks that the value in
</element> </element>
<!-- function Visibility: public --> <!-- function Visibility: public -->
<element name="TIconImage.UpdateHandles"> <element name="TIconImage.UpdateHandles">
<short/> <short>
<var>UpdateHandles</var> - returns True when Bitmap and Mask handles have been updated</short>
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso/>
@ -13357,25 +13364,29 @@ This function checks that the value in
</element> </element>
<!-- property Visibility: public --> <!-- property Visibility: public -->
<element name="TIconImage.Handle"> <element name="TIconImage.Handle">
<short/> <short>
<var>Handle</var> - for the Bitmap</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<!-- property Visibility: public --> <!-- property Visibility: public -->
<element name="TIconImage.MaskHandle"> <element name="TIconImage.MaskHandle">
<short/> <short>
<var>MaskHandle</var> - Bitmap handle for the Mask</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<!-- property Visibility: public --> <!-- property Visibility: public -->
<element name="TIconImage.Palette"> <element name="TIconImage.Palette">
<short/> <short>Handle for the <var>Palette</var>
</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<!-- class Visibility: default --> <!-- class Visibility: default -->
<element name="TCustomIcon"> <element name="TCustomIcon">
<short/> <short>
<var>TCustomIcon</var> - base class for TIcon</short>
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso/>
@ -13656,7 +13667,9 @@ This function checks that the value in
</element> </element>
<!-- procedure Visibility: public --> <!-- procedure Visibility: public -->
<element name="TCustomIcon.Add"> <element name="TCustomIcon.Add">
<short/> <short>
<var>Add</var> - an Icon formatted as <var>AFormat</var>, with specified <var>Height</var> and <var>Width</var>
</short>
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso/>
@ -13686,14 +13699,16 @@ This function checks that the value in
</element> </element>
<!-- procedure Visibility: public --> <!-- procedure Visibility: public -->
<element name="TCustomIcon.Clear"> <element name="TCustomIcon.Clear">
<short/> <short>
<var>Clear</var> the Icon and release its resources</short>
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso/>
</element> </element>
<!-- procedure Visibility: public --> <!-- procedure Visibility: public -->
<element name="TCustomIcon.Delete"> <element name="TCustomIcon.Delete">
<short/> <short>
<var>Delete</var> the indexed Icon</short>
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso/>
@ -13704,7 +13719,9 @@ This function checks that the value in
</element> </element>
<!-- procedure Visibility: public --> <!-- procedure Visibility: public -->
<element name="TCustomIcon.Remove"> <element name="TCustomIcon.Remove">
<short/> <short>
<var>Remove</var> the Icon specified by <var>AFormat</var>, <var>AHeight</var> and <var>AWidth</var>
</short>
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso/>
@ -13723,30 +13740,36 @@ This function checks that the value in
</element> </element>
<!-- procedure Visibility: public --> <!-- procedure Visibility: public -->
<element name="TCustomIcon.GetDescription"> <element name="TCustomIcon.GetDescription">
<short/> <short>
<var>GetDescription</var> - find the description for the Icon</short>
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso/>
</element> </element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="TCustomIcon.GetDescription.Aindex"> <element name="TCustomIcon.GetDescription.Aindex">
<short/> <short>
<var>Aindex</var> - the Index value for the Icon</short>
</element> </element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="TCustomIcon.GetDescription.AFormat"> <element name="TCustomIcon.GetDescription.AFormat">
<short/> <short>
<var>AFormat</var> - the Pixel Format for the Icon</short>
</element> </element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="TCustomIcon.GetDescription.AHeight"> <element name="TCustomIcon.GetDescription.AHeight">
<short/> <short>
<var>AHeight</var> - the height of the Icon</short>
</element> </element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="TCustomIcon.GetDescription.AWidth"> <element name="TCustomIcon.GetDescription.AWidth">
<short/> <short>
<var>AWidth</var> - the width of the Icon</short>
</element> </element>
<!-- procedure Visibility: public --> <!-- procedure Visibility: public -->
<element name="TCustomIcon.SetSize"> <element name="TCustomIcon.SetSize">
<short/> <short>
<var>SetSize</var> - write the size (width, height) of the Icon</short>
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso/>
@ -13761,7 +13784,8 @@ This function checks that the value in
</element> </element>
<!-- function Visibility: public --> <!-- function Visibility: public -->
<element name="TCustomIcon.GetFileExtensions"> <element name="TCustomIcon.GetFileExtensions">
<short/> <short>
<var>GetFileExtensions</var> - returns a list of valid file extensions associated with the Icon</short>
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso/>
@ -13772,7 +13796,8 @@ This function checks that the value in
</element> </element>
<!-- function Visibility: public --> <!-- function Visibility: public -->
<element name="TCustomIcon.LazarusResourceTypeValid"> <element name="TCustomIcon.LazarusResourceTypeValid">
<short/> <short>
<var>LazarusResourceTypeValid</var> - returns True if the specified <var>ResourceType</var> is valid</short>
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso/>
@ -13787,7 +13812,8 @@ This function checks that the value in
</element> </element>
<!-- function Visibility: public --> <!-- function Visibility: public -->
<element name="TCustomIcon.BitmapHandleAllocated"> <element name="TCustomIcon.BitmapHandleAllocated">
<short/> <short>
<var>BitmapHandleAllocated</var> - returns True if a Bitmap Handle has been allocated</short>
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso/>
@ -13798,7 +13824,8 @@ This function checks that the value in
</element> </element>
<!-- function Visibility: public --> <!-- function Visibility: public -->
<element name="TCustomIcon.MaskHandleAllocated"> <element name="TCustomIcon.MaskHandleAllocated">
<short/> <short>
<var>MaskHandleAllocated</var> - returns True if a Mask Bitmap handle has been allocated</short>
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso/>
@ -13809,7 +13836,8 @@ This function checks that the value in
</element> </element>
<!-- function Visibility: public --> <!-- function Visibility: public -->
<element name="TCustomIcon.PaletteAllocated"> <element name="TCustomIcon.PaletteAllocated">
<short/> <short>
<var>PaletteAllocated</var> - returns True if a Palette handle has been allocated</short>
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso/>
@ -13820,7 +13848,8 @@ This function checks that the value in
</element> </element>
<!-- procedure Visibility: public --> <!-- procedure Visibility: public -->
<element name="TCustomIcon.SetHandles"> <element name="TCustomIcon.SetHandles">
<short/> <short>
<var>SetHandles</var> - writes the values of the Bitmap and Mask handles</short>
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso/>
@ -13835,13 +13864,15 @@ This function checks that the value in
</element> </element>
<!-- property Visibility: public --> <!-- property Visibility: public -->
<element name="TCustomIcon.Current"> <element name="TCustomIcon.Current">
<short/> <short>
<var>Current</var> - the sequence number of the current Icon</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<!-- property Visibility: public --> <!-- property Visibility: public -->
<element name="TCustomIcon.Count"> <element name="TCustomIcon.Count">
<short/> <short>
<var>Count</var> - the number of references to this Icon</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
@ -13919,7 +13950,8 @@ This function checks that the value in
</element> </element>
<!-- class Visibility: default --> <!-- class Visibility: default -->
<element name="TCursorImageImage"> <element name="TCursorImageImage">
<short/> <short>
<var>TCursorImageImage</var> - the image for a cursor, stored as an Icon</short>
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso/>
@ -13932,7 +13964,8 @@ This function checks that the value in
</element> </element>
<!-- property Visibility: public --> <!-- property Visibility: public -->
<element name="TCursorImageImage.HotSpot"> <element name="TCursorImageImage.HotSpot">
<short/> <short>
<var>HotSpot</var> - the coordinates of the point to which the cursor refers, and which represents the 'active' position on the current form or canvas</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>