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

LazDoc - updates to TDBGrid, TCustomDBGrid, TCustomGrid in Grids.xml, DBGrids.xml. Minor change to StdCtrls.xml

Browse Source 
git-svn-id: trunk@13853 -
This commit is contained in:
kirkpatc 2008-01-24 11:43:54 +00:00
parent 4596953f06
commit 71e86fa60c
3 changed files with 90 additions and 109 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
docs/xml/lcl/dbgrids.xml
View File

@ -83,7 +83,8 @@
</element>
<!-- object Visibility: default -->
<element name="TCustomDbGrid">
<short><i>TCustomDBGrid </i>- the base class for <i>TDBGrid</i>, for displaying database information in the manner of a <i>StringGrid</i></short>
<short><i>TCustomDBGrid </i>
- the base class for <i>TDBGrid</i>, for displaying database information in the manner of a <i>StringGrid</i></short>
<seealso><link id="#lcl.DBCtrls.HowToUseDataAwareControls"/></seealso>
</element>
<!-- object Visibility: default -->
@ -1662,10 +1663,8 @@
</element>
<!-- object Visibility: default -->
<element name="TCustomDbGrid">
<short/>
<descr/>
<errors/>
<seealso/>
<short><i>TCustomDBGrid </i> - the base class for <i>TDBGrid</i> , for displaying database information in the manner of a <i>StringGrid</i></short>
<seealso><link id="#lcl.DBCtrls.HowToUseDataAwareControls"/></seealso>
</element>
<!-- variable Visibility: private -->
<element name="TCustomDbGrid.FDataLink">
@ -2701,9 +2700,7 @@
</element>
<!-- property Visibility: protected -->
<element name="TCustomDbGrid.DataSource">
<short/>
<descr/>
<seealso/>
<short>The DataSource from which this grid displays - usually the result of a database Query</short>
</element>
<!-- property Visibility: protected -->
<element name="TCustomDbGrid.Options">
@ -2713,9 +2710,7 @@
</element>
<!-- property Visibility: protected -->
<element name="TCustomDbGrid.ReadOnly">
<short/>
<descr/>
<seealso/>
<short>Set True to prevent writing to grid; set False to allow modification</short>
</element>
<!-- property Visibility: protected -->
<element name="TCustomDbGrid.TitleFont">
@ -2725,21 +2720,15 @@
</element>
<!-- property Visibility: protected -->
<element name="TCustomDbGrid.OnCellClick">
<short/>
<descr/>
<seealso/>
<short>Event handler for mouse click in a cell of the grid</short>
</element>
<!-- property Visibility: protected -->
<element name="TCustomDbGrid.OnColEnter">
<short/>
<descr/>
<seealso/>
<short>Event handler if mouse enters column or it gains focus</short>
</element>
<!-- property Visibility: protected -->
<element name="TCustomDbGrid.OnColExit">
<short/>
<descr/>
<seealso/>
<short>Event handler if mouse leaves column or it loses focus</short>
</element>
<!-- property Visibility: protected -->
<element name="TCustomDbGrid.OnColumnMoved">
@ -2749,9 +2738,7 @@
</element>
<!-- property Visibility: protected -->
<element name="TCustomDbGrid.OnDrawColumnCell">
<short/>
<descr/>
<seealso/>
<short>Event handler if the cell in this column requires to be drawn</short>
</element>
<!-- property Visibility: protected -->
<element name="TCustomDbGrid.OnEditButtonClick">
@ -2761,15 +2748,11 @@
</element>
<!-- property Visibility: protected -->
<element name="TCustomDbGrid.OnFieldEditMask">
<short/>
<descr/>
<seealso/>
<short>Event handler if field is associated with an edit mask</short>
</element>
<!-- property Visibility: protected -->
<element name="TCustomDbGrid.OnTitleClick">
<short/>
<descr/>
<seealso/>
<short>Event handler for mouse click on Title</short>
</element>
<!-- constructor Visibility: public -->
<element name="TCustomDbGrid.Create">
@ -2810,7 +2793,11 @@
</element>
<!-- object Visibility: default -->
<element name="TdbGrid">
<short><i>TdbGrid </i>- a data-aware version of <i>TStringGrid,</i> for displaying and operating on a series of Rows and Columns from a database</short>
<short><i>TdbGrid </i> - a data-aware version of <i>TStringGrid,</i> for displaying and operating on a series of Rows and Columns from a database</short>
<descr>
<p><i>TdbGrid </i> - a data-aware version of <i>TStringGrid,</i> for displaying and operating on a series of Rows and Columns from a database</p>
<p>Inherits many of its properties from <link id="#lcl.Grids.TCustomGrid">TCustomGrid</link> and, of course, from <link id="TCustomDBGrid">TCustomDBGrid</link></p>
</descr>
<seealso><link id="#lcl.DBCtrls.HowToUseDataAwareControls"/></seealso>
</element>
<!-- property Visibility: public -->
@ -3078,6 +3065,8 @@
<errors/>
<seealso/>
</element>
<element name="TDBGrid.AutoEdit"/>
<element name="TDBGrid.BorderSpacing"/>
</module>
<!-- DBGrids -->
</package>

149
docs/xml/lcl/grids.xml
View File

@ -1140,34 +1140,30 @@
<!-- object Visibility: default -->
<element name="TCustomGrid">
<short>The base class for all grid controls</short>
<descr><p>A grid is a collection of cells that are organized in columns and rows.
<descr>
<p>A grid is a collection of cells that are organized in columns and rows.
Grids are adequate to show data that have tabular nature, for example tables in a database.
</p><p><b>Key properties:</b></p>
<p>The <link id="TCustomGrid.ColCount">ColCount</link> and <link id="TCustomGrid.RowCount">RowCount</link> properties contain the column and row count of the grid. </p>
<p>The <link id="TCustomGrid.FixedCols">FixedCols</link> and <link id="TCustomGrid.FixedRows">FixedRows</link> properties specify the count of fixed columns or rows that are used for headings. </p>
<p>The column widths and row heights of the grid are accessible with the <link id="TCustomGrid.ColWidths">ColWidths</link> and <link id="TCustomGrid.RowHeights">RowHeights</link> properties. </p>
<p>The <link id="TCustomGrid.DefaultColWidth">DefaultColWidth</link> and DefaultRowHeight properties are used to specify default column widths or row heights respectively. </p>
<p>The colors of the cells and the grid elements are specified with the <link id="TCustomGrid.AlternateColor">AlternateColor</link>, <link id="TCustomGrid.BorderColor">BorderColor</link>, <link id="TCustomGrid.FixedColor">FixedColor</link>, <link id="TCustomGrid.FixedHotColor">FixedHotColor</link>, <link id="TCustomGrid.FocusColor">FocusColor</link>, <link id="TCustomGrid.GridLineColor">GridLineColor</link> and <link id="TCustomGrid.SelectedColor">SelectedColor</link> properties. The <link id="TCustomGrid.GridWidth">GridWidth</link> and <link id="TCustomGrid.GridHeight">GridHeight</link> properties contain the dimension of the entire grid.</p>
<p>The <link id="TCustomGrid.ScrollBars">ScrollBars</link> property controls the creation of scrollbars for the grid. </p>
<p>The <link id="TCustomGrid.LeftCol">LeftCol</link>, <link id="TCustomGrid.TopRow">TopRow</link>, <link id="TCustomGrid.VisibleColCount">VisibleColCount</link> and <link id="TCustomGrid.VisibleRowCount">VisibleRowCount</link> properties contain information about the visible area of the grid. </p>
<p>The <link id="TCustomGrid.Options">Options</link> property controls options for the grid.
</p><p><b>Key methods and events:</b></p>
<p>If the user highlights a cell of the grid, the <link id="TCustomGrid.SelectCell">SelectCell</link> method is called that triggers the <link id="TCustomGrid.OnSelectCell">OnSelectCell</link> event. The position of the highlighted cell is stored within the <link id="TCustomGrid.Col">Col</link> and <link id="TCustomGrid.Row">Row</link> property.</p>
<p>The <link id="TCustomGrid.MouseToCell">MouseToCell</link> method calculates a grid cell from a given screen position.</p>
<p>Huge changes to the grid should be encapsulated in calls to <link id="TCustomGrid.BeginUpdate">BeginUpdate</link> and <link id="TCustomGrid.EndUpdate">EndUpdate</link> to speed up the application. </p>
<p>Component developers must override the <link id="TCustomGrid.DrawCell">DrawCell</link> method in customized grids.</p></descr>
</p>
<p>
<b>Key properties:</b>
</p>
<p>The <link id="TCustomGrid.ColCount">ColCount</link> and <link id="TCustomGrid.RowCount">RowCount</link> properties contain the column and row count of the grid. </p>
<p>The <link id="TCustomGrid.FixedCols">FixedCols</link> and <link id="TCustomGrid.FixedRows">FixedRows</link> properties specify the count of fixed columns or rows that are used for headings. </p>
<p>The column widths and row heights of the grid are accessible with the <link id="TCustomGrid.ColWidths">ColWidths</link> and <link id="TCustomGrid.RowHeights">RowHeights</link> properties. </p>
<p>The <link id="TCustomGrid.DefaultColWidth">DefaultColWidth</link> and DefaultRowHeight properties are used to specify default column widths or row heights respectively. </p>
<p>The colors of the cells and the grid elements are specified with the <link id="TCustomGrid.AlternateColor">AlternateColor</link>, <link id="TCustomGrid.BorderColor">BorderColor</link>, <link id="TCustomGrid.FixedColor">FixedColor</link>, <link id="TCustomGrid.FixedHotColor">FixedHotColor</link>, <link id="TCustomGrid.FocusColor">FocusColor</link>, <link id="TCustomGrid.GridLineColor">GridLineColor</link> and <link id="TCustomGrid.SelectedColor">SelectedColor</link> properties. The <link id="TCustomGrid.GridWidth">GridWidth</link> and <link id="TCustomGrid.GridHeight">GridHeight</link> properties contain the dimension of the entire grid.</p>
<p>The <link id="TCustomGrid.ScrollBars">ScrollBars</link> property controls the creation of scrollbars for the grid. </p>
<p>The <link id="TCustomGrid.LeftCol">LeftCol</link>, <link id="TCustomGrid.TopRow">TopRow</link>, <link id="TCustomGrid.VisibleColCount">VisibleColCount</link> and <link id="TCustomGrid.VisibleRowCount">VisibleRowCount</link> properties contain information about the visible area of the grid. </p>
<p>The <link id="TCustomGrid.Options">Options</link> property controls options for the grid.
</p>
<p>
<b>Key methods and events:</b>
</p>
<p>If the user highlights a cell of the grid, the <link id="TCustomGrid.SelectCell">SelectCell</link> method is called that triggers the <link id="TCustomGrid.OnSelectCell">OnSelectCell</link> event. The position of the highlighted cell is stored within the <link id="TCustomGrid.Col">Col</link> and <link id="TCustomGrid.Row">Row</link> property.</p>
<p>The <link id="TCustomGrid.MouseToCell">MouseToCell</link> method calculates a grid cell from a given screen position.</p>
<p>Huge changes to the grid should be encapsulated in calls to <link id="TCustomGrid.BeginUpdate">BeginUpdate</link> and <link id="TCustomGrid.EndUpdate">EndUpdate</link> to speed up the application. </p>
<p>Component developers must override the <link id="TCustomGrid.DrawCell">DrawCell</link> method in customized grids.</p>
</descr>
<seealso>
<link id="TStringGrid"/>
<link id="TDrawGrid"/>
@ -2940,10 +2936,12 @@ The purpose of this method is to call event handler <i>OnBeforeSelection</i>.</d
<!-- function Visibility: protected -->
<element name="TCustomGrid.SelectCell">
<short>Is called if a grid cell is highlighted.</short>
<descr><p>The SelectCell method is called if a grid cell will be highlighted.</p>
<p>The <i>aCol</i> and <i>aRow</i> parameters contain the column and the row of the highlighted cell. </p>
<p>Component developers may use the <i>SelectCell</i> method to react on focus changes. The <i>Result</i> is true if the cell is allowed to be selected.
Application developers should use the <link id="TCustomGrid.SelectCell.OnSelectCell">OnSelectCell</link> event instead.</p></descr>
<descr>
<p>The SelectCell method is called if a grid cell will be highlighted.</p>
<p>The <i>aCol</i> and <i>aRow</i> parameters contain the column and the row of the highlighted cell. </p>
<p>Component developers may use the <i>SelectCell</i> method to react on focus changes. The <i>Result</i> is true if the cell is allowed to be selected.
Application developers should use the <link id="TCustomGrid.SelectCell.OnSelectCell">OnSelectCell</link> event instead.</p>
</descr>
</element>
<!-- function result Visibility: default -->
<element name="TCustomGrid.SelectCell.Result"><short/></element>
@ -3088,15 +3086,11 @@ Application developers should use the <link id="TCustomGrid.SelectCell.OnSelectC
<element name="TCustomGrid.WndProc.TheMessage"><short/></element>
<!-- property Visibility: protected -->
<element name="TCustomGrid.AutoAdvance">
<short/>
<descr/>
<seealso/>
<short>Automatically advance down the grid on successive mouse clicks</short>
</element>
<!-- property Visibility: protected -->
<element name="TCustomGrid.AutoFillColumns">
<short/>
<descr/>
<seealso/>
<short>Automatically fill columns with default values if nothing else specified</short>
</element>
<!-- property Visibility: protected -->
<element name="TCustomGrid.BorderStyle">
@ -3122,10 +3116,12 @@ Application developers should use the <link id="TCustomGrid.SelectCell.OnSelectC
<!-- property Visibility: protected -->
<element name="TCustomGrid.ColWidths">
<short>Column widths for the grid.</short>
<descr><p>The column is specified with the <i>aCol</i> parameter. The <i>aCol</i> parameter must fall within the valid index range of 0 to <link id="TCustomGrid.ColWidths.ColCoun">ColCount</link>-1. </p>
<p>The return value of the property is the width of this column, measured in pixels. </p>
<p>The initial width of a newly created column is specified with the <link id="TCustomGrid.ColWidths.DefaultColWidth">DefaultColWidth</link> property. After that the user may redefine this value. </p>
<p>If the <link id="TCustomGrid.ColWidths.Options">Options</link> property includes the appropriate value, the column width may also be changed by the user at runtime.</p></descr>
<descr>
<p>The column is specified with the <i>aCol</i> parameter. The <i>aCol</i> parameter must fall within the valid index range of 0 to <link id="TCustomGrid.ColWidths.ColCoun">ColCount</link>-1. </p>
<p>The return value of the property is the width of this column, measured in pixels. </p>
<p>The initial width of a newly created column is specified with the <link id="TCustomGrid.ColWidths.DefaultColWidth">DefaultColWidth</link> property. After that the user may redefine this value. </p>
<p>If the <link id="TCustomGrid.ColWidths.Options">Options</link> property includes the appropriate value, the column width may also be changed by the user at runtime.</p>
</descr>
<seealso><link id="TCustomGrid.RowHeights"/></seealso>
</element>
<!-- argument Visibility: default -->
@ -3133,15 +3129,19 @@ Application developers should use the <link id="TCustomGrid.SelectCell.OnSelectC
<!-- property Visibility: protected -->
<element name="TCustomGrid.DefaultColWidth">
<short>Default value for the width of newly created grid columns.</short>
<descr><p>If new columns of the grid are created by changing the <link id="TCustomGrid.DefaultColWidth.ColCount">ColCount</link> property, the width of these new columns will be set to the value of the <i>DefaultColWidth</i> property. </p>
<p>After that the user may redefine this value. If the <link id="TCustomGrid.DefaultColWidth.Options">Options</link> property includes the appropriate value, the column width may also be changed by the user at runtime.</p></descr>
<descr>
<p>If new columns of the grid are created by changing the <link id="TCustomGrid.DefaultColWidth.ColCount">ColCount</link> property, the width of these new columns will be set to the value of the <i>DefaultColWidth</i> property. </p>
<p>After that the user may redefine this value. If the <link id="TCustomGrid.DefaultColWidth.Options">Options</link> property includes the appropriate value, the column width may also be changed by the user at runtime.</p>
</descr>
<seealso><link id="TCustomGrid.DefaultRowHeight"/></seealso>
</element>
<!-- property Visibility: protected -->
<element name="TCustomGrid.DefaultRowHeight">
<short>Default value for the height of newly created grid rows.</short>
<descr><p>If new rows of the grid are created by changing the <link id="TCustomGrid.DefaultRowHeight.RowCount">RowCount</link> property, the height of these new rows will be set to the value of the <i>DefaultRowHeight</i> property. </p>
<p>After that the user may redefine this value. If the <link id="TCustomGrid.DefaultRowHeight.Options">Options</link> property includes the appropriate value, the row height may also be changed by the user at runtime.</p></descr>
<descr>
<p>If new rows of the grid are created by changing the <link id="TCustomGrid.DefaultRowHeight.RowCount">RowCount</link> property, the height of these new rows will be set to the value of the <i>DefaultRowHeight</i> property. </p>
<p>After that the user may redefine this value. If the <link id="TCustomGrid.DefaultRowHeight.Options">Options</link> property includes the appropriate value, the row height may also be changed by the user at runtime.</p>
</descr>
<seealso><link id="TCustomGrid.DefaultColWidth"/></seealso>
</element>
<!-- property Visibility: protected -->
@ -3152,9 +3152,7 @@ Application developers should use the <link id="TCustomGrid.SelectCell.OnSelectC
</element>
<!-- property Visibility: protected -->
<element name="TCustomGrid.DefaultTextStyle">
<short/>
<descr/>
<seealso/>
<short>Default style for displaying text - includes alignment, layout, single or multi-lines</short>
</element>
<!-- property Visibility: protected -->
<element name="TCustomGrid.DragDx">
@ -3170,9 +3168,7 @@ Application developers should use the <link id="TCustomGrid.SelectCell.OnSelectC
</element>
<!-- property Visibility: protected -->
<element name="TCustomGrid.EditorMode">
<short/>
<descr/>
<seealso/>
<short>Is grid ready to accept edits (EditorMode True)</short>
</element>
<!-- property Visibility: protected -->
<element name="TCustomGrid.EditorKey">
@ -3189,8 +3185,10 @@ Application developers should use the <link id="TCustomGrid.SelectCell.OnSelectC
<!-- property Visibility: protected -->
<element name="TCustomGrid.FixedCols">
<short>Number of the fixed columns of the grid.</short>
<descr><p>Contains the fixed column count of a grid. </p>
<p>Fixed columns are normally used for headings.</p></descr>
<descr>
<p>Contains the fixed column count of a grid. </p>
<p>Fixed columns are normally used for headings.</p>
</descr>
<seealso>
<link id="TCustomGrid.FixedRows"/>
<link id="TCustomGrid.ColCount"/>
@ -3199,8 +3197,10 @@ Application developers should use the <link id="TCustomGrid.SelectCell.OnSelectC
<!-- property Visibility: protected -->
<element name="TCustomGrid.FixedRows">
<short>Number of the fixed rows of the grid.</short>
<descr><p>Contains the fixed row count of a grid. </p>
<p>Fixed rows are normally used for headings.</p></descr>
<descr>
<p>Contains the fixed row count of a grid. </p>
<p>Fixed rows are normally used for headings.</p>
</descr>
<seealso>
<link id="TCustomGrid.RowCount"/>
<link id="TCustomGrid.FixedCols"/>
@ -3247,27 +3247,19 @@ Application developers should use the <link id="TCustomGrid.SelectCell.OnSelectC
</element>
<!-- property Visibility: protected -->
<element name="TCustomGrid.GridLineColor">
<short/>
<descr/>
<seealso/>
<short>Colour to be used for GridLines</short>
</element>
<!-- property Visibility: protected -->
<element name="TCustomGrid.GridLineStyle">
<short/>
<descr/>
<seealso/>
<short>Style to be used for GridLines</short>
</element>
<!-- property Visibility: protected -->
<element name="TCustomGrid.GridLineWidth">
<short/>
<descr/>
<seealso/>
<short>Width (thickness) of GridLines</short>
</element>
<!-- property Visibility: protected -->
<element name="TCustomGrid.GridWidth">
<short/>
<descr/>
<seealso/>
<short>Width of the whole Grid</short>
</element>
<!-- property Visibility: protected -->
<element name="TCustomGrid.LeftCol">
@ -3300,9 +3292,11 @@ Application developers should use the <link id="TCustomGrid.SelectCell.OnSelectC
<!-- property Visibility: protected -->
<element name="TCustomGrid.RowHeights">
<short>The row heights for the grid.</short>
<descr><p>The row is specified with the <i>aRow</i> parameter. The <i>aRow</i> parameter must fall within the valid index range of 0 to <link id="TCustomGrid.RowHeights.RowCount">RowCount</link>-1.</p>
<p>The return value of the property is the height of this row, measured in pixels.</p>
<p>The initial height of a newly created row is specified with the <link id="TCustomGrid.RowHeights.DefaultRowHeight">DefaultRowHeight</link> property. After that the user may redefine this value. If the <link id="TCustomGrid.RowHeights.Options">Options</link> property includes the appropriate value, the row height may also be changed by the user at runtime.</p></descr>
<descr>
<p>The row is specified with the <i>aRow</i> parameter. The <i>aRow</i> parameter must fall within the valid index range of 0 to <link id="TCustomGrid.RowHeights.RowCount">RowCount</link>-1.</p>
<p>The return value of the property is the height of this row, measured in pixels.</p>
<p>The initial height of a newly created row is specified with the <link id="TCustomGrid.RowHeights.DefaultRowHeight">DefaultRowHeight</link> property. After that the user may redefine this value. If the <link id="TCustomGrid.RowHeights.Options">Options</link> property includes the appropriate value, the row height may also be changed by the user at runtime.</p>
</descr>
<seealso><link id="TCustomGrid.ColWidths"/></seealso>
</element>
<!-- argument Visibility: default -->
@ -3321,9 +3315,7 @@ Application developers should use the <link id="TCustomGrid.SelectCell.OnSelectC
</element>
<!-- property Visibility: protected -->
<element name="TCustomGrid.SelectedColor">
<short/>
<descr/>
<seealso/>
<short>Colour to be used for selected cells</short>
</element>
<!-- property Visibility: protected -->
<element name="TCustomGrid.Selection">
@ -3333,9 +3325,7 @@ Application developers should use the <link id="TCustomGrid.SelectCell.OnSelectC
</element>
<!-- property Visibility: protected -->
<element name="TCustomGrid.ScrollBars">
<short/>
<descr/>
<seealso/>
<short>The ScrollBars to be used with this grid</short>
</element>
<!-- property Visibility: protected -->
<element name="TCustomGrid.TopRow">
@ -3451,9 +3441,10 @@ Application developers may use the OnSelection and OnBeforeSelection events to r
<!-- procedure Visibility: public -->
<element name="TCustomGrid.Clear">
<short>clear all cells from the grid.</short>
<descr><p>Reset Column and Row counts to 0. Grid is completely emptied.</p>
<p>Compatibility: This property applies to Lazarus grids only , under Delphi/Kylix a grid can't be completly emptied.</p></descr>
<descr>
<p>Reset Column and Row counts to 0. Grid is completely emptied.</p>
<p>Compatibility: This property applies to Lazarus grids only , under Delphi/Kylix a grid can't be completly emptied.</p>
</descr>
</element>
<!-- procedure Visibility: public -->
<element name="TCustomGrid.DeleteColRow">

1
docs/xml/lcl/stdctrls.xml
View File

@ -6006,6 +6006,7 @@ Indicates how text is displayed in a text editing control.</p>
</element>
<!-- property Visibility: public -->
<element name="TCustomCheckBox.TabStop">
<short>Is the control in the sequence of controls accessed by successive presses of the Tab key?</short>
<descr>Use the TabStop to allow or disallow access to the control using the Tab key.
If the TabStop is True, the control is in the tab order. If TabStop is False, the control is not in the tab order and the user can't press the Tab key to move to the control.</descr>