From b87224a3b50daa26bb5bf024bb92a719cd58d019 Mon Sep 17 00:00:00 2001 From: kirkpatc Date: Mon, 26 Nov 2007 11:22:01 +0000 Subject: [PATCH] LazDoc - updates to StdCtrls (title), ExtCtrls (TCustomImage, TImage, TBevel, TCustomLabeledEdit, TLabeledEdit), ComCtrls (TCustomTreeView, TTreeNode, TTreeView) git-svn-id: trunk@13031 - --- docs/xml/lcl/comctrls.xml | 56 +-- docs/xml/lcl/extctrls.xml | 997 ++++++++++---------------------------- docs/xml/lcl/stdctrls.xml | 2 +- 3 files changed, 287 insertions(+), 768 deletions(-) diff --git a/docs/xml/lcl/comctrls.xml b/docs/xml/lcl/comctrls.xml index 724c0d0cdc..8eb3f4b469 100644 --- a/docs/xml/lcl/comctrls.xml +++ b/docs/xml/lcl/comctrls.xml @@ -7,7 +7,7 @@ ==================================================================== --> - + Several controls commonly used in Lazarus forms @@ -7961,10 +7961,8 @@ To add, change or delete a column use the Columns property. - - - - + TCustomTrackBar - the base class for TTrackBar + TCustomTrackBar defines many of the properties inherited by TTrackBar, a control for graphically displaying the progress of a process @@ -8204,10 +8202,7 @@ To add, change or delete a column use the Columns property. - - - - + SetTick - set the interval for ticks on the taskbar (integer) @@ -8237,15 +8232,11 @@ To add, change or delete a column use the Columns property. - - - + Action to be taken on change in the process being tracked - - - + TTrackBarOrientation - horizontal or vertical @@ -8951,11 +8942,9 @@ Const - TTreeNode is a single item that holds data in TTreeView - A TTreeNode is parst of a TTreeView and is used to store data in. This can be done by using the Caption property or for more complex data the Data property can be used. Each node can have sibling or child items associated with it. - - HowToUseStdCtrls - + TTreeNode is a single item that holds data in TTreeView + A TTreeNode is part of a TTreeView and is used for storing data. This can be done by using the Caption property or for more complex data the Data property can be used. Each node can have sibling or child items associated with it. + @@ -10203,10 +10192,7 @@ Const - - - - + A collection or list of TTreeNode @@ -10933,10 +10919,8 @@ For the meaning of this options, see the documentation of TTreeView. - - - - + TCustomTreeView - ancestor class for TTreeView + TCustomTreeView - ancestor class for TTreeView, which displays a collection of items in a hierarchical tree form. This class defines many properties which are inherited by children classes, including loading the data from files or streams, saving to files or streams, updating, sorting alphabetically, editing, making visible or invisible, expanding or collapsing the tree display, and many more. @@ -12906,10 +12890,12 @@ For the meaning of this options, see the documentation of TTreeView. - TTreeview is a control that displays a hierarchical list of items - Use a TTreeview to display a hierarchical list of items. Items are shown by their caption and an optional bitmap. + TTreeView is a control that displays a hierarchical list of items + Use a TTreeView + to display a hierarchical list of items. Items are shown by their caption and an optional bitmap. - HowToUseStdCtrls + + @@ -13028,9 +13014,7 @@ For the meaning of this options, see the documentation of TTreeView. - - - + The Bitmap image associated with each item in the display @@ -13370,9 +13354,7 @@ For the meaning of this options, see the documentation of TTreeView. - - - + The Items to be displayed in the tree view - ie the actual data diff --git a/docs/xml/lcl/extctrls.xml b/docs/xml/lcl/extctrls.xml index 33508b733e..905b3ea56f 100644 --- a/docs/xml/lcl/extctrls.xml +++ b/docs/xml/lcl/extctrls.xml @@ -7,7 +7,7 @@ ==================================================================== --> - + Some extra controls commonly used in Lazarus forms @@ -106,13 +106,9 @@ - - - + - - - + @@ -144,9 +140,7 @@ - - - + @@ -155,9 +149,7 @@ - - - + @@ -166,9 +158,7 @@ - - - + @@ -177,9 +167,7 @@ - - - + @@ -188,9 +176,7 @@ - - - + @@ -205,9 +191,7 @@ - - - + @@ -223,9 +207,7 @@ - - - + @@ -234,9 +216,7 @@ - - - + @@ -257,9 +237,7 @@ - - - + @@ -268,9 +246,7 @@ - - - + @@ -279,9 +255,7 @@ - - - + @@ -290,9 +264,7 @@ - - - + @@ -360,13 +332,9 @@ - - - + - - - + @@ -375,9 +343,7 @@ - - - + @@ -386,13 +352,9 @@ - - - + - - - + @@ -401,13 +363,9 @@ - - - + - - - + @@ -416,13 +374,9 @@ - - - + - - - + @@ -438,9 +392,7 @@ - - - + @@ -449,13 +401,9 @@ - - - + - - - + @@ -464,13 +412,9 @@ - - - + - - - + @@ -478,13 +422,9 @@ - - - + - - - + @@ -492,21 +432,13 @@ - - - + - - - + - - - + - - - + @@ -514,17 +446,11 @@ - - - + - - - + - - - + @@ -532,17 +458,11 @@ - - - + - - - + - - - + @@ -550,13 +470,9 @@ - - - + - - - + @@ -660,9 +576,7 @@ - - - + @@ -692,9 +606,7 @@ - - - + @@ -703,9 +615,7 @@ - - - + @@ -714,13 +624,9 @@ - - - + - - - + @@ -729,9 +635,7 @@ - - - + @@ -740,9 +644,7 @@ - - - + @@ -751,13 +653,9 @@ - - - + - - - + @@ -766,9 +664,7 @@ - - - + @@ -777,13 +673,9 @@ - - - + - - - + @@ -792,13 +684,9 @@ - - - + - - - + @@ -807,9 +695,7 @@ - - - + @@ -818,9 +704,7 @@ - - - + @@ -829,9 +713,7 @@ - - - + @@ -840,9 +722,7 @@ - - - + @@ -851,9 +731,7 @@ - - - + @@ -862,9 +740,7 @@ - - - + @@ -873,9 +749,7 @@ - - - + @@ -884,9 +758,7 @@ - - - + @@ -895,9 +767,7 @@ - - - + @@ -920,9 +790,7 @@ - - - + @@ -965,9 +833,7 @@ - - - + @@ -976,9 +842,7 @@ - - - + @@ -994,13 +858,9 @@ - - - + - - - + @@ -1021,9 +881,7 @@ - - - + @@ -1039,13 +897,9 @@ - - - + - - - + @@ -1054,9 +908,7 @@ - - - + @@ -1065,13 +917,9 @@ - - - + - - - + @@ -1080,13 +928,9 @@ - - - + - - - + @@ -1095,13 +939,9 @@ - - - + - - - + @@ -1110,9 +950,7 @@ - - - + @@ -1121,9 +959,7 @@ - - - + @@ -1132,9 +968,7 @@ - - - + @@ -1143,9 +977,7 @@ - - - + @@ -1189,9 +1021,7 @@ - - - + @@ -1378,9 +1208,7 @@ - - - + @@ -1389,13 +1217,9 @@ - - - + - - - + @@ -1404,9 +1228,7 @@ - - - + @@ -1415,9 +1237,7 @@ - - - + @@ -1425,9 +1245,7 @@ - - - + @@ -1578,17 +1396,11 @@ - - - + - - - + - - - + @@ -1639,9 +1451,7 @@ - - - + @@ -1650,9 +1460,7 @@ - - - + @@ -1661,9 +1469,7 @@ - - - + @@ -1672,9 +1478,7 @@ - - - + @@ -1683,9 +1487,7 @@ - - - + @@ -1694,13 +1496,9 @@ - - - + - - - + @@ -1716,9 +1514,7 @@ - - - + @@ -1751,37 +1547,21 @@ - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + Shape @@ -1813,9 +1593,7 @@ - - - + @@ -1824,9 +1602,7 @@ - - - + @@ -1835,9 +1611,7 @@ - - - + @@ -1846,9 +1620,7 @@ - - - + @@ -1871,9 +1643,7 @@ - - - + @@ -1995,21 +1765,13 @@ - - - + - - - + - - - + - - - + @@ -2017,17 +1779,11 @@ - - - + - - - + - - - + Custom Splitter @@ -2095,9 +1851,7 @@ - - - + @@ -2106,9 +1860,7 @@ - - - + @@ -2117,9 +1869,7 @@ - - - + @@ -2128,9 +1878,7 @@ - - - + @@ -2139,13 +1887,9 @@ - - - + - - - + @@ -2154,21 +1898,13 @@ - - - + - - - + - - - + - - - + @@ -2177,17 +1913,11 @@ - - - + - - - + - - - + @@ -2196,21 +1926,13 @@ - - - + - - - + - - - + - - - + @@ -2219,9 +1941,7 @@ - - - + @@ -2230,9 +1950,7 @@ - - - + @@ -2241,9 +1959,7 @@ - - - + @@ -2259,13 +1975,9 @@ - - - + - - - + @@ -2281,9 +1993,7 @@ - - - + @@ -2478,9 +2188,7 @@ to separate sub-panels functionally and allow re-sizing of the constituent sub-p - - - + @@ -2634,7 +2342,8 @@ to separate sub-panels functionally and allow re-sizing of the constituent sub-p Custom Image - Custom Image: The base type for Image + TCustomImage: The base type for TImage. This is a control of the class TGraphicControl, designed to be lightweight and fast + @@ -2674,9 +2383,7 @@ to separate sub-panels functionally and allow re-sizing of the constituent sub-p - - - + @@ -2685,9 +2392,7 @@ to separate sub-panels functionally and allow re-sizing of the constituent sub-p - - - + @@ -2696,9 +2401,7 @@ to separate sub-panels functionally and allow re-sizing of the constituent sub-p - - - + @@ -2707,9 +2410,7 @@ to separate sub-panels functionally and allow re-sizing of the constituent sub-p - - - + @@ -2718,9 +2419,7 @@ to separate sub-panels functionally and allow re-sizing of the constituent sub-p - - - + @@ -2729,9 +2428,7 @@ to separate sub-panels functionally and allow re-sizing of the constituent sub-p - - - + @@ -2740,9 +2437,7 @@ to separate sub-panels functionally and allow re-sizing of the constituent sub-p - - - + @@ -2765,9 +2460,7 @@ to separate sub-panels functionally and allow re-sizing of the constituent sub-p - - - + @@ -2789,9 +2482,8 @@ to separate sub-panels functionally and allow re-sizing of the constituent sub-p - - - + Should image be centered? + Boolean property - True if image is to be centered @@ -2801,9 +2493,7 @@ to separate sub-panels functionally and allow re-sizing of the constituent sub-p - - - + Picture - the actual image for display @@ -2837,26 +2527,23 @@ to separate sub-panels functionally and allow re-sizing of the constituent sub-p - - - + True if picture is to be stretched - - - + True if you can see through the image - - - + True if image is proportional - Image - Image: A graphic image placed on the form; usually loaded from a picture file + Image - a graphic image placed on the form; usually loaded from a picture file. +

TImage +: a graphic image placed on the form; usually loaded from a picture file.

The actual image is found in Picture or Canvas

+ Inherits most of its properties from its ancestors, TCustomImage, TGraphicControl and TControl + @@ -2949,10 +2636,7 @@ to separate sub-panels functionally and allow re-sizing of the constituent sub-p - - Picture - Picture: the actual graphical image to be displayed - + @@ -2984,13 +2668,9 @@ to separate sub-panels functionally and allow re-sizing of the constituent sub-p - - - + - - - + @@ -2998,33 +2678,21 @@ to separate sub-panels functionally and allow re-sizing of the constituent sub-p - - - + - - - + - - - + - - - + - - - + - - - + - Bevel - A bevel placed around the edge of buttons and other components. Its appearance is governed by TBevelShape, TBevelStyle and TBevelwidth + A bevel placed around the edge of buttons and other components +

TBevel - a bevel placed around the edge of buttons and other components.

Its appearance is governed by TBevelShape, TBevelStyle and TBevelwidth @@ -3046,9 +2714,7 @@ to separate sub-panels functionally and allow re-sizing of the constituent sub-p - - - + @@ -3057,9 +2723,7 @@ to separate sub-panels functionally and allow re-sizing of the constituent sub-p - - - + @@ -3068,9 +2732,7 @@ to separate sub-panels functionally and allow re-sizing of the constituent sub-p - - - + @@ -3079,9 +2741,7 @@ to separate sub-panels functionally and allow re-sizing of the constituent sub-p - - - + @@ -3097,9 +2757,7 @@ to separate sub-panels functionally and allow re-sizing of the constituent sub-p - - - + @@ -3229,13 +2887,9 @@ to separate sub-panels functionally and allow re-sizing of the constituent sub-p - - - + - - - + Custom Radio Group @@ -3303,9 +2957,7 @@ to separate sub-panels functionally and allow re-sizing of the constituent sub-p - - - + @@ -3314,9 +2966,7 @@ to separate sub-panels functionally and allow re-sizing of the constituent sub-p - - - + @@ -3332,9 +2982,7 @@ to separate sub-panels functionally and allow re-sizing of the constituent sub-p - - - + @@ -3350,9 +2998,7 @@ to separate sub-panels functionally and allow re-sizing of the constituent sub-p - - - + @@ -3361,9 +3007,7 @@ to separate sub-panels functionally and allow re-sizing of the constituent sub-p - - - + @@ -3372,9 +3016,7 @@ to separate sub-panels functionally and allow re-sizing of the constituent sub-p - - - + @@ -3383,9 +3025,7 @@ to separate sub-panels functionally and allow re-sizing of the constituent sub-p - - - + @@ -3394,9 +3034,7 @@ to separate sub-panels functionally and allow re-sizing of the constituent sub-p - - - + @@ -3442,9 +3080,7 @@ to separate sub-panels functionally and allow re-sizing of the constituent sub-p - - - + @@ -3460,9 +3096,7 @@ to separate sub-panels functionally and allow re-sizing of the constituent sub-p - - - + @@ -3478,9 +3112,7 @@ to separate sub-panels functionally and allow re-sizing of the constituent sub-p - - - + Radio Group @@ -3680,13 +3312,9 @@ requiring the user to select one af a set of alternatives - - - + - - - + Custom Check Group @@ -3736,13 +3364,9 @@ requiring the user to select one af a set of alternatives - - - + - - - + @@ -3751,13 +3375,9 @@ requiring the user to select one af a set of alternatives - - - + - - - + @@ -3766,9 +3386,7 @@ requiring the user to select one af a set of alternatives - - - + @@ -3777,9 +3395,7 @@ requiring the user to select one af a set of alternatives - - - + @@ -3795,9 +3411,7 @@ requiring the user to select one af a set of alternatives - - - + @@ -3806,13 +3420,9 @@ requiring the user to select one af a set of alternatives - - - + - - - + @@ -3821,13 +3431,9 @@ requiring the user to select one af a set of alternatives - - - + - - - + @@ -3836,9 +3442,7 @@ requiring the user to select one af a set of alternatives - - - + @@ -3854,9 +3458,7 @@ requiring the user to select one af a set of alternatives - - - + @@ -3865,9 +3467,7 @@ requiring the user to select one af a set of alternatives - - - + @@ -3876,9 +3476,7 @@ requiring the user to select one af a set of alternatives - - - + @@ -3887,9 +3485,7 @@ requiring the user to select one af a set of alternatives - - - + @@ -3898,9 +3494,7 @@ requiring the user to select one af a set of alternatives - - - + @@ -3923,9 +3517,7 @@ requiring the user to select one af a set of alternatives - - - + @@ -3941,9 +3533,7 @@ requiring the user to select one af a set of alternatives - - - + @@ -3957,9 +3547,7 @@ requiring the user to select one af a set of alternatives - - - + @@ -3967,9 +3555,7 @@ requiring the user to select one af a set of alternatives - - - + @@ -4191,9 +3777,7 @@ requiring the user to select one af a set of alternatives - - - + @@ -4332,25 +3916,24 @@ requiring the user to select one af a set of alternatives - - - + - - - + - - - + - - - + - Cuatom Labelled Edit - Cuatom Labelled Edit: The base type for Labelled Edit. Note particularly the EditLabel property (see TBoundLabel). + Custom Labelled Edit + +

TCustomLabeledEdit: The base type for LabeledEdit.

+

Note particularly the EditLabel property (see TBoundLabel), which contains the label attached to the Edit control.

+ + + + + @@ -4378,9 +3961,7 @@ requiring the user to select one af a set of alternatives - - - + @@ -4389,9 +3970,7 @@ requiring the user to select one af a set of alternatives - - - + @@ -4400,9 +3979,7 @@ requiring the user to select one af a set of alternatives - - - + @@ -4411,9 +3988,7 @@ requiring the user to select one af a set of alternatives - - - + @@ -4422,21 +3997,13 @@ requiring the user to select one af a set of alternatives - - - + - - - + - - - + - - - + @@ -4452,13 +4019,9 @@ requiring the user to select one af a set of alternatives - - - + - - - + @@ -4467,9 +4030,7 @@ requiring the user to select one af a set of alternatives - - - + @@ -4478,9 +4039,7 @@ requiring the user to select one af a set of alternatives - - - + @@ -4496,9 +4055,7 @@ requiring the user to select one af a set of alternatives - - - + @@ -4507,20 +4064,21 @@ requiring the user to select one af a set of alternatives - - - + LabelPosition - whether above, below, to the left or to the right of the Edit box - - - + LabelSpacing - the distance between the Label and the Edit box - Labelled Edit - Labelled Edit: An Edit Box with a permanently attached Label;
saves time and effort over placing separate Label and Edit Box on Form. The Label property is described in the parent component, TCustomLabeledEdit + Labelled Edit: An Edit Box with a permanently attached Label +

TLabeledEdit: An Edit Box with a permanently attached Label

+Saves time and effort over placing separate Label and Edit Box on Form. The properties are described in the parent component, TCustomLabeledEdit from which most of the properties are inherited + + + + @@ -4638,8 +4196,7 @@ requiring the user to select one af a set of alternatives - Text - Text: the text-string being entered or edited in the Labelled Edit box + Text: the text-string being entered or edited in the Labelled Edit box @@ -4774,9 +4331,7 @@ requiring the user to select one af a set of alternatives - - - + @@ -4785,9 +4340,7 @@ requiring the user to select one af a set of alternatives - - - + @@ -4796,9 +4349,7 @@ requiring the user to select one af a set of alternatives - - - + @@ -4807,9 +4358,7 @@ requiring the user to select one af a set of alternatives - - - + @@ -4818,9 +4367,7 @@ requiring the user to select one af a set of alternatives - - - + @@ -4829,9 +4376,7 @@ requiring the user to select one af a set of alternatives - - - + @@ -4840,9 +4385,7 @@ requiring the user to select one af a set of alternatives - - - + @@ -4858,9 +4401,7 @@ requiring the user to select one af a set of alternatives - - - + @@ -4869,9 +4410,7 @@ requiring the user to select one af a set of alternatives - - - + @@ -4880,9 +4419,7 @@ requiring the user to select one af a set of alternatives - - - + diff --git a/docs/xml/lcl/stdctrls.xml b/docs/xml/lcl/stdctrls.xml index 43c84e2336..35abbe9f1b 100644 --- a/docs/xml/lcl/stdctrls.xml +++ b/docs/xml/lcl/stdctrls.xml @@ -7,7 +7,7 @@ ==================================================================== --> - + Several standard controls used in most Lazarus forms