From 49c34c5cb459455221fd387bcf3dbe0c5988aa11 Mon Sep 17 00:00:00 2001 From: kirkpatc Date: Sun, 3 Feb 2008 13:57:17 +0000 Subject: [PATCH] LazDoc - updates to grids, DBGrids, DBCtrls and StdCtrls git-svn-id: trunk@13970 - --- docs/xml/lcl/dbctrls.xml | 936 ++++++++--- docs/xml/lcl/dbgrids.xml | 3071 ++++++++++++++++++------------------- docs/xml/lcl/grids.xml | 20 +- docs/xml/lcl/stdctrls.xml | 109 +- 4 files changed, 2250 insertions(+), 1886 deletions(-) diff --git a/docs/xml/lcl/dbctrls.xml b/docs/xml/lcl/dbctrls.xml index e507fb7970..6a285128f3 100644 --- a/docs/xml/lcl/dbctrls.xml +++ b/docs/xml/lcl/dbctrls.xml @@ -186,7 +186,9 @@ - + + + @@ -195,7 +197,9 @@ - + + + @@ -204,7 +208,9 @@ - + + + @@ -213,7 +219,9 @@ - + + + @@ -250,7 +258,9 @@ - + + + @@ -266,7 +276,9 @@ - + + + @@ -289,7 +301,9 @@ - + + + @@ -366,8 +380,11 @@ - TDBEdit - a data-aware edit box for processing a single text-string from a dataset - + + TDBEdit - a data-aware edit box for processing a single text-string from a dataset + + + @@ -383,7 +400,9 @@ - + + + @@ -392,7 +411,9 @@ - + + + @@ -401,7 +422,9 @@ - + + + @@ -410,7 +433,9 @@ - + + + @@ -419,7 +444,9 @@ - + + + @@ -428,7 +455,9 @@ - + + + @@ -437,7 +466,9 @@ - + + + @@ -446,7 +477,9 @@ - + + + @@ -455,7 +488,9 @@ - + + + @@ -464,7 +499,9 @@ - + + + @@ -473,7 +510,9 @@ - + + + @@ -482,7 +521,9 @@ - + + + @@ -491,9 +532,13 @@ - + + + - + + + @@ -509,9 +554,13 @@ - + + + - + + + @@ -520,7 +569,9 @@ - + + + @@ -557,7 +608,9 @@ - + + + @@ -825,8 +878,11 @@ - TDBText - a data-aware text component to display a single text-string from a dataset - + + TDBText - a data-aware text component to display a single text-string from a dataset + + + @@ -842,7 +898,9 @@ - + + + @@ -851,7 +909,9 @@ - + + + @@ -860,7 +920,9 @@ - + + + @@ -869,7 +931,9 @@ - + + + @@ -878,7 +942,9 @@ - + + + @@ -887,7 +953,9 @@ - + + + @@ -896,7 +964,9 @@ - + + + @@ -912,9 +982,13 @@ - + + + - + + + @@ -923,7 +997,9 @@ - + + + @@ -1023,8 +1099,11 @@ - TDBListBox - a data-aware version of TListBox, for displaying lists of entries from a field in a database - + + TDBListBox - a data-aware version of TListBox, for displaying lists of entries from a field in a database + + + @@ -1040,7 +1119,9 @@ - + + + @@ -1049,7 +1130,9 @@ - + + + @@ -1058,7 +1141,9 @@ - + + + @@ -1067,7 +1152,9 @@ - + + + @@ -1076,7 +1163,9 @@ - + + + @@ -1085,7 +1174,9 @@ - + + + @@ -1094,7 +1185,9 @@ - + + + @@ -1103,7 +1196,9 @@ - + + + @@ -1112,7 +1207,9 @@ - + + + @@ -1121,7 +1218,9 @@ - + + + @@ -1130,7 +1229,9 @@ - + + + @@ -1139,7 +1240,9 @@ - + + + @@ -1148,9 +1251,13 @@ - + + + - + + + @@ -1166,9 +1273,13 @@ - + + + - + + + @@ -1191,7 +1302,9 @@ - + + + @@ -1387,8 +1500,11 @@ - TDBRadioGroup - a data-aware version of TRadioGroup, providing a series of mutually exclusive buttons to select entries from a databse field - + + TDBRadioGroup - a data-aware version of TRadioGroup, providing a series of mutually exclusive buttons to select entries from a databse field + + + @@ -1428,7 +1544,9 @@ - + + + @@ -1437,7 +1555,9 @@ - + + + @@ -1446,7 +1566,9 @@ - + + + @@ -1455,7 +1577,9 @@ - + + + @@ -1464,7 +1588,9 @@ - + + + @@ -1473,7 +1599,9 @@ - + + + @@ -1482,7 +1610,9 @@ - + + + @@ -1491,7 +1621,9 @@ - + + + @@ -1500,7 +1632,9 @@ - + + + @@ -1509,7 +1643,9 @@ - + + + @@ -1525,9 +1661,13 @@ - + + + - + + + @@ -1536,7 +1676,9 @@ - + + + @@ -1545,7 +1687,9 @@ - + + + @@ -1560,9 +1704,13 @@ - + + + - + + + @@ -1592,7 +1740,9 @@ - + + + @@ -1728,8 +1878,11 @@ - TDBCheckBox - a data-aware checkbox for use with logical fields in a database - + + TDBCheckBox - a data-aware checkbox for use with logical fields in a database + + + @@ -1757,7 +1910,9 @@ - + + + @@ -1766,7 +1921,9 @@ - + + + @@ -1775,7 +1932,9 @@ - + + + @@ -1784,7 +1943,9 @@ - + + + @@ -1793,7 +1954,9 @@ - + + + @@ -1802,7 +1965,9 @@ - + + + @@ -1811,7 +1976,9 @@ - + + + @@ -1820,7 +1987,9 @@ - + + + @@ -1829,7 +1998,9 @@ - + + + @@ -1838,11 +2009,17 @@ - + + + - + + + - + + + @@ -1851,7 +2028,9 @@ - + + + @@ -1860,7 +2039,9 @@ - + + + @@ -1869,7 +2050,9 @@ - + + + @@ -1878,7 +2061,9 @@ - + + + @@ -1887,9 +2072,13 @@ - + + + - + + + @@ -1912,7 +2101,9 @@ - + + + @@ -2132,8 +2323,11 @@ - TDBComboBox - a data-aware version of TComboBox to allow selection from a list of entries in a database field - + + TDBComboBox - a data-aware version of TComboBox to allow selection from a list of entries in a database field + + + @@ -2149,7 +2343,9 @@ - + + + @@ -2158,7 +2354,9 @@ - + + + @@ -2167,7 +2365,9 @@ - + + + @@ -2176,7 +2376,9 @@ - + + + @@ -2185,7 +2387,9 @@ - + + + @@ -2194,7 +2398,9 @@ - + + + @@ -2203,7 +2409,9 @@ - + + + @@ -2212,7 +2420,9 @@ - + + + @@ -2221,7 +2431,9 @@ - + + + @@ -2230,7 +2442,9 @@ - + + + @@ -2239,7 +2453,9 @@ - + + + @@ -2248,9 +2464,13 @@ - + + + - + + + @@ -2259,7 +2479,9 @@ - + + + @@ -2268,7 +2490,9 @@ - + + + @@ -2291,7 +2515,9 @@ - + + + @@ -2517,8 +2743,11 @@ - TDBMemo - a data-aware Memo box to process the multi-line text of a single field in a dataset - + + TDBMemo - a data-aware Memo box to process the multi-line text of a single field in a dataset + + + @@ -2552,7 +2781,9 @@ - + + + @@ -2561,7 +2792,9 @@ - + + + @@ -2570,7 +2803,9 @@ - + + + @@ -2579,7 +2814,9 @@ - + + + @@ -2588,7 +2825,9 @@ - + + + @@ -2597,7 +2836,9 @@ - + + + @@ -2606,7 +2847,9 @@ - + + + @@ -2615,7 +2858,9 @@ - + + + @@ -2624,7 +2869,9 @@ - + + + @@ -2633,7 +2880,9 @@ - + + + @@ -2642,7 +2891,9 @@ - + + + @@ -2651,9 +2902,13 @@ - + + + - + + + @@ -2662,7 +2917,9 @@ - + + + @@ -2671,7 +2928,9 @@ - + + + @@ -2694,7 +2953,9 @@ - + + + @@ -2843,8 +3104,11 @@ - TDBGroupBox - a data-aware version of TGroupBox, allowing a number of data-aware objects to be grouped together on a form - + + TDBGroupBox - a data-aware version of TGroupBox, allowing a number of data-aware objects to be grouped together on a form + + + @@ -2860,7 +3124,9 @@ - + + + @@ -2869,7 +3135,9 @@ - + + + @@ -2878,7 +3146,9 @@ - + + + @@ -2887,7 +3157,9 @@ - + + + @@ -2896,7 +3168,9 @@ - + + + @@ -2905,7 +3179,9 @@ - + + + @@ -2921,9 +3197,13 @@ - + + + - + + + @@ -2932,7 +3212,9 @@ - + + + @@ -3140,8 +3422,11 @@ - TDBImage - a data-aware Image box to display a single image from a dataset - + + TDBImage - a data-aware Image box to display a single image from a dataset + + + @@ -3175,7 +3460,9 @@ - + + + @@ -3184,7 +3471,9 @@ - + + + @@ -3193,7 +3482,9 @@ - + + + @@ -3202,7 +3493,9 @@ - + + + @@ -3211,7 +3504,9 @@ - + + + @@ -3220,7 +3515,9 @@ - + + + @@ -3229,7 +3526,9 @@ - + + + @@ -3238,7 +3537,9 @@ - + + + @@ -3247,9 +3548,13 @@ - + + + - + + + @@ -3258,7 +3563,9 @@ - + + + @@ -3267,7 +3574,9 @@ - + + + @@ -3290,7 +3599,9 @@ - + + + @@ -3414,8 +3725,11 @@ - TDBCalendar - a data-aware version of TCalendar, for selecting a date to put in a database field - + + TDBCalendar - a data-aware version of TCalendar, for selecting a date to put in a database field + + + @@ -3431,7 +3745,9 @@ - + + + @@ -3440,7 +3756,9 @@ - + + + @@ -3449,7 +3767,9 @@ - + + + @@ -3458,7 +3778,9 @@ - + + + @@ -3467,7 +3789,9 @@ - + + + @@ -3476,7 +3800,9 @@ - + + + @@ -3485,7 +3811,9 @@ - + + + @@ -3494,7 +3822,9 @@ - + + + @@ -3503,7 +3833,9 @@ - + + + @@ -3512,7 +3844,9 @@ - + + + @@ -3521,7 +3855,9 @@ - + + + @@ -3530,7 +3866,9 @@ - + + + @@ -3546,9 +3884,13 @@ - + + + - + + + @@ -3564,7 +3906,9 @@ - + + + @@ -3657,9 +4001,13 @@ - + + + - + + + @@ -3667,25 +4015,45 @@ - + + + - + + + - + + + - + + + - + + + - + + + - + + + - + + + - + + + - + + + @@ -3699,9 +4067,13 @@ - + + + - + + + @@ -3709,9 +4081,13 @@ - + + + - + + + @@ -3725,9 +4101,13 @@ - + + + - + + + @@ -3742,8 +4122,20 @@ - TDBCustomNavigator - the base class for TDBNavigator, a tool for navigating through the records of a dataset - + + TDBCustomNavigator - the base class for TDBNavigator, a tool for navigating through the records of a dataset + + + + +

+ TDBCustomNavigator is the parent class for +TDBNavigator, an advanced tool for navigating through datasets held locally in response to a query sent to the database. Most of the important properties are defined here.

+

It consists of a series of toolbuttons to move to the First, Prior, Next or Last record; to Insert or Delete a record; to Edit a record (enter Edit mode), to Post the changes. to Cancel the changes, and to Refresh the display from the database. The set of buttons for display can be customised in VisibleButtons, which allows display of individual buttons to be suppressed

+

If used in conjunction with a DataAware control such as TDBGrid or TDBMemo it controls which records are displayed , the position of the record selection cursor, and the initiation of changes to the dataset and ultimately the database.

+

Most of the functionality of the toolbar is already built-in to the control, but if the programmer needs to specify actions to be associated with individual buttons, there is a procedure BtnClick to which an argument can be sent with the index value of the button clicked, and the procedure chooses which action to call dependent on the button index.

+

The DataSource property must be set to link to the appropriate set of data.

+ @@ -3825,7 +4217,9 @@ - + + + @@ -3834,7 +4228,9 @@ - + + + @@ -3843,7 +4239,9 @@ - + + + @@ -3852,7 +4250,9 @@ - + + + @@ -3861,7 +4261,9 @@ - + + + @@ -3870,7 +4272,9 @@ - + + + @@ -3879,7 +4283,9 @@ - + + + @@ -3888,10 +4294,12 @@ - + + + - + The list of Buttons included in the navigator tool @@ -3931,9 +4339,13 @@ - + + + - + + + @@ -3956,7 +4368,9 @@ - + + + @@ -3965,7 +4379,9 @@ - + + + @@ -3989,38 +4405,45 @@ - + Create an instance of this control - + + + - + Destroy the control and returns its resources - + + BtnClick - procedure to respond to button clicks, and select an action from a list according to the value of the Index of the clicked button - + + + - + Finds the number of visible buttons - + + + @@ -4029,19 +4452,19 @@ - + Should the user be asked for confirmation before a record is deleted? If True, a dialog appears asking for confirmation - + The Data Source to which the control must be linked in order to function - + The direction in which the buttons appear: horizontal or vertical @@ -4053,25 +4476,27 @@ - + A list of hints to be shown if the mouse hovers over a button - + The action to be taken when a navigator button is clicked - - + The set of visible buttons (some of them can be suppressed if their function appears redundant) + +

The VisibleButtons entry in the Object Inspector can be used to set whether or not a particular button is to be visible.

+ - + Determines whether button hints are to be shown @@ -4155,7 +4580,9 @@ - + + + @@ -4165,8 +4592,20 @@ - TDBNavigator - a data-aware Button-Bar to facilitate navigating between records of a dataset - + + TDBNavigator - a data-aware Button-Bar to facilitate navigating between records of a dataset + + + + +

+ TDBNavigator is an advanced tool for navigating through datasets held locally in response to a query sent to the database.

+

It consists of a series of toolbuttons to move to the First, Prior, Next or Last record; to Insert or Delete a record; to Edit a record (enter Edit mode), to Post the changes. to Cancel the changes, and to Refresh the display from the database.

+

The programmer may determine, at design time, which buttons are to be displayed or suppressed by adjusting the VisibleButtons property in the Object Inspector.

+

If used in conjunction with a DataAware control such as TDBGrid or TDBMemo it controls which records are displayed , the position of the record selection cursor, and the initiation of changes to the dataset and ultimately the database.

+

Most of the functionality of the toolbar is already built-in to the control, but if the programmer needs to specify actions to be associated with individual buttons, there is a procedure TDBCustomNavigator.BtnClick to which an argument can be sent with the Index value of the button clicked, and the procedure chooses which action to call dependent on the button index.

+

The DataSource property must be set to link to the appropriate set of data.

+ @@ -4434,11 +4873,17 @@ - + + + - + + + - + + + @@ -4447,15 +4892,25 @@ - + + + - + + + - + + + - + + + - + + + @@ -4464,9 +4919,11 @@ - HowToUseDataAwareControls - Hints for accessing databases + + HowToUseDataAwareControls - Hints for accessing databases -

HowToUseDataAwareControls - Hints for accessing databases. A set of Data-Aware components is provided, to make it easier to access information held in databases.

+

+ HowToUseDataAwareControls - Hints for accessing databases. A set of Data-Aware components is provided, to make it easier to access information held in databases.

Before using Data-Aware components, it is necessary to make a connection with a database, and this should be done either using a TSQLConnection or a TDBf component, depending on the type of database that is being used. In any case, the components for connection with the database need to be found in $Lazdir/components/sqldb/, $Lazdir/components/tdbf/ or whatever other source is appropriate. They need to be added using the Components Menu Item of the IDE, and compiled ready for adding. The IDE needs to be re-built to include the new components.

To make the connection with the database: first place a DataBase Connection on the Form (invisible at run-time, so put it anywhere convenient); set its properties to connect the user (with name and password) to the appropriate server, database and table (the connection component should deal with all the user-authentication issues, opening and closing the database etc). Then put on a TDataSource from the Data Access tab of the Component Palette, and perhaps items such as TSQLTransaction and TSQLQuery, depending on the particular database you are using. The various database components need to be linked to each other, for example by setting the Transaction property of a database connector to the appropriate transaction component, and linking the DataBase property of the Transaction component back to the database connector; link the DataSource's DataSet property to the appropriate SQLQuery or other set of data, and its Transaction property to the transaction component

Each Data-Aware control (on the Data Controls tab of the Component Palette) has the usual set of properties to determine its shape and size, position, colour and font etc. But there are also special properties to define the data to be displayed or modified. These include the DataSource property which must be set to link to the defined set of data, and often a Field component to determine which of the columns in the database is to be displayed.

@@ -4475,7 +4932,8 @@

The way database programming works is typically as follows:

  • a database is opened for access by the user (Database Connection)
    • -
  • a command is issued (eg by TSQLQuery) to select or extract some or all of the records which are then stored locally in the DataSet
    • +
  • a command is issued (eg by TSQLQuery) to select or extract some or all of the records which are then stored locally in the DataSet +
  • the contents of the DataSet are acted on by the Data-Aware components, displaying one Row or record at a time from selected Columns, or perhaps the whole DataSet in a DBGrid, editing records, inserting or deleting records, or using the data to perform statistical tests or calculations
  • at intervals usually prescribed by the user (sometimes after every change, sometimes after a whole series of changes), the contents of the local DataSet are sent back to the database, causing an update of the database's contents. This process is referred to as 'Commit' or 'Post' or sometimes as 'Update'
diff --git a/docs/xml/lcl/dbgrids.xml b/docs/xml/lcl/dbgrids.xml index 5fe22526d2..32d15a8d7a 100644 --- a/docs/xml/lcl/dbgrids.xml +++ b/docs/xml/lcl/dbgrids.xml @@ -83,19 +83,20 @@ - - - - - - - + + + + - TCustomDBGrid -- the base class for TDBGrid, for displaying database information in the manner of a StringGrid - + + TCustomDBGrid +- the base class for TDBGrid, for displaying database information in the manner of a StringGrid + + + + @@ -111,9 +112,13 @@ - + + + - + + + @@ -121,7 +126,9 @@ - + + + @@ -129,11 +136,17 @@ - + + + - + + + - + + + @@ -141,15 +154,25 @@ - + + + - + + + - + + + - + + + - + + + @@ -157,11 +180,17 @@ - + + + - + + + - + + + @@ -169,11 +198,17 @@ - + + + - + + + - + + + @@ -181,73 +216,90 @@ - + + + - + + + - + + + - + - - + - - + - - - + + + - + + + - + + + - + + + - + + + - + + + - + + + - + + + - + + + + + + + - - - - - + + + - - + - - + - - - - - - + + + - + @@ -255,391 +307,277 @@ - - - - - + + + - - + - - + - - + - - - - - - + + + - - - - - - + + + - - + - - + - - + - - - - - - + + + - - + - - + - - + - - - - - - + + + - - + - - + - - + - - - - - - + + + - - + - - + - - + - - + - - - - - - - - + + + + - - - - - - + + + - - - - - - + + + - - - - - - - - + + + + - - + - - - - - - - - + + + + - - + - - - - - - - - + + + + - - + - - + - - - - - - - - + + + + - - + - - - - - - - - + + + + - - - - - - - - + + + + - - + - - - - - - - - + + + + - - - - - - - - + + + + - - - - - - - - + + + + - - - - - - - - + + + + - - + - - + - - + - - - - - - - - + + + + - - + - - + - - - - - - - - + + + + - - + - - - - - - + + + - - - - - - + + + - - - - - - + + + - - + - @@ -661,7 +599,9 @@ - + + + @@ -670,28 +610,24 @@ - + + + - - - - - - + + + - - + - - + - @@ -791,7 +727,9 @@ - + + + @@ -800,9 +738,13 @@ - + + + - + + + @@ -811,7 +753,9 @@ - + + + @@ -820,7 +764,9 @@ - + + + @@ -850,7 +796,9 @@ - + + + @@ -859,7 +807,9 @@ - + + + @@ -889,9 +839,13 @@ - + + + - + + + @@ -978,7 +932,9 @@ - + + + @@ -1042,7 +998,9 @@ - + + + @@ -1051,7 +1009,9 @@ - + + + @@ -1060,7 +1020,9 @@ - + + + @@ -1069,7 +1031,9 @@ - + + + @@ -1078,7 +1042,9 @@ - + + + @@ -1087,7 +1053,9 @@ - + + + @@ -1096,7 +1064,9 @@ - + + + @@ -1105,7 +1075,9 @@ - + + + @@ -1114,7 +1086,9 @@ - + + + @@ -1123,7 +1097,9 @@ - + + + @@ -1132,7 +1108,9 @@ - + + + @@ -1141,7 +1119,9 @@ - + + + @@ -1150,7 +1130,9 @@ - + + + @@ -1159,7 +1141,9 @@ - + + + @@ -1168,7 +1152,9 @@ - + + + @@ -1177,7 +1163,9 @@ - + + + @@ -1185,20 +1173,15 @@ - - - - - - - + + + + - - + - @@ -1207,7 +1190,9 @@ - + + + @@ -1230,7 +1215,9 @@ - + + + @@ -1384,7 +1371,9 @@ - + + + @@ -1393,7 +1382,9 @@ - + + + @@ -1402,7 +1393,9 @@ - + + + @@ -1411,7 +1404,9 @@ - + + + @@ -1420,7 +1415,9 @@ - + + + @@ -1429,7 +1426,9 @@ - + + + @@ -1438,7 +1437,9 @@ - + + + @@ -1447,7 +1448,9 @@ - + + + @@ -1456,7 +1459,9 @@ - + + + @@ -1465,7 +1470,9 @@ - + + + @@ -1474,7 +1481,9 @@ - + + + @@ -1483,7 +1492,9 @@ - + + + @@ -1492,7 +1503,9 @@ - + + + @@ -1501,7 +1514,9 @@ - + + + @@ -1510,7 +1525,9 @@ - + + + @@ -1519,7 +1536,9 @@ - + + + @@ -1528,7 +1547,9 @@ - + + + @@ -1537,7 +1558,9 @@ - + + + @@ -1546,7 +1569,9 @@ - + + + @@ -1555,7 +1580,9 @@ - + + + @@ -1564,7 +1591,9 @@ - + + + @@ -1573,7 +1602,9 @@ - + + + @@ -1582,7 +1613,9 @@ - + + + @@ -1591,7 +1624,9 @@ - + + + @@ -1600,7 +1635,9 @@ - + + + @@ -1609,7 +1646,9 @@ - + + + @@ -1618,7 +1657,9 @@ - + + + @@ -1627,7 +1668,9 @@ - + + + @@ -1636,7 +1679,9 @@ - + + + @@ -1645,7 +1690,9 @@ - + + + @@ -1654,7 +1701,9 @@ - + + + @@ -1663,7 +1712,9 @@ - + + + @@ -1672,7 +1723,9 @@ - + + + @@ -1681,7 +1734,9 @@ - + + + @@ -1690,7 +1745,9 @@ - + + + @@ -1699,7 +1756,9 @@ - + + + @@ -1708,7 +1767,9 @@ - + + + @@ -1717,7 +1778,9 @@ - + + + @@ -1726,7 +1789,9 @@ - + + + @@ -1735,7 +1800,9 @@ - + + + @@ -1744,7 +1811,9 @@ - + + + @@ -1753,7 +1822,9 @@ - + + + @@ -1762,7 +1833,9 @@ - + + + @@ -1771,7 +1844,9 @@ - + + + @@ -1780,7 +1855,9 @@ - + + + @@ -1789,7 +1866,9 @@ - + + + @@ -1798,7 +1877,9 @@ - + + + @@ -1807,7 +1888,9 @@ - + + + @@ -1816,7 +1899,9 @@ - + + + @@ -1845,7 +1930,9 @@ - + + + @@ -1868,7 +1955,9 @@ - + + + @@ -1883,377 +1972,258 @@ - - - - - + + + - - - - - - + + + - - - - - - + + + - - - - - - + + + - - - - - - + + + - - - - - - + + + - - - - - - - - + + + + - - - - - - - - + + + + - - + - - - - - - - - + + + + - - + - - - - - - - - + + + + - - + - - - - - - - - + + + + - - + - - - - - - - - + + + + - - + - - - - - - - - + + + + - - + - - - - - - - - + + + + - - + - - - - - - - - + + + + - - + - - - - - - - - + + + + - - + - - - - - - - - + + + + - - + - - - - - - - - + + + + - - + - - - - - - - - + + + + - - + - - - - - - - - + + + + - - + - - - - - - - - + + + + - - + - - - - - - - - + + + + - - + - - - - - - - - + + + + - - + - - - - - - + + + - - - - - - + + + - - - - - - + + + - - - - - - + + + - - - - - - + + + - - - - - - + + + @@ -2372,9 +2342,13 @@ - + + + - + + + @@ -2383,7 +2357,9 @@ - + + + @@ -2392,9 +2368,13 @@ - + + + - + + + @@ -2403,7 +2383,9 @@ - + + + @@ -2412,7 +2394,9 @@ - + + + @@ -2421,9 +2405,13 @@ - + + + - + + + @@ -2446,7 +2434,9 @@ - + + + @@ -2455,7 +2445,9 @@ - + + + @@ -2471,9 +2463,13 @@ - + + + - + + + @@ -2482,7 +2478,9 @@ - + + + @@ -2496,7 +2494,9 @@ - + + + @@ -2511,66 +2511,52 @@ - - - - - - - + + + + - - + - - - - - - - - + + + + - - + - - - - - - - - + + + + - - - - - - - - + + + + - - + - TCustomDBGrid - the base class for TDBGrid , for displaying database information in the manner of a StringGrid - + + TCustomDBGrid - the base class for TDBGrid , for displaying database information in the manner of a StringGrid + + + + @@ -2724,7 +2710,9 @@ - + + + @@ -2733,7 +2721,9 @@ - + + + @@ -2742,7 +2732,9 @@ - + + + @@ -2751,7 +2743,9 @@ - + + + @@ -2760,7 +2754,9 @@ - + + + @@ -2769,7 +2765,9 @@ - + + + @@ -2778,7 +2776,9 @@ - + + + @@ -2787,7 +2787,9 @@ - + + + @@ -2796,7 +2798,9 @@ - + + + @@ -2805,7 +2809,9 @@ - + + + @@ -2814,7 +2820,9 @@ - + + + @@ -2823,7 +2831,9 @@ - + + + @@ -2832,9 +2842,13 @@ - + + + - + + + @@ -2843,7 +2857,9 @@ - + + + @@ -2852,7 +2868,9 @@ - + + + @@ -2861,7 +2879,9 @@ - + + + @@ -2870,7 +2890,9 @@ - + + + @@ -2879,7 +2901,9 @@ - + + + @@ -2888,7 +2912,9 @@ - + + + @@ -2897,7 +2923,9 @@ - + + + @@ -2920,11 +2948,17 @@ - + + + - + + + - + + + @@ -2933,11 +2967,17 @@ - + + + - + + + - + + + @@ -2946,7 +2986,9 @@ - + + + @@ -2955,11 +2997,17 @@ - + + + - + + + - + + + @@ -2968,11 +3016,17 @@ - + + + - + + + - + + + @@ -2981,9 +3035,13 @@ - + + + - + + + @@ -2992,9 +3050,13 @@ - + + + - + + + @@ -3003,9 +3065,13 @@ - + + + - + + + @@ -3014,9 +3080,13 @@ - + + + - + + + @@ -3025,9 +3095,13 @@ - + + + - + + + @@ -3036,9 +3110,13 @@ - + + + - + + + @@ -3047,9 +3125,13 @@ - + + + - + + + @@ -3058,9 +3140,13 @@ - + + + - + + + @@ -3104,7 +3190,9 @@ - + + + @@ -3113,7 +3201,9 @@ - + + + @@ -3129,7 +3219,9 @@ - + + + @@ -3138,9 +3230,13 @@ - + + + - + + + @@ -3156,9 +3252,13 @@ - + + + - + + + @@ -3167,13 +3267,21 @@ - + + + - + + + - + + + - + + + @@ -3182,11 +3290,17 @@ - + + + - + + + - + + + @@ -3195,7 +3309,9 @@ - + + + @@ -3204,9 +3320,13 @@ - + + + - + + + @@ -3215,9 +3335,13 @@ - + + + - + + + @@ -3233,7 +3357,9 @@ - + + + @@ -3242,13 +3368,21 @@ - + + + - + + + - + + + - + + + @@ -3278,11 +3412,17 @@ - + + + - + + + - + + + @@ -3291,7 +3431,9 @@ - + + + @@ -3300,13 +3442,21 @@ - + + + - + + + - + + + - + + + @@ -3315,7 +3465,9 @@ - + + + @@ -3324,9 +3476,13 @@ - + + + - + + + @@ -3349,9 +3505,13 @@ - + + + - + + + @@ -3360,7 +3520,9 @@ - + + + @@ -3376,13 +3538,21 @@ - + + + - + + + - + + + - + + + @@ -3391,11 +3561,17 @@ - + + + - + + + - + + + @@ -3404,11 +3580,17 @@ - + + + - + + + - + + + @@ -3417,7 +3599,9 @@ - + + + @@ -3426,9 +3610,13 @@ - + + + - + + + @@ -3437,9 +3625,13 @@ - + + + - + + + @@ -3448,9 +3640,13 @@ - + + + - + + + @@ -3459,7 +3655,9 @@ - + + + @@ -3489,13 +3687,21 @@ - + + + - + + + - + + + - + + + @@ -3504,11 +3710,17 @@ - + + + - + + + - + + + @@ -3524,11 +3736,17 @@ - + + + - + + + - + + + @@ -3537,9 +3755,13 @@ - + + + - + + + @@ -3548,11 +3770,17 @@ - + + + - + + + - + + + @@ -3568,7 +3796,9 @@ - + + + @@ -3577,11 +3807,17 @@ - + + + - + + + - + + + @@ -3597,7 +3833,9 @@ - + + + @@ -3662,13 +3900,15 @@ - + Create an instance of this control - + + + @@ -3677,1016 +3917,729 @@ - + + + - + + + - + + + - + + + - + Destroy the control and returns its resources - + The selected field or column, for editing, data input or simply viewing - - - - - + + + - - - - - - + + + - - - - - - + + + - - - - - - + + + - - - - - - + + + - - - - - - + + + - - - - - - + + + - - - - - - + + + - - - - - - + + + - - - - - - + + + - - - - - - + + + - - - - - - + + + - - - - - - + + + - - - - - - + + + - - - - - - - - + + + + - - - - - - - - + + + + - - + - - - - - - - - + + + + - - + - - - - - - - - + + + + - - + - - - - - - - - + + + + - - + - - - - - - - - + + + + - - + - - - - - - - - + + + + - - + - - - - - - - - + + + + - - + - - - - - - - - + + + + - - + - - - - - - - - + + + + - - - - - - - - + + + + - - - - - - - - + + + + - - + - - - - - - - - + + + + - - - - - - - - + + + + - - + - - + - - + - - - - - - - - + + + + - - - - - - - - + + + + - - + - - - - - - - - + + + + - - + - - + - - + - - - - - - - - + + + + - - - - - - - - + + + + - - - - - - - - + + + + - - - - - - - - + + + + - - + - - + - - + - - - - - - - - + + + + - - + - - + - - + - - - - - - - - + + + + - - + - - + - - + - - - - - - - - + + + + - - + - - + - - + - - - - - - - - + + + + - - - - - - - - + + + + - - + - - + - - + - - - - - - - - + + + + - - + - - + - - + - - + - - - - - - - - + + + + - - + - - - - - - - - + + + + - - + - - + - - - - - - - - + + + + - - + - - + - - - - - - - - + + + + - - + - - + - - - - - - - - + + + + - - + - - + - - - - - - - - + + + + - - + - - - - - - - - + + + + - - + - - + - - - - - - - - + + + + - - + - - + - - + - - - - - - - - + + + + - - + - - + - - - - - - - - + + + + - - + - - + - - + - - + - - + - - + - - - - - - - - + + + + - - - - - - - - + + + + - - + - - - - - - + + + - - - - - - + + + - - - - - - + + + - - - - - - + + + - - - - - - + + + - - - - - - + + + - - - - - - + + + - - - - - - - - + + + + - - - - - - - - + + + + - - + - - + - - - - - - - - + + + + - - - - - - + Selected index - number of the row selected for viewing or editing + + - - - - - - + The selected column or field for viewing or editing + Columns and fields are often used interchangeably, but their properties are different. + - - - - - - + + + - TdbGrid - a data-aware version of TStringGrid, for displaying and operating on a series of Rows and Columns from a database + + TdbGrid - a data-aware version of TStringGrid, for displaying and operating on a series of Rows and Columns from a database -

TdbGrid - a data-aware version of TStringGrid, for displaying and operating on a series of Rows and Columns from a database

-

Inherits many of its properties from TCustomGrid and, of course, from TCustomDBGrid

+

+ TdbGrid - a data-aware version of TStringGrid, for displaying and operating on a series of Rows and Columns from a database

+

Inherits many of its properties from TCustomGrid and, of course, from TCustomDBGrid +

- + + + @@ -4732,8 +4685,14 @@ - - + Refers to the physical columns of the grid, displaying the contents of the relevant Fields + + +

Refers to the physical columns of the grid, displaying the contents of the relevant Fields +

+

The columns property deals with things like the size, shape and format of the display, and contains a link to the appropriate Field.

+

Do no confuse Grid columns (in the display) with the SQL usage of Columns, which corresponds to Fields in our environment. The Fields consist of a series of cells arranged in Rows, which contain the actual data which are to be displayed and operated upon.

+ @@ -4948,263 +4907,177 @@ - - - - - + + + - - - - - - + + + - - - - - - + + + - - - - - - + + + - - - - - - + + + - - - - - - + + + - - - - - - + + + - - - - - - + + + - - - - - - + + + - - - - - - + + + - - - - - - + + + - - - - - - + + + - - - - - - + + + - - - - - - + + + - - - - - - + + + - - - - - - + + + - - - - - - + + + - - - - - - + + + - - - - - - + + + - - - - - - + + + - - - - - - + + + - - - - - - + + + - - - - - - + + + - - - - - - + + + - - - - - - + + + - - - - - - + + + - - - - - - + + + - - - - - - + + + - - - - - - + + + diff --git a/docs/xml/lcl/grids.xml b/docs/xml/lcl/grids.xml index 801fee2ffb..75896daa8c 100644 --- a/docs/xml/lcl/grids.xml +++ b/docs/xml/lcl/grids.xml @@ -4375,7 +4375,7 @@ Application developers may use the OnSelection and OnBeforeSelection events to r - + Finds out whether a particular cell is visible @@ -4394,7 +4394,7 @@ Application developers may use the OnSelection and OnBeforeSelection events to r - + Load the grid data from a file with the specified name @@ -4405,7 +4405,7 @@ Application developers may use the OnSelection and OnBeforeSelection events to r - + Convert mouse coordinates to the position of a cell in the grid @@ -4500,7 +4500,7 @@ Application developers may use the OnSelection and OnBeforeSelection events to r - + Save the data in the grid to a file with specified name @@ -9437,13 +9437,13 @@ Segunda linea de texto - + The other colour which can be used in this grid (eg for highlighting selected text etc) - + Whether the Edit mode is automatically entered when a cell is selected @@ -9456,7 +9456,9 @@ Segunda linea de texto The properties of the columns in this grid - + +

The Columns property of a grid refers to the physical column in the table, and determines its size, shape, colour etc. It should not be confused with the COLUMNS construct frequently used in SQL programming, which refers to Fields of data. The contents of Fields can be displayed as Columns in a Grid, but they must be seen as separate and distinct. It is irrelevant to refer to the colour, font or width of a data field from a database, but these are all very relevant in specifying the appearance of a column in a grid.

+ @@ -9627,7 +9629,7 @@ Segunda linea de texto - + Clear the background to the grid @@ -9638,7 +9640,7 @@ Segunda linea de texto - + Find the mouse coordinates relative to the grid origin diff --git a/docs/xml/lcl/stdctrls.xml b/docs/xml/lcl/stdctrls.xml index 9a18fb5f26..25695e3e31 100644 --- a/docs/xml/lcl/stdctrls.xml +++ b/docs/xml/lcl/stdctrls.xml @@ -236,7 +236,8 @@ -: the base class for TScrollBar +: the base class for TScrollBar + @@ -535,7 +536,8 @@ - the size of a page - typically used for LargeChange + the size of a page - typically used for LargeChange + @@ -618,7 +620,8 @@

// standard properties, which should be supported by all descendants

Determines how the control is to be anchored to its client or parent conrol

-

Either reads a flag containing the set of anchors to be used, or writes a set of anchors. If they have been written, this is indicated in IsAnchorsStored

+

Either reads a flag containing the set of anchors to be used, or writes a set of anchors. If they have been written, this is indicated in IsAnchorsStored +

@@ -639,7 +642,8 @@

// standard properties, which should be supported by all descendants

Determines the border spacing for this control

Reads flag to find stored spacing values required for the border of the control, or writes the flag to set the spacing.

-

The properties are defined in the parent class TControlBorderSpacing

+

The properties are defined in the parent class TControlBorderSpacing +

@@ -735,7 +739,8 @@ - the size of a page - typically used for LargeChange + the size of a page - typically used for LargeChange + @@ -768,7 +773,8 @@ PopupMenu - a context-sensitive menu that pops up when the right mouse button is clicked over this control // standard properties, which should be supported by all descendants
Reads the details of the pop-up menu, or stores them.
-Properties are defined in the parent class TPopupMenu +Properties are defined in the parent class TPopupMenu + @@ -939,11 +945,13 @@ Properties are defined in the parent class TPop -- the base class for TGroupBox, TRadioGroup and TCheckGroup +- the base class for TGroupBox, TRadioGroup and TCheckGroup + - Sets up default size for the class + + GetControlClassDefaultSize - finds out default size for the class @@ -1010,7 +1018,8 @@ Properties are defined in the parent class TPop

// standard properties, which should be supported by all descendants

Determines the border spacing for this control

Reads flag to find stored spacing values required for the border of the control, or writes the flag to set the spacing.

-

The properties are defined in the parent class TControlBorderSpacing

+

The properties are defined in the parent class TControlBorderSpacing +

@@ -1129,7 +1138,8 @@ Properties are defined in the parent class TPop

// standard properties, which should be supported by all descendants

Reads a flag to see what font should be used, or sets a flag to store it. If stored, sets a flag to say so

-

The properties of Font are defined in the parent class TFont

+

The properties of Font are defined in the parent class TFont +

@@ -1180,7 +1190,8 @@ Properties are defined in the parent class TPop PopupMenu - a context-sensitive menu that pops up when the right mouse button is clicked over this control // standard properties, which should be supported by all descendants
Reads the details of the pop-up menu, or stores them.
-Properties are defined in the parent class TPopupMenu +Properties are defined in the parent class TPopupMenu + @@ -1239,7 +1250,8 @@ Properties are defined in the parent class TPop Event Handler for mouse click

// standard properties, which should be supported by all descendants

-

This is often the default action for many controls, and is often the ONLY action specified by the programmer. The action can be spcified by the user, either by typing explicit code into the implementation section for this control, or by selecting an action from a pre-supplied ActionList

+

This is often the default action for many controls, and is often the ONLY action specified by the programmer. The action can be spcified by the user, either by typing explicit code into the implementation section for this control, or by selecting an action from a pre-supplied ActionList +

Reads or writes a flag if a mouse click is detected, and sets a flag if a value is stored.

 @@ -1445,7 +1457,8 @@ Properties are defined in the parent class TPop - Set of TComboBoxAutoCompleteTextOption + Set of TComboBoxAutoCompleteTextOption + @@ -1540,7 +1553,8 @@ Properties are defined in the parent class TPop - the base class from which TComboBox is derived

Despite similarities in appearance to TCustomEdit and TCustomList -, the class inherits no properties from these classes, but only from TWinControl

+, the class inherits no properties from these classes, but only from TWinControl +

It has some interesting properties including AutoComplete and AutoCompleteText, AutoDropDown and the ability to create and add a History display

 @@ -2701,7 +2715,8 @@ has value -1.

- - the string appearing in the main box. If an item on the drop-down list is selected, it replaces the contents of Text + - the string appearing in the main box. If an item on the drop-down list is selected, it replaces the contents of Text + @@ -2724,7 +2739,8 @@ has value -1.

- a simple combination of text box for free text entry, and a drop-down list allowing one of several options to be chosen.

-

The default text-string (if any, entered in the Form Designer) and the value of the text string that is ultimately selected from the drop-down list, is held in Text

+

The default text-string (if any, entered in the Form Designer) and the value of the text string that is ultimately selected from the drop-down list, is held in Text +

The values that can be selected from the drop-down list are held in the string-array Items. Clicking on the ellipsis (...) next to Items in the Object Inspector opens a pop-up string-list editor which allows the designer to enter and edit a number of lines of text to represent the selections

At run-time, the entry selected from the drop-down list in Items is used to replace any information previously found in Text, and ItemIndex holds the (zero-origin) index number of the selected item

If no value is selected from the drop-down list, the default text (if any) remains, or any information typed directly into Text will be returned, and ItemIndex takes the value of -1

@@ -2810,7 +2826,8 @@ has value -1.

// standard properties, which should be supported by all descendants

Determines the border spacing for this control

Reads flag to find stored spacing values required for the border of the control, or writes the flag to set the spacing.

-

The properties are defined in the parent class TControlBorderSpacing

+

The properties are defined in the parent class TControlBorderSpacing +

@@ -2888,7 +2905,8 @@ has value -1.

// standard properties, which should be supported by all descendants

Reads a flag to see what font should be used, or sets a flag to store it. If stored, sets a flag to say so

-

The properties of Font are defined in the parent class TFont

+

The properties of Font are defined in the parent class TFont +

@@ -2989,7 +3007,8 @@ has value -1.

Event Handler for mouse click

// standard properties, which should be supported by all descendants

-

This is often the default action for many controls, and is often the ONLY action specified by the programmer. The action can be spcified by the user, either by typing explicit code into the implementation section for this control, or by selecting an action from a pre-supplied ActionList

+

This is often the default action for many controls, and is often the ONLY action specified by the programmer. The action can be spcified by the user, either by typing explicit code into the implementation section for this control, or by selecting an action from a pre-supplied ActionList +

Reads or writes a flag if a mouse click is detected, and sets a flag if a value is stored.

 @@ -3205,7 +3224,8 @@ has value -1.

PopupMenu - a context-sensitive menu that pops up when the right mouse button is clicked over this control // standard properties, which should be supported by all descendants
Reads the details of the pop-up menu, or stores them.
-Properties are defined in the parent class TPopupMenu +Properties are defined in the parent class TPopupMenu + @@ -3279,7 +3299,8 @@ Properties are defined in the parent class TPop - - the string appearing in the main box. If an item on the drop-down list is selected, it replaces the contents of Text + - the string appearing in the main box. If an item on the drop-down list is selected, it replaces the contents of Text + @@ -3337,7 +3358,8 @@ Properties are defined in the parent class TPop -: the base class for TListBox +: the base class for TListBox + @@ -4087,7 +4109,8 @@ Properties are defined in the parent class TPop - - the number of entries in the list of Items + - the number of entries in the list of Items + @@ -4117,7 +4140,8 @@ Properties are defined in the parent class TPop -- the height of the individual Items +- the height of the individual Items + @@ -4393,7 +4417,8 @@ of List Box - normal, owner-draw fixed, or owner-draw variable : a simple string list from which a choice is made

-

The array of strings is held in Items

+

The array of strings is held in Items +

Clicking on the ellipsis (...) next to the Items entry in the Object Inspector at design-time opens a string-list editor in which the individual text-strings for the list can be entered or edited. The editor also allows the entries to be sorted alphabetically in normal or reverse order.

 @@ -5349,11 +5374,13 @@ Indicates how text is displayed in a text editing control.

- a Scroll Bar specifically for use in Memo Boxes - Scroll Bar specifically for use in Memo Boxes. Inherits most of its properties from its ancestor, TControlScrollBar + Scroll Bar specifically for use in Memo Boxes. Inherits most of its properties from its ancestor, TControlScrollBar + - + + GetHorzScrollBar - find the position and properties of the horizontal scroll bar @@ -5364,7 +5391,8 @@ Indicates how text is displayed in a text editing control.

 - + + GetVertScrollBar - find the position and properties of the vertical scroll bar @@ -5422,7 +5450,8 @@ Indicates how text is displayed in a text editing control.

-: the base class for TMemo +: the base class for TMemo + @@ -6259,7 +6288,8 @@ Indicates how text is displayed in a text editing control.

-: the base class for Static Text +: the base class for Static Text + @@ -6852,7 +6882,8 @@ Indicates how text is displayed in a text editing control.

- provides a link between a button and its corresponding action

-

This class provides very few properties of its own, but inherits a lot from its ancestors, TWinControlActionLink, TControlActionLink, TActionLink and TBasicActionLink

+

This class provides very few properties of its own, but inherits a lot from its ancestors, TWinControlActionLink, TControlActionLink, TActionLink and TBasicActionLink +

@@ -6903,11 +6934,8 @@ Indicates how text is displayed in a text editing control.

- TCustomButton - - - - - the base class for TButton and TBitBtn + TCustomButton - the base class for TButton and TBitBtn + @@ -7964,7 +7992,8 @@ If the TabStop is True, the control is in the tab order. If TabStop is False, th

// standard properties, which should be supported by all descendants

Determines how the control is to be anchored to its client or parent conrol

-

Either reads a flag containing the set of anchors to be used, or writes a set of anchors. If they have been written, this is indicated in IsAnchorsStored

+

Either reads a flag containing the set of anchors to be used, or writes a set of anchors. If they have been written, this is indicated in IsAnchorsStored +

@@ -8169,7 +8198,8 @@ If the TabStop is True, the control is in the tab order. If TabStop is False, th is an entity in itself, with a number of additional properties, whereas the buttons within TRadioGroup are not separate entities, but rather are simply entries in a list of strings, each of which is associated with the on-screen image of a RadioButton.

-

The example shows the difference between the use of TRadioButton and TRadioGroup

+

The example shows the difference between the use of TRadioButton and TRadioGroup +

@@ -9174,7 +9204,8 @@ If the TabStop is True, the control is in the tab order. If TabStop is False, th - How to use StdCtrls, ComCtrls or ExtCtrls + How to use StdCtrls, ComCtrls or ExtCtrls +

The Units StdCtrls, ComCtrls and ExtCtrls contain definitions and descriptions of many of the most commonly used controls for constructing Forms and other Objects in Lazarus Applications.

Many of the final target controls that the application developer wants to use, such as TButton, TMemo, TScrollBar etc, have a corresponding ancestor class such as TCustomButton, TCustomMemo or TCustomScrollBar. Several of the properties and methods relevant to the final target control are defined (and explained) more fully in the TCustomXXX class, and are inherited by the final target control.