diff --git a/docs/xml/lcl/graphics.xml b/docs/xml/lcl/graphics.xml index f637ed12c7..2d5c8d2d20 100644 --- a/docs/xml/lcl/graphics.xml +++ b/docs/xml/lcl/graphics.xml @@ -2261,7 +2261,8 @@ Property is a set, so may contain zero or more of the above (if set is empty, No The Style asociated with the current Pen - The Style asociated with the current Pen
+ The Style asociated with the current Pen +
Can take any of the values: psSolid, psDash, psDot, psDashDot, psDashDotDot, psinsideFrame, psPattern,psClear
@@ -2419,7 +2420,8 @@ psSolid, psDash, psDot, psDashDot, psDashDotDot, psinsideFrame, psPattern,psClea - Copies the SourcePen to itself + Copies the Source + Pen to itself @@ -2848,10 +2850,24 @@ Default is psSolid Base class for dealing with Graphic images - The TGraphic class is an abstract base class for dealing with graphic images such as bitmaps, pixmaps, icons, and other image formats. It does not contain an actual area for displaying the image; this is provided by the descendant classes eg BitMap, Icon etc which have a Canvas element defined
LoadFromFile - Read the graphic from the file system. The old contents of the graphic are lost. If the file is not of the right format, an exception will be generated.
SaveToFile - Writes the graphic to disk in the file provided.
LoadFromStream - Like LoadFromFile except source is a stream (e.g. TBlobStream -).
SaveToStream - stream analogue of SaveToFile .
LoadFromClipboardFormat - Replaces the current image with the data provided. If the TGraphic - does not support that format it will generate an exception.
SaveToClipboardFormats - Converts the image to a clipboard format. If the image does not support being translated into a clipboard format it will generate an exception.
Height - The native, unstretched, height of the graphic.
Palette - Color palette of image. Zero if graphic doesn't need/use palettes.
Transparent - Some parts of the image are not opaque, ie the background can be seen through.
Width - The native, unstretched, width of the graphic.
OnChange - Called whenever the graphic changes
PaletteModified - Indicates in OnChange whether color palette has changed. Stays true until whoever is responsible for realizing this new palette (ex: TImage) sets it to False.
OnProgress - Generic progress indicator event. Propagates out to TPicture - and TImage OnProgress events.

+ The TGraphic class is an abstract base class for dealing with graphic images such as bitmaps, pixmaps, icons, and other image formats. It does not contain an actual area for displaying the image; this is provided by the descendant classes eg BitMap, Icon etc which have a Canvas element defined
+ LoadFromFile - Read the graphic from the file system. The old contents of the graphic are lost. If the file is not of the right format, an exception will be generated.
+ SaveToFile - Writes the graphic to disk in the file provided.
+ LoadFromStream - Like LoadFromFile except source is a stream (e.g. TBlobStream +).
+ SaveToStream - stream analogue of SaveToFile .
+ LoadFromClipboardFormat - Replaces the current image with the data provided. If the TGraphic + does not support that format it will generate an exception.
+ SaveToClipboardFormats - Converts the image to a clipboard format. If the image does not support being translated into a clipboard format it will generate an exception.
+ Height - The native, unstretched, height of the graphic.
+ Palette - Color palette of image. Zero if graphic doesn't need/use palettes.
+ Transparent - Some parts of the image are not opaque, ie the background can be seen through.
+ Width - The native, unstretched, width of the graphic.
+ OnChange - Called whenever the graphic changes
+ PaletteModified - Indicates in OnChange whether color palette has changed. Stays true until whoever is responsible for realizing this new palette (ex: TImage) sets it to False.
+ OnProgress - Generic progress indicator event. Propagates out to TPicture + and TImage OnProgress events.
+
As many of the methods and properties are virtual and/or abstract, it is the responsibility of the application programmer to supply suitable methods when implementing any descendant classes
@@ -2961,6 +2977,17 @@ Default is psSolid
+ + + + + + + + + + + @@ -3105,6 +3132,24 @@ Default is psSolid + + + + + + + + + + + + + + + + + + @@ -3194,6 +3239,20 @@ If the file is not of the right format, an exception will be generated. + + + + + + + + + + + + + + @@ -4538,7 +4597,8 @@ If the file is not of the right format, an exception will be generated. Params: ALeft, ATop, ARight, ABottom, sx, sy, ex, ey
-Returns: Nothing

+Returns: Nothing
+
Use Arc to draw an elliptically curved line with the current Pen. The values sx,sy, and ex,ey represent the starting and ending radial-points between which the Arc is drawn.
@@ -4573,7 +4633,8 @@ Use Arc to draw an elliptically curved line with the current Pen. The values sx, Params: ALeft, ATop, ARight, ABottom, angle1, angle2
-Returns: Nothing

+Returns: Nothing
+
Use Arc to draw an elliptically curved line with the current Pen.
@@ -4689,7 +4750,8 @@ Params: x1, y1, x2, y2, StartAngle16Deg, EndAngle16Deg
-Returns: Nothing

+Returns: Nothing
+
@@ -4822,7 +4884,8 @@ Zero degrees is at the 3 o'clock position. Params: X1, Y1, X2, Y2
-Returns: Nothing

+Returns: Nothing
+
Use Ellipse to draw a filled circle or ellipse on the canvas.
@@ -5099,7 +5162,8 @@ Params: x1, y1, x2, y2, StartAngle16Deg, EndAngle16Deg: Integer
-Returns: Nothing

+Returns: Nothing
+
@@ -5178,7 +5242,8 @@ Zero degrees is at the 3 o'clock position Params: EllipseX1, EllipseY1, EllipseX2, EllipseY2, StartX, StartY, EndX, EndY
-Returns: Nothing

+Returns: Nothing
+
Use Pie to draw a filled Pie-shaped wedge on the canvas. The pie is part of an ellipse between the points EllipseX1, EllipseY1, EllipseX2, EllipseY2. The values StartX, StartY and EndX, EndY represent the starting and ending radial-points between which the Bounding-Arc is drawn.
@@ -5246,7 +5311,8 @@ Params: Points, Filled, Continous
-Returns: Boolean

+Returns: Boolean
+
@@ -5261,15 +5327,18 @@ The first curve is drawn from the first point to the fourth point with the secon -If the Continuous flag is TRUE then each subsequent curve requires three more points, using the end-point of the previous Curve as its starting point, the first and second points being used as its control points, and the third point its end-point.

+If the Continuous flag is TRUE then each subsequent curve requires three more points, using the end-point of the previous Curve as its starting point, the first and second points being used as its control points, and the third point its end-point.
+
-If the continous flag is set to FALSE, then each subsequent Curve requires 4 additional points, which are used exactly as in the first curve.

+If the continous flag is set to FALSE, then each subsequent Curve requires 4 additional points, which are used exactly as in the first curve.
+
-Any additonal points which do not add up to a full bezier(4 for Continuous, 3 otherwise) are ingored. There must be at least 4 points for an drawing to occur.

+Any additonal points which do not add up to a full bezier(4 for Continuous, 3 otherwise) are ingored. There must be at least 4 points for an drawing to occur.
+
@@ -5340,7 +5409,8 @@ Params: Points: array of TPoint; Winding: Boolean = False; StartIndex: Integer -Returns: Nothing

+Returns: Nothing
+
@@ -5366,7 +5436,8 @@ Use Polygon -.

+.
+
@@ -5377,7 +5448,8 @@ The Points - parameter is an array of points that give the vertices of the polygon.
Winding + parameter is an array of points that give the vertices of the polygon.
+ Winding @@ -5414,12 +5486,14 @@ When Winding - uses the even-odd (alternative) fill algorithm.
StartIndex + uses the even-odd (alternative) fill algorithm.
+ StartIndex - gives the index of the first point in the array to use. All points before this are ignored.
NumPts + gives the index of the first point in the array to use. All points before this are ignored.
+ NumPts @@ -5523,7 +5597,8 @@ Params: Points: array of TPoint; StartIndex: Integer = 0; NumPts: Integer = -1 -Returns: Nothing

+Returns: Nothing
+
@@ -5561,13 +5636,15 @@ The Points - parameter is an array of points to be connected.
StartIndex + parameter is an array of points to be connected.
+ StartIndex - identifies the first point in the array to use.
NumPts + identifies the first point in the array to use.
+ NumPts @@ -5765,8 +5842,12 @@ Calling the MoveTo Writes Text string within a specified rectangle, according to predefined Style - Writes Text string within a specified rectangle, according to predefined Style
-The boundaries of the rectangle are specified in ARect
X, Y specify the starting point for writing the Text within the rectangle
TextStyle determines whether the text is justified, centered, word-wrapped etc. If the Style argument is omitted, defaults are assumed
+ Writes Text string within a specified rectangle, according to predefined Style +
+The boundaries of the rectangle are specified in ARect +
+ X, Y specify the starting point for writing the Text within the rectangle
+ TextStyle determines whether the text is justified, centered, word-wrapped etc. If the Style argument is omitted, defaults are assumed
@@ -11355,7 +11436,8 @@ This function checks that the value in - Returns a Bitmap of type TCustomBitMap + Returns a Bitmap of type TCustomBitMap + @@ -11404,6 +11486,2576 @@ This function checks that the value in Returns True if the supplied class is capable of reading graphic streams + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + TRasterImage - base class for a number of graphic controls, including TCustomBitmap and TCustomIcon, which use a raster of dots to display graphic information + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The Canvas on which this raster image is to be painted + + + + + + + HandleAllocated - if True, an Operating System handle has been allocated + + + + + + + + + + + + BitmapHandle - the Handle that has been allocated for the Bitmap + + + + + + + MaskHandle - the handle that has been allocated for the Bitmap Mask + + + + + + + + + + + + + TransparentColor - the colour used in transparent mode + + + + + + In TransparentMode ir is possible to see the underlying objects through the current image + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +