From 49384e3efc9004af1ccca0d989285d3ee86a7a29 Mon Sep 17 00:00:00 2001 From: juha Date: Thu, 31 Dec 2020 20:32:21 +0000 Subject: [PATCH] Docs: Documentation update for LCL, LazUtils and LazControls. Issue #38287, patch from Don Siders. git-svn-id: trunk@64314 - --- .gitattributes | 1 + components/lazcontrols/docs/dividerbevel.xml | 3 +- components/lazcontrols/docs/lvlgraphctrl.xml | 6 +- docs/xml/lazutils/graphmath.xml | 529 +++++++++++++++++++ docs/xml/lazutils/graphtype.xml | 31 +- docs/xml/lazutils/lazutilities.xml | 155 ++++-- docs/xml/lcl/asyncprocess.xml | 102 ++-- docs/xml/lcl/buttonpanel.xml | 7 +- docs/xml/lcl/buttons.xml | 4 +- docs/xml/lcl/checklst.xml | 5 +- docs/xml/lcl/comboex.xml | 344 ++++++------ docs/xml/lcl/comctrls.xml | 12 +- docs/xml/lcl/controls.xml | 5 +- docs/xml/lcl/dbctrls.xml | 6 +- docs/xml/lcl/dbextctrls.xml | 14 +- docs/xml/lcl/dialogs.xml | 144 ++--- docs/xml/lcl/extctrls.xml | 3 +- docs/xml/lcl/extdlgs.xml | 9 +- docs/xml/lcl/extgraphics.xml | 2 +- docs/xml/lcl/forms.xml | 4 +- docs/xml/lcl/graphics.xml | 14 +- docs/xml/lcl/graphutil.xml | 2 +- docs/xml/lcl/imglist.xml | 21 +- docs/xml/lcl/interfacebase.xml | 12 +- docs/xml/lcl/intfgraphics.xml | 88 +-- docs/xml/lcl/lazfreetypeintfdrawer.xml | 51 ++ docs/xml/lcl/lclintf.xml | 18 +- docs/xml/lcl/lmessages.xml | 44 +- docs/xml/lcl/postscriptcanvas.xml | 152 ++---- docs/xml/lcl/postscriptprinter.xml | 84 ++- docs/xml/lcl/themes.xml | 358 +------------ docs/xml/lcl/toolwin.xml | 7 +- 32 files changed, 1130 insertions(+), 1107 deletions(-) create mode 100644 docs/xml/lazutils/graphmath.xml diff --git a/.gitattributes b/.gitattributes index 1b1b16329e..02424a908d 100644 --- a/.gitattributes +++ b/.gitattributes @@ -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 diff --git a/components/lazcontrols/docs/dividerbevel.xml b/components/lazcontrols/docs/dividerbevel.xml index db0672defc..075afe8df2 100644 --- a/components/lazcontrols/docs/dividerbevel.xml +++ b/components/lazcontrols/docs/dividerbevel.xml @@ -11,13 +11,12 @@ - - + Line with text in the middle, used as a divider or header. diff --git a/components/lazcontrols/docs/lvlgraphctrl.xml b/components/lazcontrols/docs/lvlgraphctrl.xml index 5b7ee05b19..7bb9f47cf0 100644 --- a/components/lazcontrols/docs/lvlgraphctrl.xml +++ b/components/lazcontrols/docs/lvlgraphctrl.xml @@ -15,17 +15,17 @@ - - - + + + diff --git a/docs/xml/lazutils/graphmath.xml b/docs/xml/lazutils/graphmath.xml new file mode 100644 index 0000000000..5988af7635 --- /dev/null +++ b/docs/xml/lazutils/graphmath.xml @@ -0,0 +1,529 @@ + + + + + + A Set of Mathematical Helper routines to simply Cross-Platform Canvas drawing etc + + + + + + + + + + + + TFloatPoint - an extended precision record specifying the X and Y coordinates of a point in a graphic environment + + + + + + + + + + + + + + + + + + + + + + + + + Angles2Coords - convert an Eccentric Angle and an Angle-Length, into the coords for Start and End Radial-Points + + +

+ 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. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Arc2Bezier - convert an Arc and ArcLength into a Bezier Approximation of the Arc. + +

+ 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. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Bezier - function to get a Bezier figure from the given points + + + + + + + + + + + + + + + + + + + + + + + Bezier2Polyline - convert a 4-Point Bezier into a Pointer Array of TPoint and a Count variable + + +

+ 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. +

+ + + + + + + + + + + + + + + + + BezierArcPoints - convert an Arc and ArcLength into a Pointer Array of TPoints for use with Polyline or Polygon + + +

+ 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. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + BezierMidPoint - get the Mid-Point of any 4-Point Bezier. It is primarily for use in SplitBezier. + + + + + + + + + + + + + + CenterPoint - get the Center-Point of any rectangle. It is primarily for use with, and in, other routines such as Quadrant, and RadialPoint + + + + + + + + + + + + + + Coords2Angles - convert the coords for Start and End Radial-Points into an Eccentric counter clockwise Angle and an Angle-Length + + +

+ 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. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get the Distance between any two Points. It is primarily for use in other routines such as EccentricAngle + + + + + + + + + + + + + + + + + EccentricAngle - get the Eccentric Angle of a given point on any non-rotated ellipse + + +

+ 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. +

+ + + + + + + + + + + + + + + + + EllipseRadialLength - Radial-Length of non-rotated ellipse at any given Eccentric Angle + + +

+ 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. +

+ + + + + + + + + + + + + + + + + FloatPoint - it is essentially like Classes.Point in use, except that it accepts Extended Parameters. It is Primarily for use with and in Bezier routines. + + + + + + + + + + + + + + + + + LineEndPoint - get the End-Point of a line of any given Length at any given angle with any given Start-Point + + +

+ 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. +

+ + + + + + + + + + + + + + + + + + + + PolyBezier2Polyline - convert an array of 4-Point Bezier into a Pointer Array of TPoint and a Count variable + + +

+ 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). +

+ + + + + + + + + + + + + + + + + PolyBezierArcPoints - convert an Arc and ArcLength into a Pointer Array of TPoints for use with Polyline or Polygon + + +

+ 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). +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Determine the Quadrant of any point, given the Center + +

+ 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. +

+ + + + + + + + + + + + + + + + Get the RadialPoint at any given Eccentric angle on any non-rotated ellipse + +

+ 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. +

+ + + + + + + + + + + + + + + + SplitBezier - split any 4-Point Bezier into two 4-Point Beziers: a 'Left' and a 'Right' + + +

+ 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. +

+ + + + + + + + + + + + + + + + + GraphMath Operators + + +

+ This Unit contains a number of routines for calculating and converting series of graphic points from one coordinate system to another. +

+

+ 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: +

+ +type + TFloatPoint = record + X, Y : Extended; + end; + +

+ 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. +

+ + + + + + diff --git a/docs/xml/lazutils/graphtype.xml b/docs/xml/lazutils/graphtype.xml index 0a10cf9c52..35521904bc 100644 --- a/docs/xml/lazutils/graphtype.xml +++ b/docs/xml/lazutils/graphtype.xml @@ -9,30 +9,15 @@ Definitions of several special types (including Raw Image) to be used for graphics + - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + diff --git a/docs/xml/lazutils/lazutilities.xml b/docs/xml/lazutils/lazutilities.xml index a03579923f..3be5cab0d7 100644 --- a/docs/xml/lazutils/lazutilities.xml +++ b/docs/xml/lazutils/lazutilities.xml @@ -16,134 +16,172 @@ - - - + Ensures that the specified object instance is freed and set to Nil + + FreeThenNil is a procedure used to ensure that the object instance in obj is freed and set to Nil. If obj has been assigned, it is cast to a TObject instance and its Free method is called. Finally, the pointer to the address in obj is set to Nil. + + - + Object instance modified in the routine - - - - - + Gets the relative order for the specified Pointers + +

+ ComparePointers is an Integer function used to get the relative order for the specified Pointer values. The following return values are used in the routine: +

+
+
1
+
Returned when p1 > p2.
+
0
+
Returned when p1 = p2.
+
-1
+
Returned when p1 < p2.
+
+ + - - - + Numeric value with the relative order for the compared Pointers - - - + Pointer compared in the routine - - - + Pointer compared in the routine - - - + Compares the specified Boolean values + +
+
0
+
Returned when b1 and b2 have the same value.
+
1
+
Returned when b1 is True.
+
-1
+
Returned as the default value (when b1 is False ).
+
+ + - + Numeric value for the comparison - + Boolean value compared in the routine - + Boolean value compared in the routine - - - + Gets the ordinal position for an enumeration value with the specified name + +

+ GetEnumValueDef is an Integer function used to get the ordinal position in the specified enumeration type insformation for the value with the given name. +

+

+ The return value contains the ordinal position in TypeInfo for the enumeration value with the given Name. GetEnumValueDef calls GetEnumValue to find the value in Name in the type information. If the return value is -1, an enumeration value with the specified name is not found in TypeInfo and the value in DefaultValue is used as the return value. +

+ + + + + - + Ordinal position for the enumeration value with the specified name - + Pointer to the type information examined in the routine - + Name for the enumeration value to locate in TypeInfo - + Default ordinal position for the enumeration value used when Name is not found - - + Rounds the specified Extended value to an Integer value + +

+ Calls Round to round the Extended value, and casts the result to the Integer type used as the return value. +

+ - + Integer value for the rounded numeric value - + Extended type rounded and converted in the routine - - + Rounds the specified Extended value to a Cardinal value + +

+ Calls Round to round the Extended value, and casts the result to the Cardinal type used as the return value. +

+ - + Cardinal value for the rounded numeric value - + Extended type rounded and converted in the routine - + Truncates the extended value and returns an Integer type - + Integer type with the truncated value - + Extended value truncated and converted in the routine - + Truncates the extended value and returns a Cardinal type - + Cardinal type with the truncated value - + Extended value truncated and converted in the routine - - + Converts the specified string value to a Double type + +

+ Calls StrToFloat to convert the value in s, and casts the result to the Double data type used as the return value. +

+ - + Double type with the converted value - + String value converted in the routine + ? @@ -157,9 +195,24 @@ - - + +

+ ConsoleVerbosity 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. +

+
+
-1
+
Quiet
+
0
+
Normal verbosity (No debugger output)
+
1
+
Verbose (Debugger output enabled)
+
2
+
Very verbose (Debugger output enabled)
+
+ + + diff --git a/docs/xml/lcl/asyncprocess.xml b/docs/xml/lcl/asyncprocess.xml index 70e6f01e70..86822b3b1e 100644 --- a/docs/xml/lcl/asyncprocess.xml +++ b/docs/xml/lcl/asyncprocess.xml @@ -1,7 +1,6 @@ - - - - - - - - - - - - - - - - - - - + + + + + + + - + Implements a process with asynchronous notifications for data and termination

- TAsyncProcess is a TProcessUTF8 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. + TAsyncProcess is a TProcessUTF8 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.

- + + + - - - - - - - - - - - - - - - - - - - + + + + @@ -74,13 +48,13 @@

- GetNumBytesAvailable is a dword function used to get the value for the NumBytesAvailable property. The return value contains the value in Output.NumBytesAvailable, or 0 (zero) when Options does not include the value poUsePipes. + GetNumBytesAvailable is a dword function used to get the value for the NumBytesAvailable property. The return value contains the value in Output.NumBytesAvailable, or 0 (zero) when Options does not include the value poUsePipes.

- Use NumBytesAvailable to read the value for the property. + Use NumBytesAvailable to access the value for the property.

- Use Options to enable the Options for the process. + Use Options to enable the Options for the process.

@@ -94,17 +68,17 @@ - Implements support for asynchronous notifications during execution of the process + Implements asynchronous notifications during execution of the process

- HandlePipeInput 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. + HandlePipeInput 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.

- 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 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).

- Use OnReadData to respond to arrival of data on the handle for the process. Use NumBytesAvailable is determine the number of bytes available. + Use OnReadData to respond to arrival of data on the handle for the process. Use NumBytesAvailable is determine the number of bytes available.

@@ -127,10 +101,10 @@

- HandleProcessTermination is a procedure which performs actions needed when the process is terminated. HandleProcessTermination is assigned using AddProcessEventHandler when Execute is called. + HandleProcessTermination is a procedure which performs actions needed when the process is terminated. HandleProcessTermination is assigned using AddProcessEventHandler when Execute is called.

- 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 UnhookProcessHandle and UnhookPipeHandle to release the handlers in the class instance. HandleProcessTermination signals the OnTerminate event handler when it has been assigned.

@@ -158,7 +132,7 @@

- UnhookPipeHandle 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. + UnhookPipeHandle 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.

@@ -171,8 +145,7 @@

- UnhookProcessHandle 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. + UnhookProcessHandle 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.

@@ -185,13 +158,13 @@

- Execute 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. + Execute 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.

- When Options includes the value poUsePipes, AddPipeEventHandler is called using HandlePipeInput as the pipe handler. + When Options includes the value poUsePipes, AddPipeEventHandler is called using HandlePipeInput as the pipe handler routine.

- Execute calls AddProcessEventHandler using HandleProcessTermination as the process handle. + Execute calls AddProcessEventHandler using HandleProcessTermination as the process handler routine.

@@ -200,16 +173,17 @@ + Number of output bytes available from the process

- NumBytesAvailable 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. + NumBytesAvailable is a read-only name 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.

- Set the values for the Options property prior to calling Execute. + Set the values for the Options property prior to calling Execute.

- Use OnReadData to respond to the process notification signalled when data is available. + Use OnReadData to respond to the process notification signalled when data is available.

@@ -218,11 +192,11 @@ - Event handler signalled when data is available + Event handler signalled when output data is available for the process

- OnReadData 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. + OnReadData 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 available data must be handled, or the procedure will be called repeatedly until no more data is available.

@@ -235,7 +209,7 @@

- OnTerminate 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. + OnTerminate 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.

diff --git a/docs/xml/lcl/buttonpanel.xml b/docs/xml/lcl/buttonpanel.xml index 2b7eb23b55..b6b4546120 100644 --- a/docs/xml/lcl/buttonpanel.xml +++ b/docs/xml/lcl/buttonpanel.xml @@ -14,17 +14,16 @@ - + + - - - + diff --git a/docs/xml/lcl/buttons.xml b/docs/xml/lcl/buttons.xml index 7e28a5d2e2..2fcca66f4d 100644 --- a/docs/xml/lcl/buttons.xml +++ b/docs/xml/lcl/buttons.xml @@ -15,7 +15,7 @@ - + @@ -25,8 +25,8 @@ - + diff --git a/docs/xml/lcl/checklst.xml b/docs/xml/lcl/checklst.xml index 7ecf8ce908..6066453dd5 100644 --- a/docs/xml/lcl/checklst.xml +++ b/docs/xml/lcl/checklst.xml @@ -14,15 +14,14 @@ - - + - + diff --git a/docs/xml/lcl/comboex.xml b/docs/xml/lcl/comboex.xml index 9b595da60d..4cbd0e3c7b 100644 --- a/docs/xml/lcl/comboex.xml +++ b/docs/xml/lcl/comboex.xml @@ -32,9 +32,7 @@ - - Enumerated type with values representing the autocomplete options used in TComboBoxEx - + Enumerated type with values representing the autocomplete options used in TComboBoxEx

TAutoCompleteOption is an enumerated type with values representing the autocomplete options used in TCustomComboBoxEx and TComboBoxEx. Values from the enumeration are stored in the TAutoCompleteOptions set type used to implement the AutoCompleteOptions property in TCustomComboBoxEx and TComboBoxEx. Including a value from the enumeration in the TAutoCompleteOptions set enables the corresponding feature. @@ -47,10 +45,10 @@ - Enables auto suggest + Enables auto-suggest - Enables auto appending items to the combo-box + Enables auto-appending items to the combo-box Enables searching items for the current value in the edit control @@ -62,9 +60,7 @@ Enables Tab key navigation in the control - - Enables toggling the visibility of the drop down using Up and Down cursor keys - + Enables toggling the visibility of the drop down using Up and Down cursor keys Enables Right-to-Left text rendering (BiDi Mode) in the control @@ -85,9 +81,7 @@ - - Enumerated type with values for display styles available in TCustomComboBoxEx - + Enumerated type with values for display styles available in TCustomComboBoxEx

TComboBoxExStyle is an enumerated type with values representing the display styles available in TCustomComboBoxEx. TComboBoxExStyle is the type used to implement the Style property in TCustomComboBoxEx and TComboBoxEx. @@ -125,27 +119,27 @@ - No used in the current LCL implementation. + Not used in the current LCL implementation. Enables case-sensitive comparisons in the control - No used in the current LCL implementation. + Not used in the current LCL implementation. - No used in the current LCL implementation. + Not used in the current LCL implementation. - No used in the current LCL implementation. + Not used in the current LCL implementation. - No used in the current LCL implementation. + Not used in the current LCL implementation. - No used in the current LCL implementation. + Not used in the current LCL implementation. @@ -200,9 +194,7 @@ - - Integer with the relative order for the compared values at the specified positions - + Integer with the relative order for the compared values at the specified positions Collection with the items compared in the routine @@ -223,9 +215,7 @@ - - Specifies an event handler signalled when a checkbox in TCustomCheckCombo is changed - + Specifies an event handler signalled when a checkbox in TCustomCheckCombo is changed

TCheckItemChange is an object procedure which specifies an event handler signalled when a checkbox in TCustomCheckCombo is changed. TCheckItemChange is the type used to implement the OnItemChange property in TCustomCheckCombo and TCheckComboBox. @@ -252,19 +242,19 @@ Similar to TListItemsSortType, but implemented as an object function.

- + - + - + - + - + @@ -379,7 +369,7 @@ ImageIndex is an Integer property used to specify the ordinal position in an image list for the bitmap displayed for the list item. -1 (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.

- + @@ -445,7 +435,7 @@ Default caption used for a new item - + @@ -455,7 +445,7 @@ Create calls the inherited constructor, and sets the default values for properties in the class instance.

- + Collection which owns the collection item @@ -471,7 +461,7 @@ Destroy ensures that the number of items in the Collection and the Owner for the collection are kept in sync. Normally, the value in Count is maintained when the Collection frees an item instance in its Delete method. Destroy handles the situation where the collection item is destroyed by calling the Free method in the collection item instead.

- A component notification message is performed for the Collection to signal the delete operation. The Notify 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 Notify 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.

Destroy calls the inherited destructor prior to exiting from the method. @@ -505,9 +495,7 @@ - - Ordinal position for the image drawn as an overlay for the Image in the combo-box item - + Ordinal position for the image drawn as an overlay for the Image in the combo-box item

The default value for the property is -1, 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 -1. @@ -521,11 +509,9 @@ - - Ordinal position for the image drawn when the item is selected in the Combo-Box - + Ordinal position for the image drawn when the item is selected in the Combo-Box - + @@ -608,7 +594,7 @@

0
The captions in AItem1 and Aitem2 are the same
> 0
-
The caption in AItem1 comes after caption in AItem2
+
The caption in AItem1 comes after the caption in AItem2

CompareItems is used in the implementation of the Sort method when SortType contains the value stText or stBoth. @@ -635,33 +621,33 @@ - - - + + + - + - + - + - - - + + + - + - + - + @@ -710,9 +696,11 @@ Performs the Sort routine required for the setting in SortType - Sort is a procedure used to perform the sort routine indicated in the SortType property. +

+ Sort is a procedure used to perform the sort routine indicated in SortType. +

- + @@ -742,9 +730,7 @@ - - Indicates if case sensitivity is used when comparing items in the collection - + Indicates if case sensitivity is used when comparing items in the collection

CaseSensitive is a Boolean property which indicates if case sensitivity is used when comparing items in the collection. The value in CaseSensitive is used in the CompareItems method. When set to False, the captions for the compared Items are converted to lowercase prior to comparing their values. @@ -762,12 +748,10 @@ - - Determines the comparison mechanism used for collection items in the Sort method - + Determines the comparison mechanism used for collection items in the Sort method

- SortType is a TListItemsSortType property which determines the comparison mechanism used for collection items in the Sort method.The default value for the property is stNone 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. + SortType is a TListItemsSortType property which determines the comparison mechanism used for collection items in the Sort method. The default value for the property is stNone 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.

@@ -778,9 +762,7 @@ - - Event handler signalled to sort the collection using the data in the collection items - + Event handler signalled to sort the collection using the data in the collection items

OnCompare is a TListCompareEvent 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 @@ TComboExItems is a TListControlItems descendant which Implements a collection for the items added to TCustomComboBoxEx and TComboBoxEx. TComboExItems extends the ancestor class to use the TComboExItem 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 AddItem method is introduced to create a new collection item and configure its property values. The Notify and Update methods are overridden to use the correct ItemClass as well.

- TComboExItems is the type used to implement the ItemsEx property in TCustomComboBoxEx. + TComboExItems is the type used to implement the ItemsEx property in TCustomComboBoxEx.

@@ -833,16 +815,14 @@ Tracks the add or delete status for the collection - - - 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 - + Collection item for the notification @@ -856,7 +836,7 @@ Forces the owner of the collection (the control) to be redrawn when needed. - + Collection item examined in the method @@ -970,9 +950,7 @@ - - Implements the base class for an extended/enhanced combo-box - + Implements the base class for an extended/enhanced combo-box

TCustomComboBoxEx is a TCustomComboBox descendant which implements the base class for TComboBoxEx. @@ -1056,22 +1034,22 @@ - 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 - + Internal flag which tracks the BidiMode setting in the control - + Internal derived text height for an item in the combo-box - + @@ -1079,10 +1057,10 @@ Performs actions needed when the BiDiMode setting is changed for the control - + - + @@ -1092,10 +1070,10 @@ DrawItem is an overridden procedure used to draw an item in the extended combo-box control.

- 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 ItemsEx that is drawn in the method.

- ARect 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. + ARect 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.

State 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 ThemeServices to get theme details applied to enabled items in the combo-box. DrawItem ensures that a valid text height is available for the control Canvas, and is used to draw the text for the item.

- When Images have been assigned for the control, the image index appropriate to the value in State is determined. The value odSelected causes the SelectedImageIndex for the item is be used. Otherwise, the ImageIndex for the item is used. + When Images have been assigned for the control, the image index appropriate for the value in State is determined. The value odSelected causes the SelectedImageIndex for the item is be used. Otherwise, the ImageIndex for the item is used.

- The image size is determined by calling the SizeForPPI method in Images using the ImagesWidth and the display density for the current Font 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 DrawIcon method in ThemeServices is called to render the icon to the control Canvas using the theme details. + The image size is determined by calling the SizeForPPI method in Images using the ImagesWidth and the display density for the current Font. 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 DrawIcon method in ThemeServices is called to render the icon to the control Canvas using the theme details.

- Images are not 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 not 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.

- 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 DrawText 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 DrawText method.

Please note: DrawItem does NOT call the inherited method in TCustomComboBox or trigger its OnDrawItem event handler. The item is rendered entirely in this method. - - + Ordinal position for the item drawn in the method @@ -1196,7 +1173,7 @@
Set to True to force the item height to be recalculated
- + Owner of the class instance @@ -1215,9 +1192,7 @@ - - Adds a new item to the extended combo-box control - + Adds a new item to the extended combo-box control

Add 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.

- + Item added to the control @@ -1345,8 +1320,8 @@ Inserts a new item with the specified values at the given position - - + + Ordinal position where the new item is stored @@ -1369,16 +1344,16 @@ Contains settings for autocompletion features enabled in the control - - + + Contains images which can be displayed for items defined in the ItemsEx property - - + + @@ -1403,9 +1378,7 @@ - - Collection with the extended items defined for the control - + Collection with the extended items defined for the control

ItemsEx is a TComboExItems property which provides access to the extended items defined for the combo-box control. ItemsEx uses TComboExItem as the ItemClass for the collection. The collection is maintained using the Add, AddItem, Delete, DeleteSelected, and Clear methods. Use AssignItemsEx to set the values in the collection to the values from a specific source. @@ -1427,9 +1400,7 @@ - - Specifies the control style used for the edit in the combo-box control - + Specifies the control style used for the edit in the combo-box control

Style is a TComboBoxExStyle property which specifies the control style used for the control. This is a narrower range of values than those used in the TCustomComboBox 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 cDefStyle constant.

- + - - Enables feature or behaviors in the extended combo-box control - + Enables feature or behaviors in the extended combo-box control

StyleEx is a TComboBoxExStyles property used to store TComboBoxExStyleEx 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 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. - + Implements an extended combo-box component - + @@ -1547,9 +1516,7 @@ - - Represents state and data for a Checkbox item displayed in TCustomCheckCombo - + Represents state and data for a Checkbox item displayed in TCustomCheckCombo

TCheckComboItemState is a class used to represent state and data for a Checkbox item displayed in TCustomCheckCombo and TCheckComboBox. 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 @@ Contains arbitrary data associated with a checkbox item - + @@ -1605,10 +1572,10 @@ - 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 - - + + @@ -1761,37 +1728,37 @@ Internal member used to to track the highlighting state - + Internal member used to track size adjusts needed for them services - + Internal members used to track the state for the drop down in the control - + Internal member used to track the item highlighted in the control - + Internal member used to track the left coordinate for the highlight - + Internal member used to track the right coordinate for the highlight - + @@ -1799,7 +1766,7 @@ Internal member used to track whether the text height has been calculated for items in the control - + @@ -1807,7 +1774,7 @@ Internal member used to track whether drop down requests should be rejected; i. e. the drop down is already visible - + @@ -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 - + Internal member used to track the BiDi status for the control - + - - Internal member used to track the text height for checkboxes in the control - + Internal member used to track the text height for checkboxes in the control - + - - Performs actions needed when the BiDiMode setting is changed for the control - + Performs actions needed when the BiDiMode setting is changed for the control - + - + @@ -1878,15 +1841,13 @@ - - Draws a checkbox item defined in the combo-box control - + Draws a checkbox item defined in the combo-box control

DrawItem is an overridden procedure used to draw a checkbox defined in the Items for the control.

- 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 ItemsEx that is drawn in the method.

ARect 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 ThemeServices 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 Canvas, and is used to draw the text for the check box.

- 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 DrawText 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 DrawText method.

Please note: DrawItem does NOT call the inherited method in TCustomComboBox or trigger its OnDrawItem event handler. The item is rendered entirely in this method. - + Ordinal position for the checkbox drawn in the method @@ -1965,14 +1926,28 @@ Initializes checkbox state information for items in the control - - + +

+ InitItemStates is used to initialize state information for the Items defined in the checkbox control. InitItemStates iterates over the values in Items, and creates a TCheckComboItemState instance with the enabled, checked state, and state data for each of the items. +

+

+ The TCheckComboItemState instance is stored in the indexed Objects property. Existing values in Objects are not modified. An Exception is raised if an existing value not derived from TCheckComboItemState is found in Objects. +

+

+ InitItemStates is called from the AssignItems, InitializeWnd, and Loaded methods. It is also called when a new values is assigned to the Items property. +

+

+ ClearItemStates is used to remove TCheckComboItemState instances for Items in the control. +

+ + + Raises an Exception with the message 'Item # is not a TCheckComboItemState' when Objects contains a value not derived from TCheckComboItemState. + + - - Ensures that checkbox item state classes have been allocated for items in the control - + Ensures that checkbox item state classes have been allocated for items in the control

CheckItemStates is a procedure used to ensure that TCheckComboItemState class instances exist for the Items 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 @@ - - Queues an asynchronous call to AsyncCheckItemStates in the Application singleton - + Queues an asynchronous call to AsyncCheckItemStates in the Application singleton

QueueCheckItemStates is a procedure used to queue an asynchronous call to the AsyncCheckItemStates method in the global Application singleton. QueueCheckItemStates is called from the DrawItem method. @@ -2046,17 +2019,13 @@ - - Deactivates tracking the highlighted checkbox when the mouse leaves the control - + Deactivates tracking the highlighted checkbox when the mouse leaves the control - + - - Tracks changes to the highlighted checkbox in the control - + Tracks changes to the mouse positon for the highlighted checkbox in the control

MouseMove is overridden in TCustomCheckCombo 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 @@ Sets the value for the ItemHeight property - + New value for the property @@ -2088,13 +2057,13 @@ Sets the value for the Items property - + New value for the property - + Toggles the value for the current item selected in the control

@@ -2181,9 +2150,7 @@ - - Assigns the content in the specified TStringList to the Items in the control - + Assigns the content in the specified TStringList to the Items in the control

AssignItems calls ClearItemStates to reset the state flags for the existing Items. The Assign method in Items is called to store the values in AItems. The InitItemStates method is called to initialize the Objects properties in Items with TCheckComboItemState instances for each of the check boxes. @@ -2221,17 +2188,23 @@ Deletes the checkbox at the specified position - - + +

+ Ensures that an object instance stored in Objects is freed before removing the item. + Calls the Delete method to remove the item at the position in AIndex. +

+ + + + + - Ordinal position for the checkbox removed in the method + Ordinal positon for the item removed in the method - - Sets the state for all checkboxes defined in the control meeting the specified criteria - + Sets the state for all checkboxes defined in the control meeting the specified criteria

CheckAll is a procedure used to set the checked state for all checkboxes defined in the Items for the control. AState contains the state applied to the checkboxes defined in the control. @@ -2262,9 +2235,12 @@ - Toggles the value for the checkbox at the specified position - - + Toggles the checked state for the checkbox at the specified position + + + + Not sure how to describe the internal state map. + Ordinal position for the checkbox affected in the method @@ -2277,7 +2253,7 @@ AllowGrayed is a Boolean property which indicates if checkboxes can be displayed in the "grayed" or indeterminate state. The default value for the property is False.

- + @@ -2300,9 +2276,7 @@ - - Provides indexed access to the Boolean value for a checkbox defined in Items - + Provides indexed access to the Boolean value for a checkbox defined in Items

Checked is an indexed Boolean property which provides access to the checked state for a checkbox item defined in the control. AIndex specifies the ordinal position in Items for the checkbox. Checked uses the value from the TCheckComboItemState object stored in the Items property. True indicates that TCheckComboItemState.Checked contains the value cbChecked. False indicates that it contains the value cbUnchecked. @@ -2319,10 +2293,8 @@ - - Provides indexed access to the Boolean enabled value for a checkbox defined in Items - - + Provides indexed access to the Boolean enabled value for a checkbox defined in Items + @@ -2336,9 +2308,7 @@ - - Provides indexed access to the Data for a checkbox defined in Items - + Provides indexed access to the Data for a checkbox defined in Items

Objects is an indexed TObject property which provides access to the Data for a checkbox defined in Items. 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 @@ - - Provides indexed access to the checked State for a checkbox defined in Items - + Provides indexed access to the checked State for a checkbox defined in Items

State is an indexed TCheckBoxState property which provides access to the checked State for a checkbox defined in Items. AIndex specifies the ordinal position in Items for the checkbox. State returns the TCheckBoxState value in TCheckComboItemState.State for the associated object instance. @@ -2377,9 +2345,7 @@ - - Event handler signalled when the state for a checkbox in the control is changed - + Event handler signalled when the state for a checkbox in the control is changed

OnItemChange is a TCheckItemChange property with the event handler signalled when a value in the Checked or State properties is changed. Arguments passed to the event handler identify the object for the event notification, and the ordinal position in Items for the modified checkbox. diff --git a/docs/xml/lcl/comctrls.xml b/docs/xml/lcl/comctrls.xml index 7a5732d5e1..4f47b3ff61 100644 --- a/docs/xml/lcl/comctrls.xml +++ b/docs/xml/lcl/comctrls.xml @@ -18,19 +18,14 @@ - - - - + - - @@ -42,6 +37,11 @@ + + + + + Represents permissible results for a hit test diff --git a/docs/xml/lcl/controls.xml b/docs/xml/lcl/controls.xml index acc5e65917..9def63d10b 100644 --- a/docs/xml/lcl/controls.xml +++ b/docs/xml/lcl/controls.xml @@ -21,7 +21,6 @@ - @@ -33,10 +32,12 @@ + + + - diff --git a/docs/xml/lcl/dbctrls.xml b/docs/xml/lcl/dbctrls.xml index 11f7a1469d..f898dfa5cf 100644 --- a/docs/xml/lcl/dbctrls.xml +++ b/docs/xml/lcl/dbctrls.xml @@ -17,14 +17,11 @@ - - - @@ -34,6 +31,9 @@ + + + diff --git a/docs/xml/lcl/dbextctrls.xml b/docs/xml/lcl/dbextctrls.xml index 233bbb84a2..edce3ec157 100644 --- a/docs/xml/lcl/dbextctrls.xml +++ b/docs/xml/lcl/dbextctrls.xml @@ -13,10 +13,9 @@ - - + @@ -540,8 +539,15 @@ - - + + Registers components for use in the Lazarus IDE + +

+ Register is the procedure used to registers components for use in the Lazarus IDE. Register calls RegisterComponents to add the TDBDateEdit component to the Data Controls tab in the Lazarus IDE. +

+ + + diff --git a/docs/xml/lcl/dialogs.xml b/docs/xml/lcl/dialogs.xml index 677e59fe0f..01f0a86366 100644 --- a/docs/xml/lcl/dialogs.xml +++ b/docs/xml/lcl/dialogs.xml @@ -9,120 +9,36 @@ Some dialogs commonly used in Lazarus applications. Look at the Procedures as well as the Classes - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Constants to define the types of message dialogs. diff --git a/docs/xml/lcl/extctrls.xml b/docs/xml/lcl/extctrls.xml index 5ec870e6e8..079b54f4e7 100644 --- a/docs/xml/lcl/extctrls.xml +++ b/docs/xml/lcl/extctrls.xml @@ -24,7 +24,6 @@ - @@ -33,7 +32,9 @@ + + diff --git a/docs/xml/lcl/extdlgs.xml b/docs/xml/lcl/extdlgs.xml index 177f8898f6..bb8673ac78 100644 --- a/docs/xml/lcl/extdlgs.xml +++ b/docs/xml/lcl/extdlgs.xml @@ -16,17 +16,13 @@ - - - - + - @@ -35,6 +31,9 @@ + + + diff --git a/docs/xml/lcl/extgraphics.xml b/docs/xml/lcl/extgraphics.xml index 84d021df3c..e0dc3a22fc 100644 --- a/docs/xml/lcl/extgraphics.xml +++ b/docs/xml/lcl/extgraphics.xml @@ -16,8 +16,8 @@ - + diff --git a/docs/xml/lcl/forms.xml b/docs/xml/lcl/forms.xml index 9442775fd6..18dff8d962 100644 --- a/docs/xml/lcl/forms.xml +++ b/docs/xml/lcl/forms.xml @@ -11,6 +11,7 @@ Contains types and classes used to implement Forms, which are the basis for the Lazarus Graphical User Interface + @@ -26,7 +27,6 @@ - @@ -44,8 +44,10 @@ + + The type of a procedure that takes no arguments diff --git a/docs/xml/lcl/graphics.xml b/docs/xml/lcl/graphics.xml index acbaac2650..5806a5c9c6 100644 --- a/docs/xml/lcl/graphics.xml +++ b/docs/xml/lcl/graphics.xml @@ -30,11 +30,8 @@ + - - - - @@ -43,10 +40,15 @@ - - + + + + + + + Pointer to the TColor type diff --git a/docs/xml/lcl/graphutil.xml b/docs/xml/lcl/graphutil.xml index 8a114ba005..a50b9eff66 100644 --- a/docs/xml/lcl/graphutil.xml +++ b/docs/xml/lcl/graphutil.xml @@ -30,9 +30,9 @@ - + Converts a Lazarus TColor value to its grayscale equivalent diff --git a/docs/xml/lcl/imglist.xml b/docs/xml/lcl/imglist.xml index 59a5fc9c8e..eddeba6057 100644 --- a/docs/xml/lcl/imglist.xml +++ b/docs/xml/lcl/imglist.xml @@ -17,28 +17,29 @@ + + + + - - - - - - - - - + - + + + + + + diff --git a/docs/xml/lcl/interfacebase.xml b/docs/xml/lcl/interfacebase.xml index 5748db07dd..83707805ee 100644 --- a/docs/xml/lcl/interfacebase.xml +++ b/docs/xml/lcl/interfacebase.xml @@ -18,18 +18,18 @@ + + + + + + - - - - - - diff --git a/docs/xml/lcl/intfgraphics.xml b/docs/xml/lcl/intfgraphics.xml index 3535bc09bc..4a1426b668 100644 --- a/docs/xml/lcl/intfgraphics.xml +++ b/docs/xml/lcl/intfgraphics.xml @@ -9,73 +9,29 @@ Classes and functions for easy handling of raw images (interface images) + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/xml/lcl/lazfreetypeintfdrawer.xml b/docs/xml/lcl/lazfreetypeintfdrawer.xml index 17858bceae..64155bc01c 100644 --- a/docs/xml/lcl/lazfreetypeintfdrawer.xml +++ b/docs/xml/lcl/lazfreetypeintfdrawer.xml @@ -13,6 +13,57 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/xml/lcl/lclintf.xml b/docs/xml/lcl/lclintf.xml index f0123df82c..eb7a02c1ab 100644 --- a/docs/xml/lcl/lclintf.xml +++ b/docs/xml/lcl/lclintf.xml @@ -27,14 +27,28 @@ + + + + + + + - + + - + + + + + + + Draws an elliptical curve diff --git a/docs/xml/lcl/lmessages.xml b/docs/xml/lcl/lmessages.xml index e28dae2746..372aed54bc 100644 --- a/docs/xml/lcl/lmessages.xml +++ b/docs/xml/lcl/lmessages.xml @@ -1,53 +1,23 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + diff --git a/docs/xml/lcl/postscriptcanvas.xml b/docs/xml/lcl/postscriptcanvas.xml index dad3c6e533..458d35229f 100644 --- a/docs/xml/lcl/postscriptcanvas.xml +++ b/docs/xml/lcl/postscriptcanvas.xml @@ -9,117 +9,55 @@ --> - +Contains classes and types used to implement a PostScript printer canvas +

+ Developed using information from: +

+
    +
  • The Green Book Listing 9-1, on page 138 for Patterns
    • +
  • PostScriptPrinter.pas unit by Tony Maro
    • +
  • Piddle Project (Python language)
    • +
  • Internet PostScript forums
    • +
+

+ Warnings: +

+
    +
  • + Draw and StretchDraw are slow for big images. +
    • +
  • + Angles are expressed in 1/16th of degree. +
    • +
+

+ Author: Olivier Guilbaud. + TextRect implemented by T. P. Launchbury (12 Dec 2012). +

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + diff --git a/docs/xml/lcl/postscriptprinter.xml b/docs/xml/lcl/postscriptprinter.xml index e4e186ab8e..e40c609893 100644 --- a/docs/xml/lcl/postscriptprinter.xml +++ b/docs/xml/lcl/postscriptprinter.xml @@ -2,61 +2,39 @@ + ==================================================================== + PostScriptPrinter + ==================================================================== + --> - - + Contains classes and types used to implement a PostScript printer + +

+ Defines a special canvas type object and override drawing methods to make the postscript code. +

+

+ Defines a TPSPattern object that handles creation of patterns to be used in fill and paint operations. +

+

+ TPostScript manages a list of patterns and inserts the definitions into the postscript code and manages when they are changed. +

+

+ 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. +

+

+ Author: Tony Maro +

+ + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + diff --git a/docs/xml/lcl/themes.xml b/docs/xml/lcl/themes.xml index 84fa69d840..650df2eb60 100644 --- a/docs/xml/lcl/themes.xml +++ b/docs/xml/lcl/themes.xml @@ -1,836 +1,520 @@ - - For manipulation of display Themes, mostly in a Windows XP (and later) environment - - - - - - - - + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Represents elements which can be themed - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Represents data elements for themed buttons - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Represents data elements used to theme a Clock - - - - - - - +Represents data elemenets used to theme combo-box controls - - - - - - - - - - - - - - +Represents data elements used to theme Edit controls - - - - - - - - - - - - - - - - - - - - - - +Represents data elements used to theme an Explorer Bar - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Represents data elements used to theme a Header control - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Represents data elements used to theme List View controls - - - - - - - - - - - - - - - - - - - - - - - - +Represents data elements used to theme Menus - - - - - - - - - - - - - - - - - - - - - @@ -3729,7 +3413,7 @@ - - + + diff --git a/docs/xml/lcl/toolwin.xml b/docs/xml/lcl/toolwin.xml index 37aa567b57..8ea304128b 100644 --- a/docs/xml/lcl/toolwin.xml +++ b/docs/xml/lcl/toolwin.xml @@ -14,14 +14,13 @@ - - - - + + +