mirror of
https://gitlab.com/freepascal.org/lazarus/lazarus.git
synced 2025-04-07 18:58:04 +02:00
Docs: Documentation updates for LCL and LazUtils. Issue #37632, patch from Don Siders.
git-svn-id: trunk@63822 -
This commit is contained in:
juha
parent
d279fb5a4a
commit
7bfebf3d58
@ -14,6 +14,7 @@
|
||||
|
||||
<!-- unresolved external references -->
|
||||
<element name="SysUtils"/>
|
||||
<element name="Math"/>
|
||||
<element name="SyncObjs"/>
|
||||
<element name="LazSysUtils"/>
|
||||
|
||||
@ -190,7 +191,6 @@
|
||||
<element name="TLazThreadedQueue.FHasItemEvent"/>
|
||||
<element name="TLazThreadedQueue.FShutDown"/>
|
||||
|
||||
<!-- function Visibility: private -->
|
||||
<element name="TLazThreadedQueue.TryPushItem">
|
||||
<short>Tries to add the specified item to the queue</short>
|
||||
<descr>
|
||||
@ -198,42 +198,30 @@
|
||||
<var>TryPushItem</var> is a <var>Boolean</var> function which tries to add the item specified in <var>AItem</var> to the internal storage for the queue. The return value is <b>True</b> if the item was successfully added in the method.
|
||||
</p>
|
||||
<p>
|
||||
<var>TryPushItem</var> is used in the implementation of the <var>PushItem</var> method. Use <var>PushItem</var> or to add an item to the thread-safe queue.
|
||||
<var>TryPushItem</var> is used in the implementation of the <var>PushItem</var> method. Use <var>PushItem</var> to add an item to the thread-safe queue.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="TLazThreadedQueue.PushItem"/>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- function result Visibility: private -->
|
||||
<element name="TLazThreadedQueue.TryPushItem.Result">
|
||||
<short>True if the item was added successfully</short>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TLazThreadedQueue.TryPushItem.AItem">
|
||||
<short>Item added to the queue in the method</short>
|
||||
</element>
|
||||
|
||||
<!-- function Visibility: private -->
|
||||
<element name="TLazThreadedQueue.TryPopItem">
|
||||
<short>
|
||||
Tries to remove the next item in the thread-safe queue
|
||||
</short>
|
||||
<descr></descr>
|
||||
<errors></errors>
|
||||
<seealso></seealso>
|
||||
<short>Tries to remove the next item in the thread-safe queue</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- function result Visibility: private -->
|
||||
<element name="TLazThreadedQueue.TryPopItem.Result">
|
||||
<short>
|
||||
True if an item was successfully removed from the queue
|
||||
</short>
|
||||
<short>True if an item was successfully removed from the queue</short>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TLazThreadedQueue.TryPopItem.AItem">
|
||||
<short>
|
||||
Item removed from the queue in the method
|
||||
</short>
|
||||
<short>Item removed from the queue in the method</short>
|
||||
</element>
|
||||
|
||||
<!-- constructor Visibility: public -->
|
||||
@ -292,24 +280,20 @@
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TLazThreadedQueue.Grow">
|
||||
<short>
|
||||
Increases the allocated storage for the queue by the specified size
|
||||
</short>
|
||||
<short>Increases the allocated storage for the queue by the specified size</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>Grow</var> is a procedure which increases the storage allocated for items in the queue by the specified value in <var>ADelta</var>. The internal queue size is incremented by the value in <var>ADelta</var>. The length of the internal storage for the queue is increased to match the new queue size.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso></seealso>
|
||||
<seealso/>
|
||||
<notes><note>Update needed. Internal storage is now re-allocated.</note></notes>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TLazThreadedQueue.Grow.ADelta">
|
||||
<short>Value used to increase the size of the queue</short>
|
||||
</element>
|
||||
|
||||
<!-- function Visibility: public -->
|
||||
<element name="TLazThreadedQueue.PushItem">
|
||||
<short>Adds the specified item to the queue</short>
|
||||
<descr>
|
||||
@ -323,7 +307,7 @@
|
||||
When PushTimeout contains <b>0</b>, the request will timeout after the first failed attempt to add the specified item to the queue.
|
||||
</p>
|
||||
<p>
|
||||
When <var>ShutDown</var> contains True, the return value is updated to indicate that the request should be abandoned.
|
||||
When <var>ShutDown</var> contains <b>True</b>, the return value is updated to indicate that the request should be abandoned.
|
||||
</p>
|
||||
<p>
|
||||
The return value contains a <var>TWaitResult</var> enumeration value that indicates the status for the enqueue request. See <var>TWaitResult</var> for more information about enumeration values and their meanings.
|
||||
@ -331,15 +315,13 @@
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="TLazThreadedQueue.ShutDown"/>
|
||||
<link id="#FCL.SyncObjs.TWaitResult"/>
|
||||
<link id="#RTL.System.RTLeventWaitFor"/>
|
||||
<link id="#fcl.syncobjs.TWaitResult"/>
|
||||
<link id="#rtl.system.RTLeventWaitFor"/>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- function result Visibility: public -->
|
||||
<element name="TLazThreadedQueue.PushItem.Result">
|
||||
<short>Contains the status for the enqueue request</short>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TLazThreadedQueue.PushItem.AItem">
|
||||
<short>Item added to the storage for the queue</short>
|
||||
</element>
|
||||
|
||||
@ -17238,14 +17238,31 @@
|
||||
</element>
|
||||
|
||||
<element name="TTreeNodes.SetUpdateState">
|
||||
<short>
|
||||
<var>SetUpdateState</var> - records status of update process
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short>Sets the update state in the TreeView which owns the node tree</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>SetUpdateState</var> is a procedure used to set the update state in the TreeView which owns the class instance. <var>Updating</var> indicates the <var>TTreeViewState</var> value(s) that are included in or excluded from the States property in the <var>Owner</var>.
|
||||
</p>
|
||||
<p>
|
||||
When <var>Updating</var> is <b>True</b>, the value <var>tvsUpdating</var> is included in the <var>States</var> property in Owner.
|
||||
</p>
|
||||
<p>
|
||||
When Updating is <b>False</b>, <var>tvsUpdating</var> is excluded from and <var>tvsScrollbarChanged</var> is included in the States property in Owner. This also causes the TreeView to update its scrollbars and repaint the control .
|
||||
</p>
|
||||
<p>
|
||||
SetUpdateState is used to implement the <var>BeginUpdate</var> and <var>EndUpdate</var> methods.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="TTreeNodes.Owner"/>
|
||||
<link id="TTreeNodes.BeginUpdate"/>
|
||||
<link id="TTreeNodes.EndUpdate"/>
|
||||
<link id="TCustomTreeView.States"/>
|
||||
<link id="TTreeViewState"/>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TTreeNodes.SetUpdateState.Updating">
|
||||
<short/>
|
||||
<short>True when the tree nodes are being updated, False when the update has been completed</short>
|
||||
</element>
|
||||
|
||||
<element name="TTreeNodes.Create">
|
||||
|
||||
@ -16591,7 +16591,7 @@ BoundsRect.Left:=3; // WRONG: common newbie mistake
|
||||
<notes><note>deserves a review!</note></notes>
|
||||
</topic>
|
||||
|
||||
<topic name="Control coordinates">
|
||||
<topic name="ControlCoordinates">
|
||||
<short>
|
||||
The coordinates of a control can be specified or retrieved in various ways
|
||||
</short>
|
||||
@ -16627,7 +16627,7 @@ BoundsRect.Left:=3; // WRONG: common newbie mistake
|
||||
<notes><note>?</note><note>right?</note></notes>
|
||||
</topic>
|
||||
|
||||
<topic name="Anchoring Controls">
|
||||
<topic name="AnchoringControls">
|
||||
<short>How multiple controls can be aligned and resized together, at run-time</short>
|
||||
<descr>
|
||||
<p>
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -703,7 +703,9 @@
|
||||
<descr>
|
||||
<p>Method: <var>SplitBezier</var>
|
||||
</p>
|
||||
<pre>Params: Bezier, Left, Right
|
||||
<pre>
|
||||
Params: Bezier, Left, Right
|
||||
|
||||
Returns: Nothing
|
||||
|
||||
Use SplitBezier to split any 4-Point Bezier into two 4-Point Beziers:
|
||||
@ -725,18 +727,17 @@
|
||||
<element name="SplitBezier.Right">
|
||||
<short/>
|
||||
</element>
|
||||
<topic name="GraphMath Operators">
|
||||
<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>
|
||||
<pre>Type
|
||||
TFloatPoint = Record
|
||||
X, Y : Extended;
|
||||
end;
|
||||
|
||||
<pre>Type
|
||||
TFloatPoint = Record
|
||||
X, Y : Extended;
|
||||
end;
|
||||
</pre>
|
||||
<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>
|
||||
|
||||
@ -7,9 +7,7 @@
|
||||
====================================================================
|
||||
-->
|
||||
<module name="GraphUtil">
|
||||
<short>
|
||||
Contains routines and types used when drawing graphics
|
||||
</short>
|
||||
<short>Contains routines and types used when drawing graphics</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>GraphUtil.pp</var> contains routines and types used when drawing graphics. They focus primarily on converting colors and drawing gradients, scroll bars, and arrows.
|
||||
@ -37,9 +35,7 @@
|
||||
<element name="LCLIntf"/>
|
||||
|
||||
<element name="ColorToGray">
|
||||
<short>
|
||||
Converts a Lazarus TColor value to its grayscale equivalent
|
||||
</short>
|
||||
<short>Converts a Lazarus TColor value to its grayscale equivalent</short>
|
||||
<descr></descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
@ -70,9 +66,7 @@
|
||||
</element>
|
||||
|
||||
<element name="RGBtoHLS">
|
||||
<short>
|
||||
Converts RGB color values to Hue, Lightness, and Saturation values
|
||||
</short>
|
||||
<short>Converts RGB color values to Hue, Lightness, and Saturation values</short>
|
||||
<descr></descr>
|
||||
<errors/>
|
||||
<seealso></seealso>
|
||||
@ -97,9 +91,7 @@
|
||||
</element>
|
||||
|
||||
<element name="HLStoColor">
|
||||
<short>
|
||||
Converts Hue, Lightness, and Saturation values to a TColor value
|
||||
</short>
|
||||
<short>Converts Hue, Lightness, and Saturation values to a TColor value</short>
|
||||
<descr></descr>
|
||||
<errors/>
|
||||
<seealso></seealso>
|
||||
@ -118,9 +110,7 @@
|
||||
</element>
|
||||
|
||||
<element name="HLStoRGB">
|
||||
<short>
|
||||
Converts Hue, Lightness, and Saturation values to a RGB color values
|
||||
</short>
|
||||
<short>Converts Hue, Lightness, and Saturation values to a RGB color values</short>
|
||||
<descr></descr>
|
||||
<errors/>
|
||||
<seealso></seealso>
|
||||
@ -146,9 +136,7 @@
|
||||
|
||||
<!-- HSV functions are copied from mbColorLib without changes -->
|
||||
<element name="ColorToHSV">
|
||||
<short>
|
||||
Converts a TColor value to Hue, Saturation, and brightness Values
|
||||
</short>
|
||||
<short>Converts a TColor value to Hue, Saturation, and brightness Values</short>
|
||||
<descr></descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
@ -166,9 +154,7 @@
|
||||
</element>
|
||||
|
||||
<element name="HSVToColor">
|
||||
<short>
|
||||
Converts Hue, Saturation, and brightness values to a TColor value
|
||||
</short>
|
||||
<short>Converts Hue, Saturation, and brightness values to a TColor value</short>
|
||||
<descr></descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
@ -186,9 +172,7 @@
|
||||
</element>
|
||||
|
||||
<element name="RGBToHSV">
|
||||
<short>
|
||||
Comverts RGB values to Hue, Saturation, and brightness values
|
||||
</short>
|
||||
<short>Comverts RGB values to Hue, Saturation, and brightness values</short>
|
||||
<descr></descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
@ -215,9 +199,7 @@
|
||||
</element>
|
||||
|
||||
<element name="HSVtoRGB">
|
||||
<short>
|
||||
Converts Hue, Saturation, and brightness values to RGB values
|
||||
</short>
|
||||
<short>Converts Hue, Saturation, and brightness values to RGB values</short>
|
||||
<descr></descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
@ -386,12 +368,9 @@
|
||||
</element>
|
||||
|
||||
<element name="DrawVerticalGradient">
|
||||
<short>
|
||||
Draws a gradient from top to bottom with parabolic color variation
|
||||
</short>
|
||||
<descr></descr>
|
||||
<errors/>
|
||||
<seealso></seealso>
|
||||
<short>Draws a gradient from top to bottom with parabolic color variation</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="DrawVerticalGradient.Canvas">
|
||||
<short>Canvas where the gradient is drawn</short>
|
||||
@ -407,12 +386,9 @@
|
||||
</element>
|
||||
|
||||
<element name="DrawGradientWindow">
|
||||
<short>
|
||||
Draws a window with a Title using gradient coloring
|
||||
</short>
|
||||
<descr></descr>
|
||||
<errors/>
|
||||
<seealso></seealso>
|
||||
<short>Draws a window with a Title using gradient coloring</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="DrawGradientWindow.Canvas">
|
||||
<short>Canvas where the gradient is drawn</short>
|
||||
@ -428,9 +404,7 @@
|
||||
</element>
|
||||
|
||||
<element name="AntiAliasedStretchDrawBitmap">
|
||||
<short>
|
||||
Stretch-draws a bitmap using anti-aliased drawing
|
||||
</short>
|
||||
<short>Stretch-draws a bitmap using anti-aliased drawing</short>
|
||||
<descr></descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
@ -489,7 +463,9 @@
|
||||
<element name="DrawArrow">
|
||||
<short>Draws an arrow at the specified location on a canvas</short>
|
||||
<descr>
|
||||
DrawArrow is an overloaded procedure used to draw an arrow on a canvas at the specified location. Overloaded variants of the routine allow the type of arrow, length, angle, and drawing style to be specified in their arguments.
|
||||
<p>
|
||||
<var>DrawArrow</var> is an overloaded procedure used to draw an arrow on a canvas at the specified location. Overloaded variants of the routine allow the type of arrow, length, angle, and drawing style to be specified as arguments.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
@ -522,12 +498,10 @@
|
||||
</element>
|
||||
|
||||
<element name="FloodFill">
|
||||
<short>
|
||||
A simple first-in-first-out circular buffer (queue) for flood-filling contiguous voxels
|
||||
</short>
|
||||
<short>A simple first-in-first-out circular buffer (queue) for flood-filling contiguous voxels</short>
|
||||
<descr>
|
||||
<p>
|
||||
FloodFill is a procedure which implements a simple first-in-first-out circular buffer (queue) for flood-filling contiguous voxels. This algorithm avoids stack problems associated simple recursive algorithms described in the discussion at <url href="http://steve.hollasch.net/cgindex/polygons/floodfill.html"/>. Please note that is slow because of its use of Canvas.Pixels.
|
||||
<var>FloodFill</var> is a procedure which implements a simple first-in-first-out circular buffer (queue) for flood-filling contiguous voxels. This algorithm avoids stack problems associated simple recursive algorithms described in the discussion at <url href="http://steve.hollasch.net/cgindex/polygons/floodfill.html"/>. Please note that the routine is slow because of its use of <var>Canvas.Pixels</var>.
|
||||
</p>
|
||||
<p>
|
||||
Orginal author: Chris Rorden
|
||||
@ -551,6 +525,28 @@
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<element name="ScaleImg">
|
||||
<short>Scales the specified image to the required dimensons</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>ScaleImg</var> is a procedure used to scale the image in <var>AImage</var> to the dimensions in <var>AWidth</var> and <var>AWidth</var>.
|
||||
</p>
|
||||
<p>
|
||||
ScaleImg calls the <var>CreateIntfImage</var> method in <var>AImage</var> to get a <var>TLazIntfImage</var> instance with the original content. A temporary <var>TLazCanvas</var> instance is created for the source image, and its <var>StretchDraw</var> method is called to resize and draw the interface image on the Canvas. AImage is updated with the resized content, and its <var>Height</var> and <var>Width</var> properties are set to the parameter values.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
<element name="ScaleImg.AImage">
|
||||
<short>Bitmap image resize in the routine</short>
|
||||
</element>
|
||||
<element name="ScaleImg.AWidth">
|
||||
<short>New Width requested for the image</short>
|
||||
</element>
|
||||
<element name="ScaleImg.AHeight">
|
||||
<short>New height requested for the image</short>
|
||||
</element>
|
||||
|
||||
<element name="ColorRGBToHLS">
|
||||
<short>
|
||||
Converts an RGB color value to Hue, Lightness, and Saturation values
|
||||
@ -644,9 +640,7 @@
|
||||
</element>
|
||||
|
||||
<element name="NormalizeRect">
|
||||
<short>
|
||||
Ensures that coordinates in the rectangle are in the correct order
|
||||
</short>
|
||||
<short>Ensures that coordinates in the rectangle are in the correct order</short>
|
||||
<descr></descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
@ -658,9 +652,7 @@
|
||||
</element>
|
||||
|
||||
<element name="WaveTo">
|
||||
<short>
|
||||
Draws a hoizontal or vertical wave at the specified position to the given device context
|
||||
</short>
|
||||
<short>Draws a hoizontal or vertical wave at the specified position to the given device context</short>
|
||||
<descr></descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
|
||||
@ -1928,8 +1928,6 @@
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<!-- WIP -->
|
||||
|
||||
<element name="TCustomAbstractGroupedEdit.ClearSelection">
|
||||
<short>Clears the content for the current selection in the control</short>
|
||||
<descr></descr>
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
Loading…
Reference in New Issue
Block a user