Docs: Updated documentation for LCL. Issue #35993, patch from Don Siders.

git-svn-id: trunk@61756 -
This commit is contained in:
juha 2019-08-24 21:52:20 +00:00
parent 7096bc4c00
commit b362e1d253
3 changed files with 4243 additions and 5418 deletions

View File

@ -2,323 +2,674 @@
<fpdoc-descriptions> <fpdoc-descriptions>
<package name="lcl"> <package name="lcl">
<!-- <!--
==================================================================== ====================================================================
GraphUtil GraphUtil
==================================================================== ====================================================================
--> -->
<module name="GraphUtil"> <module name="GraphUtil">
<short/> <short>
<descr/> Contains routines and types used when drawing graphics
<!-- unresolved type reference Visibility: default --> </short>
<element name="Types"> <descr>
<short/> <p>
<descr/> <var>GraphUtil.pp</var> contains routines and types used when drawing graphics. They focus primarily on converting colors and drawing gradients, scroll bars, and arrows.
<seealso/> </p>
</element> <p>
<!-- unresolved type reference Visibility: default --> It includes routines used to convert between both the HSL (hue, saturation, lightness) and HSV (hue, saturation, brightness value) alternative representations of the RGB color model. HSV models the way different colors mix together, with the saturation dimension resembling various tints of brightly colored paint, and the value dimension resembling the mixture of those paints with varying amounts of black or white paint. HSL places saturated colors around a circle at a lightness value of .5, where a lightness value of 0 or 1 is fully black or white (respectively).
<element name="Graphics"> </p>
<short/> <p>
<descr/> GraphUtil is used in the Lazarus IDE, in LCL WidgetSet components, and optional Lazarus components like FPReport, SynEdit, and TAChart.
<seealso/> </p>
</element> </descr>
<!-- unresolved type reference Visibility: default -->
<element name="Math"> <!-- unresolved type references Visibility: default -->
<short/> <element name="Types"/>
<descr/> <element name="Math"/>
<seealso/> <element name="Graphics"/>
</element> <element name="GraphType"/>
<!-- unresolved type reference Visibility: default --> <element name="LCLType"/>
<element name="LCLType"> <element name="LCLIntf"/>
<short/>
<descr/>
<seealso/>
</element>
<!-- function Visibility: default -->
<element name="ColorToGray"> <element name="ColorToGray">
<short/> <short>
<descr/> Converts a Lazarus TColor value to its grayscale equivalent
<errors/> </short>
<seealso/> <descr></descr>
<seealso></seealso>
</element> </element>
<!-- function result Visibility: default -->
<element name="ColorToGray.Result"> <element name="ColorToGray.Result">
<short/> <short>Byte contain the grayscale value for the specified color</short>
</element> </element>
<!-- argument Visibility: default -->
<element name="ColorToGray.AColor"> <element name="ColorToGray.AColor">
<short/> <short>TColor value converted in the method</short>
</element> </element>
<!-- procedure Visibility: default -->
<element name="ColorToHLS"> <element name="ColorToHLS">
<short/> <short>Converts a TColor value to its Hue, Lightness, and Saturation values</short>
<descr/> <descr></descr>
<errors/> <errors/>
<seealso/> <seealso></seealso>
</element> </element>
<!-- argument Visibility: default -->
<element name="ColorToHLS.AColor"> <element name="ColorToHLS.AColor">
<short/> <short>TColor value converted in the method</short>
</element> </element>
<!-- argument Visibility: default -->
<element name="ColorToHLS.H"> <element name="ColorToHLS.H">
<short/> <short>Hue value for the specified color</short>
</element> </element>
<!-- argument Visibility: default -->
<element name="ColorToHLS.L"> <element name="ColorToHLS.L">
<short/> <short>Lightness value for the specified color</short>
</element> </element>
<!-- argument Visibility: default -->
<element name="ColorToHLS.S"> <element name="ColorToHLS.S">
<short/> <short>Saturation value for the specified color</short>
</element> </element>
<!-- procedure Visibility: default -->
<element name="RGBtoHLS"> <element name="RGBtoHLS">
<short/> <short>
<descr/> Converts RGB color values to Hue, Lightness, and Saturation values
</short>
<descr></descr>
<errors/> <errors/>
<seealso/> <seealso></seealso>
</element> </element>
<!-- argument Visibility: default -->
<element name="RGBtoHLS.R"> <element name="RGBtoHLS.R">
<short/> <short></short>
</element> </element>
<!-- argument Visibility: default -->
<element name="RGBtoHLS.G"> <element name="RGBtoHLS.G">
<short/> <short></short>
</element> </element>
<!-- argument Visibility: default -->
<element name="RGBtoHLS.B"> <element name="RGBtoHLS.B">
<short/> <short></short>
</element> </element>
<!-- argument Visibility: default -->
<element name="RGBtoHLS.H"> <element name="RGBtoHLS.H">
<short/> <short></short>
</element> </element>
<!-- argument Visibility: default -->
<element name="RGBtoHLS.L"> <element name="RGBtoHLS.L">
<short/> <short></short>
</element> </element>
<!-- argument Visibility: default -->
<element name="RGBtoHLS.S"> <element name="RGBtoHLS.S">
<short/> <short></short>
</element> </element>
<!-- function Visibility: default -->
<element name="HLStoColor"> <element name="HLStoColor">
<short/> <short>
<descr/> Converts Hue, Lightness, and Saturation values to a TColor value
</short>
<descr></descr>
<errors/> <errors/>
<seealso/> <seealso></seealso>
</element> </element>
<!-- function result Visibility: default -->
<element name="HLStoColor.Result"> <element name="HLStoColor.Result">
<short/> <short></short>
</element> </element>
<!-- argument Visibility: default -->
<element name="HLStoColor.H"> <element name="HLStoColor.H">
<short/> <short></short>
</element> </element>
<!-- argument Visibility: default -->
<element name="HLStoColor.L"> <element name="HLStoColor.L">
<short/> <short></short>
</element> </element>
<!-- argument Visibility: default -->
<element name="HLStoColor.S"> <element name="HLStoColor.S">
<short/> <short></short>
</element> </element>
<!-- procedure Visibility: default -->
<element name="HLStoRGB"> <element name="HLStoRGB">
<short/> <short>
<descr/> Converts Hue, Lightness, and Saturation values to a RGB color values
</short>
<descr></descr>
<errors/> <errors/>
<seealso/> <seealso></seealso>
</element> </element>
<!-- argument Visibility: default -->
<element name="HLStoRGB.H"> <element name="HLStoRGB.H">
<short/> <short></short>
</element> </element>
<!-- argument Visibility: default -->
<element name="HLStoRGB.L"> <element name="HLStoRGB.L">
<short/> <short></short>
</element> </element>
<!-- argument Visibility: default -->
<element name="HLStoRGB.S"> <element name="HLStoRGB.S">
<short/> <short></short>
</element> </element>
<!-- argument Visibility: default -->
<element name="HLStoRGB.R"> <element name="HLStoRGB.R">
<short/> <short></short>
</element> </element>
<!-- argument Visibility: default -->
<element name="HLStoRGB.G"> <element name="HLStoRGB.G">
<short/> <short></short>
</element> </element>
<!-- argument Visibility: default -->
<element name="HLStoRGB.B"> <element name="HLStoRGB.B">
<short/> <short></short>
</element> </element>
<!-- procedure Visibility: default -->
<!-- HSV functions are copied from mbColorLib without changes -->
<element name="ColorToHSV">
<short>
Converts a TColor value to Hue, Saturation, and brightness Values
</short>
<descr></descr>
<seealso></seealso>
</element>
<element name="ColorToHSV.c">
<short></short>
</element>
<element name="ColorToHSV.H">
<short></short>
</element>
<element name="ColorToHSV.S">
<short></short>
</element>
<element name="ColorToHSV.V">
<short></short>
</element>
<element name="HSVToColor">
<short>
Converts Hue, Saturation, and brightness values to a TColor value
</short>
<descr></descr>
<seealso></seealso>
</element>
<element name="HSVToColor.Result">
<short></short>
</element>
<element name="HSVToColor.H">
<short></short>
</element>
<element name="HSVToColor.S">
<short></short>
</element>
<element name="HSVToColor.V">
<short></short>
</element>
<element name="RGBToHSV">
<short>
Comverts RGB values to Hue, Saturation, and brightness values
</short>
<descr></descr>
<seealso></seealso>
</element>
<element name="RGBToHSV.Result">
<short></short>
</element>
<element name="RGBToHSV.R">
<short></short>
</element>
<element name="RGBToHSV.G">
<short></short>
</element>
<element name="RGBToHSV.B">
<short></short>
</element>
<element name="RGBToHSV.H">
<short></short>
</element>
<element name="RGBToHSV.S">
<short></short>
</element>
<element name="RGBToHSV.V">
<short></short>
</element>
<element name="HSVtoRGB">
<short>
Converts Hue, Saturation, and brightness values to RGB values
</short>
<descr></descr>
<seealso></seealso>
</element>
<element name="HSVtoRGB.H">
<short></short>
</element>
<element name="HSVtoRGB.S">
<short></short>
</element>
<element name="HSVtoRGB.V">
<short></short>
</element>
<element name="HSVtoRGB.R">
<short></short>
</element>
<element name="HSVtoRGB.G">
<short></short>
</element>
<element name="HSVtoRGB.B">
<short></short>
</element>
<element name="RGBtoHSVRange">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<element name="RGBtoHSVRange.R">
<short></short>
</element>
<element name="RGBtoHSVRange.G">
<short></short>
</element>
<element name="RGBtoHSVRange.B">
<short></short>
</element>
<element name="RGBtoHSVRange.H">
<short></short>
</element>
<element name="RGBtoHSVRange.S">
<short></short>
</element>
<element name="RGBtoHSVRange.V">
<short></short>
</element>
<element name="RGBtoHSVRange.">
<short></short>
</element>
<element name="HSVtoRGBRange">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<element name="HSVtoRGBRange.H">
<short></short>
</element>
<element name="HSVtoRGBRange.S">
<short></short>
</element>
<element name="HSVtoRGBRange.V">
<short></short>
</element>
<element name="HSVtoRGBRange.R">
<short></short>
</element>
<element name="HSVtoRGBRange.G">
<short></short>
</element>
<element name="HSVtoRGBRange.B">
<short></short>
</element>
<element name="HSVRangeToColor">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<element name="HSVRangeToColor.Result">
<short></short>
</element>
<element name="HSVRangeToColor.H">
<short></short>
</element>
<element name="HSVRangeToColor.S">
<short></short>
</element>
<element name="HSVRangeToColor.V">
<short></short>
</element>
<element name="HSVtoRGBTriple">
<short>
Converts Hue, Saturation, and brightness values to a TRGBTriple value
</short>
<descr></descr>
<seealso></seealso>
</element>
<element name="HSVtoRGBTriple.Result">
<short></short>
</element>
<element name="HSVtoRGBTriple.H">
<short></short>
</element>
<element name="HSVtoRGBTriple.S">
<short></short>
</element>
<element name="HSVtoRGBTriple.V">
<short></short>
</element>
<element name="HSVtoRGBQuad">
<short>
Converts Hue, Saturation, and brightness values to a TRGBQuad value
</short>
<descr></descr>
<seealso></seealso>
</element>
<element name="HSVtoRGBQuad.Result">
<short></short>
</element>
<element name="HSVtoRGBQuad.H">
<short></short>
</element>
<element name="HSVtoRGBQuad.S">
<short></short>
</element>
<element name="HSVtoRGBQuad.V">
<short></short>
</element>
<element name="GetHValue">
<short>Gets the Hue value from the specified TColor value</short>
<descr></descr>
<seealso></seealso>
</element>
<element name="GetHValue.Result">
<short></short>
</element>
<element name="GetHValue.Color">
<short></short>
</element>
<element name="GetSValue">
<short>Gets the Saturation value from the specified TColor value</short>
<descr></descr>
<seealso></seealso>
</element>
<element name="GetSValue.Result">
<short>Saturation value for the specified color</short>
</element>
<element name="GetSValue.Color">
<short>Color examined in the routine</short>
</element>
<element name="GetVValue">
<short>Gets the brightness value from the specified TColor value</short>
<descr></descr>
<seealso></seealso>
</element>
<element name="GetVValue.Result">
<short>Brightness value for the specified color</short>
</element>
<element name="GetVValue.Color">
<short>Color examined in the routine</short>
</element>
<element name="DrawVerticalGradient"> <element name="DrawVerticalGradient">
<short/> <short>
<descr/> Draws a gradient from top to bottom with parabolic color variation
</short>
<descr></descr>
<errors/> <errors/>
<seealso/> <seealso></seealso>
</element> </element>
<!-- argument Visibility: default -->
<element name="DrawVerticalGradient.Canvas"> <element name="DrawVerticalGradient.Canvas">
<short/> <short>Canvas where the gradient is drawn</short>
</element> </element>
<!-- argument Visibility: default -->
<element name="DrawVerticalGradient.ARect"> <element name="DrawVerticalGradient.ARect">
<short/> <short>Rectangle that defines the drawing boundaries for the gradient</short>
</element> </element>
<!-- argument Visibility: default -->
<element name="DrawVerticalGradient.TopColor"> <element name="DrawVerticalGradient.TopColor">
<short/> <short>Color used at the top of the gradient</short>
</element> </element>
<!-- argument Visibility: default -->
<element name="DrawVerticalGradient.BottomColor"> <element name="DrawVerticalGradient.BottomColor">
<short/> <short>Color used at the end or bottom of the gradient</short>
</element> </element>
<!-- procedure Visibility: default -->
<element name="DrawGradientWindow"> <element name="DrawGradientWindow">
<short/> <short>
<descr/> Draws a window with a Title using gradient coloring
</short>
<descr></descr>
<errors/> <errors/>
<seealso/> <seealso></seealso>
</element> </element>
<!-- argument Visibility: default -->
<element name="DrawGradientWindow.Canvas"> <element name="DrawGradientWindow.Canvas">
<short/> <short>Canvas where the gradient is drawn</short>
</element> </element>
<!-- argument Visibility: default -->
<element name="DrawGradientWindow.WindowRect"> <element name="DrawGradientWindow.WindowRect">
<short/> <short>Rectangle for the window drawn using a gradient </short>
</element> </element>
<!-- argument Visibility: default -->
<element name="DrawGradientWindow.TitleHeight"> <element name="DrawGradientWindow.TitleHeight">
<short/> <short>Height of the the title bar in the window</short>
</element> </element>
<!-- argument Visibility: default -->
<element name="DrawGradientWindow.BaseColor"> <element name="DrawGradientWindow.BaseColor">
<short/> <short>Base color for the window</short>
</element> </element>
<!-- procedure Visibility: default -->
<element name="ColorRGBToHLS"> <element name="AntiAliasedStretchDrawBitmap">
<short/> <short>
<descr/> Stretch-draws a bitmap using anti-aliased drawing
<errors/> </short>
<seealso/> <descr></descr>
<seealso></seealso>
</element> </element>
<!-- argument Visibility: default --> <element name="AntiAliasedStretchDrawBitmap.SourceBitmap">
<element name="ColorRGBToHLS.clrRGB"> <short>Bitmap drawn in the routine</short>
<short/>
</element> </element>
<!-- argument Visibility: default --> <element name="AntiAliasedStretchDrawBitmap.DestBitmap">
<element name="ColorRGBToHLS.Hue"> <short>Bitmap where the new image is drawn</short>
<short/>
</element> </element>
<!-- argument Visibility: default --> <element name="AntiAliasedStretchDrawBitmap.DestWidth">
<element name="ColorRGBToHLS.Luminance"> <short>Width for the resized image</short>
<short/>
</element> </element>
<!-- argument Visibility: default --> <element name="AntiAliasedStretchDrawBitmap.DestHeight">
<element name="ColorRGBToHLS.Saturation"> <short>Height for the resized image</short>
<short/>
</element>
<!-- function Visibility: default -->
<element name="ColorHLSToRGB">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="ColorHLSToRGB.Result">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="ColorHLSToRGB.Hue">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="ColorHLSToRGB.Luminance">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="ColorHLSToRGB.Saturation">
<short/>
</element>
<!-- function Visibility: default -->
<element name="ColorAdjustLuma">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="ColorAdjustLuma.Result">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="ColorAdjustLuma.clrRGB">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="ColorAdjustLuma.n">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="ColorAdjustLuma.fScale">
<short/>
</element>
<!-- function Visibility: default -->
<element name="GetHighLightColor">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="GetHighLightColor.Result">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="GetHighLightColor.Color">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="GetHighLightColor.Luminance">
<short/>
</element>
<!-- function Visibility: default -->
<element name="GetShadowColor">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="GetShadowColor.Result">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="GetShadowColor.Color">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="GetShadowColor.Luminance">
<short/>
</element> </element>
<element name="TScrollDirection"> <element name="TScrollDirection">
<short/> <short>Enumerated type that indicates the direction for scrollbar arrows</short>
<descr></descr>
<seealso></seealso>
</element> </element>
<element name="TScrollDirection.sdLeft">
<short></short>
</element>
<element name="TScrollDirection.sdRight">
<short></short>
</element>
<element name="TScrollDirection.sdUp">
<short></short>
</element>
<element name="TScrollDirection.sdDown">
<short></short>
</element>
<element name="TArrowType"> <element name="TArrowType">
<short/> <short>Indicates the drawing style for an arrow</short>
<descr></descr>
<seealso></seealso>
</element> </element>
<element name="TArrowType.atSolid">
<short>Arrow is drawn using a solid, filled color</short>
</element>
<element name="TArrowType.atArrows">
<short>Arrow is drawn using chevrons</short>
</element>
<element name="NiceArrowAngle"> <element name="NiceArrowAngle">
<short/> <short></short>
<descr>
45*pi/180
</descr>
<seealso></seealso>
<notes><note>?</note></notes>
</element>
<element name="DrawArrow">
<short>Draws an arrow at the specified location on a canvas</short>
<descr>
DrawArrow is an overloaded procedure used to draw an arrow on a canvas at the specified location. Overloaded variants of the routine allow the type of arrow, length, angle, and drawing style to be specified in their arguments.
</descr>
<seealso></seealso>
</element>
<element name="DrawArrow.Canvas">
<short>Canvas where the arrow is drawn</short>
</element>
<element name="DrawArrow.Direction">
<short>Direction for the arrow</short>
</element>
<element name="DrawArrow.Location">
<short>Point that indictes the canvas coordinates where the arrow is drawn</short>
</element>
<element name="DrawArrow.Size">
<short></short>
</element>
<element name="DrawArrow.ArrowType">
<short>Drawing style for the arrow</short>
</element>
<element name="DrawArrow.p1">
<short></short>
</element>
<element name="DrawArrow.p2">
<short></short>
</element>
<element name="DrawArrow.ArrowLen">
<short></short>
</element>
<element name="DrawArrow.ArrowAngleRad">
<short></short>
</element>
<element name="FloodFill">
<short>
A simple first-in-first-out circular buffer (queue) for flood-filling contiguous voxels
</short>
<descr>
<p>
FloodFill is a procedure which implements a simple first-in-first-out circular buffer (queue) for flood-filling contiguous voxels. This algorithm avoids stack problems associated simple recursive algorithms described in the discussion at <url href="http://steve.hollasch.net/cgindex/polygons/floodfill.html"/>. Please note that is slow because of its use of Canvas.Pixels.
</p>
<p>
Orginal author: Chris Rorden
</p>
</descr>
<seealso></seealso>
</element>
<element name="FloodFill.Canvas">
<short></short>
</element>
<element name="FloodFill.X">
<short></short>
</element>
<element name="FloodFill.Y">
<short></short>
</element>
<element name="FloodFill.lColor">
<short></short>
</element>
<element name="FloodFill.FillStyle">
<short></short>
</element>
<element name="ColorRGBToHLS">
<short>
Converts an RGB color value to Hue, Lightness, and Saturation values
</short>
<descr></descr>
<errors/>
<seealso></seealso>
</element>
<element name="ColorRGBToHLS.clrRGB">
<short></short>
</element>
<element name="ColorRGBToHLS.Hue">
<short></short>
</element>
<element name="ColorRGBToHLS.Luminance">
<short></short>
</element>
<element name="ColorRGBToHLS.Saturation">
<short></short>
</element>
<element name="ColorHLSToRGB">
<short></short>
<descr></descr>
<errors/>
<seealso></seealso>
</element>
<element name="ColorHLSToRGB.Result">
<short></short>
</element>
<element name="ColorHLSToRGB.Hue">
<short></short>
</element>
<element name="ColorHLSToRGB.Luminance">
<short></short>
</element>
<element name="ColorHLSToRGB.Saturation">
<short></short>
</element>
<element name="ColorAdjustLuma">
<short></short>
<descr></descr>
<seealso></seealso>
<notes><note>?</note></notes>
</element>
<element name="ColorAdjustLuma.Result">
<short></short>
</element>
<element name="ColorAdjustLuma.clrRGB">
<short></short>
</element>
<element name="ColorAdjustLuma.n">
<short></short>
</element>
<element name="ColorAdjustLuma.fScale">
<short></short>
<notes><note>?</note></notes>
</element>
<element name="GetHighLightColor">
<short></short>
<descr></descr>
<errors/>
<seealso></seealso>
</element>
<element name="GetHighLightColor.Result">
<short></short>
</element>
<element name="GetHighLightColor.Color">
<short></short>
</element>
<element name="GetHighLightColor.Luminance">
<short></short>
</element>
<element name="GetShadowColor">
<short></short>
<descr></descr>
<errors/>
<seealso></seealso>
</element>
<element name="GetShadowColor.Result">
<short></short>
</element>
<element name="GetShadowColor.Color">
<short></short>
</element>
<element name="GetShadowColor.Luminance">
<short></short>
</element>
<element name="NormalizeRect">
<short>
Ensures that coordinates in the rectangle are in the correct order
</short>
<descr></descr>
<seealso></seealso>
</element>
<element name="NormalizeRect.Result">
<short>Rectangle with the corrected values for its coordinates</short>
</element>
<element name="NormalizeRect.R">
<short>Rectangle examined in the routine</short>
</element>
<element name="WaveTo">
<short>
Draws a hoizontal or vertical wave at the specified position to the given device context
</short>
<descr></descr>
<seealso></seealso>
</element>
<element name="WaveTo.ADC">
<short>Device context that is the target for the drawing operation</short>
</element>
<element name="WaveTo.X">
<short>Horizontal position where the wave is drawn</short>
</element>
<element name="WaveTo.Y">
<short>Vertical position where the wave is drawn</short>
</element>
<element name="WaveTo.R">
<short>Amplitude for changes in horizontal or vertical positions in the wave</short>
</element> </element>
<element name="DrawArrow"/>
</module> </module>
<!-- GraphUtil --> <!-- GraphUtil -->
</package> </package>

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff