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

Docs: Documentation update for LCL, LazUtils and LazControls. Issue #38287, patch from Don Siders.

Browse Source 
git-svn-id: trunk@64314 -
This commit is contained in:
juha 2020-12-31 20:32:21 +00:00
parent 33cb0bd3a6
commit 49384e3efc
32 changed files with 1130 additions and 1107 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitattributes vendored
View File

@ -6092,6 +6092,7 @@ docs/xml/lazutils/filereferencelist.xml svneol=native#text/plain
docs/xml/lazutils/fileutil.xml svneol=native#text/plain
docs/xml/lazutils/fpcadds.xml svneol=LF#text/xml eol=lf
docs/xml/lazutils/fpmake.xml svneol=native#text/plain
docs/xml/lazutils/graphmath.xml svneol=native#text/plain
docs/xml/lazutils/graphtype.xml svneol=LF#text/xml eol=lf
docs/xml/lazutils/html2textrender.xml svneol=native#text/plain
docs/xml/lazutils/integerlist.xml svneol=native#text/plain

3
components/lazcontrols/docs/dividerbevel.xml
View File

@ -11,13 +11,12 @@
<element name="Types"/>
<element name="Math"/>
<element name="LCLType"/>
<element name="LCLIntf"/>
<element name="Controls"/>
<element name="Graphics"/>
<element name="GraphType"/>
<element name="ComCtrls"/>
<element name="ExtCtrls"/>
<element name="Themes"/>
<element name="GraphType"/>
<element name="TDividerBevel">
<short>Line with text in the middle, used as a divider or header.</short>

6
components/lazcontrols/docs/lvlgraphctrl.xml
View File

@ -15,17 +15,17 @@
<element name="FPImage"/>
<element name="FPCanvas"/>
<element name="Laz_AVL_Tree"/>
<element name="LazLoggerBase"/>
<element name="AvgLvlTree"/>
<element name="LMessages"/>
<element name="LCLType"/>
<element name="LCLIntf"/>
<element name="GraphType"/>
<element name="Graphics"/>
<element name="Controls"/>
<element name="ImgList"/>
<element name="Forms"/>
<element name="Themes"/>
<element name="GraphType"/>
<element name="LazLoggerBase"/>
<element name="AvgLvlTree"/>
<element name="TLazCtrlPalette">
<short/>

529
docs/xml/lazutils/graphmath.xml Normal file
View File

@ -0,0 +1,529 @@
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="lazutils">
<!--
====================================================================
GraphMath
====================================================================
-->
<module name="GraphMath">
<short>A Set of Mathematical Helper routines to simply Cross-Platform Canvas drawing etc</short>
<descr/>
<!-- unresolved external references -->
<element name="Types"/>
<element name="Classes"/>
<element name="SysUtils"/>
<element name="Math"/>
<element name="LazUtilities"/>
<element name="TFloatPoint">
<short>
<var>TFloatPoint</var> - an extended precision record specifying the X and Y coordinates of a point in a graphic environment</short>
<descr/>
<seealso/>
</element>
<element name="TFloatPoint.X">
<short/>
</element>
<element name="TFloatPoint.Y">
<short/>
</element>
<element name="TBezier">
<short/>
<descr/>
<seealso/>
</element>
<element name="PPoint">
<short/>
<descr/>
<seealso/>
</element>
<element name="Angles2Coords">
<short>
<var>Angles2Coords</var> - convert an Eccentric Angle and an Angle-Length, into the coords for Start and End Radial-Points
</short>
<descr>
<p>
Use Angles2Coords to convert an Eccentric (aka Radial) Angle and an Angle-Length, such as are used in X-Windows and GTK, into the coords, for Start and End Radial-Points, such as are used in the Windows API Arc Pie and Chord routines. The angles are 1/16th of a degree. For example, a full circle equals 5760 (16*360). Positive values of Angle and AngleLength mean counter-clockwise while negative values mean clockwise direction. Zero degrees is at the 3 o'clock position.
</p>
</descr>
<seealso/>
</element>
<element name="Angles2Coords.X">
<short/>
</element>
<element name="Angles2Coords.Y">
<short/>
</element>
<element name="Angles2Coords.Width">
<short/>
</element>
<element name="Angles2Coords.Height">
<short/>
</element>
<element name="Angles2Coords.Angle1">
<short/>
</element>
<element name="Angles2Coords.Angle2">
<short/>
</element>
<element name="Angles2Coords.SX">
<short/>
</element>
<element name="Angles2Coords.SY">
<short/>
</element>
<element name="Angles2Coords.EX">
<short/>
</element>
<element name="Angles2Coords.EY">
<short/>
</element>
<element name="Arc2Bezier">
<short>
<var>Arc2Bezier</var> - convert an Arc and ArcLength into a Bezier Approximation of the Arc.</short>
<descr>
<p>
Use Arc2Bezier to convert an Arc and ArcLength into a Bezier Approximation of the Arc. The Rotation parameter accepts a Rotation-Angle for a rotated Ellipse'- for a non-rotated ellipse this value would be 0, or 360. If the AngleLength is greater than 90 degrees, or is equal to 0, it automatically exits, as Bezier cannot accurately approximate any angle greater then 90 degrees, and in fact for best result no angle greater than 45 should be converted, instead an array of Bezier's should be created, each Bezier describing a portion of the total arc no greater than 45 degrees. The angles are 1/16th of a degree. For example, a full circle equals 5760 (16*360). Positive values of Angle and AngleLength mean counter-clockwise while negative values mean clockwise direction. Zero degrees is at the 3 o'clock position.
</p>
</descr>
<seealso/>
</element>
<element name="Arc2Bezier.X">
<short/>
</element>
<element name="Arc2Bezier.Y">
<short/>
</element>
<element name="Arc2Bezier.Width">
<short/>
</element>
<element name="Arc2Bezier.Height">
<short/>
</element>
<element name="Arc2Bezier.Angle1">
<short/>
</element>
<element name="Arc2Bezier.Angle2">
<short/>
</element>
<element name="Arc2Bezier.Rotation">
<short/>
</element>
<element name="Arc2Bezier.Points">
<short/>
</element>
<element name="Bezier">
<short>
<var>Bezier</var> - function to get a Bezier figure from the given points
</short>
<descr/>
<seealso/>
</element>
<element name="Bezier.Result">
<short/>
</element>
<element name="Bezier.C1">
<short/>
</element>
<element name="Bezier.C2">
<short/>
</element>
<element name="Bezier.C3">
<short/>
</element>
<element name="Bezier.C4">
<short/>
</element>
<element name="Bezier2Polyline">
<short>
<var>Bezier2Polyline</var> - convert a 4-Point Bezier into a Pointer Array of TPoint and a Count variable
</short>
<descr>
<p>
Use BezierToPolyline to convert a 4-Point Bezier into a Pointer Array of TPoint and a Count variable which can then be used within either a Polyline, or Polygon routine. It is primarily for use within PolyBezier2Polyline. If Points is not initialized or Count is less then 0, it is set to nil and the array starts at 0, otherwise it tries to append points to the array starting at Count. Points should ALWAYS be Freed when done by calling to ReallocMem(Points, 0) or FreeMem.
</p>
</descr>
<errors/>
<seealso/>
</element>
<element name="Bezier2Polyline.Bezier">
<short/>
</element>
<element name="Bezier2Polyline.Points">
<short/>
</element>
<element name="Bezier2Polyline.Count">
<short/>
</element>
<element name="BezierArcPoints">
<short>
<var>BezierArcPoints</var> - convert an Arc and ArcLength into a Pointer Array of TPoints for use with Polyline or Polygon
</short>
<descr>
<p>
Use BezierArcPoints to convert an Arc and ArcLength into a Pointer Array of TPoints for use with Polyline or Polygon. The Rotation parameter accepts a Rotation-Angle for a rotated Ellipse'- for a non-rotated ellipse this value would be 0, or 360. The result is an Approximation based on 1 or more Beziers. If the AngleLength is greater than 90 degrees, it calls PolyBezierArcPoints, otherwise it Converts the angles into a Bezier by calling to Arc2Bezier, and then converts the Bezier into an array of Points by calling to Bezier2Polyline. The angles are 1/16th of a degree. For example, a full circle equals 5760 (16*360). Positive values of Angle and AngleLength mean counter-clockwise while negative values mean clockwise direction. Zero degrees is at the 3'o clock position. If Points is not initialized or Count is less then 0, it is set to nil and the array starts at 0, otherwise it tries to append points to the array starting at Count. Points should ALWAYS be Freed when done by calling ReallocMem(Points, 0) or FreeMem.
</p>
</descr>
<errors/>
<seealso/>
</element>
<element name="BezierArcPoints.X">
<short/>
</element>
<element name="BezierArcPoints.Y">
<short/>
</element>
<element name="BezierArcPoints.Width">
<short/>
</element>
<element name="BezierArcPoints.Height">
<short/>
</element>
<element name="BezierArcPoints.Angle1">
<short/>
</element>
<element name="BezierArcPoints.Angle2">
<short/>
</element>
<element name="BezierArcPoints.Rotation">
<short/>
</element>
<element name="BezierArcPoints.Points">
<short/>
</element>
<element name="BezierArcPoints.Count">
<short/>
</element>
<element name="BezierMidPoint">
<short>
<var>BezierMidPoint</var> - get the Mid-Point of any 4-Point Bezier. It is primarily for use in SplitBezier.
</short>
<descr/>
<seealso/>
</element>
<element name="BezierMidPoint.Result">
<short/>
</element>
<element name="BezierMidPoint.Bezier">
<short/>
</element>
<element name="CenterPoint">
<short>
<var>CenterPoint</var> - get the Center-Point of any rectangle. It is primarily for use with, and in, other routines such as Quadrant, and RadialPoint
</short>
<descr/>
<seealso/>
</element>
<element name="CenterPoint.Result">
<short/>
</element>
<element name="CenterPoint.Rect">
<short/>
</element>
<element name="Coords2Angles">
<short>
<var>Coords2Angles</var> - convert the coords for Start and End Radial-Points into an Eccentric counter clockwise Angle and an Angle-Length
</short>
<descr>
<p>
Use Coords2Angles to convert the coords for Start and End Radial-Points, such as are used in the Windows API Arc Pie and Chord routines, into an Eccentric (aka Radial) counter clockwise Angle and an Angle-Length, such as are used in X-Windows and GTK. The angles angle1 and angle2 are returned in 1/16th of a degree. For example, a full circle equals 5760 (16*360). Zero degrees is at the 3 o'clock position.
</p>
</descr>
<errors/>
<seealso/>
</element>
<element name="Coords2Angles.X">
<short/>
</element>
<element name="Coords2Angles.Y">
<short/>
</element>
<element name="Coords2Angles.Width">
<short/>
</element>
<element name="Coords2Angles.Height">
<short/>
</element>
<element name="Coords2Angles.SX">
<short/>
</element>
<element name="Coords2Angles.SY">
<short/>
</element>
<element name="Coords2Angles.EX">
<short/>
</element>
<element name="Coords2Angles.EY">
<short/>
</element>
<element name="Coords2Angles.Angle1">
<short/>
</element>
<element name="Coords2Angles.Angle2">
<short/>
</element>
<element name="Distance">
<short>
Get the <var>Distance</var> between any two Points. It is primarily for use in other routines such as EccentricAngle
</short>
<descr/>
<seealso/>
</element>
<element name="Distance.Result">
<short/>
</element>
<element name="Distance.PT1">
<short/>
</element>
<element name="Distance.Pt2">
<short/>
</element>
<element name="EccentricAngle">
<short>
<var>EccentricAngle</var> - get the Eccentric Angle of a given point on any non-rotated ellipse
</short>
<descr>
<p>
Use EccentricAngle to get the Eccentric( aka Radial ) Angle of a given point on any non-rotated ellipse. It is primarily for use in Coords2Angles. The result is in 1/16th of a degree. For example, a full circle equals 5760 (16*360). Zero degrees is at the 3 o'clock position.
</p>
</descr>
<errors/>
<seealso/>
</element>
<element name="EccentricAngle.Result">
<short/>
</element>
<element name="EccentricAngle.PT">
<short/>
</element>
<element name="EccentricAngle.Rect">
<short/>
</element>
<element name="EllipseRadialLength">
<short>
<var>EllipseRadialLength</var> - Radial-Length of non-rotated ellipse at any given Eccentric Angle
</short>
<descr>
<p>
Use EllipseRadialLength to get the Radial-Length of non-rotated ellipse at any given Eccentric( aka Radial ) Angle. It is primarily for use in other routines such as RadialPoint. The Eccentric angle is in 1/16th of a degree. For example, a full circle equals 5760 (16*360). Zero degrees is at the 3 o'clock position.
</p>
</descr>
<errors/>
<seealso/>
</element>
<element name="EllipseRadialLength.Result">
<short/>
</element>
<element name="EllipseRadialLength.Rect">
<short/>
</element>
<element name="EllipseRadialLength.EccentricAngle">
<short/>
</element>
<element name="FloatPoint">
<short>
<var>FloatPoint</var> - it is essentially like Classes.Point in use, except that it accepts Extended Parameters. It is Primarily for use with and in Bezier routines.
</short>
<descr/>
<seealso/>
</element>
<element name="FloatPoint.Result">
<short/>
</element>
<element name="FloatPoint.AX">
<short/>
</element>
<element name="FloatPoint.AY">
<short/>
</element>
<element name="LineEndPoint">
<short>
<var>LineEndPoint</var> - get the End-Point of a line of any given Length at any given angle with any given Start-Point
</short>
<descr>
<p>
Use LineEndPoint to get the End-Point of a line of any given Length at any given angle with any given Start-Point. It is primarily for use in other routines such as RadialPoint. The angle is in 1/16th of a degree. For example, a full circle equals 5760 (16*360). Zero degrees is at the 3 o'clock position.
</p>
</descr>
<errors/>
<seealso/>
</element>
<element name="LineEndPoint.Result">
<short/>
</element>
<element name="LineEndPoint.StartPoint">
<short/>
</element>
<element name="LineEndPoint.Angle">
<short/>
</element>
<element name="LineEndPoint.Length">
<short/>
</element>
<element name="PolyBezier2Polyline">
<short>
<var>PolyBezier2Polyline</var> - convert an array of 4-Point Bezier into a Pointer Array of TPoint and a Count variable
</short>
<descr>
<p>
Use BezierToPolyline to convert an array of 4-Point Bezier into a Pointer Array of TPoint and a Count variable which can then be used within either a Polyline, or Polygon routine. Points is automatically initialized, so any existing information is lost, and the array starts at 0. Points should ALWAYS be Freed when done by calling to ReallocMem(Points, 0).
</p>
</descr>
<errors/>
<seealso/>
</element>
<element name="PolyBezier2Polyline.Beziers">
<short/>
</element>
<element name="PolyBezier2Polyline.Points">
<short/>
</element>
<element name="PolyBezier2Polyline.Count">
<short/>
</element>
<element name="PolyBezierArcPoints">
<short>
<var>PolyBezierArcPoints</var> - convert an Arc and ArcLength into a Pointer Array of TPoints for use with Polyline or Polygon
</short>
<descr>
<p>
Use PolyBezierArcPoints to convert an Arc and ArcLength into a Pointer Array of TPoints for use with Polyline or Polygon. The Rotation parameter accepts a Rotation-Angle for a rotated Ellipse'- for a non-rotated ellipse this value would be 0, or 360. The result is an Approximation based on 1 or more Beziers. If the AngleLength is greater than 45 degrees, it recursively breaks the Arc into Arcs of 45 degrees or less, and converts them into Beziers with BezierArcPoints. The angles are 1/16th of a degree. For example, a full circle equals 5760 (16*360). Positive values of Angle and AngleLength mean counter-clockwise while negative values mean clockwise direction. Zero degrees is at the 3'o clock position. Points is automatically initialized, so any existing information is lost, and the array starts at 0. Points should ALWAYS be Freed when done by calling to ReallocMem(Points, 0).
</p>
</descr>
<errors/>
<seealso/>
</element>
<element name="PolyBezierArcPoints.X">
<short/>
</element>
<element name="PolyBezierArcPoints.Y">
<short/>
</element>
<element name="PolyBezierArcPoints.Width">
<short/>
</element>
<element name="PolyBezierArcPoints.Height">
<short/>
</element>
<element name="PolyBezierArcPoints.Angle1">
<short/>
</element>
<element name="PolyBezierArcPoints.Angle2">
<short/>
</element>
<element name="PolyBezierArcPoints.Rotation">
<short/>
</element>
<element name="PolyBezierArcPoints.Points">
<short/>
</element>
<element name="PolyBezierArcPoints.Count">
<short/>
</element>
<element name="Quadrant">
<short>Determine the <var>Quadrant</var> of any point, given the Center</short>
<descr>
<p>
Use Quadrant to determine the Quadrant of any point, given the Center. It is primarily for use in other routines such as EccentricAngle. A result of 1-4 represents the primary 4 quadrants. A result of 5-8 means the point lies on one of the Axis', 5 = -Y Axis, 6 = +X Axis, 7 = +Y Axis, and 8 = -X Axis. A result of -1 means that it does not fall in any quadrant, that is, it is the Center.
</p>
</descr>
<errors/>
<seealso/>
</element>
<element name="Quadrant.Result">
<short/>
</element>
<element name="Quadrant.PT">
<short/>
</element>
<element name="Quadrant.Center">
<short/>
</element>
<element name="RadialPoint">
<short>Get the <var>RadialPoint</var> at any given Eccentric angle on any non-rotated ellipse</short>
<descr>
<p>
Use RadialPoint to get the Radial-Point at any given Eccentric( aka Radial ) angle on any non-rotated ellipse. It is primarily for use in Angles2Coords. The EccentricAngle is in 1/16th of a degree. For example, a full circle equals 5760 (16*360). Zero degrees is at the 3 o'clock position.
</p>
</descr>
<seealso/>
</element>
<element name="RadialPoint.Result">
<short/>
</element>
<element name="RadialPoint.EccentricAngle">
<short/>
</element>
<element name="RadialPoint.Rect">
<short/>
</element>
<element name="SplitBezier">
<short>
<var>SplitBezier</var> - split any 4-Point Bezier into two 4-Point Beziers: a 'Left' and a 'Right'
</short>
<descr>
<p>
Use SplitBezier to split any 4-Point Bezier into two 4-Point Beziers: a 'Left' and a 'Right'. It is primarily for use in Bezier2Polyline.
</p>
</descr>
<errors/>
<seealso/>
</element>
<element name="SplitBezier.Bezier">
<short/>
</element>
<element name="SplitBezier.Left">
<short/>
</element>
<element name="SplitBezier.Right">
<short/>
</element>
<topic name="GraphMathOperators">
<short>
<b>GraphMath Operators</b>
</short>
<descr>
<p>
This Unit contains a number of routines for calculating and converting series of graphic points from one coordinate system to another.
</p>
<p>
A fundamental type is introduced, called TFloatPoint. It is an extended precision record containing an X and a Y coordinate for a graphic point. Its structure is as follows:
</p>
<code>type
TFloatPoint = record
X, Y : Extended;
end;</code>
<p>
The unit contains definitions for mathematical operators which extend the normal definitions of addition, subtraction, multiplication, division and comparison to cover manipulations with TFloatPoints, allowing, for example, addition or multiplication of two TFloatPoints, a TFloatPoint and a TPoint, or a TFloatPoint and an Extended Precision number.
</p>
</descr>
</topic>
</module>
<!-- GraphMath -->
</package>
</fpdoc-descriptions>

31
docs/xml/lazutils/graphtype.xml
View File

@ -9,30 +9,15 @@
<module name="GraphType">
<short>Definitions of several special types (including Raw Image) to be used for graphics</short>
<descr/>
<!-- unresolved type reference Visibility: default -->
<element name="Classes">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="SysUtils">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="LCLType">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="LCLProc">
<short/>
<descr/>
<seealso/>
</element>
<element name="Classes"/>
<element name="SysUtils"/>
<element name="Types"/>
<element name="Math"/>
<element name="FPCAdds"/>
<element name="LazLoggerBase"/>
<!-- range type Visibility: default -->
<element name="TGraphicsColor">
<short/>

155
docs/xml/lazutils/lazutilities.xml
View File

@ -16,134 +16,172 @@
<element name="TypInfo"/>
<element name="FreeThenNil">
<short></short>
<descr></descr>
<seealso></seealso>
<short>Ensures that the specified object instance is freed and set to Nil</short>
<descr>
<var>FreeThenNil</var> is a procedure used to ensure that the object instance in <var>obj</var> is freed and set to Nil. If obj has been assigned, it is cast to a <var>TObject</var> instance and its Free method is called. Finally, the pointer to the address in obj is set to Nil.
</descr>
<seealso/>
</element>
<element name="FreeThenNil.obj">
<short></short>
<short>Object instance modified in the routine</short>
</element>
<!-- function Visibility: default -->
<element name="ComparePointers">
<short></short>
<descr></descr>
<errors></errors>
<seealso></seealso>
<short>Gets the relative order for the specified Pointers</short>
<descr>
<p>
<var>ComparePointers</var> is an <var>Integer</var> function used to get the relative order for the specified Pointer values. The following return values are used in the routine:
</p>
<dl>
<dt>1</dt>
<dd>Returned when p1 &gt; p2.</dd>
<dt>0</dt>
<dd>Returned when p1 = p2.</dd>
<dt>-1</dt>
<dd>Returned when p1 &lt; p2.</dd>
</dl>
</descr>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="ComparePointers.Result">
<short></short>
<short>Numeric value with the relative order for the compared Pointers</short>
</element>
<!-- argument Visibility: default -->
<element name="ComparePointers.p1">
<short></short>
<short>Pointer compared in the routine</short>
</element>
<!-- argument Visibility: default -->
<element name="ComparePointers.p2">
<short></short>
<short>Pointer compared in the routine</short>
</element>
<element name="CompareBoolean">
<short></short>
<descr></descr>
<seealso></seealso>
<short>Compares the specified Boolean values</short>
<descr>
<dl>
<dt>0</dt>
<dd>Returned when b1 and b2 have the same value.</dd>
<dt>1</dt>
<dd>Returned when b1 is True.</dd>
<dt>-1</dt>
<dd>Returned as the default value (when b1 is False ).</dd>
</dl>
</descr>
<seealso/>
</element>
<element name="CompareBoolean.Result">
<short></short>
<short>Numeric value for the comparison</short>
</element>
<element name="CompareBoolean.b1">
<short></short>
<short>Boolean value compared in the routine</short>
</element>
<element name="CompareBoolean.b2">
<short></short>
<short>Boolean value compared in the routine</short>
</element>
<element name="GetEnumValueDef">
<short/>
<descr/>
<seealso/>
<short>Gets the ordinal position for an enumeration value with the specified name</short>
<descr>
<p>
<var>GetEnumValueDef</var> is an <var>Integer</var> function used to get the ordinal position in the specified enumeration type insformation for the value with the given name.
</p>
<p>
The return value contains the ordinal position in <var>TypeInfo</var> for the enumeration value with the given <var>Name</var>. GetEnumValueDef calls <var>GetEnumValue</var> to find the value in Name in the type information. If the return value is <b>-1</b>, an enumeration value with the specified name is not found in TypeInfo and the value in <var>DefaultValue</var> is used as the return value.
</p>
</descr>
<seealso>
<link id="#rtl.typinfo.GetEnumValue"/>
<link id="#rtl.typinfo.PTypeInfo"/>
</seealso>
</element>
<element name="GetEnumValueDef.Result">
<short/>
<short>Ordinal position for the enumeration value with the specified name</short>
</element>
<element name="GetEnumValueDef.TypeInfo">
<short/>
<short>Pointer to the type information examined in the routine</short>
</element>
<element name="GetEnumValueDef.Name">
<short/>
<short>Name for the enumeration value to locate in TypeInfo</short>
</element>
<element name="GetEnumValueDef.DefaultValue">
<short/>
<short>Default ordinal position for the enumeration value used when Name is not found</short>
</element>
<element name="RoundToInt">
<short/>
<descr/>
<short>Rounds the specified Extended value to an Integer value</short>
<descr>
<p>
Calls <var>Round</var> to round the <var>Extended</var> value, and casts the result to the <var>Integer</var> type used as the return value.
</p>
</descr>
<seealso/>
</element>
<element name="RoundToInt.Result">
<short/>
<short>Integer value for the rounded numeric value</short>
</element>
<element name="RoundToInt.e">
<short/>
<short>Extended type rounded and converted in the routine</short>
</element>
<element name="RoundToCardinal">
<short/>
<descr/>
<short>Rounds the specified Extended value to a Cardinal value</short>
<descr>
<p>
Calls <var>Round</var> to round the <var>Extended</var> value, and casts the result to the <var>Cardinal</var> type used as the return value.
</p>
</descr>
<seealso/>
</element>
<element name="RoundToCardinal.Result">
<short/>
<short>Cardinal value for the rounded numeric value</short>
</element>
<element name="RoundToCardinal.e">
<short/>
<short>Extended type rounded and converted in the routine</short>
</element>
<element name="TruncToInt">
<short/>
<short>Truncates the extended value and returns an Integer type</short>
<descr/>
<seealso/>
</element>
<element name="TruncToInt.Result">
<short/>
<short>Integer type with the truncated value</short>
</element>
<element name="TruncToInt.e">
<short/>
<short>Extended value truncated and converted in the routine</short>
</element>
<element name="TruncToCardinal">
<short/>
<short>Truncates the extended value and returns a Cardinal type</short>
<descr/>
<seealso/>
</element>
<element name="TruncToCardinal.Result">
<short/>
<short>Cardinal type with the truncated value</short>
</element>
<element name="TruncToCardinal.e">
<short/>
<short>Extended value truncated and converted in the routine</short>
</element>
<element name="StrToDouble">
<short/>
<descr/>
<short>Converts the specified string value to a Double type</short>
<descr>
<p>
Calls <var>StrToFloat</var> to convert the value in <var>s</var>, and casts the result to the <var>Double</var> data type used as the return value.
</p>
</descr>
<seealso/>
</element>
<element name="StrToDouble.Result">
<short/>
<short>Double type with the converted value</short>
</element>
<element name="StrToDouble.s">
<short/>
<short>String value converted in the routine</short>
</element>
<element name="MergeSortWithLen">
<short></short>
<descr></descr>
<seealso></seealso>
<notes><note>?</note></notes>
</element>
<element name="MergeSortWithLen.List">
<short></short>
@ -157,9 +195,24 @@
<element name="ConsoleVerbosity">
<short></short>
<descr></descr>
<seealso></seealso>
<descr>
<p>
<var>ConsoleVerbosity</var> is an Integer variable which indicates the level of detail output from tools like pas2js and CodeTools. ConsoleVerbosity enables debugger output for specific levels of detail.
</p>
<dl>
<dt>-1</dt>
<dd>Quiet</dd>
<dt>0</dt>
<dd>Normal verbosity (No debugger output)</dd>
<dt>1</dt>
<dd>Verbose (Debugger output enabled)</dd>
<dt>2</dt>
<dd>Very verbose (Debugger output enabled)</dd>
</dl>
</descr>
<seealso/>
</element>
</module>
<!-- LazUtilities -->
</package>

102
docs/xml/lcl/asyncprocess.xml
View File

@ -1,7 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="lcl">
<!--
====================================================================
AsyncProcess
@ -10,62 +9,37 @@
<module name="AsyncProcess">
<short>
Defines a process with asynchronous event notifications for data
Implements a process with asynchronous event notifications
</short>
<descr></descr>
<!-- unresolved type reference Visibility: default -->
<element name="Classes">
<short></short>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="Process">
<short></short>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="InterfaceBase">
<short></short>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="LCLIntf">
<short></short>
</element>
<!-- unresolved references -->
<element name="Classes"/>
<element name="Process"/>
<element name="FileUtil"/>
<element name="UTF8Process"/>
<element name="InterfaceBase"/>
<element name="LCLIntf"/>
<!-- object Visibility: default -->
<element name="TAsyncProcess" link="#lazutils.TProcessUTF8">
<element name="TAsyncProcess">
<short>
Implements a process with asynchronous notifications for data and termination
</short>
<descr>
<p>
<var>TAsyncProcess</var> is a <var>TProcessUTF8</var> descendant which implements support for asynchronous notifications when data is available for the process. Internally, TAsyncProcess uses pipe and process handlers to detect when data is written to the Output handle, and when the process is terminated. TAsyncProcess provides OnReadData and OnTerminate event handlers signalled for the corresponding asynchronous notifications.
<var>TAsyncProcess</var> is a <var>TProcessUTF8</var> descendant which implements support for asynchronous notifications when data is available for the process. Internally, TAsyncProcess uses pipe and process handlers to detect when data is written to the Output handle, and when the process is terminated. TAsyncProcess provides <var>OnReadData</var> and <var>OnTerminate</var> event handlers signalled for the corresponding asynchronous notifications.
</p>
</descr>
<seealso></seealso>
<seealso>
<link id="#lazutils.TProcessUTF8"/>
</seealso>
</element>
<!-- variable Visibility: private -->
<element name="TAsyncProcess.FPipeHandler">
<short></short>
</element>
<!-- variable Visibility: private -->
<element name="TAsyncProcess.FProcessHandler">
<short></short>
</element>
<!-- variable Visibility: private -->
<element name="TAsyncProcess.FOnReadData">
<short></short>
</element>
<!-- variable Visibility: private -->
<element name="TAsyncProcess.FOnTerminate">
<short></short>
</element>
<element name="TAsyncProcess.FPipeHandler"/>
<element name="TAsyncProcess.FProcessHandler"/>
<element name="TAsyncProcess.FOnReadData"/>
<element name="TAsyncProcess.FOnTerminate"/>
<!-- function Visibility: protected -->
<element name="TAsyncProcess.GetNumBytesAvailable">
@ -74,13 +48,13 @@
</short>
<descr>
<p>
<var>GetNumBytesAvailable</var> is a dword function used to get the value for the <var>NumBytesAvailable</var> property. The return value contains the value in <var>Output.NumBytesAvailable</var>, or 0 (zero) when <var>Options</var> does not include the value <var>poUsePipes</var>.
<var>GetNumBytesAvailable</var> is a <var>dword</var> function used to get the value for the <var>NumBytesAvailable</var> property. The return value contains the value in <var>Output.NumBytesAvailable</var>, or 0 (zero) when <var>Options</var> does not include the value <var>poUsePipes</var>.
</p>
<p>
Use NumBytesAvailable to read the value for the property.
Use <var>NumBytesAvailable</var> to access the value for the property.
</p>
<p>
Use Options to enable the Options for the process.
Use <var>Options</var> to enable the <var>Options</var> for the process.
</p>
</descr>
<seealso></seealso>
@ -94,17 +68,17 @@
<!-- procedure Visibility: protected -->
<element name="TAsyncProcess.HandlePipeInput">
<short>
Implements support for asynchronous notifications during execution of the process
Implements asynchronous notifications during execution of the process
</short>
<descr>
<p>
<var>HandlePipeInput</var> is a procedure which implements support for asynchronous notifications which occur during execution of the process. HandlePipeInput is assigned using AddPipeEventHandler when Execute is called.
<var>HandlePipeInput</var> is a procedure which implements support for asynchronous notifications which occur during execution of the process. HandlePipeInput is assigned using <var>AddPipeEventHandler</var> when <var>Execute</var> is called.
</p>
<p>
HandlePipeInput examines values in AReasons to determine the action for the notification. When AReasons includes the value prBroken, the pipe has been closed and UnhookPipeHandle is called. When prDataAvailable is included in AReasons, the OnReadData event handler is signalled (when assigned).
HandlePipeInput examines values in <var>AReasons</var> to determine the action for the notification. When AReasons includes the value <var>prBroken</var>, the pipe has been closed and <var>UnhookPipeHandle</var> is called. When <var>prDataAvailable</var> is included in AReasons, the <var>OnReadData</var> event handler is signalled (when assigned).
</p>
<p>
Use OnReadData to respond to arrival of data on the handle for the process. Use NumBytesAvailable is determine the number of bytes available.
Use <var>OnReadData</var> to respond to arrival of data on the handle for the process. Use <var>NumBytesAvailable</var> is determine the number of bytes available.
</p>
</descr>
<seealso></seealso>
@ -127,10 +101,10 @@
</short>
<descr>
<p>
<var>HandleProcessTermination</var> is a procedure which performs actions needed when the process is terminated. HandleProcessTermination is assigned using AddProcessEventHandler when Execute is called.
<var>HandleProcessTermination</var> is a procedure which performs actions needed when the process is terminated. HandleProcessTermination is assigned using <var>AddProcessEventHandler</var> when <var>Execute</var> is called.
</p>
<p>
HandleProcessTermination calls UnhookProcessHandle and UnhookPipeHandle to release the handlers in the class instance. HandleProcessTermination signals the OnTerminate event handler when it has been assigned.
HandleProcessTermination calls <var>UnhookProcessHandle</var> and <var>UnhookPipeHandle</var> to release the handlers in the class instance. HandleProcessTermination signals the <var>OnTerminate</var> event handler when it has been assigned.
</p>
</descr>
<seealso></seealso>
@ -158,7 +132,7 @@
</short>
<descr>
<p>
<var>UnhookPipeHandle</var> is a procedure used to remove the pipe handler assigned for the process in the Execute method. UnhookPipeHandle calls RemovePipeEventHandler when it has been assigned. UnhookPipeHandle is called in the Destroy method.
<var>UnhookPipeHandle</var> is a procedure used to remove the pipe handler assigned for the process in the <var>Execute</var> method. UnhookPipeHandle calls <var>RemovePipeEventHandler</var> when it has been assigned. <var>UnhookPipeHandle</var> is called in the <var>Destroy</var> method.
</p>
</descr>
<seealso></seealso>
@ -171,8 +145,7 @@
</short>
<descr>
<p>
<var>UnhookProcessHandle</var> is a procedure used to remove the process handler assigned for the process in the Execute method. UnhookProcessHandle calls RemoveProcessEventHandler when it has been assigned. UnhookProcessHandle
is called in the Destroy method.
<var>UnhookProcessHandle</var> is a procedure used to remove the process handler assigned for the process in the <var>Execute</var> method. UnhookProcessHandle calls <var>RemoveProcessEventHandler</var> when it has been assigned. <var>UnhookProcessHandle</var> is called in the <var>Destroy</var> method.
</p>
</descr>
<seealso></seealso>
@ -185,13 +158,13 @@
</short>
<descr>
<p>
<var>Execute</var> is an overridden procedure used to execute the process. Execute calls the inherited Execute method. Execute uses values in Options to determine if a process or a pipe handler is needed for the class instance. Set the values in Options prior to calling the Execute method.
<var>Execute</var> is an overridden procedure used to execute the process. Execute calls the inherited Execute method. Execute uses values in <var>Options</var> to determine if a process or a pipe handler is needed for the class instance. Set the values in Options prior to calling the Execute method.
</p>
<p>
When Options includes the value poUsePipes, AddPipeEventHandler is called using HandlePipeInput as the pipe handler.
When Options includes the value <var>poUsePipes</var>, <var>AddPipeEventHandler</var> is called using <var>HandlePipeInput</var> as the pipe handler routine.
</p>
<p>
Execute calls AddProcessEventHandler using HandleProcessTermination as the process handle.
Execute calls <var>AddProcessEventHandler</var> using <var>HandleProcessTermination</var> as the process handler routine.
</p>
</descr>
<seealso></seealso>
@ -200,16 +173,17 @@
<!-- property Visibility: published -->
<element name="TAsyncProcess.NumBytesAvailable">
<short>
Number of output bytes available from the process
</short>
<descr>
<p>
<var>NumBytesAvailable</var> is a read-only dword property that indicates the number of bytes available on the Output handle for the process. GetNumBytesAvailable is the read access specifier for the property value. NumBytesAvailable contains the value in Output.NumBytesAvailable, or 0 (zero) when Options does not contain the value poUsePipes.
<var>NumBytesAvailable</var> is a read-only <var>name</var> property that indicates the number of bytes available on the Output handle for the process. <var>GetNumBytesAvailable</var> is the read access specifier for the property value. NumBytesAvailable contains the value in Output.NumBytesAvailable, or 0 (zero) when <var>Options</var> does not contain the value <var>poUsePipes</var>.
</p>
<p>
Set the values for the Options property prior to calling Execute.
Set the values for the <var>Options</var> property prior to calling <var>Execute</var>.
</p>
<p>
Use OnReadData to respond to the process notification signalled when data is available.
Use <var>OnReadData</var> to respond to the process notification signalled when data is available.
</p>
</descr>
<seealso></seealso>
@ -218,11 +192,11 @@
<!-- property Visibility: published -->
<element name="TAsyncProcess.OnReadData">
<short>
Event handler signalled when data is available
Event handler signalled when output data is available for the process
</short>
<descr>
<p>
<var>OnReadData</var> is a TNotifyEvent property that implements the event handler signalled when data is available for the process. Applications should assign a procedure to the event handler that responds to the pipe notification. The procedure must handle all data available on the Output.Handle up to the number of bytes in NumBytesAvailable. All data must be handled, or the procedure will be called repeatedly until no more data is available.
<var>OnReadData</var> is a <var>TNotifyEvent</var> property that implements the event handler signalled when data is available for the process. Applications should assign a procedure to the event handler that responds to the pipe notification. The procedure must handle all data available on the Output.Handle up to the number of bytes in <var>NumBytesAvailable</var>. All available data must be handled, or the procedure will be called repeatedly until no more data is available.
</p>
</descr>
<seealso></seealso>
@ -235,7 +209,7 @@
</short>
<descr>
<p>
<var>OnTerminate</var> is a TNotifyEvent property that implements the event handler signalled when the process is terminated. Applications can assign a procedure to the event handler to perform actions needed when the process is terminated.
<var>OnTerminate</var> is a <var>TNotifyEvent</var> property that implements the event handler signalled when the process is terminated. Applications can assign a procedure to the event handler to perform actions needed when the process is terminated.
</p>
</descr>
<seealso></seealso>

7
docs/xml/lcl/buttonpanel.xml
View File

@ -14,17 +14,16 @@
<element name="Types"/>
<element name="SysUtils"/>
<element name="Classes"/>
<element name="LCLProc"/>
<element name="LCLType"/>
<element name="LMessages"/>
<element name="Controls"/>
<element name="ExtCtrls"/>
<element name="StdCtrls"/>
<element name="Buttons"/>
<element name="Forms"/>
<element name="GraphType"/>
<element name="Graphics"/>
<element name="LMessages"/>
<element name="Themes"/>
<element name="LCLType"/>
<element name="GraphType"/>
<element name="TButtonOrder">
<short>

4
docs/xml/lcl/buttons.xml
View File

@ -15,7 +15,7 @@
<element name="LCLProc"/>
<element name="LCLIntf"/>
<element name="LCLStrConsts"/>
<element name="GraphType"/>
<element name="LResources"/>
<element name="Graphics"/>
<element name="ImgList"/>
<element name="ActnList"/>
@ -25,8 +25,8 @@
<element name="Forms"/>
<element name="Themes"/>
<element name="Menus"/>
<element name="LResources"/>
<element name="ImageListCache"/>
<element name="GraphType"/>
<element name="LazUtilities"/>
<element name="TButtonLayout">

5
docs/xml/lcl/checklst.xml
View File

@ -14,15 +14,14 @@
<element name="Classes"/>
<element name="SysUtils"/>
<element name="Math"/>
<element name="LCLProc"/>
<element name="LCLType"/>
<element name="GraphType"/>
<element name="LCLIntf"/>
<element name="Graphics"/>
<element name="LMessages"/>
<element name="LResources"/>
<element name="Controls"/>
<element name="StdCtrls"/>
<element name="LCLIntf"/>
<element name="GraphType"/>
<element name="TCheckListClicked">
<short>

344
docs/xml/lcl/comboex.xml
View File

@ -32,9 +32,7 @@
<element name="Forms"/>
<element name="TAutoCompleteOption">
<short>
Enumerated type with values representing the autocomplete options used in TComboBoxEx
</short>
<short>Enumerated type with values representing the autocomplete options used in TComboBoxEx</short>
<descr>
<p>
<var>TAutoCompleteOption</var> is an enumerated type with values representing the autocomplete options used in <var>TCustomComboBoxEx</var> and <var>TComboBoxEx</var>. Values from the enumeration are stored in the <var>TAutoCompleteOptions</var> set type used to implement the <var>AutoCompleteOptions</var> property in <var>TCustomComboBoxEx</var> and <var>TComboBoxEx</var>. Including a value from the enumeration in the TAutoCompleteOptions set enables the corresponding feature.
@ -47,10 +45,10 @@
</seealso>
</element>
<element name="TAutoCompleteOption.acoAutoSuggest">
<short>Enables auto suggest</short>
<short>Enables auto-suggest</short>
</element>
<element name="TAutoCompleteOption.acoAutoAppend">
<short>Enables auto appending items to the combo-box</short>
<short>Enables auto-appending items to the combo-box</short>
</element>
<element name="TAutoCompleteOption.acoSearch">
<short>Enables searching items for the current value in the edit control</short>
@ -62,9 +60,7 @@
<short>Enables Tab key navigation in the control</short>
</element>
<element name="TAutoCompleteOption.acoUpDownKeyDropsList">
<short>
Enables toggling the visibility of the drop down using Up and Down cursor keys
</short>
<short>Enables toggling the visibility of the drop down using Up and Down cursor keys</short>
</element>
<element name="TAutoCompleteOption.acoRtlReading">
<short>Enables Right-to-Left text rendering (BiDi Mode) in the control</short>
@ -85,9 +81,7 @@
</element>
<element name="TComboBoxExStyle">
<short>
Enumerated type with values for display styles available in TCustomComboBoxEx
</short>
<short>Enumerated type with values for display styles available in TCustomComboBoxEx</short>
<descr>
<p>
<var>TComboBoxExStyle</var> is an enumerated type with values representing the display styles available in <var>TCustomComboBoxEx</var>. TComboBoxExStyle is the type used to implement the <var>Style</var> property in <var>TCustomComboBoxEx</var> and <var>TComboBoxEx</var>.
@ -125,27 +119,27 @@
<link id="TCustomComboBoxEx.StyleEx"/>
<link id="TComboBoxEx.StyleEx"/>
</seealso>
<notes><note>No used in the current LCL implementation.</note></notes>
<notes><note>Not used in the current LCL implementation.</note></notes>
</element>
<element name="TComboBoxExStyleEx.csExCaseSensitive">
<short>Enables case-sensitive comparisons in the control</short>
<notes><note>No used in the current LCL implementation.</note></notes>
<notes><note>Not used in the current LCL implementation.</note></notes>
</element>
<element name="TComboBoxExStyleEx.csExNoEditImage">
<short/>
<notes><note>No used in the current LCL implementation.</note></notes>
<notes><note>Not used in the current LCL implementation.</note></notes>
</element>
<element name="TComboBoxExStyleEx.csExNoEditImageIndent">
<short/>
<notes><note>No used in the current LCL implementation.</note></notes>
<notes><note>Not used in the current LCL implementation.</note></notes>
</element>
<element name="TComboBoxExStyleEx.csExNoSizeLimit">
<short/>
<notes><note>No used in the current LCL implementation.</note></notes>
<notes><note>Not used in the current LCL implementation.</note></notes>
</element>
<element name="TComboBoxExStyleEx.csExPathWordBreak">
<short/>
<notes><note>No used in the current LCL implementation.</note></notes>
<notes><note>Not used in the current LCL implementation.</note></notes>
</element>
<element name="TComboBoxExStyles">
@ -200,9 +194,7 @@
</seealso>
</element>
<element name="TListItemsCompare.Result">
<short>
Integer with the relative order for the compared values at the specified positions
</short>
<short>Integer with the relative order for the compared values at the specified positions</short>
</element>
<element name="TListItemsCompare.AList">
<short>Collection with the items compared in the routine</short>
@ -223,9 +215,7 @@
</element>
<element name="TCheckItemChange">
<short>
Specifies an event handler signalled when a checkbox in TCustomCheckCombo is changed
</short>
<short>Specifies an event handler signalled when a checkbox in TCustomCheckCombo is changed</short>
<descr>
<p>
<var>TCheckItemChange</var> is an object procedure which specifies an event handler signalled when a checkbox in <var>TCustomCheckCombo</var> is changed. TCheckItemChange is the type used to implement the <var>OnItemChange</var> property in <var>TCustomCheckCombo</var> and <var>TCheckComboBox</var>.
@ -252,19 +242,19 @@
Similar to <var>TListItemsSortType</var>, but implemented as an object function.
</p>
</descr>
<seealso></seealso>
<seealso/>
</element>
<element name="TListCompareEvent.Result">
<short></short>
<short/>
</element>
<element name="TListCompareEvent.AList">
<short></short>
<short/>
</element>
<element name="TListCompareEvent.AItem1">
<short></short>
<short/>
</element>
<element name="TListCompareEvent.AItem2">
<short></short>
<short/>
</element>
<element name="TListControlItem">
@ -379,7 +369,7 @@
<var>ImageIndex</var> is an <var>Integer</var> property used to specify the ordinal position in an image list for the bitmap displayed for the list item. <b>-1</b> (the default value for the property) indicates that an explicit value has not been assigned for the property, and no image should be displayed for the collection item.
</p>
</descr>
<seealso></seealso>
<seealso/>
</element>
<element name="TComboExItem">
@ -445,7 +435,7 @@
<element name="TComboExItem.cDefCaption">
<short>Default caption used for a new item</short>
<descr/>
<seealso></seealso>
<seealso/>
</element>
<element name="TComboExItem.Create">
@ -455,7 +445,7 @@
<var>Create</var> calls the inherited constructor, and sets the default values for properties in the class instance.
</p>
</descr>
<seealso></seealso>
<seealso/>
</element>
<element name="TComboExItem.Create.ACollection">
<short>Collection which owns the collection item</short>
@ -471,7 +461,7 @@
Destroy ensures that the number of items in the <var>Collection</var> and the <var>Owner</var> for the collection are kept in sync. Normally, the value in <var>Count</var> is maintained when the Collection frees an item instance in its <var>Delete</var> method. Destroy handles the situation where the collection item is destroyed by calling the <var>Free</var> method in the collection item instead.
</p>
<p>
A component notification message is performed for the Collection to signal the delete operation. The <var>Notify</var> method in Collection is not called when Collection is unassigned or does not have an Owner, or when the Owner of the Collection is being freed.
A component notification message is performed for the Collection to signal the delete operation. The <var>Notify</var> method in Collection is <b>not</b> called when Collection is unassigned or does not have an Owner, or when the Owner of the Collection is being freed.
</p>
<p>
Destroy calls the inherited destructor prior to exiting from the method.
@ -505,9 +495,7 @@
</element>
<element name="TComboExItem.OverlayImageIndex">
<short>
Ordinal position for the image drawn as an overlay for the Image in the combo-box item
</short>
<short>Ordinal position for the image drawn as an overlay for the Image in the combo-box item</short>
<descr>
<p>
The default value for the property is <b>-1</b>, and indicates that an overlay image index has not been explicitly assigned for the item. The overlay image is not drawn when the property contains <b>-1</b>.
@ -521,11 +509,9 @@
</element>
<element name="TComboExItem.SelectedImageIndex">
<short>
Ordinal position for the image drawn when the item is selected in the Combo-Box
</short>
<short>Ordinal position for the image drawn when the item is selected in the Combo-Box</short>
<descr/>
<seealso></seealso>
<seealso/>
</element>
<element name="TListControlItems">
@ -608,7 +594,7 @@
<dt>0</dt>
<dd>The captions in AItem1 and Aitem2 are the same</dd>
<dt>&gt; 0</dt>
<dd>The caption in AItem1 comes after caption in AItem2</dd>
<dd>The caption in AItem1 comes after the caption in AItem2</dd>
</dl>
<p>
CompareItems is used in the implementation of the <var>Sort</var> method when <var>SortType</var> contains the value <var>stText</var> or <var>stBoth</var>.
@ -635,33 +621,33 @@
</element>
<element name="TListControlItems.DoCustomSort">
<short></short>
<descr></descr>
<seealso></seealso>
<short/>
<descr/>
<seealso/>
</element>
<element name="TListControlItems.DoCustomSort.Result">
<short></short>
<short/>
</element>
<element name="TListControlItems.DoCustomSort.AItem1">
<short></short>
<short/>
</element>
<element name="TListControlItems.DoCustomSort.AItem2">
<short></short>
<short/>
</element>
<element name="TListControlItems.DoOnCompare">
<short></short>
<descr></descr>
<seealso></seealso>
<short/>
<descr/>
<seealso/>
</element>
<element name="TListControlItems.DoOnCompare.Result">
<short></short>
<short/>
</element>
<element name="TListControlItems.DoOnCompare.AItem1">
<short></short>
<short/>
</element>
<element name="TListControlItems.DoOnCompare.AItem2">
<short></short>
<short/>
</element>
<element name="TListControlItems.Update" link="#rtl.Classes.TCollection.Update">
@ -710,9 +696,11 @@
<element name="TListControlItems.Sort">
<short>Performs the Sort routine required for the setting in SortType</short>
<descr>
Sort is a procedure used to perform the sort routine indicated in the SortType property.
<p>
<var>Sort</var> is a procedure used to perform the sort routine indicated in <var>SortType</var>.
</p>
</descr>
<seealso></seealso>
<seealso/>
</element>
<element name="TListControlItems.Items" link="#rtl.Classes.TCollection.Items">
@ -742,9 +730,7 @@
</element>
<element name="TListControlItems.CaseSensitive">
<short>
Indicates if case sensitivity is used when comparing items in the collection
</short>
<short>Indicates if case sensitivity is used when comparing items in the collection</short>
<descr>
<p>
<var>CaseSensitive</var> is a <var>Boolean</var> property which indicates if case sensitivity is used when comparing items in the collection. The value in CaseSensitive is used in the <var>CompareItems</var> method. When set to <b>False</b>, the captions for the compared Items are converted to lowercase prior to comparing their values.
@ -762,12 +748,10 @@
</element>
<element name="TListControlItems.SortType">
<short>
Determines the comparison mechanism used for collection items in the Sort method
</short>
<short>Determines the comparison mechanism used for collection items in the Sort method</short>
<descr>
<p>
<var>SortType</var> is a <var>TListItemsSortType</var> property which determines the comparison mechanism used for collection items in the <var>Sort</var> method.The default value for the property is <var>stNone</var> and indicates that no sorting is performed for Items in the collection. Changing the value for the property causes the Sort method to be called to apply the new order to the collection Items.
<var>SortType</var> is a <var>TListItemsSortType</var> property which determines the comparison mechanism used for collection items in the <var>Sort</var> method. The default value for the property is <var>stNone</var> and indicates that no sorting is performed for Items in the collection. Changing the value for the property causes the Sort method to be called to apply the new order to the collection Items.
</p>
</descr>
<seealso>
@ -778,9 +762,7 @@
</element>
<element name="TListControlItems.OnCompare">
<short>
Event handler signalled to sort the collection using the data in the collection items
</short>
<short>Event handler signalled to sort the collection using the data in the collection items</short>
<descr>
<p>
<var>OnCompare</var> is a <var>TListCompareEvent</var> property with the event handler signalled to sort the collection using the arbitrary data stored in each collection item. Applications must implement and assign an object procedure using the signature in TListCompareEvent to allow responding to the event notification.
@ -807,7 +789,7 @@
<var>TComboExItems</var> is a <var>TListControlItems</var> descendant which Implements a collection for the items added to <var>TCustomComboBoxEx</var> and <var>TComboBoxEx</var>. TComboExItems extends the ancestor class to use the <var>TComboExItem</var> type for items added to the collection. Reimplemented methods are provided to add, insert, and retrieve collection items using the ItemClass required for the collection. An <var>AddItem</var> method is introduced to create a new collection item and configure its property values. The <var>Notify</var> and <var>Update</var> methods are overridden to use the correct ItemClass as well.
</p>
<p>
TComboExItems is the type used to implement the ItemsEx property in TCustomComboBoxEx.
TComboExItems is the type used to implement the <var>ItemsEx</var> property in <var>TCustomComboBoxEx</var>.
</p>
</descr>
<seealso>
@ -833,16 +815,14 @@
<element name="TComboExItems.FAddingOrDeletingItem">
<short>Tracks the add or delete status for the collection</short>
<descr/>
<seealso/>
</element>
<element name="TComboExItems.Notify">
<short>
Performs component notifications when a collection item is added to or removed from the collection
Performs component notifications when a collection item is added to or removed from the Collection
</short>
<descr/>
<seealso></seealso>
<seealso/>
</element>
<element name="TComboExItems.Notify.Item">
<short>Collection item for the notification</short>
@ -856,7 +836,7 @@
<descr>
Forces the owner of the collection (the control) to be redrawn when needed.
</descr>
<seealso></seealso>
<seealso/>
</element>
<element name="TComboExItems.Update.Item">
<short>Collection item examined in the method</short>
@ -970,9 +950,7 @@
</element>
<element name="TCustomComboBoxEx">
<short>
Implements the base class for an extended/enhanced combo-box
</short>
<short>Implements the base class for an extended/enhanced combo-box</short>
<descr>
<p>
<var>TCustomComboBoxEx</var> is a <var>TCustomComboBox</var> descendant which implements the base class for <var>TComboBoxEx</var>.
@ -1056,22 +1034,22 @@
<element name="TCustomComboBoxEx.FNeedMeasure">
<short>
Internal flag which indicates if the text height needs to be calculated when drawing an item in the control
Internal flag which indicates if the text height needs to be calculated when drawing an item
</short>
<descr/>
<seealso></seealso>
<seealso/>
</element>
<element name="TCustomComboBoxEx.FRightToLeft">
<short>Internal flag which tracks the BidiMode setting in the control</short>
<descr/>
<seealso></seealso>
<seealso/>
</element>
<element name="TCustomComboBoxEx.FTextHeight">
<short>Internal derived text height for an item in the combo-box</short>
<descr/>
<seealso></seealso>
<seealso/>
</element>
<element name="TCustomComboBoxEx.CMBiDiModeChanged">
@ -1079,10 +1057,10 @@
Performs actions needed when the BiDiMode setting is changed for the control
</short>
<descr/>
<seealso></seealso>
<seealso/>
</element>
<element name="TCustomComboBoxEx.CMBiDiModeChanged.Message">
<short></short>
<short/>
</element>
<element name="TCustomComboBoxEx.DrawItem">
@ -1092,10 +1070,10 @@
<var>DrawItem</var> is an overridden procedure used to draw an item in the extended combo-box control.
</p>
<p>
Index contains the ordinal position for the TComboExItem instance in ItemsEx that is drawn in the method.
Index contains the ordinal position for the TComboExItem instance in <var>ItemsEx</var> that is drawn in the method.
</p>
<p>
<var>ARect</var> is the rectangle with the coordinates for the item drawn in the method. The values in ARect are set in the calling procedure (LMDrawListItem in TCustomComboBox). When the left coordinate is greater than zero (0), the item is a sub-item (not a main item). Sub-items are drawn using the additional spacing in Indent applied to the edge boundary in the drawing rectangle.
<var>ARect</var> is the rectangle with the coordinates for the item. The values in ARect are set in the calling procedure (LMDrawListItem in TCustomComboBox). When the left coordinate is greater than zero (0), the item is a sub-item (or not a main item). Sub-items are drawn with the additional spacing in Indent applied to the drawing rectangle.
</p>
<p>
<var>State</var> contains the owner draw state used to render the item, and determines the window, border, and font colors for the control.
@ -1104,23 +1082,22 @@
DrawItem uses <var>ThemeServices</var> to get theme details applied to enabled items in the combo-box. DrawItem ensures that a valid text height is available for the control <var>Canvas</var>, and is used to draw the text for the item.
</p>
<p>
When <var>Images</var> have been assigned for the control, the image index appropriate to the value in State is determined. The value <var>odSelected</var> causes the <var>SelectedImageIndex</var> for the item is be used. Otherwise, the <var>ImageIndex</var> for the item is used.
When <var>Images</var> have been assigned for the control, the image index appropriate for the value in State is determined. The value <var>odSelected</var> causes the <var>SelectedImageIndex</var> for the item is be used. Otherwise, the <var>ImageIndex</var> for the item is used.
</p>
<p>
The image size is determined by calling the <var>SizeForPPI</var> method in <var>Images</var> using the <var>ImagesWidth</var> and the display density for the current <var>Font</var> in the control. DrawItem determines the location for the image and the indent spacing for the current BiDiMode setting for the control. Right-to-Left rendering aligns the image and indent to the right-hand edge of the drawing rectangle. The <var>DrawIcon</var> method in <var>ThemeServices</var> is called to render the icon to the control Canvas using the theme details.
The image size is determined by calling the <var>SizeForPPI</var> method in <var>Images</var> using the <var>ImagesWidth</var> and the display density for the current <var>Font</var>. DrawItem determines the location for the image and the indent spacing for the current BiDiMode setting for the control. Right-to-Left rendering aligns the image and indent to the right-hand edge of the drawing rectangle. The <var>DrawIcon</var> method in <var>ThemeServices</var> is called to render the icon to the control Canvas using the theme details.
</p>
<p>
Images are <b>not</b> drawn when Images is unassigned or contains zero (0) images, or when values have not been explicitly assigned to the ImageIndex or SelectedImageIndex properties for the extended item in Index.
Images are <b>not</b> drawn when Images is unassigned or contains zero (0) images, or when values have not been explicitly assigned to either ImageIndex or SelectedImageIndex for the extended item in Index.
</p>
<p>
DrawItem configures the Canvas to use the brush style and font color needed for the value in State. Text drawing flags are derived for the item, and the text is rendered by calling the <var>DrawText</var> method in ThemeServices.
DrawItem configures the Canvas to use the brush style and font color needed for the value in State. Text drawing flags are derived for the item, and the text is rendered by calling the <var>DrawText</var> method.
</p>
<remark>
Please note: DrawItem does <b>NOT</b> call the inherited method in <var>TCustomComboBox</var> or trigger its <var>OnDrawItem</var> event handler. The item is rendered entirely in this method.
</remark>
</descr>
<seealso>
</seealso>
<seealso/>
</element>
<element name="TCustomComboBoxEx.DrawItem.Index">
<short>Ordinal position for the item drawn in the method</short>
@ -1196,7 +1173,7 @@
<dd>Set to True to force the item height to be recalculated</dd>
</dl>
</descr>
<seealso></seealso>
<seealso/>
</element>
<element name="TCustomComboBoxEx.Create.TheOwner">
<short>Owner of the class instance</short>
@ -1215,9 +1192,7 @@
</element>
<element name="TCustomComboBoxEx.Add">
<short>
Adds a new item to the extended combo-box control
</short>
<short>Adds a new item to the extended combo-box control</short>
<descr>
<p>
<var>Add</var> is an overloaded method used to add a new item to the extended combo-box control. Both procedure and function variants are provided.
@ -1229,7 +1204,7 @@
The procedure variant does not return the new position for the inserted item. Use the Count property in ItemsEx to determine the ordinal position for the item on exit from the method. Use the parameters to specify the values stored in the corresponding properties in the TComboExItem class instance.
</p>
</descr>
<seealso></seealso>
<seealso/>
</element>
<element name="TCustomComboBoxEx.Add.Result">
<short>Item added to the control</short>
@ -1345,8 +1320,8 @@
<element name="TCustomComboBoxEx.Insert">
<short>Inserts a new item with the specified values at the given position</short>
<descr></descr>
<seealso></seealso>
<descr/>
<seealso/>
</element>
<element name="TCustomComboBoxEx.Insert.AIndex">
<short>Ordinal position where the new item is stored</short>
@ -1369,16 +1344,16 @@
<element name="TCustomComboBoxEx.AutoCompleteOptions">
<short>Contains settings for autocompletion features enabled in the control</short>
<descr></descr>
<seealso></seealso>
<descr/>
<seealso/>
</element>
<element name="TCustomComboBoxEx.Images">
<short>
Contains images which can be displayed for items defined in the ItemsEx property
</short>
<descr></descr>
<seealso></seealso>
<descr/>
<seealso/>
</element>
<element name="TCustomComboBoxEx.ImagesWidth">
@ -1403,9 +1378,7 @@
</element>
<element name="TCustomComboBoxEx.ItemsEx">
<short>
Collection with the extended items defined for the control
</short>
<short>Collection with the extended items defined for the control</short>
<descr>
<p>
<var>ItemsEx</var> is a <var>TComboExItems</var> property which provides access to the extended items defined for the combo-box control. ItemsEx uses <var>TComboExItem</var> as the <var>ItemClass</var> for the collection. The collection is maintained using the <var>Add</var>, <var>AddItem</var>, <var>Delete</var>, <var>DeleteSelected</var>, and <var>Clear</var> methods. Use <var>AssignItemsEx</var> to set the values in the collection to the values from a specific source.
@ -1427,9 +1400,7 @@
</element>
<element name="TCustomComboBoxEx.Style">
<short>
Specifies the control style used for the edit in the combo-box control
</short>
<short>Specifies the control style used for the edit in the combo-box control</short>
<descr>
<p>
<var>Style</var> is a <var>TComboBoxExStyle</var> property which specifies the control style used for the control. This is a narrower range of values than those used in the <var>TCustomComboBox</var> ancestor class; the owner drawn options are not needed in this class. The following values are used:
@ -1446,13 +1417,11 @@
The default value for the property is set using the <var>cDefStyle</var> constant.
</p>
</descr>
<seealso></seealso>
<seealso/>
</element>
<element name="TCustomComboBoxEx.StyleEx">
<short>
Enables feature or behaviors in the extended combo-box control
</short>
<short>Enables feature or behaviors in the extended combo-box control</short>
<descr>
<p>
<var>StyleEx</var> is a <var>TComboBoxExStyles</var> property used to store <var>TComboBoxExStyleEx</var> values which enable features in the extended combo-box control. Including a value from the enumeration enables the corresponding feature or behavior in the control. See <link id="TComboBoxExStyleEx"/> for more information on the enumeration values and their meanings.
@ -1464,12 +1433,12 @@
Please note: Values in StyleEx are not used in the current implementation of TCustomComboBoxEx.
</remark>
</descr>
<seealso></seealso>
<seealso/>
</element>
<element name="TComboBoxEx" link="#lcl.comboex.TCustomComboBoxEx">
<short>Implements an extended combo-box component</short>
<descr></descr>
<descr/>
<seealso>
<link id="TCustomComboBoxEx"/>
</seealso>
@ -1547,9 +1516,7 @@
<element name="TComboBoxEx.Visible" link="#lcl.Controls.TControl.Visible"/>
<element name="TCheckComboItemState">
<short>
Represents state and data for a Checkbox item displayed in TCustomCheckCombo
</short>
<short>Represents state and data for a Checkbox item displayed in TCustomCheckCombo</short>
<descr>
<p>
<var>TCheckComboItemState</var> is a class used to represent state and data for a Checkbox item displayed in <var>TCustomCheckCombo</var> and <var>TCheckComboBox</var>. Properties are provided to store the checkbox state, the enabled setting for the checkbox control, and arbitrary data used for the checkbox.
@ -1597,7 +1564,7 @@
<element name="TCheckComboItemState.Data">
<short>Contains arbitrary data associated with a checkbox item</short>
<descr></descr>
<descr/>
<seealso>
<link id="TCustomCheckCombo.Objects"/>
</seealso>
@ -1605,10 +1572,10 @@
<element name="TCustomCheckCombo">
<short>
Implements the base class for a combo-box which displays checkboxes for items in the control
Implements the base class for a combo-box which displays checkboxes for items in the controls
</short>
<descr></descr>
<seealso></seealso>
<descr/>
<seealso/>
</element>
<element name="TCustomCheckCombo.FAllowGrayed"/>
@ -1761,37 +1728,37 @@
<element name="TCustomCheckCombo.FCheckHighlight">
<short>Internal member used to to track the highlighting state</short>
<descr/>
<seealso></seealso>
<seealso/>
</element>
<element name="TCustomCheckCombo.FCheckSize">
<short>Internal member used to track size adjusts needed for them services</short>
<descr/>
<seealso></seealso>
<seealso/>
</element>
<element name="TCustomCheckCombo.FDropped">
<short>Internal members used to track the state for the drop down in the control</short>
<descr/>
<seealso></seealso>
<seealso/>
</element>
<element name="TCustomCheckCombo.FHilightedIndex">
<short>Internal member used to track the item highlighted in the control</short>
<descr/>
<seealso></seealso>
<seealso/>
</element>
<element name="TCustomCheckCombo.FHiLiteLeft">
<short>Internal member used to track the left coordinate for the highlight</short>
<descr/>
<seealso></seealso>
<seealso/>
</element>
<element name="TCustomCheckCombo.FHiLiteRight">
<short>Internal member used to track the right coordinate for the highlight</short>
<descr/>
<seealso></seealso>
<seealso/>
</element>
<element name="TCustomCheckCombo.FNeedMeasure">
@ -1799,7 +1766,7 @@
Internal member used to track whether the text height has been calculated for items in the control
</short>
<descr/>
<seealso></seealso>
<seealso/>
</element>
<element name="TCustomCheckCombo.FRejectDropDown">
@ -1807,7 +1774,7 @@
Internal member used to track whether drop down requests should be rejected; i. e. the drop down is already visible
</short>
<descr/>
<seealso></seealso>
<seealso/>
</element>
<element name="TCustomCheckCombo.FRejectToggleOnSelect">
@ -1815,32 +1782,28 @@
Internal member used to track whether the current checkbox selection can toggle its value; i. e. whether the drop down is visible
</short>
<descr/>
<seealso></seealso>
<seealso/>
</element>
<element name="TCustomCheckCombo.FRightToLeft">
<short>Internal member used to track the BiDi status for the control</short>
<descr/>
<seealso></seealso>
<seealso/>
</element>
<element name="TCustomCheckCombo.FTextHeight">
<short>
Internal member used to track the text height for checkboxes in the control
</short>
<short>Internal member used to track the text height for checkboxes in the control</short>
<descr/>
<seealso></seealso>
<seealso/>
</element>
<element name="TCustomCheckCombo.CMBiDiModeChanged">
<short>
Performs actions needed when the BiDiMode setting is changed for the control
</short>
<short>Performs actions needed when the BiDiMode setting is changed for the control</short>
<descr/>
<seealso></seealso>
<seealso/>
</element>
<element name="TCustomCheckCombo.CMBiDiModeChanged.Message">
<short></short>
<short/>
</element>
<element name="TCustomCheckCombo.ClearItemStates">
@ -1878,15 +1841,13 @@
</element>
<element name="TCustomCheckCombo.DrawItem">
<short>
Draws a checkbox item defined in the combo-box control
</short>
<short>Draws a checkbox item defined in the combo-box control</short>
<descr>
<p>
<var>DrawItem</var> is an overridden procedure used to draw a checkbox defined in the Items for the control.
</p>
<p>
Index contains the ordinal position for the TComboExItem instance in ItemsEx that is drawn in the method.
<var>Index</var> contains the ordinal position for the <var>TComboExItem</var> instance in <var>ItemsEx</var> that is drawn in the method.
</p>
<p>
<var>ARect</var> is the rectangle with the coordinates for the checkbox item drawn in the method. The values in ARect are set in the calling procedure (LMDrawListItem in TCustomComboBox).
@ -1898,13 +1859,13 @@
DrawItem uses <var>ThemeServices</var> to get theme element details applied to checkbox items in the combo-box. DrawItem ensures that a valid text height is available for the control <var>Canvas</var>, and is used to draw the text for the check box.
</p>
<p>
DrawItem configures the Canvas to use the brush style and font color needed for the value in State. Text drawing flags are derived for the item, and the text is rendered by calling the <var>DrawText</var> method in ThemeServices.
DrawItem configures the Canvas to use the brush style and font color needed for the value in State. Text drawing flags are derived for the item, and the text is rendered by calling the <var>DrawText</var> method.
</p>
<remark>
Please note: DrawItem does <b>NOT</b> call the inherited method in <var>TCustomComboBox</var> or trigger its <var>OnDrawItem</var> event handler. The item is rendered entirely in this method.
</remark>
</descr>
<seealso></seealso>
<seealso/>
</element>
<element name="TCustomCheckCombo.DrawItem.Index">
<short>Ordinal position for the checkbox drawn in the method</short>
@ -1965,14 +1926,28 @@
<element name="TCustomCheckCombo.InitItemStates">
<short>Initializes checkbox state information for items in the control</short>
<descr></descr>
<seealso></seealso>
<descr>
<p>
<var>InitItemStates</var> is used to initialize state information for the Items defined in the checkbox control. InitItemStates iterates over the values in <var>Items</var>, and creates a <var>TCheckComboItemState</var> instance with the enabled, checked state, and state data for each of the items.
</p>
<p>
The TCheckComboItemState instance is stored in the indexed <var>Objects</var> property. Existing values in Objects are not modified. An <var>Exception</var> is raised if an existing value not derived from TCheckComboItemState is found in Objects.
</p>
<p>
InitItemStates is called from the <var>AssignItems</var>, <var>InitializeWnd</var>, and <var>Loaded</var> methods. It is also called when a new values is assigned to the <var>Items</var> property.
</p>
<p>
<var>ClearItemStates</var> is used to remove TCheckComboItemState instances for Items in the control.
</p>
</descr>
<errors>
Raises an Exception with the message <b>'Item # is not a TCheckComboItemState'</b> when Objects contains a value not derived from TCheckComboItemState.
</errors>
<seealso/>
</element>
<element name="TCustomCheckCombo.CheckItemStates">
<short>
Ensures that checkbox item state classes have been allocated for items in the control
</short>
<short>Ensures that checkbox item state classes have been allocated for items in the control</short>
<descr>
<p>
<var>CheckItemStates</var> is a procedure used to ensure that <var>TCheckComboItemState</var> class instances exist for the <var>Items</var> defined in the checkbox combo control. CheckItemStates iterates over the values in Items to determine if its Objects property contains a valid TCheckComboItemState instance. An Exception is raised when the object is not derived from TCheckComboItemState.
@ -1993,9 +1968,7 @@
</element>
<element name="TCustomCheckCombo.QueueCheckItemStates">
<short>
Queues an asynchronous call to AsyncCheckItemStates in the Application singleton
</short>
<short>Queues an asynchronous call to AsyncCheckItemStates in the Application singleton</short>
<descr>
<p>
<var>QueueCheckItemStates</var> is a procedure used to queue an asynchronous call to the <var>AsyncCheckItemStates</var> method in the global Application singleton. QueueCheckItemStates is called from the <var>DrawItem</var> method.
@ -2046,17 +2019,13 @@
</element>
<element name="TCustomCheckCombo.MouseLeave" link="#lcl.Controls.TControl.MouseLeave">
<short>
Deactivates tracking the highlighted checkbox when the mouse leaves the control
</short>
<short>Deactivates tracking the highlighted checkbox when the mouse leaves the control</short>
<descr/>
<seealso></seealso>
<seealso/>
</element>
<element name="TCustomCheckCombo.MouseMove" link="#lcl.Controls.TControl.MouseMove">
<short>
Tracks changes to the highlighted checkbox in the control
</short>
<short>Tracks changes to the mouse positon for the highlighted checkbox in the control</short>
<descr>
<p>
<var>MouseMove</var> is overridden in <var>TCustomCheckCombo</var> to track the X and Y coordinates for the highlighted checkbox item, and to refresh the control when needed. MouseMove calls the inherited method.
@ -2079,7 +2048,7 @@
<element name="TCustomCheckCombo.SetItemHeight">
<short>Sets the value for the ItemHeight property</short>
<descr/>
<seealso></seealso>
<seealso/>
</element>
<element name="TCustomCheckCombo.SetItemHeight.AValue">
<short>New value for the property</short>
@ -2088,13 +2057,13 @@
<element name="TCustomCheckCombo.SetItems">
<short>Sets the value for the Items property</short>
<descr/>
<seealso></seealso>
<seealso/>
</element>
<element name="TCustomCheckCombo.SetItems.Value">
<short>New value for the property</short>
</element>
<element name="TCustomCheckCombo.Select" link="#lcl.StdCtrls.TCustomComboBox.Select">
<element name="TCustomCheckCombo.Select">
<short>Toggles the value for the current item selected in the control</short>
<descr>
<p>
@ -2181,9 +2150,7 @@
</element>
<element name="TCustomCheckCombo.AssignItems">
<short>
Assigns the content in the specified TStringList to the Items in the control
</short>
<short>Assigns the content in the specified TStringList to the Items in the control</short>
<descr>
<p>
<var>AssignItems</var> calls <var>ClearItemStates</var> to reset the state flags for the existing Items. The <var>Assign</var> method in <var>Items</var> is called to store the values in <var>AItems</var>. The <var>InitItemStates</var> method is called to initialize the Objects properties in Items with <var>TCheckComboItemState</var> instances for each of the check boxes.
@ -2221,17 +2188,23 @@
<element name="TCustomCheckCombo.DeleteItem">
<short>Deletes the checkbox at the specified position</short>
<descr></descr>
<seealso></seealso>
<descr>
<p>
Ensures that an object instance stored in <var>Objects</var> is freed before removing the item.
Calls the <var>Delete</var> method to remove the item at the position in <var>AIndex</var>.
</p>
</descr>
<seealso>
<link id="TCustomCheckCombo.Objects"/>
<link id="#rtl.classes.TStrings.Delete"/>
</seealso>
</element>
<element name="TCustomCheckCombo.DeleteItem.AIndex">
<short>Ordinal position for the checkbox removed in the method</short>
<short>Ordinal positon for the item removed in the method</short>
</element>
<element name="TCustomCheckCombo.CheckAll">
<short>
Sets the state for all checkboxes defined in the control meeting the specified criteria
</short>
<short>Sets the state for all checkboxes defined in the control meeting the specified criteria</short>
<descr>
<p>
<var>CheckAll</var> is a procedure used to set the checked state for all checkboxes defined in the <var>Items</var> for the control. <var>AState</var> contains the state applied to the checkboxes defined in the control.
@ -2262,9 +2235,12 @@
</element>
<element name="TCustomCheckCombo.Toggle">
<short>Toggles the value for the checkbox at the specified position</short>
<descr></descr>
<seealso></seealso>
<short>Toggles the checked state for the checkbox at the specified position</short>
<descr/>
<seealso/>
<notes>
<note>Not sure how to describe the internal state map.</note>
</notes>
</element>
<element name="TCustomCheckCombo.Toggle.AIndex">
<short>Ordinal position for the checkbox affected in the method</short>
@ -2277,7 +2253,7 @@
<var>AllowGrayed</var> is a <var>Boolean</var> property which indicates if checkboxes can be displayed in the "grayed" or indeterminate state. The default value for the property is <b>False</b>.
</p>
</descr>
<seealso></seealso>
<seealso/>
</element>
<element name="TCustomCheckCombo.Count">
@ -2300,9 +2276,7 @@
</element>
<element name="TCustomCheckCombo.Checked">
<short>
Provides indexed access to the Boolean value for a checkbox defined in Items
</short>
<short>Provides indexed access to the Boolean value for a checkbox defined in Items</short>
<descr>
<p>
<var>Checked</var> is an indexed <var>Boolean</var> property which provides access to the checked state for a checkbox item defined in the control. <var>AIndex</var> specifies the ordinal position in Items for the checkbox. Checked uses the value from the <var>TCheckComboItemState</var> object stored in the <var>Items</var> property. <b>True</b> indicates that TCheckComboItemState.Checked contains the value <var>cbChecked</var>. <b>False</b> indicates that it contains the value <var>cbUnchecked</var>.
@ -2319,10 +2293,8 @@
</element>
<element name="TCustomCheckCombo.ItemEnabled">
<short>
Provides indexed access to the Boolean enabled value for a checkbox defined in Items
</short>
<descr></descr>
<short>Provides indexed access to the Boolean enabled value for a checkbox defined in Items</short>
<descr/>
<seealso>
<link id="TCustomCheckCombo.State"/>
<link id="TCustomCheckCombo.Checked"/>
@ -2336,9 +2308,7 @@
</element>
<element name="TCustomCheckCombo.Objects">
<short>
Provides indexed access to the Data for a checkbox defined in Items
</short>
<short>Provides indexed access to the Data for a checkbox defined in Items</short>
<descr>
<p>
<var>Objects</var> is an indexed <var>TObject</var> property which provides access to the Data for a checkbox defined in <var>Items</var>. AIndex specifies the ordinal position in Items for the checkbox. Objects return the value from the TCheckComboItemState object stored in the Items property. The object instance is the property value that represents the content stored in the TCheckComboItemState.Data property.
@ -2353,9 +2323,7 @@
</element>
<element name="TCustomCheckCombo.State">
<short>
Provides indexed access to the checked State for a checkbox defined in Items
</short>
<short>Provides indexed access to the checked State for a checkbox defined in Items</short>
<descr>
<p>
<var>State</var> is an indexed <var>TCheckBoxState</var> property which provides access to the checked State for a checkbox defined in Items. <var>AIndex</var> specifies the ordinal position in Items for the checkbox. State returns the <var>TCheckBoxState</var> value in <var>TCheckComboItemState.State</var> for the associated object instance.
@ -2377,9 +2345,7 @@
</element>
<element name="TCustomCheckCombo.OnItemChange">
<short>
Event handler signalled when the state for a checkbox in the control is changed
</short>
<short>Event handler signalled when the state for a checkbox in the control is changed</short>
<descr>
<p>
<var>OnItemChange</var> is a <var>TCheckItemChange</var> property with the event handler signalled when a value in the <var>Checked</var> or <var>State</var> properties is changed. Arguments passed to the event handler identify the object for the event notification, and the ordinal position in <var>Items</var> for the modified checkbox.

12
docs/xml/lcl/comctrls.xml
View File

@ -18,19 +18,14 @@
<element name="Classes"/>
<element name="Math"/>
<element name="Laz_AVL_Tree"/>
<element name="LazUTF8"/>
<element name="LazUTF8Classes"/>
<element name="LazLoggerBase"/>
<element name="LazUtilities"/>
<element name="LCLStrConsts"/>
<element name="LResources"/>
<element name="LCLIntf"/>
<element name="LCLType"/>
<element name="LCLProc"/>
<element name="LMessages"/>
<element name="WSLCLClasses"/>
<element name="WSReferences"/>
<element name="LCLProc"/>
<element name="GraphType"/>
<element name="Graphics"/>
<element name="ImgList"/>
<element name="ActnList"/>
@ -42,6 +37,11 @@
<element name="ExtCtrls"/>
<element name="ToolWin"/>
<element name="Buttons"/>
<element name="GraphType"/>
<element name="LazUTF8"/>
<element name="LazUTF8Classes"/>
<element name="LazLoggerBase"/>
<element name="LazUtilities"/>
<element name="THitTest">
<short>Represents permissible results for a hit test</short>

5
docs/xml/lcl/controls.xml
View File

@ -21,7 +21,6 @@
<element name="LCLStrConsts"/>
<element name="LCLType"/>
<element name="LCLProc"/>
<element name="GraphType"/>
<element name="Graphics"/>
<element name="LMessages"/>
<element name="LCLIntf"/>
@ -33,10 +32,12 @@
<element name="LCLClasses"/>
<element name="LResources"/>
<element name="LCLPlatformDef"/>
<element name="GraphType"/>
<element name="UITypes"/>
<element name="LazMethodList"/>
<element name="LazLoggerBase"/>
<element name="LazTracer"/>
<element name="LazUtilities"/>
<element name="UITypes"/>
<!-- included from controlconsts.inc -->
<element name="CM_BASE">

6
docs/xml/lcl/dbctrls.xml
View File

@ -17,14 +17,11 @@
<element name="SysUtils"/>
<element name="DB"/>
<element name="Variants"/>
<element name="LazTracer"/>
<element name="LazUtilities"/>
<element name="LCLStrConsts"/>
<element name="LMessages"/>
<element name="LCLType"/>
<element name="LCLIntf"/>
<element name="LResources"/>
<element name="GraphType"/>
<element name="Controls"/>
<element name="Graphics"/>
<element name="Dialogs"/>
@ -34,6 +31,9 @@
<element name="ExtCtrls"/>
<element name="Calendar"/>
<element name="ImgList"/>
<element name="GraphType"/>
<element name="LazTracer"/>
<element name="LazUtilities"/>
<element name="TFieldDataLink" link="#FCL.Db.TDataLink">
<short>

14
docs/xml/lcl/dbextctrls.xml
View File

@ -13,10 +13,9 @@
<element name="SysUtils"/>
<element name="LCLType"/>
<element name="LMessages"/>
<element name="Ctrls"/>
<element name="EditBtn"/>
<element name="DB"/>
<element name="DBCtrls"/>
<element name="EditBtn"/>
<!-- class Visibility: default -->
<element name="TDBDateEdit" link="#lcl.EditBtn.TDateEdit">
@ -540,8 +539,15 @@
</seealso>
</element>
<!-- procedure Visibility: default -->
<element name="Register"/>
<element name="Register">
<short>Registers components for use in the Lazarus IDE</short>
<descr>
<p>
<var>Register</var> is the procedure used to registers components for use in the Lazarus IDE. Register calls <var>RegisterComponents</var> to add the <var>TDBDateEdit</var> component to the <b>Data Controls</b> tab in the Lazarus IDE.
</p>
</descr>
</element>
</module>
<!-- DBExtCtrls -->

144
docs/xml/lcl/dialogs.xml
View File

@ -9,120 +9,36 @@
<module name="Dialogs">
<short>Some dialogs commonly used in Lazarus applications. Look at the Procedures as well as the Classes</short>
<descr/>
<!-- unresolved type reference Visibility: default -->
<element name="Types">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="Classes">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="LResources">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="SysUtils">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="LCLIntf">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="InterfaceBase">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="FileUtil">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="LCLStrConsts">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="LCLType">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="LMessages">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="LCLProc">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="Forms">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="Controls">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="GraphType">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="Graphics">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="Buttons">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="StdCtrls">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="ExtCtrls">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="LCLClasses">
<short/>
<descr/>
<seealso/>
</element>
<element name="Types"/>
<element name="TypInfo"/>
<element name="Classes"/>
<element name="SysUtils"/>
<element name="LMessages"/>
<element name="LResources"/>
<element name="LCLIntf"/>
<element name="InterfaceBase"/>
<element name="LCLStrConsts"/>
<element name="LCLType"/>
<element name="Forms"/>
<element name="Controls"/>
<element name="Themes"/>
<element name="Graphics"/>
<element name="Buttons"/>
<element name="ButtonPanel"/>
<element name="StdCtrls"/>
<element name="ExtCtrls"/>
<element name="LCLClasses"/>
<element name="ClipBrd"/>
<element name="Menus"/>
<element name="LCLTaskDialog"/>
<element name="GraphType"/>
<element name="UITypes"/>
<element name="FileUtil"/>
<element name="LazFileUtils"/>
<element name="LazStringUtils"/>
<element name="LazLoggerBase"/>
<!-- enumeration type Visibility: default -->
<element name="TMsgDlgType">
<short>Constants to define the types of message dialogs.</short>

3
docs/xml/lcl/extctrls.xml
View File

@ -24,7 +24,6 @@
<element name="Controls"/>
<element name="Forms"/>
<element name="StdCtrls"/>
<element name="GraphType"/>
<element name="Graphics"/>
<element name="LCLIntf"/>
<element name="CustomTimer"/>
@ -33,7 +32,9 @@
<element name="Menus"/>
<element name="PopupNotifier"/>
<element name="ImgList"/>
<element name="GraphType"/>
<element name="LazLoggerBase"/>
<element name="LazTracer"/>
<element name="LazUtilities"/>
<element name="TBeforeShowPageEvent">

9
docs/xml/lcl/extdlgs.xml
View File

@ -16,17 +16,13 @@
<element name="Types"/>
<element name="Classes"/>
<element name="SysUtils"/>
<element name="LCLProc"/>
<element name="LResources"/>
<element name="LCLType"/>
<element name="LCLStrConsts"/>
<element name="InterfaceBase"/>
<element name="LCLPlatformDef"/>
<element name="FileUtil"/>
<element name="LazFileUtils"/>
<element name="InterfaceBase"/>
<element name="Controls"/>
<element name="Dialogs"/>
<element name="GraphType"/>
<element name="Graphics"/>
<element name="ExtCtrls"/>
<element name="StdCtrls"/>
@ -35,6 +31,9 @@
<element name="Buttons"/>
<element name="Masks"/>
<element name="CalcForm"/>
<element name="GraphType"/>
<element name="FileUtil"/>
<element name="LazFileUtils"/>
<element name="TPreviewFileControl">
<short>

2
docs/xml/lcl/extgraphics.xml
View File

@ -16,8 +16,8 @@
<element name="Classes"/>
<element name="Math"/>
<element name="LazUtilities"/>
<element name="Graphics"/>
<element name="GraphMath"/>
<element name="Graphics"/>
<!-- enumeration type Visibility: default -->
<element name="TShapeDirection">

4
docs/xml/lcl/forms.xml
View File

@ -11,6 +11,7 @@
Contains types and classes used to implement Forms, which are the basis for the Lazarus Graphical User Interface
</short>
<descr/>
<!-- unresolved type references -->
<element name="Classes"/>
<element name="SysUtils"/>
@ -26,7 +27,6 @@
<element name="LCLClasses"/>
<element name="InterfaceBase"/>
<element name="LResources"/>
<element name="GraphType"/>
<element name="Graphics"/>
<element name="Menus"/>
<element name="LMessages"/>
@ -44,8 +44,10 @@
<element name="LazMethodList"/>
<element name="LazLoggerBase"/>
<element name="LazUtilities"/>
<element name="GraphType"/>
<element name="UITypes"/>
<element name="gettext"/>
<!-- procedure type Visibility: default -->
<element name="TProcedure">
<short>The type of a procedure that takes no arguments</short>

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

@ -30,11 +30,8 @@
<element name="FPWriteJpeg"/>
<element name="FPReadTiff"/>
<element name="FPWriteTiff"/>
<element name="FPTiffCmn"/>
<element name="FPReadGif"/>
<element name="FPCAdds"/>
<element name="LazUTF8Classes"/>
<element name="LazLoggerBase"/>
<element name="LazUtilities"/>
<element name="LCLVersion"/>
<element name="LCLStrConsts"/>
<element name="LCLType"/>
@ -43,10 +40,15 @@
<element name="LResources"/>
<element name="LCLResCache"/>
<element name="IntfGraphics"/>
<element name="GraphType"/>
<element name="IcnsTypes"/>
<element name="GraphMath"/>
<element name="WSReferences"/>
<element name="GraphType"/>
<element name="GraphMath"/>
<element name="FPCAdds"/>
<element name="LazUTF8Classes"/>
<element name="LazLoggerBase"/>
<element name="LazTracer"/>
<element name="LazUtilities"/>
<element name="PColor">
<short>Pointer to the TColor type</short>

2
docs/xml/lcl/graphutil.xml
View File

@ -30,9 +30,9 @@
<element name="Types"/>
<element name="Math"/>
<element name="Graphics"/>
<element name="GraphType"/>
<element name="LCLType"/>
<element name="LCLIntf"/>
<element name="GraphType"/>
<element name="ColorToGray">
<short>Converts a Lazarus TColor value to its grayscale equivalent</short>

21
docs/xml/lcl/imglist.xml
View File

@ -17,28 +17,29 @@
<element name="Math"/>
<element name="SysUtils"/>
<element name="Classes"/>
<element name="RtlConsts"/>
<element name="Contnrs"/>
<element name="ZStream"/>
<element name="Laz_AVL_Tree"/>
<element name="FPReadBMP"/>
<element name="FPimage"/>
<element name="FPImgCanv"/>
<element name="FPCanvas"/>
<element name="Contnrs"/>
<element name="ZStream"/>
<element name="Laz_AVL_Tree"/>
<element name="FPCAdds"/>
<element name="LazLoggerBase"/>
<element name="LazUtilities"/>
<element name="AvgLvlTree"/>
<element name="LCLStrConsts"/>
<element name="LCLIntf"/>
<element name="LResources"/>
<element name="LCLType"/>
<element name="LCLProc"/>
<element name="Graphics"/>
<element name="GraphType"/>
<element name="LCLClasses"/>
<element name="Graphics"/>
<element name="IntfGraphics"/>
<element name="WSReferences"/>
<element name="RtlConsts"/>
<element name="GraphType"/>
<element name="FPCAdds"/>
<element name="LazLoggerBase"/>
<element name="LazTracer"/>
<element name="LazUtilities"/>
<element name="AvgLvlTree"/>
<!-- "type" alias type Visibility: default -->
<element name="TImageIndex">

12
docs/xml/lcl/interfacebase.xml
View File

@ -18,18 +18,18 @@
<element name="SysUtils"/>
<element name="Math"/>
<element name="FPImage"/>
<element name="LCLProc"/>
<element name="LCLType"/>
<element name="LMessages"/>
<element name="LCLPlatformDef"/>
<element name="IntfGraphics"/>
<element name="Themes"/>
<element name="LazUTF8"/>
<element name="IntegerList"/>
<element name="LazUtilities"/>
<element name="LazLoggerBase"/>
<element name="GraphType"/>
<element name="LCLProc"/>
<element name="LCLType"/>
<element name="LMessages"/>
<element name="LCLPlatformDef"/>
<element name="GraphMath"/>
<element name="IntfGraphics"/>
<element name="Themes"/>
<!-- "type" alias type Visibility: default -->
<element name="PEventHandler">

88
docs/xml/lcl/intfgraphics.xml
View File

@ -9,73 +9,29 @@
<module name="IntfGraphics">
<short>Classes and functions for easy handling of raw images (interface images)</short>
<descr/>
<!-- unresolved type reference Visibility: default -->
<element name="Classes">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="SysUtils">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="fpImage">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="FPReadBMP">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="BMPComn">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="FPCAdds">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="AvgLvlTree">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="LCLType">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="LCLProc">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="GraphType">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="LCLIntf">
<short/>
<descr/>
<seealso/>
</element>
<!-- procedure type Visibility: default -->
<element name="Classes"/>
<element name="SysUtils"/>
<element name="Math"/>
<element name="fpImage"/>
<element name="FPReadBMP"/>
<element name="FPWriteBMP"/>
<element name="BMPComn"/>
<element name="FPReadPNG"/>
<element name="FPWritePNG"/>
<element name="FPReadTiff"/>
<element name="FPWriteTiff"/>
<element name="FPTiffCmn"/>
<element name="AvgLvlTree"/>
<element name="GraphType"/>
<element name="FPCAdds"/>
<element name="LazLoggerBase"/>
<element name="LazTracer"/>
<element name="LCLType"/>
<element name="LCLVersion"/>
<element name="IcnsTypes"/>
<element name="TOnGetLazIntfImagePixel">
<short/>
<descr/>

51
docs/xml/lcl/lazfreetypeintfdrawer.xml
View File

@ -13,6 +13,57 @@
<descr>
</descr>
<!-- unresolved external references -->
<element name="Classes"/>
<element name="SysUtils"/>
<element name="FPImage"/>
<element name="GraphType"/>
<element name="EasyLazFreeType"/>
<element name="Graphics"/>
<element name="IntfGraphics"/>
<element name="TLazIntfImageGetPixelAtProc">
<short/>
<descr/>
<seealso/>
</element>
<element name="TLazIntfImageGetPixelAtProc.p">
<short/>
</element>
<element name="TLazIntfImageGetPixelAtProc.Color">
<short/>
</element>
<element name="TLazIntfImageSetPixelAtProc">
<short/>
<descr/>
<seealso/>
</element>
<element name="TLazIntfImageSetPixelAtProc.p">
<short/>
</element>
<element name="TLazIntfImageSetPixelAtProc.Color">
<short/>
</element>
<element name="TLazIntfHorizLineProc">
<short/>
<descr/>
<seealso/>
</element>
<element name="TLazIntfHorizLineProc.x1">
<short/>
</element>
<element name="TLazIntfHorizLineProc.y">
<short/>
</element>
<element name="TLazIntfHorizLineProc.x2">
<short/>
</element>
<element name="TLazIntfHorizLineProc.Color">
<short/>
</element>
<!-- class Visibility: default -->
<element name="TIntfFreeTypeDrawer">
<short></short>

18
docs/xml/lcl/lclintf.xml
View File

@ -27,14 +27,28 @@
</descr>
<!-- unresolved type references -->
<element name="Windows"/>
<element name="ShellApi"/>
<element name="LazUTF16"/>
<element name="Unix"/>
<element name="MacOSAll"/>
<element name="CocoaAll"/>
<element name="Math"/>
<element name="Classes"/>
<element name="SysUtils"/>
<element name="Types"/>
<element name="LCLType"/>
<element name="LCLProc"/>
<element name="GraphType"/>
<element name="LMessages"/>
<element name="LCLStrConsts"/>
<element name="InterfaceBase"/>
<element name="LResources"/>
<element name="GraphType"/>
<element name="FileUtil"/>
<element name="LazFileUtils"/>
<element name="UTF8Process"/>
<element name="LazUTF8"/>
<element name="LazSysUtils"/>
<element name="Maps"/>
<element name="Arc">
<short>Draws an elliptical curve</short>

44
docs/xml/lcl/lmessages.xml
View File

@ -1,53 +1,23 @@
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="lcl">
<!--
====================================================================
LMessages
====================================================================
-->
<module name="LMessages">
<short/>
<descr>
</descr>
<!-- unresolved type reference Visibility: default -->
<element name="Classes">
<short/>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="SysUtils">
<short/>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="LCLType">
<short/>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="GraphType">
<short/>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- unresolved external references -->
<element name="Classes"/>
<element name="SysUtils"/>
<element name="Types"/>
<element name="LCLType"/>
<element name="GraphType"/>
<element name="Messages"/>
<!-- constant Visibility: default -->
<element name="LM_USER">

152
docs/xml/lcl/postscriptcanvas.xml
View File

@ -9,117 +9,55 @@
-->
<module name="PostscriptCanvas">
<short/>
<short>Contains classes and types used to implement a PostScript printer canvas</short>
<descr>
<p>
Developed using information from:
</p>
<ul>
<li>The Green Book Listing 9-1, on page 138 for Patterns</li>
<li>PostScriptPrinter.pas unit by Tony Maro</li>
<li>Piddle Project (Python language)</li>
<li>Internet PostScript forums</li>
</ul>
<p>
<b>Warnings:</b>
</p>
<ul>
<li>
Draw and StretchDraw are slow for big images.
</li>
<li>
Angles are expressed in 1/16th of degree.
</li>
</ul>
<p>
Author: Olivier Guilbaud.
TextRect implemented by T. P. Launchbury (12 Dec 2012).
</p>
</descr>
<!-- unresolved type reference Visibility: default -->
<element name="Classes">
<short/>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="SysUtils">
<short/>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="Math">
<short/>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="Graphics">
<short/>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="Forms">
<short/>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="GraphMath">
<short/>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="GraphType">
<short/>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="FPImage">
<short/>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="IntfGraphics">
<short/>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="Printers">
<short/>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="LCLType">
<short/>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="LCLIntf">
<short/>
<descr>
</descr>
<seealso>
</seealso>
</element>
<element name="Classes"/>
<element name="SysUtils"/>
<element name="StrUtils"/>
<element name="Math"/>
<element name="Types"/>
<element name="FPImage"/>
<element name="LCLType"/>
<element name="LCLIntf"/>
<element name="LclProc"/>
<element name="Graphics"/>
<element name="Forms"/>
<element name="IntfGraphics"/>
<element name="Printers"/>
<element name="PostScriptUnicode"/>
<element name="GraphType"/>
<element name="GraphMath"/>
<element name="LazFileUtils"/>
<element name="IntegerList"/>
<element name="LazUTF8"/>
<element name="LazUTF8Classes"/>
<!-- object Visibility: default -->
<element name="TPostscriptPrinterCanvas">

84
docs/xml/lcl/postscriptprinter.xml
View File

@ -2,61 +2,39 @@
<fpdoc-descriptions>
<package name="lcl">
<!--
====================================================================
PostScriptPrinter
====================================================================
-->
====================================================================
PostScriptPrinter
====================================================================
-->
<module name="PostScriptPrinter">
<short/>
<descr/>
<short>Contains classes and types used to implement a PostScript printer</short>
<descr>
<p>
Defines a special canvas type object and override drawing methods to make the postscript code.
</p>
<p>
Defines a TPSPattern object that handles creation of patterns to be used in fill and paint operations.
</p>
<p>
TPostScript manages a list of patterns and inserts the definitions into the postscript code and manages when they are changed.
</p>
<p>
A pattern definition can access pattern definitions within the same postscript object, as long as the TPSPattern object pointer is placed into the canvas pen/brush at the time the new pattern is made.
</p>
<p>
Author: Tony Maro
</p>
</descr>
<!-- unresolved type reference Visibility: default -->
<element name="Classes">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="SysUtils">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="LCLProc">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="GraphType">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="Graphics">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="GraphMath">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="LCLIntf">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="Forms">
<short/>
<descr/>
<seealso/>
</element>
<element name="Classes"/>
<element name="SysUtils"/>
<element name="LCLIntf"/>
<element name="Graphics"/>
<element name="Forms"/>
<element name="GraphMath"/>
<element name="LazLoggerBase"/>
<!-- enumeration type Visibility: default -->
<element name="TPSPaintType">
<short/>

358
docs/xml/lcl/themes.xml
View File

@ -1,836 +1,520 @@
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="lcl">
<!--
====================================================================
Themes
====================================================================
-->
<module name="Themes">
<short>For manipulation of display Themes, mostly in a Windows XP (and later) environment</short>
<descr>
</descr>
<!-- unresolved type reference Visibility: default -->
<element name="Types">
<short/>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- unresolved type references -->
<element name="Classes"/>
<element name="SysUtils"/>
<element name="Types"/>
<element name="Math"/>
<element name="LCLProc"/>
<element name="LCLType"/>
<element name="Graphics"/>
<element name="TmSchema"/>
<element name="GraphType"/>
<!-- unresolved type reference Visibility: default -->
<element name="Classes">
<short/>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="LCLType">
<short/>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="TmSchema">
<short/>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- enumeration type Visibility: default -->
<element name="TThemedElement">
<short/>
<short>Represents elements which can be themed</short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedElement.teButton">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedElement.teClock">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedElement.teComboBox">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedElement.teEdit">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedElement.teExplorerBar">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedElement.teHeader">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedElement.teListView">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedElement.teMenu">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedElement.tePage">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedElement.teProgress">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedElement.teRebar">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedElement.teScrollBar">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedElement.teSpin">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedElement.teStartPanel">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedElement.teStatus">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedElement.teTab">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedElement.teTaskBand">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedElement.teTaskBar">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedElement.teToolBar">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedElement.teToolTip">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedElement.teTrackBar">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedElement.teTrayNotify">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedElement.teTreeview">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedElement.teWindow">
<short/>
</element>
<!-- enumeration type Visibility: default -->
<element name="TThemedButton">
<short/>
<short>Represents data elements for themed buttons</short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedButton.tbButtonDontCare">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedButton.tbButtonRoot">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedButton.tbPushButtonNormal">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedButton.tbPushButtonHot">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedButton.tbPushButtonPressed">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedButton.tbPushButtonDisabled">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedButton.tbPushButtonDefaulted">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedButton.tbRadioButtonUncheckedNormal">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedButton.tbRadioButtonUncheckedHot">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedButton.tbRadioButtonUncheckedPressed">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedButton.tbRadioButtonUncheckedDisabled">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedButton.tbRadioButtonCheckedNormal">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedButton.tbRadioButtonCheckedHot">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedButton.tbRadioButtonCheckedPressed">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedButton.tbRadioButtonCheckedDisabled">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedButton.tbCheckBoxUncheckedNormal">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedButton.tbCheckBoxUncheckedHot">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedButton.tbCheckBoxUncheckedPressed">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedButton.tbCheckBoxUncheckedDisabled">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedButton.tbCheckBoxCheckedNormal">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedButton.tbCheckBoxCheckedHot">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedButton.tbCheckBoxCheckedPressed">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedButton.tbCheckBoxCheckedDisabled">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedButton.tbCheckBoxMixedNormal">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedButton.tbCheckBoxMixedHot">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedButton.tbCheckBoxMixedPressed">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedButton.tbCheckBoxMixedDisabled">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedButton.tbGroupBoxNormal">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedButton.tbGroupBoxDisabled">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedButton.tbUserButton">
<short/>
</element>
<!-- enumeration type Visibility: default -->
<element name="TThemedClock">
<short/>
<short>Represents data elements used to theme a Clock</short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedClock.tcClockDontCare">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedClock.tcClockRoot">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedClock.tcTimeNormal">
<short/>
</element>
<!-- enumeration type Visibility: default -->
<element name="TThemedComboBox">
<short/>
<short>Represents data elemenets used to theme combo-box controls</short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedComboBox.tcComboBoxDontCare">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedComboBox.tcComboBoxRoot">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedComboBox.tcDropDownButtonNormal">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedComboBox.tcDropDownButtonHot">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedComboBox.tcDropDownButtonPressed">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedComboBox.tcDropDownButtonDisabled">
<short/>
</element>
<!-- enumeration type Visibility: default -->
<element name="TThemedEdit">
<short/>
<short>Represents data elements used to theme Edit controls</short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedEdit.teEditDontCare">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedEdit.teEditRoot">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedEdit.teEditTextNormal">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedEdit.teEditTextHot">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedEdit.teEditTextSelected">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedEdit.teEditTextDisabled">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedEdit.teEditTextFocused">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedEdit.teEditTextReadOnly">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedEdit.teEditTextAssist">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedEdit.teEditCaret">
<short/>
</element>
<!-- enumeration type Visibility: default -->
<element name="TThemedExplorerBar">
<short/>
<short>Represents data elements used to theme an Explorer Bar</short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedExplorerBar.tebExplorerBarDontCare">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedExplorerBar.tebExplorerBarRoot">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedExplorerBar.tebHeaderBackgroundNormal">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedExplorerBar.tebHeaderBackgroundHot">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedExplorerBar.tebHeaderBackgroundPressed">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedExplorerBar.tebHeaderCloseNormal">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedExplorerBar.tebHeaderCloseHot">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedExplorerBar.tebHeaderClosePressed">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedExplorerBar.tebHeaderPinNormal">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedExplorerBar.tebHeaderPinHot">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedExplorerBar.tebHeaderPinPressed">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedExplorerBar.tebHeaderPinSelectedNormal">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedExplorerBar.tebHeaderPinSelectedHot">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedExplorerBar.tebHeaderPinSelectedPressed">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedExplorerBar.tebIEBarMenuNormal">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedExplorerBar.tebIEBarMenuHot">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedExplorerBar.tebIEBarMenuPressed">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedExplorerBar.tebNormalGroupBackground">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedExplorerBar.tebNormalGroupCollapseNormal">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedExplorerBar.tebNormalGroupCollapseHot">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedExplorerBar.tebNormalGroupCollapsePressed">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedExplorerBar.tebNormalGroupExpandNormal">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedExplorerBar.tebNormalGroupExpandHot">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedExplorerBar.tebNormalGroupExpandPressed">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedExplorerBar.tebNormalGroupHead">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedExplorerBar.tebSpecialGroupBackground">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedExplorerBar.tebSpecialGroupCollapseSpecial">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedExplorerBar.tebSpecialGroupCollapseHot">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedExplorerBar.tebSpecialGroupCollapsePressed">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedExplorerBar.tebSpecialGroupExpandSpecial">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedExplorerBar.tebSpecialGroupExpandHot">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedExplorerBar.tebSpecialGroupExpandPressed">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedExplorerBar.tebSpecialGroupHead">
<short/>
</element>
<!-- enumeration type Visibility: default -->
<element name="TThemedHeader">
<short/>
<short>Represents data elements used to theme a Header control</short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedHeader.thHeaderDontCare">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedHeader.thHeaderRoot">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedHeader.thHeaderItemNormal">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedHeader.thHeaderItemHot">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedHeader.thHeaderItemPressed">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedHeader.thHeaderItemLeftNormal">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedHeader.thHeaderItemLeftHot">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedHeader.thHeaderItemLeftPressed">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedHeader.thHeaderItemRightNormal">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedHeader.thHeaderItemRightHot">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedHeader.thHeaderItemRightPressed">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedHeader.thHeaderSortArrowSortedUp">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedHeader.thHeaderSortArrowSortedDown">
<short/>
</element>
<!-- enumeration type Visibility: default -->
<element name="TThemedListview">
<short/>
<short>Represents data elements used to theme List View controls</short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedListview.tlListviewDontCare">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedListview.tlListviewRoot">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedListview.tlListItemNormal">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedListview.tlListItemHot">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedListview.tlListItemSelected">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedListview.tlListItemDisabled">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedListview.tlListItemSelectedNotFocus">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedListview.tlListGroup">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedListview.tlListDetail">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedListview.tlListSortDetail">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedListview.tlEmptyText">
<short/>
</element>
<!-- enumeration type Visibility: default -->
<element name="TThemedMenu">
<short/>
<short>Represents data elements used to theme Menus</short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedMenu.tmMenuDontCare">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedMenu.tmMenuRoot">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedMenu.tmMenuItemNormal">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedMenu.tmMenuItemSelected">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedMenu.tmMenuItemDemoted">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedMenu.tmMenuDropDown">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedMenu.tmMenuBarItem">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedMenu.tmMenuBarDropDown">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedMenu.tmChevron">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TThemedMenu.tmSeparator">
<short/>
</element>
<!-- enumeration type Visibility: default -->
<element name="TThemedPage">
<short/>
<descr>
@ -3729,7 +3413,7 @@
</seealso>
</element>
</module> <!-- Themes -->
</module>
<!-- Themes -->
</package>
</fpdoc-descriptions>

7
docs/xml/lcl/toolwin.xml
View File

@ -14,14 +14,13 @@
<!-- unresolved type references Visibility: default -->
<element name="Classes"/>
<element name="LCLProc"/>
<element name="Controls"/>
<element name="SysUtils"/>
<element name="GraphType"/>
<element name="Graphics"/>
<element name="LCLType"/>
<element name="LCLIntf"/>
<element name="Controls"/>
<element name="Graphics"/>
<element name="StdCtrls"/>
<element name="GraphType"/>
<!-- enumeration type Visibility: default -->
<element name="TEdgeBorder">