From 7689ccf97ef6b33fd366ed124edd062cc0a8e929 Mon Sep 17 00:00:00 2001 From: kirkpatc Date: Mon, 3 Nov 2008 15:48:33 +0000 Subject: [PATCH] FPDoc - added descriptions and links for TCanvas, TBitmap, TPixmap, TFPImageBitmap, TPortableNetworkGraphic, TBitmapImage, TJPEGImage, TCustomBitmap, TPortableAnyMapGraphic, TCustomImage, TSharedRasterImage, TRasterImage, TSharedCustomBitmap, TSharedIcon, TIconImage, TCustomIcon, TIcon, TSharedCursorImage in Graphics.xml git-svn-id: trunk@17202 - --- docs/xml/lcl/graphics.xml | 289 +++++++++++++++++++++----------------- 1 file changed, 159 insertions(+), 130 deletions(-) diff --git a/docs/xml/lcl/graphics.xml b/docs/xml/lcl/graphics.xml index 0082b89257..9a05767504 100644 --- a/docs/xml/lcl/graphics.xml +++ b/docs/xml/lcl/graphics.xml @@ -5051,7 +5051,7 @@ Use Ellipse - + Produce a Frame or border in the specified rectangle using a Pen @@ -5075,7 +5075,7 @@ Use Ellipse - FrameRect - produce a border in th especified rectangle using a Brush + FrameRect - produce a border in the specified rectangle using a Brush @@ -5086,7 +5086,8 @@ Use Ellipse - + + FrameRect - produce a border in the specified rectangle using a Brush @@ -5163,6 +5164,8 @@ Use Ellipse + + RadialPie - draw a filled pie-shaped wedge on the canvas with specified start and end coordinates, and starting and ending angular positions @@ -5340,7 +5343,10 @@ Use Pie - + + + Polybezier draws cubic Bezier curves + @@ -5416,7 +5422,8 @@ If the Filled Flag is set to TRUE then the resulting Poly-Bezier will be drawn a - + + Polygon draws a closed, many-sided shape on the canvas, using the value of Pen @@ -5610,7 +5617,8 @@ To draw a polygon on the canvas, without filling it, use the Polyline - + + Polyline connects a set of points on the canvas @@ -5628,7 +5636,10 @@ To draw a polygon on the canvas, without filling it, use the Polyline - + + + Polyline connects a set of points on the canvas + @@ -5798,7 +5809,7 @@ Calling the MoveTo - + Draws a Rectangle at the specified coordinates @@ -5841,7 +5852,8 @@ Calling the MoveTo - + + RoundRect - draws a rectangle at the specified position, with corners rounded by the factors RX, RY @@ -6971,25 +6983,7 @@ The boundaries of the rectangle are specified in ARect The target resource type specified as a string - - - LoadFromStream: obtains - - - - - - - BitMap data from a - - - - - - - Stream - - + @@ -7097,8 +7091,7 @@ Checks for the presence of a valid Lazarus Resource, then uses - - Finds the available file extensions + @@ -7370,10 +7363,7 @@ Checks for the presence of a valid Lazarus Resource, then uses - - - LazarusResourceTypeValid - checks that specified resource has correct format - + Returns True if resource type is 'XPM' @@ -7422,8 +7412,7 @@ Checks for the presence of a valid Lazarus Resource, then uses - - Find the file extensions for valid bitmap image files + @@ -7500,7 +7489,7 @@ Checks for the presence of a valid Lazarus Resource, then uses - + @@ -7568,7 +7557,7 @@ Checks for the presence of a valid Lazarus Resource, then uses - + @@ -8571,8 +8560,8 @@ Checks for the presence of a valid Lazarus Resource, then uses The class of stream for saving data - - + + @@ -10677,23 +10666,21 @@ Checks for the presence of a valid Lazarus Resource, then uses - - - BitMap constructor + BitMap constructor. The supplied code can - override the definition from ancestor classes + override the definition from ancestor classes + - - - BitMap destructor + BitMap destructor. The supplied code can - override the method defined for ancestor classes + override the method defined for ancestor classes + @@ -10727,17 +10714,13 @@ Checks for the presence of a valid Lazarus Resource, then uses Returns True if a handle is allocated - - Is a handle allocated for the bitmap mask? - + Returns True is a mask handle has been allocated - - Has a colour palette been allocated for this bitmap? - + Returns True if a palette has been allocated @@ -10759,9 +10742,7 @@ Checks for the presence of a valid Lazarus Resource, then uses - - Checks that the Resource Type specified in the string argument is a valid Lazarus type - + Returns TRUE if a valid resource type is found @@ -10839,9 +10820,7 @@ Checks for the presence of a valid Lazarus Resource, then uses - - Finds the type of resource for the bitmap - + @@ -10863,9 +10842,7 @@ Checks for the presence of a valid Lazarus Resource, then uses - - Sets handles for the bitmap and its mask - + @@ -11103,7 +11080,7 @@ Checks for the presence of a valid Lazarus Resource, then uses - + @@ -11235,7 +11212,7 @@ Checks for the presence of a valid Lazarus Resource, then uses - + @@ -11246,7 +11223,7 @@ Checks for the presence of a valid Lazarus Resource, then uses - + @@ -11629,7 +11606,7 @@ This function checks that the value in - + @@ -11656,14 +11633,14 @@ This function checks that the value in - + - + @@ -12223,21 +12200,21 @@ This function checks that the value in - + - + - + @@ -12248,7 +12225,7 @@ This function checks that the value in - + @@ -12256,14 +12233,16 @@ This function checks that the value in - + + FreeImage - method for freeing or detaching image from the Raster - + + BitmapHandleAllocated - returns True if a handle has been allocated for the Bitmap @@ -12274,7 +12253,8 @@ This function checks that the value in - + + MaskHandleAllocated - returns True if a handle has been allocated for the Mask @@ -12285,7 +12265,8 @@ This function checks that the value in - + + PaletteAllocated - returns True if a Palette has been allocated @@ -12296,7 +12277,8 @@ This function checks that the value in - + + LoadFromBitmapHandles - loads the data from the Bitmap and Mask specified by their handles @@ -12315,7 +12297,8 @@ This function checks that the value in - + + LoadFromDevice - loads data from the device specified by its handle DC @@ -12326,7 +12309,8 @@ This function checks that the value in - + + LoadFromStream - loads data for the image from a specified data stream, optionally supplying its size @@ -12341,7 +12325,8 @@ This function checks that the value in - + + LoadFromMimeStream - loads data for the image from a specified MIME stream @@ -12356,7 +12341,8 @@ This function checks that the value in - + + LoadFromIntfImage - loads image data from an Interface stream @@ -12366,8 +12352,7 @@ This function checks that the value in - - + @@ -12377,7 +12362,7 @@ This function checks that the value in - + @@ -12389,7 +12374,7 @@ This function checks that the value in - + The Mask to be used with the Image @@ -12400,7 +12385,8 @@ This function checks that the value in - + + SetHandles - allows the user to specify handles @@ -12415,7 +12401,8 @@ This function checks that the value in - + + ReleaseBitmapHandle - releases the handle used by the Bitmap @@ -12426,7 +12413,8 @@ This function checks that the value in - + + ReleaseMaskHandle - releases the Handle used for the Mask @@ -12437,7 +12425,8 @@ This function checks that the value in - + + ReleasePalette - release the Handle used for the Palettte @@ -12448,7 +12437,8 @@ This function checks that the value in - + + CreateIntfImage - creates an image on the Interface @@ -12491,7 +12481,8 @@ This function checks that the value in - + + PixelFormat - the format of the Pixels in this Image @@ -12606,21 +12597,21 @@ This function checks that the value in - + - + - + @@ -12824,7 +12815,7 @@ This function checks that the value in - + @@ -12836,7 +12827,8 @@ This function checks that the value in - + + SetSize - allows the user to specify the size of the Bitmap @@ -13070,7 +13062,7 @@ This function checks that the value in - + @@ -13225,14 +13217,14 @@ This function checks that the value in - + - + @@ -13336,8 +13328,9 @@ This function checks that the value in - - + + + Create - Specifies a Raw image to be used, then used Inherited Create @@ -13359,7 +13352,7 @@ This function checks that the value in - + @@ -13423,19 +13416,20 @@ This function checks that the value in - + The Height of the Icon - + The Width of the Icon - + + PixelFormat - the format of the Pixels in the Image @@ -13736,7 +13730,7 @@ This function checks that the value in - + @@ -13764,7 +13758,7 @@ This function checks that the value in - + @@ -13860,9 +13854,7 @@ This function checks that the value in - - - GetFileExtensions - returns a list of valid file extensions associated with the Icon + @@ -13872,9 +13864,7 @@ This function checks that the value in - - - LazarusResourceTypeValid - returns True if the specified ResourceType is valid + @@ -13888,9 +13878,7 @@ This function checks that the value in - - - BitmapHandleAllocated - returns True if a Bitmap Handle has been allocated + @@ -13900,9 +13888,7 @@ This function checks that the value in - - - MaskHandleAllocated - returns True if a Mask Bitmap handle has been allocated + @@ -13912,9 +13898,7 @@ This function checks that the value in - - - PaletteAllocated - returns True if a Palette handle has been allocated + @@ -13924,9 +13908,7 @@ This function checks that the value in - - - SetHandles - writes the values of the Bitmap and Mask handles + @@ -13984,7 +13966,8 @@ This function checks that the value in - + + ReleaseHandle - frees the handle that was iused for the Icon @@ -13995,7 +13978,7 @@ This function checks that the value in - + The Operating System Handle used for the Icon @@ -14015,7 +13998,7 @@ This function checks that the value in - + @@ -14088,7 +14071,8 @@ This function checks that the value in - + + ReleaseHandle - free the handle used for the cursor Image @@ -14193,6 +14177,51 @@ This function checks that the value in Count - returns the number of references to the shared icon + + + BeginUpdate - start the update process + + BeginUpdate - start the update process; by default the boolean argument ACanvasOnly is False, ie more than just the Canvas is to be updated + + + + + EndUpdate - finishes the update process + + EndUpdate - finishes the update process. By default the boolean argument AStreamIsValid is False, ie no stream is valid at the end of the process. +be carefull with this, modify only within a begin/endupdate + + + + GetSize - finds the size of the Image + + + + Masked - returns True if a Mask is being applied + + + + RawImage - allows the user to access the Raw Image: CAUTION! + + RawImage - allows the user to access the Raw Image: CAUTION! Modify only within a begin/endupdate. + + + + PixelFormat - the format for the Pixels in this Bitmap + + + + + RawImageNeeded - if ADescOnly is True (descriptor only), then we need a Raw Image + + + + AssignImage - assign the source image to the current one + + + + GetBestIndexForSize - returns the best estimate of the index value for size +