paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-08-18 18:59:21 +02:00
Code Issues Packages Projects Releases Wiki Activity

LazDoc - more updates to ExtCtrls and Controls

Browse Source 
git-svn-id: trunk@13095 -
This commit is contained in:
kirkpatc 2007-12-01 08:36:36 +00:00
parent 1f16e30ecb
commit 086cb54594
2 changed files with 46 additions and 70 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -9103,19 +9103,16 @@ Reads or writes a flag to find or store the identity of the parent for this cont
<element name="TWinControl.IntfUTF8KeyPress.RepeatCount"><short/></element> <element name="TWinControl.IntfUTF8KeyPress.RepeatCount"><short/></element>
<!-- object Visibility: default --> <!-- object Visibility: default -->
<element name="TGraphicControl"> <element name="TGraphicControl">
<short>TGraphicControl is the base class for all lightweight controls.</short> <short><i>TGraphicControl</i> is the base class for all lightweight controls.</short>
<descr> <descr>
<pre>TGraphicControl supports simple lightweight controls that do not <p><i>TGraphicControl</i> supports simple lightweight controls that do not
need the ability to accept keyboard input or contain other controls. Since need the ability to accept keyboard input or contain other controls. </p>
lightweight controls do not wrap GUI screen objects, they are faster and use <p>Since lightweight controls do not wrap GUI screen objects, they are faster and use fewer resources than controls based on <i>TWinControl</i>.</p>
fewer resources than controls based on TWinControl. <p><i>TGraphicControl</i> provides a <i>Canvas</i> property for access to the control's drawing surface and a virtual <i>Paint</i> method called in response to paint requests received by the parent control.</p>
TGraphicControl provides a Canvas property for access to the
control's drawing surface and a virtual Paint method called in response to
paint requests received by the parent control.</pre>
</descr> </descr>
<seealso> <seealso>
<link id="TWinControl"/> <link id="TWinControl"/>
<link id="#lcl.Graphics.TCanvas">TCanvas</link> <link id="#lcl.Graphics.TCanvas"/>
</seealso> </seealso>
</element> </element>
<!-- variable Visibility: private --> <!-- variable Visibility: private -->
@ -9140,10 +9137,8 @@ paint requests received by the parent control.</pre>
<element name="TGraphicControl.WMPaint.Message"><short/></element> <element name="TGraphicControl.WMPaint.Message"><short/></element>
<!-- procedure Visibility: protected --> <!-- procedure Visibility: protected -->
<element name="TGraphicControl.Paint"> <element name="TGraphicControl.Paint">
<short>Virtual Paint method called in response to paint requests.</short> <short>Virtual <i>Paint</i> method called in response to paint requests.</short>
<descr>Virtual Paint method called in response to paint requests received by the parent control.</descr> <descr>Virtual <i>Paint</i> method called in response to paint requests received by the parent control.</descr>
<errors/>
<seealso/>
</element> </element>
<!-- constructor Visibility: public --> <!-- constructor Visibility: public -->
<element name="TGraphicControl.Create"> <element name="TGraphicControl.Create">
@ -9159,20 +9154,16 @@ paint requests received by the parent control.</pre>
<element name="TGraphicControl.Canvas"> <element name="TGraphicControl.Canvas">
<short>A clipping window to the parent canvas.</short> <short>A clipping window to the parent canvas.</short>
<descr> <descr>
<p>The TGraphicsControl.Canvas is a clipping window to the parent canvas.<br/><br/> <p><i>The TGraphicsControl.Canvas</i> is a clipping window to the parent canvas.</p>
If you ask for the Canvas.Width or Canvas.Height, you are actually <p>If you ask for the <i>Canvas.Width</i> or <i>Canvas.Height</i>, you are actually
getting the parent control's Canvas dimensions. To get the dimensions of the getting the parent control's Canvas dimensions.</p>
TGraphicControl, you must query the ClientRect.</p> <p>To get the dimensions of the <i>TGraphicControl,</i> you must query the <i>ClientRect</i>.</p>
</descr> </descr>
<seealso> <seealso><link id="#lcl.Graphics.TCanvas"/></seealso>
<link id="#lcl.Graphics.TCanvas">FCanvas</link>
</seealso>
</element> </element>
<!-- property Visibility: public --> <!-- property Visibility: public -->
<element name="TGraphicControl.OnPaint"> <element name="TGraphicControl.OnPaint">
<short/> <short><i>OnPaint</i> - event handler for request to paint canvas</short>
<descr/>
<seealso/>
</element> </element>
<!-- object Visibility: default --> <!-- object Visibility: default -->
<element name="TCustomControl"> <element name="TCustomControl">

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

@ -1708,9 +1708,7 @@
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TShape.Brush"> <element name="TShape.Brush">
<short/> <short>The Brush to be used for colouring this shape</short>
<descr/>
<seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TShape.Constraints"> <element name="TShape.Constraints">
@ -1750,9 +1748,7 @@
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TShape.Pen"> <element name="TShape.Pen">
<short/> <short>The Pen to be ussed for drawing this shape</short>
<descr/>
<seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TShape.OnChangeBounds"> <element name="TShape.OnChangeBounds">
@ -1786,9 +1782,7 @@
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TShape.Shape"> <element name="TShape.Shape">
<short/> <short>Which Shape? (Rectangle, Square, RoundRect, RoundSquare, Ellipse, Circle, SquaredDiamond, Diamond)</short>
<descr/>
<seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TShape.ShowHint"> <element name="TShape.ShowHint">
@ -1830,11 +1824,20 @@
<element name="TCanResizeEvent.Accept"><short/></element> <element name="TCanResizeEvent.Accept"><short/></element>
<!-- object Visibility: default --> <!-- object Visibility: default -->
<element name="TCustomSplitter"> <element name="TCustomSplitter">
<short><i>TCustomSplitter</i>: the base type for <i>TSplitter</i></short> <short><i>TCustomSplitter</i> : the base type for <i>TSplitter</i></short>
<descr> <descr>
<p><i>TCustomSplitter</i>: the base type for <i>TSplitter</i></p> <p><i>TCustomSplitter</i>: the base type for <i>TSplitter</i></p>
<p>A Splitter is a vertical or horizontal bar that can be placed on a panel or form, to separate sub-panels functionally and allow re-sizing of the constituent sub-panels</p> <p>A Splitter is a vertical or horizontal bar that can be placed on a panel or form, to separate sub-panels functionally and allow re-sizing of the constituent sub-panels</p>
<p>This class defines many of the basic properties for the children classes, such as positioning, sizing and alignment</p> <p>This class defines many of the basic properties for the children classes, such as positioning, sizing and alignment</p>
<pre>{ TCustomSplitter is a control for interactively resizing another control.
It is a vertical or horizontal bar anchored to a side of a control.
You can either set the Align property to alLeft (alRight,alTop,alBottom),
then it will become a vertical bar, aligned to the left and when the user
moves it with the mouse, the control to the left with the same Align=alLeft
will be resized.
The second more flexible possibility is to set the properties Align=alNone,
AnchorSides and ResizeAnchor.
} </pre>
</descr> </descr>
</element> </element>
<!-- variable Visibility: private --> <!-- variable Visibility: private -->
@ -2050,9 +2053,7 @@
</element> </element>
<!-- property Visibility: public --> <!-- property Visibility: public -->
<element name="TCustomSplitter.ResizeStyle"> <element name="TCustomSplitter.ResizeStyle">
<short/> <short>Style for resizing - as a line, a pattern, full update, or none</short>
<descr/>
<seealso/>
</element> </element>
<!-- property Visibility: public --> <!-- property Visibility: public -->
<element name="TCustomSplitter.AutoSnap"> <element name="TCustomSplitter.AutoSnap">
@ -2065,21 +2066,15 @@
</element> </element>
<!-- property Visibility: public --> <!-- property Visibility: public -->
<element name="TCustomSplitter.MinSize"> <element name="TCustomSplitter.MinSize">
<short/> <short>Minimum size for splitter - default 30 pixels</short>
<descr/>
<seealso/>
</element> </element>
<!-- property Visibility: public --> <!-- property Visibility: public -->
<element name="TCustomSplitter.OnCanResize"> <element name="TCustomSplitter.OnCanResize">
<short/> <short>Event handler for receiving permission to resize</short>
<descr/>
<seealso/>
</element> </element>
<!-- property Visibility: public --> <!-- property Visibility: public -->
<element name="TCustomSplitter.OnMoved"> <element name="TCustomSplitter.OnMoved">
<short/> <short>Event handler for occasion when splitter has moved</short>
<descr/>
<seealso/>
</element> </element>
<!-- property Visibility: public --> <!-- property Visibility: public -->
<element name="TCustomSplitter.Width"> <element name="TCustomSplitter.Width">
@ -2912,9 +2907,8 @@
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TBevel.Shape"> <element name="TBevel.Shape">
<short/> <short><i>Shape</i> - whether a box, a frame or a line along one of the edges</short>
<descr/> <seealso><link id="#lcl.ExtCtrls.TBevelShape"/></seealso>
<seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TBevel.Top"> <element name="TBevel.Top">
@ -2924,9 +2918,8 @@
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TBevel.Style"> <element name="TBevel.Style">
<short/> <short><i>Style</i> - whether raised or lowered</short>
<descr/> <seealso><link id="#lcl.ExtCtrls.TBevelStyle"/></seealso>
<seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TBevel.Visible"> <element name="TBevel.Visible">
@ -3155,9 +3148,7 @@ requiring the user to select one af a set of alternatives</p>
</element> </element>
<!-- property Visibility: protected --> <!-- property Visibility: protected -->
<element name="TCustomRadioGroup.Columns"> <element name="TCustomRadioGroup.Columns">
<short/> <short><i>Columns</i> - the number of columns in which the <i>Items</i> (radio buttons) are to be arranges</short>
<descr/>
<seealso/>
</element> </element>
<!-- property Visibility: protected --> <!-- property Visibility: protected -->
<element name="TCustomRadioGroup.ColumnLayout"> <element name="TCustomRadioGroup.ColumnLayout">
@ -3203,13 +3194,12 @@ requiring the user to select one af a set of alternatives</p>
</element> </element>
<!-- function Visibility: public --> <!-- function Visibility: public -->
<element name="TCustomRadioGroup.Rows"> <element name="TCustomRadioGroup.Rows">
<short/> <short><i>Rows </i>- the number of rows in which Items (radio boxes) are held</short>
<descr/>
<errors/>
<seealso/>
</element> </element>
<!-- function result Visibility: default --> <!-- function result Visibility: default -->
<element name="TCustomRadioGroup.Rows.Result"><short/></element> <element name="TCustomRadioGroup.Rows.Result">
<short>Number of rows</short>
</element>
<!-- object Visibility: default --> <!-- object Visibility: default -->
<element name="TRadioGroup"> <element name="TRadioGroup">
<short><i>TRadioGroup</i> : A group of related but mutually exclusive radio buttons, requiring the user to select one af a set of alternatives</short> <short><i>TRadioGroup</i> : A group of related but mutually exclusive radio buttons, requiring the user to select one af a set of alternatives</short>
@ -3637,13 +3627,12 @@ requiring the user to select one af a set of alternatives</p>
</element> </element>
<!-- function Visibility: public --> <!-- function Visibility: public -->
<element name="TCustomCheckGroup.Rows"> <element name="TCustomCheckGroup.Rows">
<short/> <short><i>Rows</i> - the number of rows in which the Items (check boxes) are arranged</short>
<descr/>
<errors/>
<seealso/>
</element> </element>
<!-- function result Visibility: default --> <!-- function result Visibility: default -->
<element name="TCustomCheckGroup.Rows.Result"><short/></element> <element name="TCustomCheckGroup.Rows.Result">
<short>The number of rows holding items</short>
</element>
<!-- property Visibility: public --> <!-- property Visibility: public -->
<element name="TCustomCheckGroup.Items"> <element name="TCustomCheckGroup.Items">
<short><i>Items</i> - a string list for the captions of the check boxes</short> <short><i>Items</i> - a string list for the captions of the check boxes</short>
@ -3666,9 +3655,7 @@ requiring the user to select one af a set of alternatives</p>
<element name="TCustomCheckGroup.CheckEnabled.Index"><short/></element> <element name="TCustomCheckGroup.CheckEnabled.Index"><short/></element>
<!-- property Visibility: public --> <!-- property Visibility: public -->
<element name="TCustomCheckGroup.Columns"> <element name="TCustomCheckGroup.Columns">
<short/> <short><i>Columns</i> - the number of columns in which the <i>Items</i> (check boxes) are to be arranges</short>
<descr/>
<seealso/>
</element> </element>
<!-- property Visibility: public --> <!-- property Visibility: public -->
<element name="TCustomCheckGroup.ColumnLayout"> <element name="TCustomCheckGroup.ColumnLayout">
@ -3676,9 +3663,7 @@ requiring the user to select one af a set of alternatives</p>
</element> </element>
<!-- property Visibility: public --> <!-- property Visibility: public -->
<element name="TCustomCheckGroup.OnItemClick"> <element name="TCustomCheckGroup.OnItemClick">
<short/> <short><i>OnItemClick</i> - event handler for mouse click on one of the Items in the Check Group</short>
<descr/>
<seealso/>
</element> </element>
<!-- object Visibility: default --> <!-- object Visibility: default -->
<element name="TCheckGroup"> <element name="TCheckGroup">