mirror of
https://gitlab.com/freepascal.org/lazarus/lazarus.git
synced 2025-04-29 06:24:02 +02:00
14181 lines
549 KiB
XML
14181 lines
549 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<fpdoc-descriptions>
|
|
<package name="lcl">
|
|
<!--
|
|
====================================================================
|
|
Grids
|
|
====================================================================
|
|
-->
|
|
<module name="Grids">
|
|
<short>
|
|
Classes for displaying tabular data as a series of rows and columns
|
|
</short>
|
|
<descr></descr>
|
|
|
|
<!-- unresolved type reference Visibility: default -->
|
|
<element name="Classes"/>
|
|
<element name="SysUtils"/>
|
|
<element name="Types"/>
|
|
<element name="TypInfo"/>
|
|
<element name="Math"/>
|
|
<element name="FPCanvas"/>
|
|
<element name="HtmlDefs"/>
|
|
<element name="LCLStrConsts"/>
|
|
<element name="LCLType"/>
|
|
<element name="LCLIntf"/>
|
|
<element name="Controls"/>
|
|
<element name="Graphics"/>
|
|
<element name="Forms"/>
|
|
<element name="LMessages"/>
|
|
<element name="StdCtrls"/>
|
|
<element name="LResources"/>
|
|
<element name="MaskEdit"/>
|
|
<element name="Buttons"/>
|
|
<element name="Clipbrd"/>
|
|
<element name="Themes"/>
|
|
<element name="ImgList"/>
|
|
<element name="LazFileUtils"/>
|
|
<element name="DynamicArray"/>
|
|
<element name="Maps"/>
|
|
<element name="LazUTF8"/>
|
|
<element name="LazUtf8Classes"/>
|
|
<element name="Laz2_XMLCfg"/>
|
|
<element name="LazLoggerBase"/>
|
|
<element name="LazUtilities"/>
|
|
<element name="LCSVUtils"/>
|
|
<element name="IntegerList"/>
|
|
<element name="Messages"/>
|
|
|
|
<element name="GRIDFILEVERSION">
|
|
<short>Current revision level for the <file>grids.pas</file> file</short>
|
|
<descr>
|
|
<dl>
|
|
<dt>1</dt>
|
|
<dd>Initial revision</dd>
|
|
<dt>2</dt>
|
|
<dd>Introduced goSmoothScroll grid option</dd>
|
|
<dt>3</dt>
|
|
<dd>Introduced Col/Row FixedAttr and NormalAttr</dd>
|
|
</dl>
|
|
</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- constant Visibility: default -->
|
|
<element name="GM_SETVALUE">
|
|
<short>Lazarus message for setting the value in a grid edit control</short>
|
|
</element>
|
|
|
|
<!-- constant Visibility: default -->
|
|
<element name="GM_GETVALUE">
|
|
<short>Lazarus message for getting the value in a grid edit control</short>
|
|
</element>
|
|
|
|
<!-- constant Visibility: default -->
|
|
<element name="GM_SETGRID">
|
|
<short>Lazarus message for setting the grid for an edit control</short>
|
|
</element>
|
|
|
|
<element name="GM_SETBOUNDS">
|
|
<short>Lazarus message for setting the bounds for a grid edit control</short>
|
|
</element>
|
|
|
|
<!-- constant Visibility: default -->
|
|
<element name="GM_SELECTALL">
|
|
<short>Lazarus message for selecting the content in a grid edit control</short>
|
|
</element>
|
|
|
|
<!-- constant Visibility: default -->
|
|
<element name="GM_SETMASK">
|
|
<short>Lazarus message for setting the edit mask used in a grid edit control</short>
|
|
</element>
|
|
|
|
<!-- constant Visibility: default -->
|
|
<element name="GM_SETPOS">
|
|
<short>Lazarus message for setting the position of a grid edit control</short>
|
|
</element>
|
|
|
|
<element name="GM_READY">
|
|
<short>Lazarus message sent when the grid can display its editing controls</short>
|
|
</element>
|
|
|
|
<element name="GM_GETGRID">
|
|
<short>Lazarus message used to get the grid for an editing control</short>
|
|
</element>
|
|
|
|
<!-- constant Visibility: default -->
|
|
<element name="EO_AUTOSIZE">
|
|
<short>Represents the auto-size editor option in a grid message</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- constant Visibility: default -->
|
|
<element name="EO_HOOKKEYDOWN">
|
|
<short>Represnts the hook key down editor option in a grid message</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- constant Visibility: default -->
|
|
<element name="EO_HOOKKEYPRESS">
|
|
<short>Represents the hook key press editor option in a grid message</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- constant Visibility: default -->
|
|
<element name="EO_HOOKKEYUP">
|
|
<short>Represents the hook key up editor option in a grid message</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- constant Visibility: default -->
|
|
<element name="EO_SELECTALL">
|
|
<short>Represents the select all content editor option in a grid message</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- constant Visibility: default -->
|
|
<element name="EO_IMPLEMENTED">
|
|
<short>Represents the implemented editor option in a grid message</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="DEFCOLWIDTH">
|
|
<short>Default width for columns in a grid control</short>
|
|
<descr>
|
|
<p>
|
|
<var>DEFCOLWIDTH</var> is a constant used as the default width for columns in a grid control. The value for the constant is <b>64</b> (pixels). DEFCOLWIDTH is used when getting the value for the <var>DefColWidth</var> in <var>TCustomGrid</var>.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.DefaultColWidth"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<element name="DEFBUTTONWIDTH">
|
|
<short>Default width for edit control buttons in a grid</short>
|
|
<descr>
|
|
<p>
|
|
<var>DEFBUTTONWIDTH</var> is a constant that contains the default width for the button displayed in a grid cell editor. The value for the constant is <b>25</b> (pixels). DEFBUTTONWIDTH is used when setting the bounds for <var>TButtonCellEditor</var> controls.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TButtonCellEditor"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<element name="DEFIMAGEPADDING">
|
|
<short>Default padding used for title images displayed in a grid</short>
|
|
<descr>
|
|
<p>
|
|
<var>DEFIMAGEPADDING</var> is a constant which contains the padding added to images displayed in the fixed title area for grid controls. The value for the constant is <b>2</b> (pixels). DEFIMAGEPADDING is used in methods like <var>TCustomGrid.DrawColumnTitleImage</var> and <var>TCustomStringGrid.AutoAdjustColumn</var>.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.DrawColumnTitleImage"/>
|
|
<link id="TCustomStringGrid.AutoAdjustColumn"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- object Visibility: default -->
|
|
<element name="EGridException">
|
|
<short>
|
|
Exception raised for an error occurring in a Grid class
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
Used mainly when a row or a column position is invalid for a grid control.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- enumeration type Visibility: default -->
|
|
<element name="TGridOption">
|
|
<short>Represents grip option values available for grid controls</short>
|
|
<descr>
|
|
<p>
|
|
<var>TGridOption</var> is an enumerated type with values that represent grid options available in LCL grid controls. Values from TGridOption are stored in a <var>TGridOptions</var> set type to indicate that the grid feature or behavior is enabled.
|
|
</p>
|
|
<p>
|
|
Values from TGridOption are stored in the <var>DefaultGridOptions</var> constant which defines the default set of options for LCL grid controls.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TGridOptions"/>
|
|
<link id="TGridOptions2"/>
|
|
<link id="DefaultGridOptions"/>
|
|
<link id="TCustomGrid.Options"/>
|
|
<link id="TCustomGrid.Options2"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TGridOption.goFixedVertLine">
|
|
<short>Shows vertical lines around fixed cells</short>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TGridOption.goFixedHorzLine">
|
|
<short>Shows horizontal lines around fixed cells</short>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TGridOption.goVertLine">
|
|
<short>Show vertical lines</short>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TGridOption.goHorzLine">
|
|
<short>Show horizontal lines</short>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TGridOption.goRangeSelect">
|
|
<short>Enables range selection for grid cells</short>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TGridOption.goDrawFocusSelected">
|
|
<short>Enables focused drawing for selected cell(s)</short>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TGridOption.goRowSizing">
|
|
<short>Allow user to change row height</short>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TGridOption.goColSizing">
|
|
<short>Allow user to change column width</short>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TGridOption.goRowMoving">
|
|
<short>Enables moving the position of an entire row in a grid</short>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TGridOption.goColMoving">
|
|
<short>Enables moving the position of an entire column in a grid</short>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TGridOption.goEditing">
|
|
<short>Allows editing in grid cells</short>
|
|
<seealso>
|
|
<link id="TGridOption.goAlwaysShowEditor"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<element name="TGridOption.goAutoAddRows">
|
|
<short>Automatically add new rows</short>
|
|
<descr>
|
|
Does not add rows if the last cell is empty and
|
|
<link id="TGridOption.goAutoAddRowsSkipContentCheck">goAutoAddRowsSkipContentCheck</link> is not set.
|
|
</descr>
|
|
<seealso>
|
|
<link id="TGridOption.goAutoAddRowsSkipContentCheck"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TGridOption.goTabs">
|
|
<short>Controls Tab key behavior in the grid</short>
|
|
<descr>
|
|
<p>
|
|
When included in the <var>TCustomGrid.Options</var> property, the <b>Tab</b> key changes the active cell within the grid. When omitted from the grid <var>Options</var>, the <b>Tab</b> key changes to the next active control.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.Options"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TGridOption.goRowSelect">
|
|
<short>Select the whole row instead of only one cell</short>
|
|
</element>
|
|
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TGridOption.goAlwaysShowEditor">
|
|
<short>Always shows the cell editor</short>
|
|
<descr>
|
|
<p>
|
|
Always shows the cell editor. If not set, the user has to enter edit mode by data characters for the cell, or by pressing the <b>F2</b> key.
|
|
</p>
|
|
</descr>
|
|
</element>
|
|
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TGridOption.goThumbTracking">
|
|
<short>Enables tracking of the thumb position in grid scroll bars</short>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TGridOption.goColSpanning">
|
|
<short>Enable cellextent calculations</short>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TGridOption.goRelaxedRowSelect">
|
|
<short>User can see focused cell on goRowSelect</short>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TGridOption.goDblClickAutoSize">
|
|
<short>Double clicking column's borders (on headers) resize column</short>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TGridOption.goSmoothScroll">
|
|
<short>Switch scrolling mode</short>
|
|
<descr>Default is pixel scroll.</descr>
|
|
</element>
|
|
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TGridOption.goFixedRowNumbering">
|
|
<short>Show row numbers in first fixed column</short>
|
|
<descr>
|
|
<p>
|
|
The displayed row numbers starts with 1. The row number is displayed when no text has been directly assigned to the fixed cell.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.FixedCols"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<element name="TGridOption.goScrollKeepVisible">
|
|
<short>Keeps focused cell visible while scrolling</short>
|
|
</element>
|
|
|
|
<element name="TGridOption.goHeaderHotTracking">
|
|
<short>Header cells change look when mouse is over them</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TGridOption.goHeaderPushedLook">
|
|
<short>Header cells looks pushed when clicked</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TGridOption.goSelectionActive">
|
|
<short>Setting grid selection also moves the cell cursor</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TGridOption.goFixedColSizing">
|
|
<short>Allow to resize fixed columns</short>
|
|
<seealso>
|
|
<link id="TGridOption.goColSizing"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<element name="TGridOption.goDontScrollPartCell">
|
|
<short>Selecting a partially visible cell will not scroll the grid content</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TGridOption.goCellHints">
|
|
<short>Show individual cell hints</short>
|
|
<descr>
|
|
Requires the <link id="TControl.ShowHint">ShowHint</link> to be set to <var>TRUE</var>. If set, the <link id="TControl.Hint">Hint</link> will be ignored. Instead the <link id="TCustomGrid.OnGetCellHint">OnGetCellHint</link> event will be called for each cell.
|
|
</descr>
|
|
<seealso>
|
|
<link id="TControl.Hint"/>
|
|
<link id="TControl.ShowHint"/>
|
|
<link id="TCustomGrid.OnGetCellHint"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<element name="TGridOption.goTruncCellHints">
|
|
<short>Truncates cell hints when they are longer than the cell content</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TGridOption.goCellEllipsis">
|
|
<short>Shows an Ellipsis (...) at the end of truncated cell hints</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TGridOption.goAutoAddRowsSkipContentCheck">
|
|
<short>Also add a row if last row is empty</short>
|
|
<seealso>
|
|
<link id="TGridOption.goAutoAddRows"/>
|
|
</seealso>
|
|
<descr>
|
|
<link id="TGridOption.goAutoAddRows">goAutoAddRows</link> must also be set. Otherwise this option does not take effect at all.
|
|
</descr>
|
|
</element>
|
|
|
|
<element name="TGridOption.goRowHighlight">
|
|
<short>Highlights the current Row in a grid control</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- set type Visibility: default -->
|
|
<element name="TGridOptions">
|
|
<short>Set type used to store enabled grid options</short>
|
|
<descr>
|
|
<p>
|
|
<var>TGridOptions</var> is a set type used to store values from the <var>TGridOption</var> enumeration. The features or behaviors in TGridOption are enabled when their enumeration values are included in the set. TGridOptions is the type used for the <var>TCustomGrid.Options</var> property.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.Options"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<element name="TGridOption2">
|
|
<short></short>
|
|
<descr>
|
|
</descr>
|
|
<seealso>
|
|
</seealso>
|
|
</element>
|
|
|
|
<element name="TGridOption2.goScrollToLastCol">
|
|
<short>Allows scrolling to last column (so that last column can be leftcol)</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TGridOption2.goScrollToLastRow">
|
|
<short>Allows scrolling to last row (so that last row can be toprow)</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TGridOptions2">
|
|
<short>Set type used to store enabled grid options from TGridOption2</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- enumeration type Visibility: default -->
|
|
<element name="TGridSaveOptions">
|
|
<short>Represents save options available for LCL grid controls</short>
|
|
<descr>
|
|
</descr>
|
|
<seealso>
|
|
</seealso>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TGridSaveOptions.soDesign">
|
|
<short>Enables saving grid structure (col/row count and Options)</short>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TGridSaveOptions.soAttributes">
|
|
<short>Enables saving grid attributes (Font, Brush, TextStyle)</short>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TGridSaveOptions.soContent">
|
|
<short>Enables saving Grid content (Text in TStringGrid)</short>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TGridSaveOptions.soPosition">
|
|
<short>Enables saving the Grid cursor and selection position</short>
|
|
</element>
|
|
|
|
<!-- set type Visibility: default -->
|
|
<element name="TSaveOptions">
|
|
<short>Set type used to store TGridSaveOptions values</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- set type Visibility: default -->
|
|
<element name="TGridDrawState">
|
|
<short>Enumeration with Grid draw state values</short>
|
|
<descr>
|
|
<p>
|
|
<var>TGridDrawState</var> is an enumeration with values that represent grid drawing states for a grid control. Values in TGridDrawState indicate the display attributes applied to a row, column, or individual cell in a grid control.
|
|
</p>
|
|
<p>
|
|
TGridDrawState arguments are passed to event handlers and methods in <var>TCustomGrid</var>.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TOnDrawCell"/>
|
|
<link id="TOnPrepareCanvasEvent"/>
|
|
<link id="TCustomGrid.DrawCell"/>
|
|
<link id="TCustomGrid.DrawCellGrid"/>
|
|
<link id="TCustomGrid.DrawCellText"/>
|
|
<link id="TCustomGrid.DrawButtonCell"/>
|
|
<link id="TCustomGrid.DrawColumnText"/>
|
|
<link id="TCustomGrid.DrawTextInCell"/>
|
|
<link id="TCustomGrid.DrawThemedCell"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TGridDrawState.gdSelected">
|
|
<short>Drawn in its Selected state</short>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TGridDrawState.gdFocused">
|
|
<short>Drawn in its Focused state</short>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TGridDrawState.gdFixed">
|
|
<short>Drawn using the Fixed cell colors</short>
|
|
</element>
|
|
<element name="TGridDrawState.gdHot">
|
|
<short>Drawn using the Hot display attributes</short>
|
|
</element>
|
|
<element name="TGridDrawState.gdPushed">
|
|
<short>Drawn in a Pushed state</short>
|
|
</element>
|
|
<element name="TGridDrawState.gdRowHighlight">
|
|
<short>Drawn using the row highlighting color</short>
|
|
</element>
|
|
|
|
<!-- enumeration type Visibility: default -->
|
|
<element name="TGridState">
|
|
<short>Enumerated type with grid state values</short>
|
|
<descr>
|
|
<p>
|
|
<var>TGridState</var> is an enumerated type with values that reflect the state in a grid control. TGridState values represent actions performed using a grid control, rather the display state for rows, columns, and/or cells.
|
|
</p>
|
|
<p>
|
|
TCustomGrid maintains an internal TGridState member used to track the state for the grid control. Methods in TCustomGrid cause the value in the member to be read or updated to reflect the request and/or completion of an action in the grid control.
|
|
</p>
|
|
<p>
|
|
Use the TCustomGrid.Options and TCustomGrid.Options2 properties to determine if specific features or behaviors are enabled for a grid control.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid"/>
|
|
<link id="TCustomGrid.Options"/>
|
|
<link id="TCustomGrid.Options2"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TGridState.gsNormal">
|
|
<short>Normal state for the grid when navigation or editing can be performed</short>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TGridState.gsSelecting">
|
|
<short>
|
|
Grid is selecting a row, column, or cell after keyboard or mouse activity
|
|
</short>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TGridState.gsRowSizing">
|
|
<short>Grid is resizing a row</short>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TGridState.gsColSizing">
|
|
<short>Grid is resizing a column</short>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TGridState.gsRowMoving">
|
|
<short>Grid is moving or dragging a row</short>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TGridState.gsColMoving">
|
|
<short>Grid is moving or dragging a column</short>
|
|
</element>
|
|
|
|
<element name="TGridState.gsHeaderClicking">
|
|
<short>A fixed header cell has been clicked in the Grid</short>
|
|
</element>
|
|
<element name="TGridState.gsButtonColumnClicking">
|
|
<short>A button in a column has been clicked</short>
|
|
</element>
|
|
|
|
<!-- enumeration type Visibility: default -->
|
|
<element name="TGridZone">
|
|
<short>Enumerated type for grid zone values</short>
|
|
<descr>
|
|
<p>
|
|
<var>TGridZone</var> is an enumeration type with values representing zones in a grid control which are monitored to determine activity and subsequent changes in the grid control state.
|
|
</p>
|
|
</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TGridZone.gzNormal">
|
|
<short></short>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TGridZone.gzFixedCols">
|
|
<short></short>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TGridZone.gzFixedRows">
|
|
<short></short>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TGridZone.gzFixedCells">
|
|
<short></short>
|
|
</element>
|
|
<element name="TGridZone.gzInvalid">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TGridZoneSet">
|
|
<short>Set type used to store TGridZone enumeration values</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- enumeration type Visibility: default -->
|
|
<element name="TAutoAdvance">
|
|
<short>Enumerated type with values controlling grid auto advance behavior</short>
|
|
<descr>
|
|
<p>
|
|
<var>TAutoAdvance</var> is an enumerated type with values that represent the auto advance behaviors available in a grid control. TAutoAdvance is the type used to represent the <var>AutoAdvance</var> and <var>TabAdvance</var> properties in <var>TCustomGrid</var>.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.AutoAdvance"/>
|
|
<link id="TCustomGrid.TabAdvance"/>
|
|
<link id="TCustomGrid.MoveNextSelectable"/>
|
|
<link id="TCustomGrid.MouseDown"/>
|
|
<link id="TCustomGrid.KeyDown"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TAutoAdvance.aaNone">
|
|
<short>Auto advance is not enabled</short>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TAutoAdvance.aaDown">
|
|
<short>Advances down to the next row in the grid</short>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TAutoAdvance.aaRight">
|
|
<short>Advances to the right (next cell) in the grid</short>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TAutoAdvance.aaLeft">
|
|
<short>Advances to the left (previous cell) in the grid</short>
|
|
</element>
|
|
|
|
<element name="TAutoAdvance.aaRightDown">
|
|
<short>Advances to the right and then to the next row</short>
|
|
</element>
|
|
<element name="TAutoAdvance.aaLeftDown">
|
|
<short>Advances to the left and then to the next row</short>
|
|
</element>
|
|
<element name="TAutoAdvance.aaRightUp">
|
|
<short>Advances to the right and then to the previous row</short>
|
|
</element>
|
|
<element name="TAutoAdvance.aaLeftUp">
|
|
<short>Advances to the left and then to the previous row</short>
|
|
</element>
|
|
|
|
<element name="TRangeSelectMode">
|
|
<short>Range selection modes available in a grid control</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TRangeSelectMode.rsmSingle">
|
|
<short>Allows range selection for a single range in a grid</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TRangeSelectMode.rsmMulti">
|
|
<short>Allows range selection for multiple ranges in a grid</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- enumeration type Visibility: default -->
|
|
<element name="TItemType">
|
|
<short></short>
|
|
<descr>
|
|
Not used in the current implementation.
|
|
</descr>
|
|
<notes>
|
|
<note>Not used in the current implementation.</note>
|
|
</notes>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TItemType.itNormal">
|
|
<short></short>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TItemType.itCell">
|
|
<short></short>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TItemType.itColumn">
|
|
<short></short>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TItemType.itRow">
|
|
<short></short>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TItemType.itFixed">
|
|
<short></short>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TItemType.itFixedColumn">
|
|
<short></short>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TItemType.itFixedRow">
|
|
<short></short>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TItemType.itSelected">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TColumnButtonStyle">
|
|
<short>Enumerated type with cell editor types available in a grid control</short>
|
|
<descr>
|
|
<p>
|
|
<var>TColumnButtonStyle</var> is an enumerated type with values that represent the different cell editor types available in a grid control. TColumnButtonStyle is the type used for the <var>TGridColumn.ButtonStyle</var> property, and passed as an argument when an editor is requested for a column definition. It is also used when the <var>TCustomGrid.GetDefaultEditor</var> method is called to get the default cell editor for a given column.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TGridColumn.ButtonStyle"/>
|
|
<link id="TCustomGrid.GetDefaultEditor"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<element name="TColumnButtonStyle.cbsAuto">
|
|
<short>
|
|
Button style is automatically determined by the grid control. Results in a TStringCellEditor being used for the cell.
|
|
</short>
|
|
</element>
|
|
<element name="TColumnButtonStyle.cbsEllipsis">
|
|
<short>
|
|
Button style with an Ellipsis (<b>...</b>) is displayed as the cell editor. Results in a TCompositeCellEditor being used for the cell.
|
|
</short>
|
|
</element>
|
|
<element name="TColumnButtonStyle.cbsNone">
|
|
<short>Indicates no editor is required for a cell.</short>
|
|
</element>
|
|
<element name="TColumnButtonStyle.cbsPickList">
|
|
<short>
|
|
Indicates a Pick List is used as the cell editor. Results in a TPickListCellEditor being used for the cell.
|
|
</short>
|
|
</element>
|
|
<element name="TColumnButtonStyle.cbsCheckboxColumn">
|
|
<short>Indicates a CheckBox is displayed as the editor for the grid column.</short>
|
|
</element>
|
|
<element name="TColumnButtonStyle.cbsButton">
|
|
<short>Indicates a cell editor with a Button is used as the cell editor. Results in a TButtonCellEditor being used.</short>
|
|
</element>
|
|
<element name="TColumnButtonStyle.cbsButtonColumn">
|
|
<short>Indicates a button centered in the cell is used as the cell editor.</short>
|
|
</element>
|
|
|
|
<!-- enumeration type Visibility: default -->
|
|
<element name="TTitleStyle">
|
|
<short>
|
|
Enumeration with values that control the display style for fixed title cells
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>TTitleStyle</var> is an enumerated type with values that determine the drawing style used for fixed title cells in a grid. TTitleStyle is the type used to implement the <var>TCustomGrid.TitleStyle</var> property, and used in the implementation of the <var>TCustomGrid.DrawCellGrid</var> method.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.TitleStyle"/>
|
|
<link id="TCustomGrid.DrawCellGrid"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TTitleStyle.tsLazarus">
|
|
<short>Titles are displayed using the Lazarus drawing style</short>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TTitleStyle.tsStandard">
|
|
<short>Titles are displayed using the standard drawing style (higher contrast)</short>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TTitleStyle.tsNative">
|
|
<short>Titles are displayed using the drawing style Native to the OS or platform</short>
|
|
</element>
|
|
|
|
<!-- enumeration type Visibility: default -->
|
|
<element name="TGridFlagsOption">
|
|
<short></short>
|
|
<descr>
|
|
<p>
|
|
<var>TGridFlagsOption</var> is an enumerated type with values which reflect temporal state changes in a grid control. Values from TGridFlagsOption are stored at run-time in the <var>TGridFlags</var> set type used for the <var>TCustomGrid.GridFlags</var> property.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.GridFlags"/>
|
|
<link id="TGridFlags"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TGridFlagsOption.gfEditorUpdateLock">
|
|
<short>Indicates a cell is locked during a cell editor update</short>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TGridFlagsOption.gfNeedsSelectActive">
|
|
<short>
|
|
Indicates a selection needs to be active prior to mouse down or move actions
|
|
</short>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TGridFlagsOption.gfEditorTab">
|
|
<short>Indicates a Tab key can be applied to focus the next cell in the grid</short>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TGridFlagsOption.gfRevEditorTab">
|
|
<short>
|
|
Indicates a Shift+Tab key combination can be applied to select the previous cell in the grid
|
|
</short>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TGridFlagsOption.gfVisualChange">
|
|
<short>
|
|
Indicates visible changes to row or column sizes can be applied to the grid
|
|
</short>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TGridFlagsOption.gfColumnsLocked">
|
|
<short>Indicates columns in the grid are locked and cannot be reordered</short>
|
|
</element>
|
|
<element name="TGridFlagsOption.gfEditingDone">
|
|
<short>Indicates editing using a cell editor has been completed</short>
|
|
</element>
|
|
<element name="TGridFlagsOption.gfSizingStarted">
|
|
<short>Indicates a row or column sizing action is in effect</short>
|
|
</element>
|
|
<element name="TGridFlagsOption.gfPainting">
|
|
<short>Indicates the grid is being redrawn</short>
|
|
</element>
|
|
<element name="TGridFlagsOption.gfUpdatingSize">
|
|
<short>Indicates the grid is updating its size</short>
|
|
</element>
|
|
<element name="TGridFlagsOption.gfClientRectChange">
|
|
<short>Indicates the client rectangle for the grid has changed</short>
|
|
</element>
|
|
<element name="TGridFlagsOption.gfAutoEditPending">
|
|
<short>
|
|
Indicates a cell editor is being prepared for a newly selected cell in the grid
|
|
</short>
|
|
</element>
|
|
<element name="TGridFlagsOption.gfUpdatingScrollbar">
|
|
<short>Indicates the visibility of scrollbar(s) has been changed for a grid</short>
|
|
</element>
|
|
|
|
<!-- set type Visibility: default -->
|
|
<element name="TGridFlags">
|
|
<short>Set type used to store TGridFlagsOption enumeration values</short>
|
|
<descr>
|
|
<p>
|
|
<var>TGridFlags</var> is a set type used to store <var>TGridFlagsOption</var> enumeration values. TGridFlags is the type used to implement the <var>TCustomGrid.GridFlags</var> property.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TGridFlagsOption"/>
|
|
<link id="TCustomGrid.GridFlags"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- enumeration type Visibility: default -->
|
|
<element name="TSortOrder">
|
|
<short>Enumerated type with sort orders supported in a grid control</short>
|
|
<descr>
|
|
<p>
|
|
<var>TSortOrder</var> is an enumerated type with values for sort orders supported in a grid control. TSortOrder is the type used to implement the <var>TCustomGrid.SortOrder</var> property.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.SortOrder"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TSortOrder.soAscending">
|
|
<short>Rows are sorted such that the column is in ascending order</short>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TSortOrder.soDescending">
|
|
<short>Rows are sorted such that the column is in descending order</short>
|
|
</element>
|
|
|
|
<element name="TPrefixOption">
|
|
<short>Indicates if Accelerator keys if column titles are handled for a grid</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TPrefixOption.poNone">
|
|
<short>Accelerator keys are ignored in the grid</short>
|
|
</element>
|
|
<element name="TPrefixOption.poHeaderClick">
|
|
<short>Accelerator keys emulate a mouse click on the column title</short>
|
|
</element>
|
|
|
|
<element name="TMouseWheelOption">
|
|
<short>Enumerated type with values that control mouse wheel operation in a grid</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TMouseWheelOption.mwCursor">
|
|
<short>Causes the mouse wheel to move the cursor on the screen</short>
|
|
</element>
|
|
<element name="TMouseWheelOption.mwGrid">
|
|
<short>Causes the mouse wheel to scroll the content in the grid</short>
|
|
</element>
|
|
|
|
<element name="TCellHintPriority">
|
|
<short>Represents cell hint display priorities</short>
|
|
<descr>
|
|
<p>
|
|
A grid control can display three types of hint: the default hint (in the Hint property), individual cell hints (using the OnCellHint event), and hints for truncated cells. TCellHintPriority determines how the hint text is determined when multiple hint text values are displayed.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
</seealso>
|
|
</element>
|
|
<element name="TCellHintPriority.chpAll">
|
|
<short>
|
|
Uses all hints (both control and cell hints) including short and long display text values
|
|
</short>
|
|
</element>
|
|
<element name="TCellHintPriority.chpAllNoDefault">
|
|
<short>Uses all hints except the default hint for the grid control</short>
|
|
</element>
|
|
<element name="TCellHintPriority.chpTruncOnly">
|
|
<short>Uses the truncated cell hint text</short>
|
|
</element>
|
|
|
|
<element name="TCellProcessType">
|
|
<short>Identifies the action performed for cell content</short>
|
|
<descr>
|
|
TCellProcessType is an enumerated type with values that identify the action performed for the content in a grid cell. Values in the enumeration indicate whether cell content is copied or pasted in event handlers. TCellProcessType arguments are passed to the TCustomStringGrid.OnCellProcess event handler.
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCellProcessEvent"/>
|
|
<link id="TCustomStringGrid.OnCellProcess"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TCellProcessType.cpCopy">
|
|
<short>Copies the content in a grid cell</short>
|
|
</element>
|
|
<element name="TCellProcessType.cpPaste">
|
|
<short>Pastes content into the grid cell</short>
|
|
</element>
|
|
|
|
<!-- constant Visibility: default -->
|
|
<element name="soAll">
|
|
<short>All save options available in LCL grid controls</short>
|
|
<descr>
|
|
<p>
|
|
<var>soAll</var> is a <var>TSaveOptions</var> set type representing all of the TGridSaveOptions values available in a LCL grid control.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TGridSaveOptions"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<element name="DefaultGridOptions">
|
|
<short>Set with the default grid options enabled for LCL grid controls</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="DefaultGridOptions2">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- constant Visibility: default -->
|
|
<element name="constRubberSpace">
|
|
<short>Default spacing around rubberband rectangles</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="constCellPadding">
|
|
<short>Default padding for the content in grid cells</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="constColRowBorderTolerance">
|
|
<short>Minimum proximity to row or column borders for resizing operations</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- pointer type Visibility: default -->
|
|
<element name="PCellProps">
|
|
<short>Pointer to a TCellProps type</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- record type Visibility: default -->
|
|
<element name="TCellProps">
|
|
<short>Contains attributes, data, and text for grid cells</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- variable Visibility: default -->
|
|
<element name="TCellProps.Attr">
|
|
<short>Attributes for a grid cell</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- variable Visibility: default -->
|
|
<element name="TCellProps.Data">
|
|
<short>Data for a grid cell</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- variable Visibility: default -->
|
|
<element name="TCellProps.Text">
|
|
<short>Display text for a grid cell</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- pointer type Visibility: default -->
|
|
<element name="PColRowProps">
|
|
<short>Pointer to a TColRowProps type</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- record type Visibility: default -->
|
|
<element name="TColRowProps">
|
|
<short>Contains the size and attributes for a column or a row in a grid</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- variable Visibility: default -->
|
|
<element name="TColRowProps.Size">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- variable Visibility: default -->
|
|
<element name="TColRowProps.FixedAttr">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- variable Visibility: default -->
|
|
<element name="TColRowProps.NormalAttr">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- pointer type Visibility: default -->
|
|
<element name="PGridMessage">
|
|
<short>Pointer to a TGridMessage type</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- record type Visibility: default -->
|
|
<element name="TGridMessage">
|
|
<short>Contains a LCL message and its auxiliary values</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- variable Visibility: default -->
|
|
<element name="TGridMessage.LclMsg">
|
|
<short>The LCL message value</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- variable Visibility: default -->
|
|
<element name="TGridMessage.Grid">
|
|
<short>Grid for the LCL message</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- variable Visibility: default -->
|
|
<element name="TGridMessage.Col">
|
|
<short>Grid column for the LCL message</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- variable Visibility: default -->
|
|
<element name="TGridMessage.Row">
|
|
<short>Grid row for the LCL message</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- variable Visibility: default -->
|
|
<element name="TGridMessage.Value">
|
|
<short>Cell value for the LCL message</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- variable Visibility: default -->
|
|
<element name="TGridMessage.CellRect">
|
|
<short>Rectangle coordinates for the LCL message</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- variable Visibility: default -->
|
|
<element name="TGridMessage.Options">
|
|
<short>Options for the LCL message</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- object Visibility: default -->
|
|
<element name="TStringCellEditor">
|
|
<short>
|
|
Implements the default editor for cells in <var>TCustomGrid</var>
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>TStringCellEditor</var> is a <var>TCustomMaskEdit</var> descendant that implements the default editor for cells in <var>TCustomGrid</var>. TStringCellEditor contains internal members used to reference its Grid control, and to access the row and column numbers for the underlying grid cell. TStringCellEditor also implements methods needed for LCL message passing using <var>TGridMessage</var>. An event handler is also published to perform actions needed when editing has been completed in the cell editor.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid"/>
|
|
<link id="TGridMessage"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<element name="TStringCellEditor.FGrid"/>
|
|
<element name="TStringCellEditor.FCol"/>
|
|
<element name="TStringCellEditor.FRow"/>
|
|
|
|
<element name="TStringCellEditor.WndProc">
|
|
<short>Window handling procedure for the cell editor</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TStringCellEditor.WndProc.TheMessage">
|
|
<short>LCL message for the window handling procedure</short>
|
|
</element>
|
|
|
|
<element link="#LCL.StdCtrls.TCustomEdit.Change" name="TStringCellEditor.Change"/>
|
|
<element link="#LCL.Controls.TWinControl.KeyDown" name="TStringCellEditor.KeyDown"/>
|
|
<element name="TStringCellEditor.KeyDown.Key">
|
|
<short></short>
|
|
</element>
|
|
<element name="TStringCellEditor.KeyDown.Shift">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TStringCellEditor.msg_SetMask">
|
|
<short>
|
|
<var>msg_SetMask</var> - issues message for specifying mask</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TStringCellEditor.msg_SetMask.Msg">
|
|
<short>Message for the control</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TStringCellEditor.msg_SetValue">
|
|
<short>
|
|
<var>msg_SetValue</var> - issue message for specifying value</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TStringCellEditor.msg_SetValue.Msg">
|
|
<short>Message for the control</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TStringCellEditor.msg_GetValue">
|
|
<short>
|
|
<var>msg_GetValue</var> - issues message for obtaining value</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TStringCellEditor.msg_GetValue.Msg">
|
|
<short>Message for the control</short>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TStringCellEditor.msg_SetGrid">
|
|
<short>
|
|
<var>msg_SetGrid</var> - issues message for specifying grid</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TStringCellEditor.msg_SetGrid.Msg">
|
|
<short>Message for the control</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TStringCellEditor.msg_SelectAll">
|
|
<short>
|
|
<var>msg_SelectAll</var> - issues message for Selecting All</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TStringCellEditor.msg_SelectAll.Msg">
|
|
<short>Message for the control</short>
|
|
</element>
|
|
|
|
<element name="TStringCellEditor.msg_SetPos">
|
|
<short>
|
|
<var>msg_SetPos</var> - issues message for specifying position</short>
|
|
</element>
|
|
<element name="TStringCellEditor.msg_SetPos.Msg">
|
|
<short>Message for the control</short>
|
|
</element>
|
|
|
|
<element name="TStringCellEditor.msg_GetGrid">
|
|
<short>Message used to get the grid control for the cell editor</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TStringCellEditor.msg_GetGrid.Msg">
|
|
<short>Message for the control</short>
|
|
</element>
|
|
|
|
<element name="TStringCellEditor.Create">
|
|
<short>Constructor for the class instance</short>
|
|
<descr>
|
|
<p>
|
|
<var>Create</var> is the overridden constructor for the class instance. Create calls the inherited constructor using the value in <var>AOwner</var> as an argument. Create sets the value in the <var>AutoSize</var> property to <b>False</b>.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="#LCL.StdCtrls.TCustomEdit.AutoSize"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TStringCellEditor.Create.AOwner">
|
|
<short>Owner of the class instance</short>
|
|
</element>
|
|
|
|
<element name="TStringCellEditor.EditingDone">
|
|
<short>
|
|
Performs actions needed when the cell editor has finished editing the value in a cell
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>EditingDone</var> is an overridden procedure used to perform actions required when the cell editor has finished editing the value in a cell. EditingDone calls the inherited method, and calls the EditingDone method in the attached Grid control (when assigned) for the cell editor.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.EditingDone"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<element name="TStringCellEditor.EditText" link="TCustomMaskEdit.EditText">
|
|
<short></short>
|
|
<descr>
|
|
EditText is a published in TStringCellEditor.
|
|
</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TStringCellEditor.OnEditingDone" link="TCustomMaskEdit.OnEditingDone">
|
|
<short></short>
|
|
<descr>
|
|
OnEditingDone is a published in TStringCellEditor.
|
|
</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- object Visibility: default -->
|
|
<element name="TButtonCellEditor">
|
|
<short>
|
|
<var>TButtonCellEditor</var> - the editor for button cells in a grid</short>
|
|
<descr>
|
|
<p>
|
|
<var>TButtonCellEditor</var> is a <var>TButton</var> descendant which implements a grid cell editor which uses a button to activate the editor control. TButtonCellEditor maintains interval member variables for the TCustomGrid hosting the editor control. The row and column numbers for the underlying cell for the editor control are available in the <var>Row</var> and <var>Col</var> properties. TButtonCellEditor includes methods used to perform LCL message passing using a <var>TGridMessage</var> message type.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid"/>
|
|
<link id="TGridMessage"/>
|
|
<link id="TButtonCellEditor.Col"/>
|
|
<link id="TButtonCellEditor.Row"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<element name="TButtonCellEditor.FGrid"/>
|
|
<element name="TButtonCellEditor.FCol"/>
|
|
<element name="TButtonCellEditor.FRow"/>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TButtonCellEditor.msg_SetGrid">
|
|
<short>
|
|
<var>msg_SetGrid</var> - issues message for specifying grid</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TButtonCellEditor.msg_SetGrid.Msg">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TButtonCellEditor.msg_SetBounds">
|
|
<short>
|
|
<var>msg_SetBounds</var> - issues message for specifying bounds</short>
|
|
</element>
|
|
<element name="TButtonCellEditor.msg_SetBounds.Msg">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TButtonCellEditor.msg_SetPos">
|
|
<short>
|
|
<var>msg_SetPos</var> - issues message for specifying position</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TButtonCellEditor.msg_SetPos.Msg">
|
|
<short>LCL message for the grid control</short>
|
|
</element>
|
|
|
|
<element name="TButtonCellEditor.msg_Ready">
|
|
<short>
|
|
<var>msg_Ready</var> - issues message when ready</short>
|
|
</element>
|
|
<element name="TButtonCellEditor.msg_Ready.Msg">
|
|
<short>LCL message for the grid control</short>
|
|
</element>
|
|
|
|
<!-- Visibility: public -->
|
|
<element name="TButtonCellEditor.Col">
|
|
<short>Column number for the grid cell editor</short>
|
|
<descr>
|
|
<p>
|
|
<var>Col</var> is a public read-only <var>Integer</var> which contains the column number for the cell hosting the editor control.
|
|
</p>
|
|
<p>
|
|
Use <var>Row</var> to access the row number for the cell hosting the editor control.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TButtonCellEditor.Row"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: public -->
|
|
<element name="TButtonCellEditor.Row">
|
|
<short>Row number for the grid cell editor</short>
|
|
<descr>
|
|
<p>
|
|
<var>Row</var> is a public read-only <var>Integer</var> which contains the row number for the cell hosting the editor control.
|
|
</p>
|
|
<p>
|
|
Use <var>Col</var> to access the column number for the cell hosting the editor control.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TButtonCellEditor.Col"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- object Visibility: default -->
|
|
<element name="TPickListCellEditor">
|
|
<short>Implements a cell editor control which displays a Pick List</short>
|
|
<descr>
|
|
<p>
|
|
<var>TPickListCellEditor</var> is a <var>TCustomComboBox</var> descendant which implements a cell editor control that displays a Pick List. TPickListCellEditor provides overridden methods to alter the behavior of the TCustomComboBox ancestor.
|
|
</p>
|
|
<p>
|
|
TPickListCellEditor has an internal member used to store the <var>TCustomGrid</var> for the cell editor. In addition, the <var>Row</var> and <var>Column</var> numbers for the underlying cell are stored in internal members. TPickListCellEditor provides methods needed to implement LCL message passing using the TGridMessage message type.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TGridMessage"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<element name="TPickListCellEditor.FGrid"/>
|
|
<element name="TPickListCellEditor.FCol"/>
|
|
<element name="TPickListCellEditor.FRow"/>
|
|
|
|
<element link="#LCL.Controls.TControl.WndProc" name="TPickListCellEditor.WndProc"/>
|
|
<element name="TPickListCellEditor.WndProc.TheMessage">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element link="#LCL.Controls.TWinControl.KeyDown" name="TPickListCellEditor.KeyDown"/>
|
|
<element name="TPickListCellEditor.KeyDown.Key">
|
|
<short></short>
|
|
</element>
|
|
<element name="TPickListCellEditor.KeyDown.Shift">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element link="#LCL.StdCtrls.TCustomComboBox.DropDown" name="TPickListCellEditor.DropDown"/>
|
|
<element link="#LCL.StdCtrls.TCustomComboBox.CloseUp" name="TPickListCellEditor.CloseUp"/>
|
|
<element link="#LCL.StdCtrls.TCustomComboBox.Select" name="TPickListCellEditor.Select"/>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TPickListCellEditor.msg_GetValue">
|
|
<short>
|
|
<var>msg_GetValue</var> - issues a message to find the value</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TPickListCellEditor.msg_GetValue.Msg">
|
|
<short>LCL message for the grid control</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TPickListCellEditor.msg_SetGrid">
|
|
<short>
|
|
<var>msg_SetGrid</var> - issues a message to specify the grid</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TPickListCellEditor.msg_SetGrid.Msg">
|
|
<short>LCL message for the grid control</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TPickListCellEditor.msg_SetValue">
|
|
<short>
|
|
<var>msg_SetValue</var> - issues a message to specify the value</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TPickListCellEditor.msg_SetValue.Msg">
|
|
<short>LCL message for the grid control</short>
|
|
</element>
|
|
|
|
<element name="TPickListCellEditor.msg_SetPos">
|
|
<short>
|
|
<var>msg_SetPos</var> - issues a message to specify the position</short>
|
|
</element>
|
|
<element name="TPickListCellEditor.msg_SetPos.Msg">
|
|
<short>LCL message for the grid control</short>
|
|
</element>
|
|
|
|
<element link="#LCL.Controls.TControl.EditingDone"
|
|
name="TPickListCellEditor.EditingDone"/>
|
|
<element link="#LCL.Controls.TWinControl.BorderStyle" name="TPickListCellEditor.BorderStyle"/>
|
|
|
|
<element name="TEditorItem">
|
|
<short>
|
|
<var>TEditorItem</var> - a single item on which a Composite Cell Editor operates</short>
|
|
</element>
|
|
<element name="TEditorItem.Editor">
|
|
<short>The <var>Editor</var> to be used for this item</short>
|
|
</element>
|
|
<element name="TEditorItem.Align">
|
|
<short>
|
|
<var>Align</var> - how this item is to be aligned</short>
|
|
</element>
|
|
<element name="TEditorItem.ActiveControl">
|
|
<short>
|
|
<var>ActiveControl</var> - returns True if this item is part of an active control</short>
|
|
</element>
|
|
|
|
<element name="TCompositeCellEditor">
|
|
<short>
|
|
<var>TCompositeCellEditor</var> - a general purpose editor for cells in a grid</short>
|
|
</element>
|
|
|
|
<element link="#LCL.Controls.TWinControl.DoUTF8KeyPress" name="TCompositeCellEditor.DoUTF8KeyPress"/>
|
|
<element link="#LCL.Controls.TWinControl.SetFocus"
|
|
name="TCompositeCellEditor.SetFocus"/>
|
|
<element link="#LCL.Controls.TControl.VisibleChanging" name="TCompositeCellEditor.VisibleChanging"/>
|
|
|
|
<element name="TCompositeCellEditor.msg_GetValue">
|
|
<short>
|
|
<var>msg_GetValue</var> - issues a message to find the value</short>
|
|
</element>
|
|
<element name="TCompositeCellEditor.msg_SetGrid">
|
|
<short>
|
|
<var>msg_SetGrid</var> - issues message for specifying grid</short>
|
|
</element>
|
|
<element name="TCompositeCellEditor.msg_SetValue">
|
|
<short>
|
|
<var>msg_SetValue</var> - issues a message to specify the value</short>
|
|
</element>
|
|
<element name="TCompositeCellEditor.msg_SetBounds">
|
|
<short>
|
|
<var>msg_SetBounds</var> - issues message for specifying bounds</short>
|
|
</element>
|
|
<element name="TCompositeCellEditor.msg_SetMask">
|
|
<short>
|
|
<var>msg_SetMask</var> - issues message for specifying mask</short>
|
|
</element>
|
|
<element name="TCompositeCellEditor.msg_SelectAll">
|
|
<short>
|
|
<var>msg_SelectAll</var> - issues message for Selecting All</short>
|
|
</element>
|
|
<element name="TCompositeCellEditor.CMControlChange">
|
|
<short>
|
|
<var>CMControlChange</var> - issues Control Message for a change in a control</short>
|
|
</element>
|
|
<element name="TCompositeCellEditor.msg_SetPos">
|
|
<short>
|
|
<var>msg_SetPos</var> - issues a message to specify the position</short>
|
|
</element>
|
|
|
|
<element name="TCompositeCellEditor.SendChar">
|
|
<short>
|
|
<var>SendChar</var> - transmits the specified character and returns an integer status result</short>
|
|
<descr>0 - failure, 1 - success</descr>
|
|
</element>
|
|
|
|
<element link="#LCL.Controls.TControl.WndProc" name="TCompositeCellEditor.WndProc"/>
|
|
<element link="#rtl.Classes.TComponent.Destroy" name="TCompositeCellEditor.Destroy"/>
|
|
|
|
<element name="TCompositeCellEditor.AddEditor">
|
|
<short>
|
|
<var>AddEditor</var> - adds the specified Editor with the given alignment and specified ActiveControl property</short>
|
|
</element>
|
|
|
|
<!-- procedure type Visibility: default -->
|
|
<element name="TOnDrawCell">
|
|
<short>Defines the event handler signalled to draw a cell a grid control</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TOnDrawCell.Sender">
|
|
<short>Grid control for the event notification</short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TOnDrawCell.aCol">
|
|
<short>Column number to draw in the event handler</short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TOnDrawCell.aRow">
|
|
<short>Row number to draw in the event handler</short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TOnDrawCell.aRect">
|
|
<short>Rectangle to draw in the event handler</short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TOnDrawCell.aState">
|
|
<short>Grid drawing state used in the event handler</short>
|
|
</element>
|
|
|
|
<!-- procedure type Visibility: default -->
|
|
<element name="TOnSelectCellEvent">
|
|
<short>
|
|
Specifies the event handler signalled when a cell is selected in a grid control
|
|
</short>
|
|
<descr>
|
|
<var>TOnSelectCellEvent</var> specifies the event handler signalled when a cell is selected in a custom-drawn grid control. TOnSelectCellEvent is the type used to implement the OnSelectCell in TCustomDrawGrid.
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomDrawGrid.OnSelectCell"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TOnSelectCellEvent.Sender">
|
|
<short>Control for the event notification</short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TOnSelectCellEvent.aCol">
|
|
<short>Column number for the selection notification</short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TOnSelectCellEvent.aRow">
|
|
<short>Row number for the selection notification</short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TOnSelectCellEvent.CanSelect">
|
|
<short>Set to True if the specified cell can be selected</short>
|
|
</element>
|
|
|
|
<!-- procedure type Visibility: default -->
|
|
<element name="TOnSelectEvent">
|
|
<short>
|
|
Specifies an event handler signalled for a selection in a grid control
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>TOnSelectEvent</var> specifies an event handler signalled when a selection is made in a grid control. TOnSelectEvent is the type used to implement event handler properties in TCustomGrid, including:
|
|
</p>
|
|
<ul>
|
|
<li>OnAfterSelection</li>
|
|
<li>OnBeforeSelection</li>
|
|
<li>OnButtonClick</li>
|
|
<li>OnSelection</li>
|
|
</ul>
|
|
<p>
|
|
Applications must implement an object procedure using the signature for the event handler to respond to the event notification.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.OnAfterSelection"/>
|
|
<link id="TCustomGrid.OnBeforeSelection"/>
|
|
<link id="TCustomGrid.OnButtonClick"/>
|
|
<link id="TCustomGrid.OnSelection"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TOnSelectEvent.Sender">
|
|
<short>Control generating the event notification</short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TOnSelectEvent.aCol">
|
|
<short>Column number for the selection</short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TOnSelectEvent.aRow">
|
|
<short>Row number for the selection</short>
|
|
</element>
|
|
|
|
<!-- procedure type Visibility: default -->
|
|
<element name="TGridOperationEvent">
|
|
<short>
|
|
Event handler signalled when rows or columns are added, deleted or moved in a grid
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>TGridOperationEvent</var> specifies an event handler signalled when rows or columns are added, deleted or moved in a custom-drawn grid control. TGridOperationEvent is the type used to implement event handler properties in <var>TCustomDrawGrid</var>, including:
|
|
</p>
|
|
<ul>
|
|
<li>OnColRowDeleted</li>
|
|
<li>OnColRowExchanged</li>
|
|
<li>OnColRowInserted/</li>
|
|
<li>OnColRowMoved</li>
|
|
</ul>
|
|
<p>
|
|
Applications must implement an object procedure using the signature for the event handler to respond to the event notification.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomDrawGrid.OnColRowDeleted"/>
|
|
<link id="TCustomDrawGrid.OnColRowExchanged"/>
|
|
<link id="TCustomDrawGrid.OnColRowInserted"/>
|
|
<link id="TCustomDrawGrid.OnColRowMoved"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TGridOperationEvent.Sender">
|
|
<short>Control for the event notification</short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TGridOperationEvent.IsColumn">
|
|
<short>True when the notification is for a column and not a row</short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TGridOperationEvent.sIndex">
|
|
<short>Starting index position for the row or column</short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TGridOperationEvent.tIndex">
|
|
<short>Final index position for the row or column</short>
|
|
</element>
|
|
|
|
<!-- procedure type Visibility: default -->
|
|
<element name="THdrEvent">
|
|
<short>
|
|
Specifies an event handler signalled when an event occurs in a fixed header cell
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>THdrEvent</var> specifies an event handler signalled when an event occurs in a column header. Arguments passed to the event handler indicate whether the action occurred for a column or a row header, and the index position for the row or column.
|
|
</p>
|
|
<p>
|
|
<var>THdrEvent</var> is the type used to implement the <var>OnHeaderClick</var> and <var>OnHeaderSized</var> properties in <var>TCustomDrawGrid</var>. Applications must implement an object procedure using the event signature to respond to the event notification.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomDrawGrid.OnHeaderClick"/>
|
|
<link id="TCustomDrawGrid.OnHeaderSized"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="THdrEvent.Sender">
|
|
<short>Control generating the event notification</short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="THdrEvent.IsColumn">
|
|
<short>
|
|
True if the event applies to a column header; False when a row header is affected
|
|
</short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="THdrEvent.Index">
|
|
<short>Index position for the row or column in the event notification</short>
|
|
</element>
|
|
|
|
<!-- function type Visibility: default -->
|
|
<element name="TOnCompareCells">
|
|
<short>Specifies an event handler signalled to compare cell values</short>
|
|
<descr>
|
|
<p>
|
|
<var>TOnCompareCells</var> specifies an event handler signalled to compare the cells at the coordinates in <var>ACol</var>, <var>ARow</var>, <var>BCol</var>, and <var>BRow</var>. ACol and ARow are the column and row numbers for the first value in the comparison. BCol and BRow are the column and row number for the second value in the comparison.
|
|
</p>
|
|
<p>
|
|
<var>Result</var> is a variable <var>Integer</var> argument used to return the relative sort order for the compared values. The event handler must perform the actions needed to compare the cell values, and set the value in Result accordingly. <var>Result</var> should contain the following values:
|
|
</p>
|
|
<dl>
|
|
<dt>-1</dt>
|
|
<dd>The cell value at ACol, ARow occurs before the value at BCol, BRow</dd>
|
|
<dt>0</dt>
|
|
<dd>The compared cells contain the same values</dd>
|
|
<dt>1</dt>
|
|
<dd>The cell value at ACol, ARow occurs after the cell value at BCol, BRow</dd>
|
|
</dl>
|
|
<p>
|
|
TOnCompareCells is the type used to implement the <var>OnCompareCells</var> in <var>TCustomGrid</var>.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.OnCompareCells"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TOnCompareCells.Result">
|
|
<short>Relative sort order for the compared values</short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TOnCompareCells.Sender">
|
|
<short>Control generating the event notification</short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TOnCompareCells.ACol">
|
|
<short>Column number for the first compared cell value</short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TOnCompareCells.ARow">
|
|
<short>Row number for the first compared cell value</short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TOnCompareCells.Bcol">
|
|
<short>Column number for the second compared cell value</short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TOnCompareCells.BRow">
|
|
<short>Row number for the second compared cell value</short>
|
|
</element>
|
|
|
|
<!-- procedure type Visibility: default -->
|
|
<element name="TSelectEditorEvent">
|
|
<short>
|
|
Specifies an event handler signalled to get an editor control for the specified cell
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>TSelectEditorEvent</var> specifies an event handler signalled to get an editor control for the cell at the coordinates in <var>ACol</var> and <var>ARow</var>.
|
|
</p>
|
|
<p>
|
|
<var>Editor</var> is the <var>TWinControl</var> or descendent class instance to use as the cell editor for the given cell.
|
|
</p>
|
|
<p>
|
|
TSelectEditorEvent is the type used to implement the <var>OnSelectEditor</var> in <var>TCustomGrid</var>. Applications must implement an object procedure using the event signature to respond to the event notification.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.OnSelectEditor"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TSelectEditorEvent.Sender">
|
|
<short>Control generating the event notification</short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TSelectEditorEvent.aCol">
|
|
<short>Column number for the cell editor</short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TSelectEditorEvent.aRow">
|
|
<short>Row number for the cell editor</short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TSelectEditorEvent.Editor">
|
|
<short>Editor control to use for the specified cell</short>
|
|
</element>
|
|
|
|
<!-- procedure type Visibility: default -->
|
|
<element name="TOnPrepareCanvasEvent">
|
|
<short>
|
|
Specifies an event handler signalled when preparing the canvas for a grid control
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>TOnPrepareCanvasEvent</var> specifies an event handler signalled when the canvas for a grid control is prepared for rendering. TOnPrepareCanvasEvent allows the canvas for the grid control to be altered prior to rendering cell data.
|
|
</p>
|
|
<p>
|
|
<var>Sender</var> is the grid control triggering the event notification.
|
|
</p>
|
|
<p>
|
|
<var>ACol</var> and <var>ARow</var> are the column and row numbers (respectively) for the grid cell in the event notification.
|
|
</p>
|
|
<p>
|
|
<var>AState</var> contains the grid drawing state for the cell data.
|
|
</p>
|
|
<p>
|
|
TOnPrepareCanvasEvent is the type used to implement the <var>OnPrepareCanvas</var> in <var>TCustomGrid</var>. Applications must implement an object procedure using the event signature to respond to the event notification.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.OnPrepareCanvas"/>
|
|
<link id="TCustomGrid.PrepareCanvas"/>
|
|
<link id="TCustomGrid.DoPrepareCanvas"/>
|
|
<link id="TCustomGrid.DrawCell"/>
|
|
<link id="TCustomGrid.ShowCellHintWindow"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TOnPrepareCanvasEvent.Sender">
|
|
<short>Grid control for the event notification</short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TOnPrepareCanvasEvent.aCol">
|
|
<short>Column number for the cell in the event notification</short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TOnPrepareCanvasEvent.aRow">
|
|
<short>Row number for the cell in the event notification</short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TOnPrepareCanvasEvent.aState">
|
|
<short>Grid drawing state for the cell in the event notification</short>
|
|
</element>
|
|
|
|
<element name="TUserCheckBoxImageEvent">
|
|
<short>
|
|
Specifies the event handler used to get the image drawn for a Checkbox column in a grid
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>TUserCheckBoxImageEvent</var> specifies an event handler signalled to get the image drawn for a grid cell which displays a Checkbox.
|
|
</p>
|
|
<p>
|
|
<var>Sender</var> is the grid control generating the event notification.
|
|
</p>
|
|
<p>
|
|
<var>ACol</var> and <var>ARow</var> are the column and row numbers (respectively) for the cell where the Checkbox is drawn.
|
|
</p>
|
|
<p>
|
|
<var>CheckedState</var> indicates whether the Checkbox is drawn using the Checked state.
|
|
</p>
|
|
<p>
|
|
<var>ImageList</var> contains the images used for the Unchecked and Checked states.
|
|
</p>
|
|
<p>
|
|
<var>ImageIndex</var> indicates the image in ImageList used for the drawing operation.
|
|
</p>
|
|
<p>
|
|
TUserCheckBoxImageEvent is the type used to implement the <var>OnUserCheckboxImage</var> in <var>TCustomGrid</var>. Applications must implement an object procedure using the event signature to respond to the event notification.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.OnUserCheckboxImage"/>
|
|
<link id="TCustomGrid.GetImageForCheckBox"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TUserCheckBoxImageEvent.Sender">
|
|
<short>Grid generating the event notification</short>
|
|
</element>
|
|
<element name="TUserCheckBoxImageEvent.aCol">
|
|
<short>Column number for the cell</short>
|
|
</element>
|
|
<element name="TUserCheckBoxImageEvent.aRow">
|
|
<short>Row number for the cell</short>
|
|
</element>
|
|
<element name="TUserCheckBoxImageEvent.CheckedState">
|
|
<short>State for the Checkbox</short>
|
|
</element>
|
|
<element name="TUserCheckBoxImageEvent.ImageList">
|
|
<short>Image list with unchecked and checked images</short>
|
|
</element>
|
|
<element name="TUserCheckBoxImageEvent.ImageIndex">
|
|
<short>Position of the image to use in ImageList</short>
|
|
</element>
|
|
|
|
<element name="TValidateEntryEvent">
|
|
<short>Specifies the event handler used to validate the content in a grid cell</short>
|
|
<descr>
|
|
<p>
|
|
<var>TValidateEntryEvent</var> specifies an event handler used to validate the content in a grid cell. TValidateEntryEvent is the type used to implement the <var>OnValidateEntry</var> in <var>TCustomGrid</var>. Applications must implement an object procedure using the event signature to respond to the event notification.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.OnValidateEntry"/>
|
|
<link id="TCustomGrid.ValidateEntry"/>
|
|
<link id="TCustomGrid.EditorDoGetValue"/>
|
|
<link id="TCustomStringGrid.SelectionSetText"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TValidateEntryEvent.Sender">
|
|
<short>Grid generating the event notification</short>
|
|
</element>
|
|
<element name="TValidateEntryEvent.aCol">
|
|
<short>Column number for the cell</short>
|
|
</element>
|
|
<element name="TValidateEntryEvent.aRow">
|
|
<short>Row number for the cell</short>
|
|
</element>
|
|
<element name="TValidateEntryEvent.OldValue">
|
|
<short>Value checked in the event handler</short>
|
|
</element>
|
|
<element name="TValidateEntryEvent.NewValue">
|
|
<short>Value returned from the event handler</short>
|
|
</element>
|
|
|
|
<element name="TToggledCheckboxEvent">
|
|
<short>
|
|
Specifies an event handler signalled when the value in a CheckBox cell is changed
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>TToggledCheckboxEvent</var> specifies an event handler signalled when the value in CheckBox-style cell is changed in a grid. Arguments passed to the event handler identify the grid control for the event notification, the row and column numbers for the altered cell, and the state for a CheckBox cell editor.
|
|
</p>
|
|
<p>
|
|
<var>TToggledCheckboxEvent</var> is the type used to implement the <var>OnCheckboxToggled</var> in <var>TCustomGrid</var> and descendent classes. Applications must implement an object procedure using the signature for the event handler to respond to the event notification.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.OnCheckboxToggled"/>
|
|
<link id="TCustomDrawGrid.ToggleCheckbox"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TToggledCheckboxEvent.Sender">
|
|
<short>Grid control for the event notification</short>
|
|
</element>
|
|
<element name="TToggledCheckboxEvent.aCol">
|
|
<short>Column number for the altered cell</short>
|
|
</element>
|
|
<element name="TToggledCheckboxEvent.aRow">
|
|
<short>Row number for the altered cell</short>
|
|
</element>
|
|
<element name="TToggledCheckboxEvent.aState">
|
|
<short>State for the CheckBox in the associated cell editor</short>
|
|
</element>
|
|
|
|
<element name="THeaderSizingEvent">
|
|
<short>
|
|
Specifies an event handler signalled when a fixed cell header in a grid is resized
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
THeaderSizingEvent specifies an event handler signalled when a fixed cell header in a grid is resized. Arguments passed to the event handler identify the grid control for the event, and information the row or column affected by the operation.
|
|
</p>
|
|
<p>
|
|
THeaderSizingEvent is the type used to implement the OnHeaderSizing in TCustomDrawGrid. Applications must implement an object procedure using the signature for the event to allow responding to the event notification.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomDrawGrid.OnHeaderSizing"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="THeaderSizingEvent.Sender">
|
|
<short>Grid control for the event notification</short>
|
|
</element>
|
|
<element name="THeaderSizingEvent.IsColumn">
|
|
<short>
|
|
True when the affected cell is a column header; False when it is a row header
|
|
</short>
|
|
</element>
|
|
<element name="THeaderSizingEvent.aIndex">
|
|
<short>Position of the row or column in the grid control</short>
|
|
</element>
|
|
<element name="THeaderSizingEvent.aSize">
|
|
<short>Size (in pixels) for the resized cell</short>
|
|
</element>
|
|
|
|
<element name="TCellProcessEvent">
|
|
<short>Specifies an event handler used to process the value in a grid cell</short>
|
|
<descr>
|
|
<p>
|
|
<var>TCellProcessEvent</var> specifies an event handler used to process the value in a grid cell in <var>TCustomStringGrid</var>. Arguments to the event handler identify the grid generating the event notification, the row and column numbers for the affected cell, and the value for the cell after processing. The <var>processType</var> argument specifies whether <var>aValue</var> is copied from or pasted to the cell.
|
|
</p>
|
|
<p>
|
|
TCellProcessEvent is the type used to implement the <var>OnCellProcess</var> in <var>TCustomStringGrid</var>. Applications must implement an object procedure using the signature for the event handler to respond to the event notification.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomStringGrid.OnCellProcess"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TCellProcessEvent.Sender">
|
|
<short>Grid control generating the event notification</short>
|
|
</element>
|
|
<element name="TCellProcessEvent.aCol">
|
|
<short>Column number for the cell in the event notification</short>
|
|
</element>
|
|
<element name="TCellProcessEvent.aRow">
|
|
<short>Row number for the cell in the event notification</short>
|
|
</element>
|
|
<element name="TCellProcessEvent.processType">
|
|
<short>Process to perform on the cell value</short>
|
|
</element>
|
|
<element name="TCellProcessEvent.aValue">
|
|
<short>Value for the cell after processing has been applied</short>
|
|
</element>
|
|
|
|
<element name="TGetCellHintEvent">
|
|
<short>Event used to get cell hints</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TGetCellHintEvent.Sender">
|
|
<short>The grid</short>
|
|
</element>
|
|
<element name="TGetCellHintEvent.ACol">
|
|
<short>Column index</short>
|
|
</element>
|
|
<element name="TGetCellHintEvent.ARow">
|
|
<short>Row index</short>
|
|
</element>
|
|
<element name="TGetCellHintEvent.HintText">
|
|
<short>Hint text</short>
|
|
<descr>This text will be displayed as hint.</descr>
|
|
</element>
|
|
|
|
<element name="TSaveColumnEvent">
|
|
<short>
|
|
Specifies an event handler used to load/save the configuration for a column in a grid
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>TSaveColumnEvent</var> is the type used to implement the <var>OnLoadColumn</var> and <var>OnSaveColumn</var> properties in <var>TCustomGrid</var>.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.OnLoadColumn"/>
|
|
<link id="TCustomGrid.OnSaveColumn"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TSaveColumnEvent.Sender">
|
|
<short>Grid for the event notification</short>
|
|
</element>
|
|
<element name="TSaveColumnEvent.aColumn">
|
|
<short>Column object for the event notification</short>
|
|
</element>
|
|
<element name="TSaveColumnEvent.aColIndex">
|
|
<short>Index of the column in the grid</short>
|
|
</element>
|
|
<element name="TSaveColumnEvent.aCfg">
|
|
<short>XML configuration file for the column information</short>
|
|
</element>
|
|
<element name="TSaveColumnEvent.aVersion">
|
|
<short>Grid version for the event</short>
|
|
</element>
|
|
<element name="TSaveColumnEvent.aPath">
|
|
<short>Path expression in the configuration file the column</short>
|
|
</element>
|
|
|
|
<!-- object Visibility: default -->
|
|
<element name="TVirtualGrid">
|
|
<short>
|
|
Implements a grid for metadata where rows and columns are stored as arrays of Pointers
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>TVirtualGrid</var> is a class used to represent a grid where the rows and columns containing grid metadata are stored as arrays of Pointers. Data stored in the grid includes the Size for data in a cell, and pointers to attributes for fixed and normal cell display.
|
|
</p>
|
|
<p>
|
|
TVirtualGrid is the type used for an internal member in TCustomDrawGrid.
|
|
</p>
|
|
</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TVirtualGrid.FColCount"/>
|
|
<element name="TVirtualGrid.FRowCount"/>
|
|
<element name="TVirtualGrid.FCellArr"/>
|
|
<element name="TVirtualGrid.FColArr"/>
|
|
<element name="TVirtualGrid.FRowArr"/>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TVirtualGrid.GetCells">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TVirtualGrid.GetCells.Result">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TVirtualGrid.GetCells.Col">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TVirtualGrid.GetCells.Row">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TVirtualGrid.GetRows">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TVirtualGrid.GetRows.Result">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TVirtualGrid.GetRows.Row">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TVirtualGrid.GetCols">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TVirtualGrid.GetCols.Result">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TVirtualGrid.GetCols.Col">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TVirtualGrid.SetCells">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TVirtualGrid.SetCells.Col">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TVirtualGrid.SetCells.Row">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TVirtualGrid.SetCells.AValue">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TVirtualGrid.SetRows">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TVirtualGrid.SetRows.Row">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TVirtualGrid.SetRows.Avalue">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TVirtualGrid.SetColCount">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TVirtualGrid.SetColCount.Avalue">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TVirtualGrid.SetRowCount">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TVirtualGrid.SetRowCount.AValue">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TVirtualGrid.SetCols">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TVirtualGrid.SetCols.Col">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TVirtualGrid.SetCols.Avalue">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TVirtualGrid.doDestroyItem">
|
|
<short>
|
|
<var>doDestroyItem</var> - method for destroying an Item at the given Row and Column location
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TVirtualGrid.doDestroyItem.Sender">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TVirtualGrid.doDestroyItem.Col">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TVirtualGrid.doDestroyItem.Row">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TVirtualGrid.doDestroyItem.Item">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TVirtualGrid.doNewItem">
|
|
<short>
|
|
<var>doNewItem</var> - method for producing a new item at the given location specified by Row, Col
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TVirtualGrid.doNewItem.Sender">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TVirtualGrid.doNewItem.Col">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TVirtualGrid.doNewItem.Row">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TVirtualGrid.doNewItem.Item">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TVirtualGrid.DeleteColRow">
|
|
<short>
|
|
<var>DeleteColRow</var> - remove either a column or a row, depending on the value of
|
|
<var>IsColumn</var>
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TVirtualGrid.DeleteColRow.IsColumn">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TVirtualGrid.DeleteColRow.Index">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TVirtualGrid.MoveColRow">
|
|
<short>
|
|
<var>MoveColRow</var> - move either a column or a row (depending on value of <var>IsColumn</var>) at <var>FromIndex</var> to the location <var>ToIndex</var>
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TVirtualGrid.MoveColRow.IsColumn">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TVirtualGrid.MoveColRow.FromIndex">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TVirtualGrid.MoveColRow.ToIndex">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TVirtualGrid.ExchangeColRow">
|
|
<short>
|
|
<var>ExchangeColRow</var> - exchange either the current column or row (depending on the value of <var>IsColumn</var>) with the entity specified by <var>WithIndex</var>
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TVirtualGrid.ExchangeColRow.IsColumn">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TVirtualGrid.ExchangeColRow.Index">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TVirtualGrid.ExchangeColRow.WithIndex">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TVirtualGrid.DisposeCell">
|
|
<short>
|
|
<var>DisposeCell</var> - dispose of the resources and pointer for the given cell
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TVirtualGrid.DisposeCell.P">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TVirtualGrid.DisposeColRow">
|
|
<short>
|
|
<var>DisposeColRow</var> - dispose of the specified row or column, freeing its pointer
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TVirtualGrid.DisposeColRow.p">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TVirtualGrid.IsColumnIndexValid">
|
|
<short></short>
|
|
<descr></descr>
|
|
</element>
|
|
<element name="TVirtualGrid.IsColumnIndexValid.Result">
|
|
<short></short>
|
|
</element>
|
|
<element name="TVirtualGrid.IsColumnIndexValid.AIndex">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TVirtualGrid.IsRowIndexValid">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TVirtualGrid.IsRowIndexValid.Result">
|
|
<short></short>
|
|
</element>
|
|
<element name="TVirtualGrid.IsRowIndexValid.AIndex">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- constructor Visibility: public -->
|
|
<element name="TVirtualGrid.Create">
|
|
<short>
|
|
<var>Create</var> - constructor for TVirtualGrid: calls inherited <var>Create</var> then creates arrays of Cells, Columns and Rows; forms links for actions and event handlers
|
|
</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="#rtl.System.TObject.Create">TObject.Create</link>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- destructor Visibility: public -->
|
|
<element name="TVirtualGrid.Destroy">
|
|
<short>
|
|
<var>Destroy</var> - destructor for <var>TVirtualGrid</var>: frees rows, columns and cells, then calls inherited <var>Destroy</var>
|
|
</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="#rtl.System.TObject.Destroy">TObject.Destroy</link>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: public -->
|
|
<element name="TVirtualGrid.Clear">
|
|
<short>
|
|
<var>Clear</var> the grid
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- function Visibility: public -->
|
|
<element name="TVirtualGrid.GetDefaultCell">
|
|
<short>
|
|
<var>GetDefaultCell</var> - returns the properties of the default cell
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TVirtualGrid.GetDefaultCell.Result">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: public -->
|
|
<element name="TVirtualGrid.GetDefaultColRow">
|
|
<short>
|
|
<var>GetDefaultColRow</var> - returns the properties of the default column and row
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TVirtualGrid.GetDefaultColRow.Result">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- Visibility: public -->
|
|
<element name="TVirtualGrid.ColCount">
|
|
<short>
|
|
<var>ColCount</var> - the number of columns in the current grid
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: public -->
|
|
<element name="TVirtualGrid.RowCount">
|
|
<short>
|
|
<var>RowCount</var> - the number of rows in the current grid
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: public -->
|
|
<element name="TVirtualGrid.Celda">
|
|
<short>
|
|
<var>Celda</var> - the current cell as defined by its column and row
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TVirtualGrid.Celda.Col">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TVirtualGrid.Celda.Row">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- Visibility: public -->
|
|
<element name="TVirtualGrid.Cols">
|
|
<short>
|
|
<var>Cols</var> - the columns to which the grid applies
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TVirtualGrid.Cols.Col">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- Visibility: public -->
|
|
<element name="TVirtualGrid.Rows">
|
|
<short>The <var>Rows</var> to which the grid applies</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TVirtualGrid.Rows.Row">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TVirtualGrid.InsertColRow">
|
|
<short>
|
|
<var>InsertColRow</var> - insert either a column or a row (depending on value of <var>IsColumn</var>) at the specified index position
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TVirtualGrid.InsertColRow.IsColumn">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TVirtualGrid.InsertColRow.Index">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- object Visibility: default -->
|
|
<element name="TGridColumnTitle">
|
|
<short>
|
|
Provides properties and methods relevant to the title for a column in a grid
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>TGridColumnTitle</var> is <var>TPersistent</var> descendant used to represent properties and methods relevant to the title for a column in a grid. Use the published properties in the class to access the layout and display attributes for the column title, including:
|
|
</p>
|
|
<ul>
|
|
<li>Alignment</li>
|
|
<li>Color</li>
|
|
<li>Font</li>
|
|
<li>ImageIndex</li>
|
|
<li>ImageLayout</li>
|
|
<li>Layout</li>
|
|
<li>MultiLine</li>
|
|
<li>PrefixOption</li>
|
|
</ul>
|
|
<p>
|
|
Use the <var>Caption</var> to read or write the text displayed as the title for a grid column.
|
|
</p>
|
|
<p>
|
|
Use the <var>Column</var> to read the column reference (assigned in the constructor for the class instance) to which the column title is attached.
|
|
</p>
|
|
<p>
|
|
<var>TGridColumnTitle</var> is the type used to implement the <var>TGridColumn.Title</var> property.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TGridColumn.Title"/>
|
|
<link id="TGridColumnTitle.Caption"/>
|
|
<link id="TGridColumnTitle.Column"/>
|
|
<link id="TGridColumnTitle.Alignment"/>
|
|
<link id="TGridColumnTitle.Color"/>
|
|
<link id="TGridColumnTitle.Font"/>
|
|
<link id="TGridColumnTitle.ImageIndex"/>
|
|
<link id="TGridColumnTitle.ImageLayout"/>
|
|
<link id="TGridColumnTitle.Layout"/>
|
|
<link id="TGridColumnTitle.MultiLine"/>
|
|
<link id="TGridColumnTitle.PrefixOption"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<element name="TGridColumnTitle.FColumn"/>
|
|
<element name="TGridColumnTitle.FCaption"/>
|
|
<element name="TGridColumnTitle.FColor"/>
|
|
<element name="TGridColumnTitle.FAlignment"/>
|
|
<element name="TGridColumnTitle.FFont"/>
|
|
<element name="TGridColumnTitle.FIsDefaultTitleFont"/>
|
|
<element name="TGridColumnTitle.FLayout"/>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TGridColumnTitle.FontChanged">
|
|
<short>Updates the column for when font for the title has changed</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TGridColumnTitle.FontChanged.Sender">
|
|
<short>Class generating the notification</short>
|
|
</element>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TGridColumnTitle.GetAlignment" link="TGridColumnTitle.Alignment">
|
|
<short>Gets the value for the Alignment property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TGridColumnTitle.GetAlignment.Result">
|
|
<short>Value for the property</short>
|
|
</element>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TGridColumnTitle.GetCaption">
|
|
<short>Gets the value for the Caption property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TGridColumnTitle.GetCaption.Result">
|
|
<short>Value for the property</short>
|
|
</element>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TGridColumnTitle.GetColor">
|
|
<short>Gets the value for the Color property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TGridColumnTitle.GetColor.Result">
|
|
<short>Value for the property</short>
|
|
</element>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TGridColumnTitle.GetFont">
|
|
<short>Gets the value for the Font property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TGridColumnTitle.GetFont.Result">
|
|
<short>Value for the property</short>
|
|
</element>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TGridColumnTitle.GetLayout">
|
|
<short>Gets the value for the Layout property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TGridColumnTitle.GetLayout.Result">
|
|
<short>Value for the property</short>
|
|
</element>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TGridColumnTitle.IsAlignmentStored">
|
|
<short>
|
|
Indicates if the Alignment is used when saving the component
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>IsAlignmentStored</var> indicates if the Alignment is used for the component. <var>IsAlignmentStored</var> contains <b>True</b> when the Alignment has been assigned (is not <b>Nil</b>) for the class instance.
|
|
</p>
|
|
<p>
|
|
It is used in the TCustomGrid.SaveColumns method. It is also used as the storage specifier for the Alignment as used in LCL component streaming.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TGridColumnTitle.Alignment"/>
|
|
<link id="TCustomGrid.SaveColumns"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TGridColumnTitle.IsAlignmentStored.Result">
|
|
<short>True if Alignment is available for the column title</short>
|
|
</element>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TGridColumnTitle.IsCaptionStored">
|
|
<short>Indicates if the Caption is available in the component</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TGridColumnTitle.Caption"/>
|
|
<link id="TCustomGrid.SaveColumns"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TGridColumnTitle.IsCaptionStored.Result">
|
|
<short>True when Caption is available for the column title</short>
|
|
</element>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TGridColumnTitle.IsColorStored">
|
|
<short>Indicates if the Color is assigned for the column title</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TGridColumnTitle.Color"/>
|
|
<link id="TCustomGrid.SaveColumns"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TGridColumnTitle.IsColorStored.Result">
|
|
<short>True when Color has been assigned </short>
|
|
</element>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TGridColumnTitle.IsFontStored">
|
|
<short>Indicates if the Font has been assigned for the column title</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TGridColumnTitle.Font"/>
|
|
<link id="TCustomGrid.SaveColumns"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TGridColumnTitle.IsFontStored.Result">
|
|
<short>True when Font has been assigned in the column title</short>
|
|
</element>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TGridColumnTitle.IsLayoutStored">
|
|
<short>Indicates if the Layout has been assigned in the column title</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TGridColumnTitle.Layout"/>
|
|
<link id="TCustomGrid.SaveColumns"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TGridColumnTitle.IsLayoutStored.Result">
|
|
<short>True when the Layout has been assigned in the column title</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TGridColumnTitle.SetAlignment" link="TGridColumnTitle.Alignment">
|
|
<short>Sets the value in the Alignment property</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TGridColumnTitle.Alignment"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TGridColumnTitle.SetAlignment.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TGridColumnTitle.SetColor" link="TGridColumnTitle.Color">
|
|
<short>Sets the value in the Color property</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TGridColumnTitle.Color"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TGridColumnTitle.SetColor.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TGridColumnTitle.SetFont" link="TGridColumnTitle.Font">
|
|
<short>Sets the value in the Font property</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TGridColumnTitle.Font"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TGridColumnTitle.SetFont.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TGridColumnTitle.SetLayout" link="TGridColumnTitle.Layout">
|
|
<short>Sets the value in the Layout property</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TGridColumnTitle.Layout"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TGridColumnTitle.SetLayout.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<!-- Visibility: private -->
|
|
<element name="TGridColumnTitle.IsDefaultFont">
|
|
<short>Indicates if the Font contains a default value</short>
|
|
<descr>
|
|
<p>
|
|
<var>IsDefaultFont</var> is a read-only <var>Boolean</var> that indicates if the <var>Font</var> contains a default value. The value in <var>IsDefaultFont</var> is set to <b>False</b> when a new value is assigned to the <var>Font</var> property.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TGridColumnTitle.Font"/>
|
|
<link id="TGridColumnTitle.IsDefault"/>
|
|
<link id="TGridColumnTitle.IsFontStored"/>
|
|
<link id="TGridColumn.IsDefaultTitleFont"/>
|
|
<link id="TGridColumn.Title"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element link="#rtl.Classes.TPersistent.Assign" name="TGridColumnTitle.Assign"/>
|
|
<element name="TGridColumnTitle.Assign.Source">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TGridColumnTitle.GetDefaultCaption">
|
|
<short>
|
|
<var>GetDefaultCaption</var> - returns the e default caption for this column
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TGridColumnTitle.GetDefaultCaption.Result">
|
|
<short>Default value for the Caption property</short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TGridColumnTitle.GetDefaultAlignment">
|
|
<short>
|
|
<var>GetDefaultAlignment</var> - returns the default alignment
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TGridColumnTitle.GetDefaultAlignment.Result">
|
|
<short>Default value for the Alignment property</short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TGridColumnTitle.GetDefaultColor">
|
|
<short>
|
|
<var>GetDefaultColor</var> - returns the default color</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TGridColumnTitle.GetDefaultColor.Result">
|
|
<short>Default value for the Color property</short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TGridColumnTitle.GetDefaultLayout">
|
|
<short>
|
|
<var>GetDefaultLayout</var> - returns the default layout
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TGridColumnTitle.GetDefaultLayout.Result">
|
|
<short>Default value for the Layout property</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TGridColumnTitle.SetCaption">
|
|
<short>
|
|
<var>SetCaption</var> - specifies the caption to use (rather than using default)
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TGridColumnTitle.SetCaption.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<!-- constructor Visibility: public -->
|
|
<element name="TGridColumnTitle.Create">
|
|
<short>
|
|
Constructor for the class instance
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>Create</var> is the virtual constructor for the class instance. Create calls the inherited constructor, allocates resources, and sets the default values for members in the class instance.
|
|
</p>
|
|
<p>
|
|
Create calls the <var>FillTitleDefaultFont</var> method to get the default value used in the <var>Font</var> property. It can contain either the font for titles in the Grid instance or the font for the Column definition; preference is given to the value in the Grid.
|
|
</p>
|
|
<p>
|
|
Create assigns the <var>FontChanged</var> method as the <var>OnChange</var> event handler for the <var>Font</var> property.
|
|
</p>
|
|
<p>
|
|
<var>TheColumn</var> contains contains the <var>TGridColumn</var> instance where the column title is used.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="#rtl.System.TObject.Create">TObject.Create</link>
|
|
</seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TGridColumnTitle.Create.TheColumn">
|
|
<short>Column class instance where the column title is used</short>
|
|
</element>
|
|
|
|
<!-- destructor Visibility: public -->
|
|
<element name="TGridColumnTitle.Destroy">
|
|
<short>
|
|
<var>Destroy</var> - destructor for <var>TGridColumnTitle</var>: frees form, disconnects alignments, disposes of captions and colors then calls inherited <var>Destroy</var>
|
|
</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="#rtl.Classes.TPersistent.Destroy">TPersistent.Destroy</link>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: public -->
|
|
<element name="TGridColumnTitle.FillTitleDefaultFont">
|
|
<short>
|
|
<var>FillTitleDefaultFont</var> - use the default font for the whole of the title
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TGridColumnTitle.FixDesignFontsPPI">
|
|
<!-- TODO -->
|
|
<short></short>
|
|
<descr>
|
|
<p>
|
|
<var>FixDesignFontsPPI</var> is a procedure used to...
|
|
</p>
|
|
</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TGridColumnTitle.FixDesignFontsPPI.ADesignTime">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TGridColumnTitle.ScaleFontsPPI">
|
|
<!-- TODO -->
|
|
<short></short>
|
|
<descr>
|
|
<p>
|
|
<var>ScaleFontsPPI</var> is an overridden procedure used to...
|
|
</p>
|
|
</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TGridColumnTitle.ScaleFontsPPI.AToPPI">
|
|
<short></short>
|
|
</element>
|
|
<element name="TGridColumnTitle.ScaleFontsPPI.AProportion">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: public -->
|
|
<element name="TGridColumnTitle.IsDefault">
|
|
<short>
|
|
<var>IsDefault</var> - returns True if this is the default title
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TGridColumnTitle.IsDefault.Result">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- Visibility: public -->
|
|
<element name="TGridColumnTitle.Column">
|
|
<short>The <var>Column</var> to which the title applies</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: published -->
|
|
<element name="TGridColumnTitle.Alignment">
|
|
<short>The <var>Alignment</var> (whether justified or centered) for this title</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: published -->
|
|
<element name="TGridColumnTitle.Caption">
|
|
<short>The <var>Caption</var> for this title</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: published -->
|
|
<element name="TGridColumnTitle.Color">
|
|
<short>The <var>Color</var> to use for this title</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: published -->
|
|
<element name="TGridColumnTitle.Font">
|
|
<short>The <var>Font</var> for this title</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TGridColumnTitle.ImageIndex">
|
|
<short>
|
|
<var>ImageIndex</var> - the index for any image to be used in the title (default=0, i.e. no image)
|
|
</short>
|
|
</element>
|
|
|
|
<element name="TGridColumnTitle.ImageLayout">
|
|
<short>
|
|
<var>ImageLayout</var> - the layout to use for any image in the title
|
|
</short>
|
|
</element>
|
|
|
|
<!-- Visibility: published -->
|
|
<element name="TGridColumnTitle.Layout">
|
|
<short>The <var>Layout</var> for the text of the title</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TGridColumnTitle.MultiLine">
|
|
<short>Indicates if the column title can be displayed as multiple lines</short>
|
|
<descr>
|
|
<p>
|
|
<var>MultiLine</var> is a <var>Boolean</var> that indicates if the column title can be displayed as multiple lines. The default value for the is <b>False</b>. Changing the value in MultiLine cause the <var>ColumnChanged</var> method for the <var>TGridColumn</var> class instance to be called.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TGridColumn.ColumnChanged"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<element name="TGridColumnTitle.PrefixOption">
|
|
<short>Indicates if accelerator keys are used in the column title</short>
|
|
<descr>
|
|
<p>
|
|
<var>PrefixOption</var> is a <var>TPrefixOption</var> that indicates if accelerator keys are recognized and displayed in the column title. The default value for the is <var>poNone</var>, and indicates Accelerator keys are ignored for the column title. Changing the value in <var>PrefixOption</var> causes the <var>ColumnChanged</var> method for the <var>TGridColumn</var> class instance to be called.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TGridColumn.ColumnChanged"/>
|
|
<link id="TPrefixOption"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- object Visibility: default -->
|
|
<element name="TGridColumn">
|
|
<short>Implements a column definition used for tabular data in TCustomGrid</short>
|
|
<descr>
|
|
<p>
|
|
<var>TGridColumn</var> is a <var>TCollectionItem</var> descendant which implements a column definition for grid controls. TGridColumn contains properties which control the appearance, layout, and editing behavior used for a column in <var>TCustomGrid</var> and descendent classes. For instance:
|
|
</p>
|
|
<ul>
|
|
<li>Alignment</li>
|
|
<li>ButtonStyle</li>
|
|
<li>Color</li>
|
|
<li>DropDownRows</li>
|
|
<li>Font</li>
|
|
<li>Layout</li>
|
|
<li>MinSize</li>
|
|
<li>MaxSize</li>
|
|
<li>PickList</li>
|
|
<li>ReadOnly</li>
|
|
<li>Width</li>
|
|
<li>Visible</li>
|
|
<li>ValueChecked</li>
|
|
<li>ValueUnchecked</li>
|
|
</ul>
|
|
<p>
|
|
The column has an associated <var>TGridColumnTitle</var> class instance in <var>Title</var> that defines the fixed cell header displayed for the column. As a convenience, the column includes a reference to the <var>TCustomGrid</var> which uses the column definition.
|
|
</p>
|
|
<p>
|
|
Instances of <var>TGridColumn</var> are created by and stored in the <var>TGridColumns</var> collection class. Use the methods in <var>TGridColumns</var> to create, access, and maintain the items in the collection.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TGridColumns"/>
|
|
<link id="TCustomGrid.Columns"/>
|
|
<link id="TGridColumnTitle"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- variable Visibility: private -->
|
|
<element name="TGridColumn.FButtonStyle"/>
|
|
<element name="TGridColumn.FDropDownRows"/>
|
|
<element name="TGridColumn.FTitle"/>
|
|
<element name="TGridColumn.FWidthChanged"/>
|
|
<element name="TGridColumn.FAlignment"/>
|
|
<element name="TGridColumn.FColor"/>
|
|
<element name="TGridColumn.FLayout"/>
|
|
<element name="TGridColumn.FVisible"/>
|
|
<element name="TGridColumn.FReadOnly"/>
|
|
<element name="TGridColumn.FWidth"/>
|
|
<element name="TGridColumn.FFont"/>
|
|
<element name="TGridColumn.FIsDefaultFont"/>
|
|
<element name="TGridColumn.FPickList"/>
|
|
<element name="TGridColumn.FMinSize"/>
|
|
<element name="TGridColumn.FMaxSize"/>
|
|
<element name="TGridColumn.FSizePriority"/>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TGridColumn.FontChanged">
|
|
<short>
|
|
Performs actions needed when the Font has been changed for the grid column
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>FontChanged</var> is a procedure used to perform actions needed when the <var>Font</var> for the grid column has been changed. For <var>TGridColumn</var>, it sets the value in <var>IsDefaultFont</var> to <b>False</b> and calls the <var>ColumnChanged</var> method.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TGridColumn.IsDefaultFont"/>
|
|
<link id="TGridColumn.ColumnChanged"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TGridColumn.FontChanged.Sender">
|
|
<short>Class instance generating the notification</short>
|
|
</element>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TGridColumn.GetAlignment" link="TGridColumn.Alignment">
|
|
<short>Gets the value for the Alignment property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TGridColumn.GetAlignment.Result">
|
|
<short>Value for the property</short>
|
|
</element>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TGridColumn.GetColor" link="TGridColumn.Color">
|
|
<short>Gets the value for the Color property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TGridColumn.GetColor.Result">
|
|
<short>Value for the property</short>
|
|
</element>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TGridColumn.GetExpanded">
|
|
<short>Gets the value for the Expanded property</short>
|
|
<descr>
|
|
Always returns True in the current implementation.
|
|
</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TGridColumn.GetExpanded.Result">
|
|
<short>Value for the property</short>
|
|
</element>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TGridColumn.GetFont" link="TGridColumn.Font">
|
|
<short>Gets the value for the Font property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TGridColumn.GetFont.Result">
|
|
<short>Value for the property</short>
|
|
</element>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TGridColumn.GetGrid" link="TGridColumn.Grid">
|
|
<short>Gets the value for the Grid property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TGridColumn.GetGrid.Result">
|
|
<short>Value for the property</short>
|
|
</element>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TGridColumn.GetLayout" link="TGridColumn.Layout">
|
|
<short>Gets the value for the Layout property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TGridColumn.GetLayout.Result">
|
|
<short>Value for the property</short>
|
|
</element>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TGridColumn.GetMaxSize" link="TGridColumn.MaxSize">
|
|
<short>Gets the value for the MaxSize property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TGridColumn.GetMaxSize.Result">
|
|
<short>Value for the property</short>
|
|
</element>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TGridColumn.GetMinSize" link="TGridColumn.MinSize">
|
|
<short>Gets the value for the MinSize property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TGridColumn.GetMinSize.Result">
|
|
<short>Value for the property</short>
|
|
</element>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TGridColumn.GetSizePriority" link="TGridColumn.SizePriority">
|
|
<short>Gets the value for the SizePriority property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TGridColumn.GetSizePriority.Result">
|
|
<short>Value for the property</short>
|
|
</element>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TGridColumn.GetPickList" link="TGridColumn.PickList">
|
|
<short>
|
|
<var>GetPickList</var> - returns the picklist as a list of strings
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TGridColumn.GetPickList.Result">
|
|
<short>Value for the property</short>
|
|
</element>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TGridColumn.GetReadOnly" link="TGridColumn.ReadOnly">
|
|
<short>Gets the value for the ReadOnly property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TGridColumn.GetReadOnly.Result">
|
|
<short>Value for the property</short>
|
|
</element>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TGridColumn.GetVisible" link="TGridColumn.Visible">
|
|
<short>Gets the value for the Visible property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TGridColumn.GetVisible.Result">
|
|
<short>Value for the property</short>
|
|
</element>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TGridColumn.GetWidth" link="TGridColumn.Width">
|
|
<short>Gets the value for the Width property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TGridColumn.GetWidth.Result">
|
|
<short>Value for the property</short>
|
|
</element>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TGridColumn.IsAlignmentStored">
|
|
<short>Indicates if the Alignment is used for the class instance</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TGridColumn.Alignment"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TGridColumn.IsAlignmentStored.Result">
|
|
<short>True when Alignment has been assigned in the class instance</short>
|
|
</element>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TGridColumn.IsColorStored">
|
|
<short>Indicates if the Color is used in the class instance</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TGridColumn.Color"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TGridColumn.IsColorStored.Result">
|
|
<short>True when Color has been assigned in the class instance</short>
|
|
</element>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TGridColumn.IsFontStored">
|
|
<short>Indicates if the Font has been assigned for the column</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TGridColumn.IsFontStored.Result">
|
|
<short>True when Font has a value other than the default font</short>
|
|
</element>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TGridColumn.IsLayoutStored">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TGridColumn.IsLayoutStored.Result">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TGridColumn.IsMinSizeStored">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TGridColumn.IsMinSizeStored.Result">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TGridColumn.IsMaxSizeStored">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TGridColumn.IsMaxSizeStored.Result">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TGridColumn.IsReadOnlyStored">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TGridColumn.IsReadOnlyStored.Result">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TGridColumn.IsSizePriorityStored">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TGridColumn.IsSizePriorityStored.Result">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TGridColumn.IsVisibleStored">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TGridColumn.IsVisibleStored.Result">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TGridColumn.IsWidthStored">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TGridColumn.IsWidthStored.Result">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TGridColumn.SetAlignment" link="TGridColumn.Alignment">
|
|
<short>Sets the value in the Alignment property</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TGridColumn.Alignment"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TGridColumn.SetAlignment.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TGridColumn.SetButtonStyle">
|
|
<short>Sets the value in the ButtonStyle property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TGridColumn.SetButtonStyle.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TGridColumn.SetColor">
|
|
<short>Sets the value in the Color property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TGridColumn.SetColor.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TGridColumn.SetExpanded">
|
|
<short>Sets the value in the Expanded property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TGridColumn.SetExpanded.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TGridColumn.SetFont">
|
|
<short>Sets the value in the Font property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TGridColumn.SetFont.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TGridColumn.SetLayout">
|
|
<short>Sets the value in the Layout property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TGridColumn.SetLayout.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TGridColumn.SetMaxSize">
|
|
<short>Sets the value in the MaxSize property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TGridColumn.SetMaxSize.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TGridColumn.SetMinSize">
|
|
<short>Sets the value for the MinSize property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TGridColumn.SetMinSize.Avalue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TGridColumn.SetPickList">
|
|
<short>Sets the value for the PickList property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TGridColumn.SetPickList.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TGridColumn.SetReadOnly">
|
|
<short>Sets the value for the ReadOnly property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TGridColumn.SetReadOnly.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TGridColumn.SetSizePriority">
|
|
<short>Sets the value for the SizePriority property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TGridColumn.SetSizePriority.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TGridColumn.SetTitle">
|
|
<short>Sets the value for the Title property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TGridColumn.SetTitle.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TGridColumn.SetVisible">
|
|
<short>Sets the value for the Visible property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TGridColumn.SetVisible.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TGridColumn.SetWidth">
|
|
<short>Sets the value for the Width property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TGridColumn.SetWidth.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<element link="#rtl.Classes.TPersistent.Assign" name="TGridColumn.Assign"/>
|
|
<element name="TGridColumn.Assign.Source">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element link="#rtl.Classes.TCollectionItem.GetDisplayName" name="TGridColumn.GetDisplayName"/>
|
|
<element name="TGridColumn.GetDisplayName.Result">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TGridColumn.GetDefaultAlignment">
|
|
<short>
|
|
<var>GetDefaultAlignment</var> - returns the default alignment
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TGridColumn.GetDefaultAlignment.Result">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TGridColumn.GetDefaultColor">
|
|
<short>
|
|
<var>GetDefaultColor</var> - returns the default color
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TGridColumn.GetDefaultColor.Result">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TGridColumn.GetDefaultLayout">
|
|
<short>
|
|
<var>GetDefaultLayout</var> - returns the default layout for text
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TGridColumn.GetDefaultLayout.Result">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TGridColumn.GetDefaultMaxSize">
|
|
<short>
|
|
<var>GetDefaultMaxSize</var> -returns the default maximum size
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TGridColumn.GetDefaultMaxSize.Result">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TGridColumn.GetDefaultMinSize">
|
|
<short>
|
|
<var>GetDefaultMinSize</var> - returns the default minimum size
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TGridColumn.GetDefaultMinSize.Result">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TGridColumn.GetDefaultReadOnly">
|
|
<short>
|
|
<var>GetDefaultReadOnly</var> - returns the default value for the <var>ReadOnly</var> property
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TGridColumn.GetDefaultReadOnly.Result">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TGridColumn.GetDefaultSizePriority">
|
|
<short>
|
|
<var>GetDefaultSizePriority</var> - returns the default value for size priority
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TGridColumn.GetDefaultSizePriority.Result">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TGridColumn.GetDefaultVisible">
|
|
<short>
|
|
<var>GetDefaultVisible</var> - returns the default value for the <var>Visible</var> property
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TGridColumn.GetDefaultVisible.Result">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TGridColumn.GetDefaultWidth">
|
|
<short>
|
|
<var>GetDefaultWidth</var> - returns the default value for width
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TGridColumn.GetDefaultWidth.Result">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TGridColumn.ColumnChanged">
|
|
<short>
|
|
<var>ColumnChanged</var> - method for dealing with change in the column
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TGridColumn.AllColumnsChange">
|
|
<short>
|
|
<var>AllColumnsChange</var> - method for processing a change in all columns
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TGridColumn.CreateTitle">
|
|
<short>
|
|
<var>CreateTitle</var> - creates a column title and returns it in the result
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TGridColumn.CreateTitle.Result">
|
|
<short>TGridColumnTitle instance created in the method</short>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TGridColumn.IsDefaultFont">
|
|
<short>
|
|
<var>IsDefaultFont</var> - if True, the default font is being used
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- constructor Visibility: public -->
|
|
<element name="TGridColumn.Create">
|
|
<short>Constructor for the class instance</short>
|
|
<descr>
|
|
<p>
|
|
<var>Create</var> is the constructor for <var>TGridColumn</var>. Create calls the inherited <var>Create</var> method using <var>ACollection</var> as the owner for the collection item. Create allocates resources needed for members in the class instance, and sets the default values for properties such as: <var>Title</var>, <var>Font</var>, <var>IsDefaultFont</var>, <var>ButtonStyle</var> and <var>DropDownRows</var>.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="#rtl.Classes.TCollectionItem.Create">TCollectionItem.Create</link>
|
|
<link id="TGridColumn.Title"/>
|
|
<link id="TGridColumn.Font"/>
|
|
<link id="TGridColumn.IsDefaultFont"/>
|
|
<link id="TGridColumn.ButtonStyle"/>
|
|
<link id="TGridColumn.DropDownRows"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TGridColumn.Create.ACollection">
|
|
<short>Collection which owns the collection item</short>
|
|
</element>
|
|
|
|
<!-- destructor Visibility: public -->
|
|
<element name="TGridColumn.Destroy">
|
|
<short>
|
|
<var>Destroy</var> - destructor for <var>TGridColumn</var>: disposes of various local variables, frees picklist, font and title, then calls inherited <var>Destroy</var>
|
|
</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="#rtl.Classes.TCollectionItem.Destroy"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: public -->
|
|
<element name="TGridColumn.FillDefaultFont">
|
|
<short>
|
|
<var>FillDefaultFont</var> - method to fill all cells in the column with the default font
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TGridColumn.FixDesignFontsPPI">
|
|
<!-- TODO -->
|
|
<short></short>
|
|
<descr>
|
|
<p>
|
|
<var>FixDesignFontsPPI</var> is a procedure used to...
|
|
</p>
|
|
</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TGridColumn.FixDesignFontsPPI.ADesignTime">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TGridColumn.ScaleFontsPPI">
|
|
<!-- TODO -->
|
|
<short></short>
|
|
<descr>
|
|
<p>
|
|
<var>ScaleFontsPPI</var> is an overridden procedure used to...
|
|
</p>
|
|
</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TGridColumn.ScaleFontsPPI.AToPPI">
|
|
<short></short>
|
|
</element>
|
|
<element name="TGridColumn.ScaleFontsPPI.AProportion">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: public -->
|
|
<element name="TGridColumn.IsDefault">
|
|
<short>
|
|
<var>IsDefault</var> - returns True if this column is the default
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TGridColumn.IsDefault.Result">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- Visibility: public -->
|
|
<element name="TGridColumn.Grid">
|
|
<short>The <var>Grid</var> to which this column belongs</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: public -->
|
|
<element name="TGridColumn.WidthChanged">
|
|
<short>
|
|
<var>WidthChanged</var> - if True, width has been changed
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: published -->
|
|
<element name="TGridColumn.Alignment">
|
|
<short>
|
|
<var>Alignment</var> - whether justified, centered, etc
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: published -->
|
|
<element name="TGridColumn.ButtonStyle">
|
|
<short>
|
|
<var>ButtonStyle</var> - the style of any column button
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: published -->
|
|
<element name="TGridColumn.Color">
|
|
<short>The <var>Color</var> for this column</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: published -->
|
|
<element name="TGridColumn.DropDownRows">
|
|
<short>
|
|
<var>DropDownRows</var> - the number of rows in the drop-down list
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: published -->
|
|
<element name="TGridColumn.Expanded">
|
|
<short>
|
|
Whether the column has been <var>Expanded</var>
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: published -->
|
|
<element name="TGridColumn.Font">
|
|
<short>The <var>Font</var> for the column</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: published -->
|
|
<element name="TGridColumn.Layout">
|
|
<short>The <var>Layout</var> for text</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: published -->
|
|
<element name="TGridColumn.MinSize">
|
|
<short>
|
|
<var>MinSize</var> - the minimum size
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: published -->
|
|
<element name="TGridColumn.MaxSize">
|
|
<short>
|
|
<var>MaxSize</var> - the maximum size
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: published -->
|
|
<element name="TGridColumn.PickList">
|
|
<short>
|
|
<var>PickList</var> - the list of items selected from this column
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: published -->
|
|
<element name="TGridColumn.ReadOnly">
|
|
<short>
|
|
<var>ReadOnly</var> - if True, only reading (not writing) is allowed
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: published -->
|
|
<element name="TGridColumn.SizePriority">
|
|
<short>
|
|
<var>SizePriority</var> - the value of the size priority in the sorted order
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: published -->
|
|
<element name="TGridColumn.Title">
|
|
<short>The <var>Title</var> for the column</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: published -->
|
|
<element name="TGridColumn.Width">
|
|
<short>The <var>Width</var> of the column</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: published -->
|
|
<element name="TGridColumn.Visible">
|
|
<short>
|
|
<var>Visible</var> - if True, the column can be seen (i.e. not hidden)
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TGridColumn.GetValueChecked">
|
|
<short>
|
|
<var>GetValueChecked</var> - returns a checked value as a string
|
|
</short>
|
|
</element>
|
|
|
|
<element name="TGridColumn.GetValueUnchecked">
|
|
<short>
|
|
<var>GetValueUnchecked</var> - returns an unchecked value as a string
|
|
</short>
|
|
</element>
|
|
|
|
<element name="TGridColumn.ValueChecked">
|
|
<short>
|
|
<var>ValueChecked</var> - a string value of a checked item
|
|
</short>
|
|
</element>
|
|
|
|
<element name="TGridColumn.ValueUnchecked">
|
|
<short>
|
|
<var>ValueUnchecked</var> - a string value of an unchecked item
|
|
</short>
|
|
</element>
|
|
|
|
<element name="TGridColumn.GetDefaultValueUnchecked">
|
|
<short>
|
|
<var>GetDefaultValueUnchecked</var> - returns the default value for an unchecked column
|
|
</short>
|
|
</element>
|
|
|
|
<!-- record type Visibility: default -->
|
|
<element name="TGridPropertyBackup">
|
|
<short>
|
|
Stores data about rows and columns used in a TCustomGrid class instance
|
|
</short>
|
|
<descr>
|
|
TGridPropertyBackup is a record type used to store data about rows and columns, including fixed cells, used in a TCustomGrid class instance.
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- variable Visibility: default -->
|
|
<element name="TGridPropertyBackup.ValidData">
|
|
<short>
|
|
Indicates if the grid contains valid row or column counts
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- variable Visibility: default -->
|
|
<element name="TGridPropertyBackup.FixedRowCount">
|
|
<short>Number of fixed rows in the grid</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- variable Visibility: default -->
|
|
<element name="TGridPropertyBackup.FixedColCount">
|
|
<short>Number of fixed columns in the grid</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TGridPropertyBackup.RowCount">
|
|
<short>Number of rows in the grid</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TGridPropertyBackup.ColCount">
|
|
<short>Number of columns in the grid</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- object Visibility: default -->
|
|
<element name="TGridColumns">
|
|
<short>
|
|
<var>TGridColumns</var> - the group of columns in the grid
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>TGridColumns</var> is a <var>TCollection</var> descendant that implements a container for column definitions used in <var>TCustomGrid</var> and descendent classes. TGridColumns is the type used to implement the Columns in TCustomGrid.
|
|
</p>
|
|
<p>
|
|
TGridColumns is used to create, access, and maintain <var>TGridColumn</var> class instances representing the columns in a grid. Use the indexed <var>Items</var> to access a <var>TGridColumn</var> instance in the collection using its ordinal position.
|
|
</p>
|
|
<p>
|
|
Additional properties and methods are included in the collection that are relevant to their use with grid column definitions. A reference to the <var>TCustomGrid</var> which owns the collection is maintained to provide access to the properties, methods, and events in the grid.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TGridColumn"/>
|
|
<link id="TCustomGrid.Columns"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- variable Visibility: private -->
|
|
<element name="TGridColumns.FGrid"/>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TGridColumns.GetColumn">
|
|
<short>Gets the value for the indexed Items property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TGridColumns.GetColumn.Result">
|
|
<short>Collection the collection item at the specified position</short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TGridColumns.GetColumn.Index">
|
|
<short>Ordinal position for the requested collection item</short>
|
|
</element>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TGridColumns.GetEnabled">
|
|
<short>Gets the value in the Enabled property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TGridColumns.GetEnabled.Result">
|
|
<short>Value for the property</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TGridColumns.SetColumn">
|
|
<short>Sets the item at the specified position in the Items property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TGridColumns.SetColumn.Index">
|
|
<short>Ordinal position for the collection item updated in the method</short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TGridColumns.SetColumn.Value">
|
|
<short>Value stored at the specified position in the collection</short>
|
|
</element>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TGridColumns.GetVisibleCount">
|
|
<short>Gets the value for the VisibleCount property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TGridColumns.GetVisibleCount.Result">
|
|
<short>Value for the property</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TGridColumns.Update" link="#rtl.Classes.TCollection.Update">
|
|
<short>Notifies the Grid using the collection when a column is updated</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TGridColumns.Update.Item">
|
|
<short>Collection item requiring the update notification</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TGridColumns.TitleFontChanged">
|
|
<short>
|
|
Performs action needed when the title font is changed for items in the collection
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>TitleFontChanged</var> is a procedure used to perform actions needed when the title font for a grid has been changed. TitleFontChanged examines each of the column definitions in the collection, and updates the default font for the column when it has not been set to another value. TitleFontChanged is called during execution of the <var>OnTitleFontChanged</var> event handler in <var>TCustomGrid</var>.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.TitleFont"/>
|
|
<link id="TGridColumnTitle.Font"/>
|
|
<link id="TGridColumnTitle.IsDefault"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TGridColumns.FontChanged">
|
|
<short>
|
|
<var>FontChanged</var> - method to deal with a change in font for the columns
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TGridColumns.RemoveColumn">
|
|
<short>
|
|
<var>RemoveColumn</var> - method to remove the specified column
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TGridColumns.RemoveColumn.Index">
|
|
<short>Ordinal position of the column to remove in the method</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TGridColumns.MoveColumn">
|
|
<short>
|
|
<var>MoveColumn</var> from the first index to the second
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TGridColumns.MoveColumn.FromIndex">
|
|
<short>Original position for the column moved in the method</short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TGridColumns.MoveColumn.ToIndex">
|
|
<short>New position for the column moved in the method</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TGridColumns.ExchangeColumn">
|
|
<short>
|
|
<var>ExchangeColumn</var> - exchange the position of the current column with the specified other column
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TGridColumns.ExchangeColumn.Index">
|
|
<short>Position of a column exchanged in the method</short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TGridColumns.ExchangeColumn.WithIndex">
|
|
<short>Position of the other column exchanged in the method</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TGridColumns.InsertColumn">
|
|
<short>
|
|
<var>InsertColumn</var> with the specified index
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TGridColumns.InsertColumn.Index">
|
|
<short>Position in the collection where the column is inserted</short>
|
|
</element>
|
|
|
|
<!-- constructor Visibility: public -->
|
|
<element name="TGridColumns.Create">
|
|
<short>
|
|
<var>Create</var> - constructor for <var>TGridColumns</var>: calls inherited <var>Create</var> then loads the grid
|
|
</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="#rtl.Classes.TCollection.Create">TCollection.Create</link>
|
|
</seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TGridColumns.Create.AGrid">
|
|
<short>Grid which owns the collection of column definitions</short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TGridColumns.Create.aItemClass">
|
|
<short>Class reference used to create new items in the collection</short>
|
|
</element>
|
|
|
|
<!-- function Visibility: public -->
|
|
<element link="#rtl.Classes.TCollection.Add" name="TGridColumns.Add"/>
|
|
<element name="TGridColumns.Add.Result">
|
|
<short>Column added to the collection</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: public -->
|
|
<element link="#rtl.Classes.TCollection.Clear" name="TGridColumns.Clear">
|
|
<short>Clears all items in the collection</short>
|
|
<descr>
|
|
<p>
|
|
<var>Clear</var> calls <var>BeginUpdate</var> to suppress notifications when items are removed from the collection. It also calls <var>EndUpdate</var> when all items have been removed in the method. Clear calls the inherited method to remove the items in the collection.
|
|
</p>
|
|
</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- function Visibility: public -->
|
|
<element name="TGridColumns.RealIndex">
|
|
<short>
|
|
<var>RealIndex</var> - the proper index for this column
|
|
</short>
|
|
<descr>
|
|
Real in this sense means proper or correct, not a Real number (as it is specified as an integer)
|
|
</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TGridColumns.RealIndex.Result">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TGridColumns.RealIndex.Index">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: public -->
|
|
<element name="TGridColumns.IndexOf">
|
|
<short>
|
|
Gets the ordinal position in the collection for the specified item
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>IndexOf</var> is an <var>Integer</var> function used to get the ordinal position in the collection for the <var>TGridColumn</var> instance specified in <var>Column</var>. The return value contains the ordinal position (in the range <b>0</b> to <b>Count-1</b>), or <b>-1</b> when no items exist in the collection or when <var>Column</var> cannot be located in the container.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TGridColumns.Items"/>
|
|
<link id="TGridColumn"/>
|
|
<link id="#RTL.Classes.TCollection.Count"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TGridColumns.IndexOf.Result">
|
|
<short>Ordinal position for the collection item, or -1 when not found</short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TGridColumns.IndexOf.Column">
|
|
<short>Grid column to locate in the collection</short>
|
|
</element>
|
|
|
|
<!-- function Visibility: public -->
|
|
<element name="TGridColumns.IsDefault">
|
|
<short>
|
|
<var>IsDefault</var> returns True if this is the default column
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TGridColumns.IsDefault.Result">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: public -->
|
|
<element name="TGridColumns.HasIndex">
|
|
<short>
|
|
<var>HasIndex</var> - returns True if the current column has an index value
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TGridColumns.HasIndex.Result">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TGridColumns.HasIndex.Index">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: public -->
|
|
<element name="TGridColumns.VisibleIndex">
|
|
<short>
|
|
<var>VisibleIndex</var> - the index value of a visible column
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TGridColumns.VisibleIndex.Result">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TGridColumns.VisibleIndex.Index">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- Visibility: public -->
|
|
<element name="TGridColumns.Grid">
|
|
<short>
|
|
The <var>Grid</var> to which the current collection of columns belongs
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>Grid</var> is a read-only <var>TCustomGrid</var> which provides access to the grid which owns the column collection. The value in Grid is set in the constructor to an argument passed to the method, and used as the value for the <var>Owner</var> property.
|
|
</p>
|
|
<p>
|
|
Grid can be used to access the properties, methods, and events in the grid class instance. It is used in the implementation of methods in the collection, such as <var>Update</var> and <var>InsertColumn</var>.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.CreateColumns"/>
|
|
<link id="TCustomGrid.ColumnsChanged"/>
|
|
<link id="TGridColumns.InsertColumn"/>
|
|
<link id="TGridColumns.Update"/>
|
|
<link id="#RTL.Classes.TCollection.Owner"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: public -->
|
|
<element name="TGridColumns.Items">
|
|
<short>
|
|
Provides indexed access to column definitions in the collection
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>Items</var> is an indexed <var>TGridColumn</var> used to access column definitions in the collection by the ordinal position specified in the <var>Index</var> argument. Items is the default for the collection.
|
|
</p>
|
|
<p>
|
|
Use <var>Add</var> to create and store a new instance of <var>TGridColumn</var> in the collection.
|
|
</p>
|
|
<p>
|
|
Use <var>InsertColumn</var> to create and store a new collection item at a specific position in the collection.
|
|
</p>
|
|
<p>
|
|
Use <var>RemoveColumn</var>, <var>Delete</var> or <var>Clear</var> to remove one or all item(s) in the collection.
|
|
</p>
|
|
<p>
|
|
Use <var>IndexOf</var> to get the ordinal position in the collection for an existing <var>TGridColumn</var> class instance.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TGridColumns.Clear"/>
|
|
<link id="TGridColumns.IndexOf"/>
|
|
<link id="TGridColumns.Add"/>
|
|
<link id="TGridColumns.InsertColumn"/>
|
|
<link id="TGridColumns.RemoveColumn"/>
|
|
<link id="#RTL.Classes.TCollection.Delete"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TGridColumns.Items.Index">
|
|
<short>Ordinal position for the column definition used as the value</short>
|
|
</element>
|
|
|
|
<!-- Visibility: public -->
|
|
<element name="TGridColumns.VisibleCount">
|
|
<short>
|
|
<var>VisibleCount</var> - the number of visible columns
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: public -->
|
|
<element name="TGridColumns.Enabled">
|
|
<short>
|
|
If True, the columns are <var>Enabled</var>
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- alias type Visibility: default -->
|
|
<element name="TGridCoord">
|
|
<short>Stores mouse coordinates in screen pixels</short>
|
|
<descr>
|
|
<p>
|
|
<var>TGridCoordinate</var> is an alias for the <var>TPoint</var> type, and used to capture mouse coordinates in <var>TCustomGrid</var> and descendent classes. The <var>X</var> and <var>Y</var> coordinates refer to screen pixels, and are derived from the row and column numbers for the corresponding cell.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.MouseCoord"/>
|
|
<link id="TCustomGrid.MouseToCell"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- alias type Visibility: default -->
|
|
<element name="TGridRect">
|
|
<short></short>
|
|
<descr>
|
|
TGridRect is an alias for the TRect type.
|
|
</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TGridRectArray">
|
|
<short></short>
|
|
<descr>
|
|
TGridRectArray is an array type used to store TGridRect values.
|
|
</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TSizingRec">
|
|
<short>
|
|
Stores size and movement data for columns or rows in a grid
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>TSizingRec</var> is a record type used to store size and movement information for columns or rows in TCustomGrid and descendent classes. TSizingRec is the type used for an internal member in TCustomGrid.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.MouseMove"/>
|
|
<link id="TCustomGrid.MouseUp"/>
|
|
<link id="TCustomGrid.DblClick"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TSizingRec.Index">
|
|
<short></short>
|
|
</element>
|
|
<element name="TSizingRec.OffIni">
|
|
<short></short>
|
|
</element>
|
|
<element name="TSizingRec.OffEnd">
|
|
<short></short>
|
|
</element>
|
|
<element name="TSizingRec.DeltaOff">
|
|
<short></short>
|
|
</element>
|
|
<element name="TSizingRec.PrevLine">
|
|
<short></short>
|
|
</element>
|
|
<element name="TSizingRec.PrevOffset">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- record type Visibility: default -->
|
|
<element name="TGridDataCache">
|
|
<short>
|
|
Stores cache information about a grid control
|
|
</short>
|
|
<descr>
|
|
TGridDataCache is a record type used to store and cache information about a grid control, its layout, and activity. TGridDataCache is the type used to implement the GCache in TCustomGrid.
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.GCache"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- variable Visibility: default -->
|
|
<element name="TGridDataCache.FixedWidth">
|
|
<short></short>
|
|
<descr>
|
|
Sum of the column widths for fixed cells in a grid.
|
|
</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- variable Visibility: default -->
|
|
<element name="TGridDataCache.FixedHeight">
|
|
<short></short>
|
|
<descr>
|
|
Sum of the row heights for fixed cells in a grid.
|
|
</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- variable Visibility: default -->
|
|
<element name="TGridDataCache.GridWidth">
|
|
<short></short>
|
|
<descr>
|
|
Sum of the column widths for all cells in a grid.
|
|
</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- variable Visibility: default -->
|
|
<element name="TGridDataCache.GridHeight">
|
|
<short></short>
|
|
<descr>
|
|
Sum of the row heights for all cells in a grid.
|
|
</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- variable Visibility: default -->
|
|
<element name="TGridDataCache.ClientWidth">
|
|
<short></short>
|
|
<descr>
|
|
Width of the grid control minus the width for the vertical scrollbar.
|
|
</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- variable Visibility: default -->
|
|
<element name="TGridDataCache.ClientHeight">
|
|
<short></short>
|
|
<descr>
|
|
Height of the grid control minus the width of the horizontal scrollbar.
|
|
</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- variable Visibility: default -->
|
|
<element name="TGridDataCache.ScrollWidth">
|
|
<short></short>
|
|
<descr>
|
|
Difference between ClientWidth and FixedWidth.
|
|
</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- variable Visibility: default -->
|
|
<element name="TGridDataCache.ScrollHeight">
|
|
<short></short>
|
|
<descr>
|
|
Difference between ClientHeight and FixedHeight.
|
|
</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TGridDataCache.HScrollBarNetRange">
|
|
<short></short>
|
|
<descr>
|
|
Difference between the scrollbar range and the grid page
|
|
</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- variable Visibility: default -->
|
|
<element name="TGridDataCache.VisibleGrid">
|
|
<short></short>
|
|
<descr>
|
|
Visible non-fixed rectangle of cell coordinates.
|
|
</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- variable Visibility: default -->
|
|
<element name="TGridDataCache.MaxClientXY">
|
|
<short></short>
|
|
<descr>
|
|
Bottom/Right coordinates in (pixels) for the visible parts of a grid.
|
|
</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- variable Visibility: default -->
|
|
<element name="TGridDataCache.ValidRows">
|
|
<short></short>
|
|
<descr>
|
|
True when there are no fixed columns to display in a grid.
|
|
</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- variable Visibility: default -->
|
|
<element name="TGridDataCache.ValidCols">
|
|
<short></short>
|
|
<descr>
|
|
True when there are no fixed rows to display in the grid.
|
|
</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- variable Visibility: default -->
|
|
<element name="TGridDataCache.ValidGrid">
|
|
<short></short>
|
|
<descr>
|
|
True when there are no fixed cells for columns or rows in a grid.
|
|
</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- variable Visibility: default -->
|
|
<element name="TGridDataCache.AccumWidth">
|
|
<short></short>
|
|
<descr>
|
|
Cumulative width for all columns in a grid.
|
|
</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- variable Visibility: default -->
|
|
<element name="TGridDataCache.AccumHeight">
|
|
<short></short>
|
|
<descr>
|
|
Cumulative height for all rows in a grid.
|
|
</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- variable Visibility: default -->
|
|
<element name="TGridDataCache.TLColOff">
|
|
<short></short>
|
|
<descr>
|
|
Offset in pixels for the Top/Left column in a grid.
|
|
</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- variable Visibility: default -->
|
|
<element name="TGridDataCache.TLRowOff">
|
|
<short></short>
|
|
<descr>
|
|
Offset in pixels for the Top/Left row in a grid.
|
|
</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- variable Visibility: default -->
|
|
<element name="TGridDataCache.MaxTopLeft">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TGridDataCache.MaxTLOffset">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- variable Visibility: default -->
|
|
<element name="TGridDataCache.HotCell">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- variable Visibility: default -->
|
|
<element name="TGridDataCache.HotCellPainted">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- variable Visibility: default -->
|
|
<element name="TGridDataCache.HotGridZone">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- variable Visibility: default -->
|
|
<element name="TGridDataCache.ClickCell">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- variable Visibility: default -->
|
|
<element name="TGridDataCache.ClickMouse">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- variable Visibility: default -->
|
|
<element name="TGridDataCache.PushedCell">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- variable Visibility: default -->
|
|
<element name="TGridDataCache.PushedMouse">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- variable Visibility: default -->
|
|
<element name="TGridDataCache.ClickCellPushed">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TGridDataCache.FullVisibleGrid">
|
|
<short></short>
|
|
<descr>Visible cells excluding partially visible cells</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TGridDataCache.MouseCell">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TGridDataCache.OldMaxTopLeft">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TGridCursorState">
|
|
<short>Enumerated type with cursors available in a grid</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TGridCursorState.gcsDefault">
|
|
<short>Normal cursor shape/style</short>
|
|
</element>
|
|
<element name="TGridCursorState.gcsColWidthChanging">
|
|
<short>Cursor displayed when changing the size of a column</short>
|
|
</element>
|
|
<element name="TGridCursorState.gcsRowHeightChanging">
|
|
<short>Cursor displayed when resizing the height of a row</short>
|
|
</element>
|
|
<element name="TGridCursorState.gcsDragging">
|
|
<short>Cursor displayed when dragging a row or column</short>
|
|
</element>
|
|
|
|
<!-- object Visibility: default -->
|
|
<element name="TCustomGrid">
|
|
<short>
|
|
<var>TCustomGrid</var> - the base class for all grid controls
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
A grid is a collection of cells that are organized in columns and rows. Grids are suitable for showing data that using a tabular layout, for example tables in a database, or formulae and data in a spreadsheet.
|
|
</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 <link id="TCustomGrid.DefaultRowHeight">DefaultRowHeight</link> 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> 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> 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 OnSelectCell 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"/>
|
|
<link id="HowToUseGrids"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.FAlternateColor"/>
|
|
<element name="TCustomGrid.FAutoAdvance"/>
|
|
<element name="TCustomGrid.FAutoEdit"/>
|
|
<element name="TCustomGrid.FAutoFillColumns"/>
|
|
<element name="TCustomGrid.FBorderColor"/>
|
|
<element name="TCustomGrid.FDefaultDrawing"/>
|
|
<element name="TCustomGrid.FEditor"/>
|
|
<element name="TCustomGrid.FEditorHidingCount"/>
|
|
<element name="TCustomGrid.FEditorMode"/>
|
|
<element name="TCustomGrid.FEditorOldValue"/>
|
|
<element name="TCustomGrid.FEditorShowing"/>
|
|
<element name="TCustomGrid.FEditorKey"/>
|
|
<element name="TCustomGrid.FEditorOptions"/>
|
|
<element name="TCustomGrid.FExtendedSelect"/>
|
|
<element name="TCustomGrid.FFastEditing"/>
|
|
<element name="TCustomGrid.FAltColorStartNormal"/>
|
|
<element name="TCustomGrid.FFlat"/>
|
|
<element name="TCustomGrid.FOnAfterSelection"/>
|
|
<element name="TCustomGrid.FOnLoadColumn"/>
|
|
<element name="TCustomGrid.FOnSaveColumn"/>
|
|
<element name="TCustomGrid.FRangeSelectMode"/>
|
|
<element name="TCustomGrid.FSelections"/>
|
|
<element name="TCustomGrid.FOnUserCheckboxBitmap"/>
|
|
<element name="TCustomGrid.FOnUserCheckboxImage"/>
|
|
<element name="TCustomGrid.FSortOrder"/>
|
|
<element name="TCustomGrid.FSortColumn"/>
|
|
<element name="TCustomGrid.FSortLCLImages"/>
|
|
<element name="TCustomGrid.FTabAdvance"/>
|
|
<element name="TCustomGrid.FTitleImageList"/>
|
|
<element name="TCustomGrid.FTitleImageListWidth"/>
|
|
<element name="TCustomGrid.FTitleStyle"/>
|
|
<element name="TCustomGrid.FAscImgInd"/>
|
|
<element name="TCustomGrid.FDescImgInd"/>
|
|
<element name="TCustomGrid.FOnCompareCells"/>
|
|
<element name="TCustomGrid.FGridLineStyle"/>
|
|
<element name="TCustomGrid.FGridLineWidth"/>
|
|
<element name="TCustomGrid.FDefColWidth"/>
|
|
<element name="TCustomGrid.FDefRowHeight"/>
|
|
<element name="TCustomGrid.FRealizedDefColWidth"/>
|
|
<element name="TCustomGrid.FRealizedDefRowHeight"/>
|
|
<element name="TCustomGrid.FCol"/>
|
|
<element name="TCustomGrid.FRow"/>
|
|
<element name="TCustomGrid.FFixedCols"/>
|
|
<element name="TCustomGrid.FFixedRows"/>
|
|
<element name="TCustomGrid.FOnEditButtonClick"/>
|
|
<element name="TCustomGrid.FOnButtonClick"/>
|
|
<element name="TCustomGrid.FOnPickListSelect"/>
|
|
<element name="TCustomGrid.FOnCheckboxToggled"/>
|
|
<element name="TCustomGrid.FOnPrepareCanvas"/>
|
|
<element name="TCustomGrid.FOnSelectEditor"/>
|
|
<element name="TCustomGrid.FOnValidateEntry"/>
|
|
<element name="TCustomGrid.FGridLineColor"/>
|
|
<element name="TCustomGrid.FFixedGridLineColor"/>
|
|
<element name="TCustomGrid.FFixedColor"/>
|
|
<element name="TCustomGrid.FFixedHotColor"/>
|
|
<element name="TCustomGrid.FFocusColor"/>
|
|
<element name="TCustomGrid.FSelectedColor"/>
|
|
<element name="TCustomGrid.FDisabledFontColor"/>
|
|
<element name="TCustomGrid.FFocusRectVisible"/>
|
|
<element name="TCustomGrid.FCols"/>
|
|
<element name="TCustomGrid.FRows"/>
|
|
<element name="TCustomGrid.FSaveOptions"/>
|
|
<element name="TCustomGrid.FScrollBars"/>
|
|
<element name="TCustomGrid.FSelectActive"/>
|
|
<element name="TCustomGrid.FTopLeft"/>
|
|
<element name="TCustomGrid.FPivot"/>
|
|
<element name="TCustomGrid.FRange"/>
|
|
<element name="TCustomGrid.FDragDx"/>
|
|
<element name="TCustomGrid.FMoveLast"/>
|
|
<element name="TCustomGrid.FUpdateCount"/>
|
|
<element name="TCustomGrid.FGCache"/>
|
|
<element name="TCustomGrid.FOptions"/>
|
|
<element name="TCustomGrid.FOptions2"/>
|
|
<element name="TCustomGrid.FOnDrawCell"/>
|
|
<element name="TCustomGrid.FOnBeforeSelection"/>
|
|
<element name="TCustomGrid.FOnSelection"/>
|
|
<element name="TCustomGrid.FOnTopLeftChanged"/>
|
|
<element name="TCustomGrid.FUseXORFeatures"/>
|
|
<element name="TCustomGrid.FValidateOnSetSelection"/>
|
|
<element name="TCustomGrid.FVSbVisible"/>
|
|
<element name="TCustomGrid.FHSbVisible"/>
|
|
<element name="TCustomGrid.FDefaultTextStyle"/>
|
|
<element name="TCustomGrid.FLastWidth"/>
|
|
<element name="TCustomGrid.FTitleFont"/>
|
|
<element name="TCustomGrid.FLastFont"/>
|
|
<element name="TCustomGrid.FTitleFontIsDefault"/>
|
|
<element name="TCustomGrid.FColumns"/>
|
|
<element name="TCustomGrid.FButtonEditor"/>
|
|
<element name="TCustomGrid.FStringEditor"/>
|
|
<element name="TCustomGrid.FButtonStringEditor"/>
|
|
<element name="TCustomGrid.FPickListEditor"/>
|
|
<element name="TCustomGrid.FExtendedColSizing"/>
|
|
<element name="TCustomGrid.FExtendedRowSizing"/>
|
|
<element name="TCustomGrid.FUpdatingAutoFillCols"/>
|
|
<element name="TCustomGrid.FGridBorderStyle"/>
|
|
<element name="TCustomGrid.FGridFlags"/>
|
|
<element name="TCustomGrid.FGridPropBackup"/>
|
|
<element name="TCustomGrid.FStrictSort"/>
|
|
<element name="TCustomGrid.FIgnoreClick"/>
|
|
<element name="TCustomGrid.FAllowOutboundEvents"/>
|
|
<element name="TCustomGrid.FColumnClickSorts"/>
|
|
<element name="TCustomGrid.FHeaderHotZones"/>
|
|
<element name="TCustomGrid.FHeaderPushZones"/>
|
|
<element name="TCustomGrid.FCursorChangeLock"/>
|
|
<element name="TCustomGrid.FCursorState"/>
|
|
<element name="TCustomGrid.FColRowDragIndicatorColor"/>
|
|
<element name="TCustomGrid.FSavedCursor"/>
|
|
<element name="TCustomGrid.FSpecialCursors"/>
|
|
<element name="TCustomGrid.FSizing"/>
|
|
<element name="TCustomGrid.FRowAutoInserted"/>
|
|
<element name="TCustomGrid.FMouseWheelOption"/>
|
|
<element name="TCustomGrid.FSavedHint"/>
|
|
<element name="TCustomGrid.FCellHintPriority"/>
|
|
<element name="TCustomGrid.FOnGetCellHint"/>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TCustomGrid.AdjustCount">
|
|
<short>Adjusts a row or column count</short>
|
|
<descr>
|
|
<p>
|
|
<var>AdjustCount</var> is a procedure used to adjust the row or column count for the grid, and to update properties and cache information for the grid.
|
|
</p>
|
|
<p>
|
|
<var>IsColumn</var> indicates if the <var>OldValue</var> and <var>NewValue</var> arguments refer to the column or row count for the grid; when IsColumn is <b>True</b>, the values refer to the column count.
|
|
</p>
|
|
<p>
|
|
<var>OldValue</var> contains the previous row or column count in the grid.
|
|
</p>
|
|
<p>
|
|
<var>NewValue</var> contains the row or column count on exit from the method.
|
|
</p>
|
|
<p>
|
|
AdjustCount is called when the value in the <var>RowCount</var> or <var>ColCount</var> is changed. It calls the <var>UpdateCachedSizes</var> and <var>SizeChanged</var> methods. It may also call <var>FixPos</var> when NewValue causes the row or column to be out of range for the grid control.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.ColCount"/>
|
|
<link id="TCustomGrid.SetColCount"/>
|
|
<link id="TCustomGrid.InternalSetColCount"/>
|
|
<link id="TCustomGrid.RowCount"/>
|
|
<link id="TCustomGrid.SetRowCount"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.AdjustCount.IsColumn">
|
|
<short>True when the count values are for a columns instead of rows</short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.AdjustCount.OldValue">
|
|
<short>Count value before adjustment</short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.AdjustCount.NewValue">
|
|
<short>Count value after adjustment</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TCustomGrid.CacheVisibleGrid">
|
|
<short>
|
|
Stores visible parts of the grid (excluding fixed cells) in the grid cache
|
|
</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.ScrollBy"/>
|
|
<link id="TCustomGrid.VisualChange"/>
|
|
<link id="TCustomGrid.ResetSizes"/>
|
|
<link id="TCustomGrid.ResetOffset"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.CancelSelection">
|
|
<short>Removes the range selection active in the grid</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.SetSelection"/>
|
|
<link id="TCustomGrid.MouseDown"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TCustomGrid.CheckFixedCount">
|
|
<short>Ensures that row and column numbers for fixed cells are valid</short>
|
|
<descr></descr>
|
|
<errors>
|
|
Raises an EGridException if values in row or column numbers for fixed cells contain negative values, or are not in range for the grid control.
|
|
</errors>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.CheckFixedCount.aCol">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.CheckFixedCount.aRow">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.CheckFixedCount.aFCol">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.CheckFixedCount.aFRow">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TCustomGrid.CheckCount">
|
|
<short>
|
|
Ensures that a handle has been allocated for the grid prior to actions that affect the row or column count
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.CheckCount.aNewColCount">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.CheckCount.aNewRowCount">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.CheckIndex">
|
|
<short>Ensures a row or column index is not out of range</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.Sort"/>
|
|
<link id="TCustomGrid.DoOPMoveColRow"/>
|
|
<link id="TCustomGrid.DoOPDeleteColRow"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TCustomGrid.CheckIndex.IsColumn">
|
|
<short>True when the Index is for a column; False when it is for a Row</short>
|
|
</element>
|
|
<element name="TCustomGrid.CheckIndex.Index">
|
|
<short>Value examined in the method</short>
|
|
</element>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TCustomGrid.CheckTopLeft">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.CheckTopLeft.Result">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.CheckTopLeft.aCol">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.CheckTopLeft.aRow">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.CheckTopLeft.CheckCols">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.CheckTopLeft.CheckRows">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.GetQuickColRow">
|
|
<short>Gets the value for the ColRow property</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.ColRow"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TCustomGrid.GetQuickColRow.Result">
|
|
<short>Value for the property</short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.SetQuickColRow">
|
|
<short>Sets the value for the ColRow property</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.ColRow"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TCustomGrid.SetQuickColRow.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.IsCellButtonColumn">
|
|
<short>
|
|
Indicates if the cell at the specified coordinates is a non-fixed cell, and uses a button-style column editor
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.IsCellButtonColumn.Result">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.IsCellButtonColumn.ACell">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.GetSelectedColumn" link="TCustomGrid.SelectedColumn">
|
|
<short>Gets the value for the SelectedColumn property</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.SelectedColumn"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TCustomGrid.GetSelectedColumn.Result">
|
|
<short>Value for the property</short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.SetAlternateColor" link="TCustomGrid.AlternateColor">
|
|
<short>Sets the value in the AlternateColor property</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.AlternateColor"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TCustomGrid.SetAlternateColor.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TCustomGrid.SetAutoFillColumns" link="TCustomGrid.AutoFillColumns">
|
|
<short>Sets the value in the AutoFillColumns property</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.AutoFillColumns"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.SetAutoFillColumns.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.SetBorderColor" link="TCustomGrid.BorderColor">
|
|
<short>Sets the value for the BorderColor property</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.BorderColor"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TCustomGrid.SetBorderColor.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.SetColumnClickSorts" link="TCustomGrid.ColumnClickSorts">
|
|
<short>Sets the value for the ColumnClickSorts property</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.ColumnClickSorts"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TCustomGrid.SetColumnClickSorts.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.SetColumns" link="TCustomGrid.Columns">
|
|
<short>Sets the value for the Columns property</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.Columns"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TCustomGrid.SetColumns.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.SetEditorOptions" link="TCustomGrid.EditorOptions">
|
|
<short>Sets the value for the EditorOptions property</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.EditorOptions"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TCustomGrid.SetEditorOptions.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.SetEditorBorderStyle" link="TCustomGrid.EditorBorderStyle">
|
|
<short>Sets the value for the EditorBorderStyle property</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.EditorBorderStyle"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TCustomGrid.SetEditorBorderStyle.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.SetAltColorStartNormal" link="TCustomGrid.AltColorStartNormal">
|
|
<short>Sets the value for the AltColorStartNormal property</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.AltColorStartNormal"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TCustomGrid.SetAltColorStartNormal.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TCustomGrid.SetFlat" link="TCustomGrid.Flat">
|
|
<short>Sets the value for the Flat property</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.Flat"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.SetFlat.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TCustomGrid.SetFocusRectVisible">
|
|
<short>Sets the value for the FocusRectVisible property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.SetFocusRectVisible.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.SetTitleImageList">
|
|
<short>Sets the value for the TitleImageList property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.SetTitleImageList.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.SetTitleImageListWidth">
|
|
<short>Sets the value for the TitleImageListWidth property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.SetTitleImageListWidth.aTitleImageListWidth">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.SetTitleFont">
|
|
<short>Sets the value for the TitleFont property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.SetTitleFont.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.SetTitleStyle">
|
|
<short>Sets the value for the TitleStyle property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.SetTitleStyle.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.SetUseXorFeatures">
|
|
<short>Sets the value for the UseXorFeatures property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.SetUseXorFeatures.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TCustomGrid.doColSizing">
|
|
<short>Performs actions needed when a column in the grid is resized</short>
|
|
<descr>
|
|
<p>
|
|
<var>doColSizing</var> is a <var>Boolean</var> function used to perform actions needed when a column in the grid is resized. <var>X</var> and <var>Y</var> contain the mouse coordinates where the action was initiated. The return value contains <b>True</b> when the resizing operation is successfully completed.
|
|
</p>
|
|
<p>
|
|
No actions are performed in doColSizing if the GridState member contains any value other than <var>gsColSizing</var>. The GridFlags member is updated to include the value <var>gfSizingStarted</var>, and the <var>ResizeColumn</var> and <var>HeaderSizing</var> methods are called to reflect the altered column size.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link ied="TCustomGrid.Options"/>
|
|
<link id="TGridOptions.goColSizing"/>
|
|
<link id="TCustomGrid.MouseMove"/>
|
|
<link id="TGridFlagsOption.gfSizingStarted"/>
|
|
<link id="TGridFlags"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.doColSizing.Result">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.doColSizing.X">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.doColSizing.Y">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TCustomGrid.doRowSizing">
|
|
<short>Performs actions needed when a grid row is resized</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.doRowSizing.Result">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.doRowSizing.X">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.doRowSizing.Y">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TCustomGrid.doColMoving">
|
|
<short>Performs actions needed to move or drag a grid column</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.doColMoving.X">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.doColMoving.Y">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TCustomGrid.doRowMoving">
|
|
<short>Performs actions needed to move or drag a grid row</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.doRowMoving.X">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.doRowMoving.Y">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.doPushCell">
|
|
<short>Performs actions needed to render a cell using its "Pushed" appearance</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.StartPushCell"/>
|
|
<link id="TCustomGrid.MouseDown"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TCustomGrid.doTopleftChange">
|
|
<short>
|
|
Performs actions needed when the origin or dimensions for the grid are changed
|
|
</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.SetFixedCols"/>
|
|
<link id="TCustomGrid.ScrollToCell"/>
|
|
<link id="TCustomGrid.CheckTopLeft"/>
|
|
<link id="TCustomGrid.FixScroll"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.doTopleftChange.DimChg">
|
|
<short>True when the dimensions for the grid have been altered</short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.DrawXORVertLine">
|
|
<short>
|
|
Draws a vertical line at the specified horizontal location using XOR pen mode
|
|
</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.doColSizing"/>
|
|
<link id="TCustomGrid.MouseUp"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TCustomGrid.DrawXORVertLine.X">
|
|
<short>Horizontal location where the vertical grid line is drawn</short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.DrawXORHorzLine">
|
|
<short>
|
|
Draws a horiizontal line at the specified vertical location using XOR pen mode
|
|
</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id=""/>
|
|
<link id=""/>
|
|
<link id=""/>
|
|
<link id=""/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TCustomGrid.DrawXORHorzLine.Y">
|
|
<short>Vertical location where the horizontal grid line is drawn</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TCustomGrid.EditorGetValue">
|
|
<short>Gets the value for a cell editor</short>
|
|
<descr>
|
|
<p>
|
|
<var>EditorGetValue</var> is a <var>Boolean</var> function used to get the value for a cell editor in the grid. EditorGetValue is used in the implementation of <var>TCustomGrid</var> methods like: <var>EditorShowInCell</var>, <var>ResetEditor</var>, <var>MoveExtend</var>, and <var>DestroyHandle</var>. It is used to get the cell value prior to editing, and to display the value from the cell editor when it is hidden.
|
|
</p>
|
|
<p>
|
|
<var>Validate</var> is a <var>Boolean</var> argument that indicates if the <var>ValidateEntry</var> method is called to validate the edited cell value. When it contains <b>True</b>, <var>ValidateEntry</var> is called prior to calling <var>EditorDoSetValue</var> and/or <var>EditorHide</var>.
|
|
</p>
|
|
<p>
|
|
The return value contains <b>True</b> when the edited cell value is valid. It also contains <b>True</b> if a cell editor has not been assigned or is not visible, or the method was called at design-time or during component destruction.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.ResetEditor"/>
|
|
<link id="TCustomGrid.DestroyHandle"/>
|
|
<link id="TCustomGrid.MoveExtend"/>
|
|
<link id="TCustomGrid.EditorShowInCell"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TCustomGrid.EditorGetValue.Result">
|
|
<short>True when the cell is valid or has not been altered</short>
|
|
</element>
|
|
<element name="TCustomGrid.EditorGetValue.Validate">
|
|
<short>Indicates the cell value is validated using ValidateEntry</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TCustomGrid.EditorPos">
|
|
<short>Sets the position and size for an active cell editor in the grid</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TCustomGrid.EditorShowChar">
|
|
<short>Applies a UTF-8-encoded character value to the active cell editor</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.EditorShowChar.Ch">
|
|
<short>UTF-8-encoded character applied in the method</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TCustomGrid.EditorSetMode" link="TCustomGrid.EditorMode">
|
|
<short>Sets the value for the EditorMode property</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.EditorMode"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.EditorSetMode.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TCustomGrid.EditorSetValue">
|
|
<short>Changes the cell editor position and value at run-time</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.DoEditorHide"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TCustomGrid.EditorAlwaysShown">
|
|
<short>
|
|
Indicates if a cell editor is always displayed for an active cell in the grid
|
|
</short>
|
|
<descr>
|
|
The return value is True when editing is allowed for the cell, it is not a fixed cell, and goAlwaysShowEditor is included in the Options property.
|
|
</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.EditorAlwaysShown.Result">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.FixPosition">
|
|
<short>
|
|
Ensures that row and column positions, and selection(s) are valid for the grid
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.FixPosition.IsColumn">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.FixPosition.aIndex">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.FixScroll">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TCustomGrid.GetLeftCol">
|
|
<short>Gets the value for LeftCol property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.GetLeftCol.Result">
|
|
<short>Value for the property</short>
|
|
</element>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TCustomGrid.GetColCount">
|
|
<short>Gets the value for the ColCount property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.GetColCount.Result">
|
|
<short>Value for the property</short>
|
|
</element>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TCustomGrid.GetColWidths">
|
|
<short>Gets the value for the ColWidths property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.GetColWidths.Result">
|
|
<short>Value for the property</short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.GetColWidths.ACol">
|
|
<short>Column number to examine in the method</short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.GetColumns">
|
|
<short>Gets the value for the Columns property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.GetColumns.Result">
|
|
<short>Value for the property</short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.GetDefColWidth">
|
|
<short>Gets the value for the DefaultColWidth property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.GetDefColWidth.Result">
|
|
<short>Value for the property</short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.GetDefRowHeight">
|
|
<short>Gets the value for the DefaultRowHeight property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.GetDefRowHeight.Result">
|
|
<short>Value for the property</short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.GetEditorBorderStyle">
|
|
<short>Gets the value for the EditorBorderStyle property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.GetEditorBorderStyle.Result">
|
|
<short>Value for the property</short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.GetBorderWidth">
|
|
<short>Gets the number of pixels needed for the grid border when used</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.InternalNeedBorder"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TCustomGrid.GetBorderWidth.Result">
|
|
<short>Number of pixels needed for the grid border</short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.GetTitleImageInfo">
|
|
<short>
|
|
Gets position and layout information for an image used in the column fixed header cell
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.GetTitleImageInfo.aColumnIndex">
|
|
<short>Column number examined in the method</short>
|
|
</element>
|
|
<element name="TCustomGrid.GetTitleImageInfo.ImgIndex">
|
|
<short>Position of the image used for the column</short>
|
|
</element>
|
|
<element name="TCustomGrid.GetTitleImageInfo.ImgLayout">
|
|
<short>Image layout used for the column</short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.GetSortTitleImageInfo">
|
|
<short>
|
|
Gets image information displayed in a column header for a sortable column in the grid
|
|
</short>
|
|
<descr>
|
|
GetSortTitleImageInfo is used in the implementation of the methods like TCustomGrid.DrawColumnTitleImage and TCustomStringGrid.AutoAdjustColumn.
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.DrawColumnTitleImage"/>
|
|
<link id="TCustomStringGrid.AutoAdjustColumn"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TCustomGrid.GetSortTitleImageInfo.aColumnIndex">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.GetSortTitleImageInfo.ImgList">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.GetSortTitleImageInfo.ImgIndex">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.GetSortTitleImageInfo.ImgListWidth">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.GetSortTitleImageInfo.NativeSortGlyphs">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TCustomGrid.GetRowCount">
|
|
<short>Gets the value for the RowCount property</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.RowCount"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.GetRowCount.Result">
|
|
<short>Value for the property</short>
|
|
</element>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TCustomGrid.GetRowHeights">
|
|
<short>Gets the value for the RowHeights property</short>
|
|
<descr>Returns the current row height</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.GetRowHeights.Result">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.GetRowHeights.Arow">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.GetSelectedRange">
|
|
<short>Gets the value for the indexed SelectedRange property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.GetSelectedRange.Result">
|
|
<short>Value for the property</short>
|
|
</element>
|
|
<element name="TCustomGrid.GetSelectedRange.AIndex">
|
|
<short>Ordinal position for the grid rectangle</short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.GetSelectedRangeCount">
|
|
<short>Gets the value for the SelectedRangeCount property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.GetSelectedRangeCount.Result">
|
|
<short>Value for the property</short>
|
|
</element>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TCustomGrid.GetSelection">
|
|
<short>Gets the value for the Selection property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.GetSelection.Result">
|
|
<short>Value for the property</short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.GetSpecialCursor">
|
|
<short>Gets a cursor for the specified grid cursor state</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.GetSpecialCursor.Result">
|
|
<short>TCursor representing the specified cursor state</short>
|
|
</element>
|
|
<element name="TCustomGrid.GetSpecialCursor.ACursorState">
|
|
<short>Grid cursor state retrieved in the method</short>
|
|
</element>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TCustomGrid.GetTopRow">
|
|
<short>Gets the value for the TopRow property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.GetTopRow.Result">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TCustomGrid.GetVisibleColCount">
|
|
<short>Gets the value for the VisibleRowCount property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.GetVisibleColCount.Result">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TCustomGrid.GetVisibleGrid">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.GetVisibleGrid.Result">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TCustomGrid.GetVisibleRowCount">
|
|
<short>Gets the value for the VisibleRowCount property</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.VisibleRowCount"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.GetVisibleRowCount.Result">
|
|
<short>Value for the property</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TCustomGrid.InternalAutoFillColumns">
|
|
<short>
|
|
Performs actions needed to resize one or more columns to fill the client area for the grid control
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>InternalAutoFillColumns</var> is a procedure used to resize one or more columns to fill the client area for the grid control. No actions are performed in the method if <var>AutoFillColumns</var> contains <b>False</b>, or when the method has already been called but has not yet completed.
|
|
</p>
|
|
<p>
|
|
InternalAutoFillColumns calls <var>GetAutoFillColumnInfo</var> to accumulate the fixed cell width, data width, and sizing priority for each of the <var>Columns</var> defined in the grid. At least one of the cells in the grid must have sizing priority; the last non-fixed column is expanded to fill the client area in the grid when no other column has sizing priority.
|
|
</p>
|
|
<p>
|
|
InternalAutoFillColumns is called from the UpdateCachedSizes method.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.AutoFillColumns"/>
|
|
<link id="TCustomGrid.GetAutoFillColumnInfo"/>
|
|
<link id="TCustomGrid.UpdateCachedSizes"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.InternalNeedBorder">
|
|
<short>Indicates if borders are needed to render the grid control</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.DrawBorder"/>
|
|
<link id="TCustomGrid.GetBorderWidth"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TCustomGrid.InternalNeedBorder.Result">
|
|
<short>True when a border is drawn around the grid control</short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.InternalSetColWidths">
|
|
<short>
|
|
Performs internal actions neeed to set the width of a column to the specified value
|
|
</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.SetColWidths"/>
|
|
<link id="TCustomGrid.ColWidths"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TCustomGrid.InternalSetColWidths.aCol">
|
|
<short>Column number affected in the method</short>
|
|
</element>
|
|
<element name="TCustomGrid.InternalSetColWidths.aValue">
|
|
<short>Width applied to the column</short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.InternalUpdateColumnWidths">
|
|
<short>
|
|
Performs internal actions needed to update columns widths from the Column definitions
|
|
</short>
|
|
<descr>
|
|
Not used in the current implementation.
|
|
</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.InvalidateMovement">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.InvalidateMovement.DCol">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.InvalidateMovement.DRow">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.InvalidateMovement.OldRange">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.IsAltColorStored">
|
|
<short>
|
|
Indicates if AlternateColor has a value different than the Color for the grid control
|
|
</short>
|
|
<descr>
|
|
Used as the storage specifier for the AlternateColor property.
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.AlternateColor"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TCustomGrid.IsAltColorStored.Result">
|
|
<short>True when AlternateColor is different than Color</short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.IsColumnsStored">
|
|
<short>
|
|
Indicates if Columns has been enabled for the grid control
|
|
</short>
|
|
<descr>
|
|
Used as the storage specifier for the Columns property.
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.Columns"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TCustomGrid.IsColumnsStored.Result">
|
|
<short>True when the Enabled in Columns is True</short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.IsPushCellActive">
|
|
<short>Indicates if the pushed cell for the grid is visible</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.DrawRow"/>
|
|
<link id="TCustomGrid.MouseUp"/>
|
|
<link id="TCustomGrid.HeadersMouseMove"/>
|
|
<link id="TCustomGrid.GetGridDrawState"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TCustomGrid.IsPushCellActive.Result">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.LoadColumns">
|
|
<short>
|
|
Loads column settings from the specified XML configuration file
|
|
</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.LoadContent"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TCustomGrid.LoadColumns.cfg">
|
|
<short>XML configuration file with values loaded in the method</short>
|
|
</element>
|
|
<element name="TCustomGrid.LoadColumns.Version">
|
|
<short>Version number requested from the XML configuration</short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.LoadResBitmapImage">
|
|
<short>
|
|
Loads a bitmap with the specified name from the resource file for the control instance
|
|
</short>
|
|
<descr>
|
|
Assumes the resource in ResNmae can be loaded using TPortableNetworkGraphic, and assigned to the TBitmap return value.
|
|
</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.LoadResBitmapImage.Result">
|
|
<short>TBitmap with the image loaded in the method</short>
|
|
</element>
|
|
<element name="TCustomGrid.LoadResBitmapImage.ResName">
|
|
<short>Resource name loaded in the method</short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.LoadSub">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.LoadSub.ACfg">
|
|
<short>XML configuration file with values loaded in the method</short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.OnTitleFontChanged">
|
|
<short>
|
|
Event handler signalled when the font used for fixed title cells has been changed
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
OnTitleFontChanged is a procedure which implements the event handler signalled when the TitleFont for fixed cells has been changed. OnTitleFontChanged is assigned to the OnChange event handler in TitleFont in the constructor for the class instance.
|
|
</p>
|
|
<p>
|
|
OnTitleFontChanged sets the value in TitleFontIsDefault to False to reflect the change in the font setting. When Columns have been enabled (VisibleCount contains a non-zero value), the TitleFontChanged method in Columns is called. The ColumnsChanged method is called to force the grid to be updated. If Columns have not been enabled, the VisualChange method is called to update the grid control.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.Create"/>
|
|
<link id="TCustomGrid.TitleFont"/>
|
|
<link id="TCustomGrid.TitleFontIsDefault"/>
|
|
<link id="TCustomGrid.Columns"/>
|
|
<link id="TCustomGrid.VisibleCount"/>
|
|
<link id="TCustomGrid.ColumnsChanged"/>
|
|
<link id="TCustomGrid.VisualChange"/>
|
|
<link id="TGridColumns.Enabled"/>
|
|
<link id="TGridColumns.TitleFontChanged"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TCustomGrid.OnTitleFontChanged.Sender">
|
|
<short>Object generating the event notification</short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.ReadColumns">
|
|
<short>Reads the Columns collection from the specified TReader class instance</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.ReadColumns.Reader">
|
|
<short>TReader used to load values during LCL component streaming</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TCustomGrid.ReadColWidths">
|
|
<short>
|
|
Reads the list of Integer values in ColWidths from the specified TReader class instance
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.ReadColWidths.Reader">
|
|
<short>TReader used to load values during LCL component streaming</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TCustomGrid.ReadRowHeights">
|
|
<short>
|
|
Reads the list of Integer values in RowHeights using the specified TReader class instance
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.ReadRowHeights.Reader">
|
|
<short>TReader used to load values during LCL component streaming</short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.ResetPushedCell">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.ResetPushedCell.ResetColRow">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.RestoreCursor">
|
|
<short>
|
|
Restores the SavedCursor for the grid, and resets CursorState to its default value
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.SaveColumns">
|
|
<short>
|
|
Saves configuration, layout, and appearance information in Columns to an XML configuration file
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.SaveColumns.cfg">
|
|
<short>XML configuration file where the values are written</short>
|
|
</element>
|
|
<element name="TCustomGrid.SaveColumns.Version">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TCustomGrid.ScrollToCell">
|
|
<short>Scrolls the grid until the cell at the specified location is visible</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.ScrollToCell.Result">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.ScrollToCell.aCol">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.ScrollToCell.aRow">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TCustomGrid.ScrollGrid">
|
|
<short>
|
|
Scrolls the grid until the cell at the specified location is the new origin (top, left) for the grid
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.ScrollGrid.Result">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.ScrollGrid.Relative">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.ScrollGrid.DCol">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.ScrollGrid.DRow">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TCustomGrid.SetCol">
|
|
<short>Sets the value in the Col property</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.Col"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.SetCol.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TCustomGrid.SetColWidths">
|
|
<short>Sets the value in the indexed ColWidths property</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.ColWidths"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.SetColWidths.ACol">
|
|
<short>Column number for the update width value</short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.SetColWidths.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.SetColRowDragIndicatorColor">
|
|
<short>Sets the value for the ColRowDragIndicatorColor property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.SetColRowDragIndicatorColor.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TCustomGrid.SetDefColWidth">
|
|
<short>Sets the value for the DefColWidth property</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.DefColWidth"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.SetDefColWidth.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TCustomGrid.SetDefRowHeight">
|
|
<short>Sets the value for the DefRowHeight property</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.DefRowHeight"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.SetDefRowHeight.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TCustomGrid.SetDefaultDrawing">
|
|
<short>Sets the value for the DefaultDrawing property</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.DefaultDrawing"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.SetDefaultDrawing.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TCustomGrid.SetEditor">
|
|
<short>Sets the value for the Editor property</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.Editor"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.SetEditor.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TCustomGrid.SetFocusColor">
|
|
<short>Sets the value for the FocusColor property</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.FocusColor"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.SetFocusColor.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TCustomGrid.SetGridLineColor">
|
|
<short>Sets the value for the GridLineColor property</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.GridLineColor"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.SetGridLineColor.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.SetFixedGridLineColor">
|
|
<short>Sets the value for the FixedGridLineColor property</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.FixedGridLineColor"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TCustomGrid.SetFixedGridLineColor.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TCustomGrid.SetGridLineStyle">
|
|
<short>Sets the value for the GridLineStyle property</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.GridLineStyle"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.SetGridLineStyle.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TCustomGrid.SetGridLineWidth">
|
|
<short>Sets the value for the GridLineWidth property</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.GridLineWidth"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.SetGridLineWidth.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TCustomGrid.SetLeftCol">
|
|
<short>Sets the value for the LeftCol property</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.LeftCol"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.SetLeftCol.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TCustomGrid.SetOptions">
|
|
<short>Sets the value for the Options property</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.Options"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.SetOptions.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.SetOptions2">
|
|
<short>Sets the value for the Options2 property</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.Options2"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TCustomGrid.SetOptions2.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.SetRangeSelectMode">
|
|
<short>Sets the value for the RangeSelectMode property</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.RangeSelectMode"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TCustomGrid.SetRangeSelectMode.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TCustomGrid.SetRow">
|
|
<short>Sets the value for the Row property</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.Row"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.SetRow.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TCustomGrid.SetRowCount">
|
|
<short>Sets the value for the RowCount property</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.RowCount"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.SetRowCount.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TCustomGrid.SetRowHeights">
|
|
<short>Sets the value in the indexed RowHeights property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.SetRowHeights.ARow">
|
|
<short>Row number affected in the method</short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.SetRowHeights.AValue">
|
|
<short>New value for the specified row number</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TCustomGrid.SetScrollBars">
|
|
<short>Sets the value for the ScrollBars property</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.ScrollBars"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.SetScrollBars.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TCustomGrid.SetSelectActive">
|
|
<short>Sets the value for the SelectActive property</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.SelectActive"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.SetSelectActive.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TCustomGrid.SetSelection">
|
|
<short>Sets the value for the Selection property</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.Selection"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.SetSelection.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.SetSpecialCursor">
|
|
<short>Sets the value for the indexed cursor state in the grid control</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.SetSpecialCursor.ACursorState">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.SetSpecialCursor.AValue">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TCustomGrid.SetTopRow">
|
|
<short>Sets the value for the TopRow property</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.TopRow"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.SetTopRow.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.StartColSizing">
|
|
<short>
|
|
Updates the grid to perform a column sizing operation for the cell at the specified location
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.StartColSizing.Result">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.StartColSizing.X">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.StartColSizing.Y">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.ChangeCursor">
|
|
<short>Changes the cursor shape to the specified value</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.SetCursor"/>
|
|
<link id="TCustomGrid.CursorState"/>
|
|
<link id="TCustomGrid.MouseMove"/>
|
|
<link id="TCustomGrid.MouseUp"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TCustomGrid.ChangeCursor.ACursor">
|
|
<short>Cursor shape applied in the method</short>
|
|
</element>
|
|
<element name="TCustomGrid.ChangeCursor.ASaveCurrentCursor">
|
|
<short>Indicates if the existing cursor shape is stored for later reuse</short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.TrySmoothScrollBy">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.TrySmoothScrollBy.Result">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.TrySmoothScrollBy.aColDelta">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.TrySmoothScrollBy.aRowDelta">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TCustomGrid.TryScrollTo">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.TryScrollTo.aCol">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.TryScrollTo.aRow">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.UpdateCachedSizes">
|
|
<short>
|
|
Performs actions needed when the size for columns or rows in the grid are adjusted
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.UpdateSBVisibility">
|
|
<short>
|
|
Updates the visibility for horizontal and vertical scrollbars
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.UpdateSizes">
|
|
<short>
|
|
Updates the Cache information for the grid when visual aspects for columns or rows are changed
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.WriteColumns">
|
|
<short>
|
|
Writes the Columns collection using the specified TWriter instance
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
A Nil collection is written using Writer when Column contains the default column definitions (has not been modified at design-time or run-time).
|
|
</p>
|
|
<remark>
|
|
Not used in the current implementation of TCustomGrid.DefineProperties.
|
|
</remark>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.DefineProperties"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TCustomGrid.WriteColumns.Writer">
|
|
<short>TWriter instance used for the class</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TCustomGrid.WriteColWidths">
|
|
<short>
|
|
Writes the list of Integers in ColWidths using the specified TWriter instance
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.WriteColWidths.Writer">
|
|
<short>TWriter instance used to write the values</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TCustomGrid.WriteRowHeights">
|
|
<short>
|
|
Writes the list of Integers in RowHeights using the specified TWriter instance
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.WriteRowHeights.Writer">
|
|
<short>TWriter instance used to write the values</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TCustomGrid.WMEraseBkgnd">
|
|
<short>Handles the Window Message used to erase the background for the control</short>
|
|
<descr>
|
|
<notes>
|
|
<note>Always returns 1 as the Message result.</note>
|
|
</notes>
|
|
</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.WMEraseBkgnd.message">
|
|
<short>Lazarus message applied in the method</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TCustomGrid.WMGetDlgCode">
|
|
<short>
|
|
Handles the Window Message which applies Tab and Arrow keys in dialog boxes and custom controls
|
|
</short>
|
|
<descr>
|
|
Examines the Options property for the presence of the goTabs enumeration value. When present, the DLGC_WANTTAB is or'd to the result value in Msg.
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.Options"/>
|
|
<link id="TGridOption.goTabs"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.WMGetDlgCode.Msg">
|
|
<short>Lazarus message processed in the method</short>
|
|
</element>
|
|
|
|
<!-- variable Visibility: protected -->
|
|
<element name="TCustomGrid.fGridState">
|
|
<short>
|
|
<var>fGridState</var> - local variable to hold current state of the grid (whether being edited, updated etc)
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.RTLSign">
|
|
<short>
|
|
Gets the positive or negative multiplier used to adjust scroll values for BiDi mode
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.RTLSign.Result">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.WSRegisterClass"
|
|
link="#LCL.LCLClasses.TLCLComponent.WSRegisterClass"/>
|
|
|
|
<element name="TCustomGrid.AddSelectedRange">
|
|
<short>Adds the current selection to the array of rectangles in Selections</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.AdjustClientRect">
|
|
<short>
|
|
Adjusts the client rectangle and sets the grid flag reflecting the change
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.AdjustClientRect.ARect">
|
|
<short>Client rectangle adjusted in the method</short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.AdjustEditorBounds">
|
|
<short>
|
|
<var>AdjustEditorBounds</var> - method to adjust the editor's bounds to include a new row and column</short>
|
|
</element>
|
|
<element name="TCustomGrid.AdjustEditorBounds.NewCol">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.AdjustEditorBounds.NewRow">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.AfterMoveSelection">
|
|
<short>Signals the OnAfterSelection event handler for the grid</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.AfterMoveSelection.prevCol">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.AfterMoveSelection.prevRow">
|
|
<short></short>``
|
|
</element>
|
|
|
|
<element name="TCustomGrid.AssignTo">
|
|
<short>
|
|
Stores properties from the current grid class instance in the specified target
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.AssignTo.Dest">
|
|
<short>Grid instance where value are stored</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.AutoAdjustColumn">
|
|
<short>
|
|
<var>AutoAdjustColumn</var> - automatically adjust column properties to accommodate the largest value in the column
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.AutoAdjustColumn.aCol">
|
|
<short>Column number adjusted in the method</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.BeforeMoveSelection">
|
|
<short>
|
|
<var>BeforeMoveSelection</var> - method to use before a selection is moved
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>BeforeMoveSelection</var> is called from the <var>MoveExtend</var> method whenever the current grid cursor location is about to change. The destination column and row are specified in the <var>DCol</var> and <var>DRow</var> parameters respectively.
|
|
</p>
|
|
<p>
|
|
The new location is known to be a valid selectable cell (see <link id="TCustomGrid.SelectCell"/>), and is given in absolute cell coordinates. At this point the current grid location has not changed and can be retrieved with Col and Row properties.
|
|
</p>
|
|
<p>
|
|
The purpose of this method is to call the <var>OnBeforeSelection</var> event handler.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.MoveExtend"/>
|
|
<link id="TCustomGrid.SelectCell"/>
|
|
<link id="TCustomDrawGrid.OnBeforeSelection"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.BeforeMoveSelection.DCol">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.BeforeMoveSelection.DRow">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.BeginAutoDrag">
|
|
<short>Starts an auto-drag operation in the grid control</short>
|
|
<descr>
|
|
<p>
|
|
<var>BeginAutoDrag</var> is an overridden procedure used to start an auto-dragging operation. Auto-dragging is in effect when <var>DragMode</var> contains the value <var>dmAutomatic</var>.
|
|
</p>
|
|
<p>
|
|
BeginAutoDrag examines the <var>Options</var> property to determine if column sizing (<var>goColSizing</var>) or row sizing (<var>goRowSizing</var>) have been enabled for the grid control. In addition, the <var>CursorState</var> property must contain a value that represents the action (<var>gcsColWidthChanging</var> or <var>gcsRowHeightChanging</var>). If either condition is not met, <var>BeginDrag</var> is called using <b>False</b> as an argument.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.Options"/>
|
|
<link id="TCustomGrid.CursorState"/>
|
|
<link id="TGridOption.goColSizing"/>
|
|
<link id="TGridOption.goRowSizing"/>
|
|
<link id="TGridCursorState.gcsColWidthChanging"/>
|
|
<link id="TGridCursorState.gcsRowHeightChanging"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.BoxRect">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
<notes>
|
|
<note>Not currently used in the grid implementation.</note>
|
|
</notes>
|
|
</element>
|
|
<element name="TCustomGrid.BoxRect.Result">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.BoxRect.ALeft">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.BoxRect.ATop">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.BoxRect.ARight">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.BoxRect.ABottom">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.CacheMouseDown">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.CacheMouseDown.X">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.CacheMouseDown.Y">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.CalcAutoSizeColumn">
|
|
<short>
|
|
<var>CalcAutoSizeColumn</var> - method for automatically calculating the size of a column
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.CalcAutoSizeColumn.Index">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.CalcAutoSizeColumn.AMin">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.CalcAutoSizeColumn.AMax">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.CalcAutoSizeColumn.APriority">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.CalcCellExtent">
|
|
<short>Deprecated</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.CalcCellExtent.aCol">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.CalcCellExtent.aRow">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.CalcCellExtent.aRect">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.CalcFocusRect">
|
|
<short>
|
|
<var>CalcFocusRect</var> - method for calculating the bounds of a focused rectangle
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.CalcFocusRect.ARect">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.CalcMaxTopLeft">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.CalcScrollbarsRange">
|
|
<short>Updates the range, page, and thumb position for visible scrollbars</short>
|
|
<descr>
|
|
<p>
|
|
<var>CalcScrollbarsRange</var> is a procedure used to update the range, page, and thumb position for visible scrollbars in the grid control. CalcScrollbarsRange accesses the cached grid data in <var>GCache</var> to calculate values needed in the method. The visibility for both horizontal and vertical scrollbars is determined, and the range, page and thumb position is applied in the <var>UpdateHorzScrollBar</var> and <var>UpdateVertScrollbar</var> methods.
|
|
</p>
|
|
<p>
|
|
CalcScrollbarsRange is used in the implementation of the <var>ScrollBy</var> and <var>UpdateSizes</var> methods in TCustomGrid.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.GCache"/>
|
|
<link id="TCustomGrid.GetSBRanges"/>
|
|
<link id="TCustomGrid.UpdateHorzScrollBar"/>
|
|
<link id="TCustomGrid.UpdateVertScrollBar"/>
|
|
<link id="TCustomGrid.ScrollBy"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.CalculatePreferredSize">
|
|
<short>Gets the preferred width and height for cells in the grid</short>
|
|
<descr>
|
|
Always returns 0 (zero) in the PreferredWidth and PreferredHeight variable arguments.
|
|
</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.CalculatePreferredSize.PreferredWidth">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.CalculatePreferredSize.PreferredHeight">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.CalculatePreferredSize.WithThemeSpace">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TCustomGrid.CanEditShow">
|
|
<short>
|
|
<var>CanEditShow</var> - returns True if the editing data can be shown</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.CanEditShow.Result">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TCustomGrid.CanGridAcceptKey">
|
|
<short>
|
|
<var>CanGridAcceptKey</var> - returns True is the grid is able to accept the given key</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.CanGridAcceptKey.Result">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.CanGridAcceptKey.Key">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.CanGridAcceptKey.Shift">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.CellClick">
|
|
<short>
|
|
<var>CellClick</var> - method for processing a click in a cell
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.CellClick.aCol">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.CellClick.aRow">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.CellExtent">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.CellExtent.aCol">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.CellExtent.aRow">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.CellExtent.R">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.CellExtent.exCol">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.CheckLimits">
|
|
<short>
|
|
<var>CheckLimits</var> - method for checking limits of specified cell
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.CheckLimits.aCol">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.CheckLimits.aRow">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.CheckLimitsWithError">
|
|
<short>
|
|
<var>CheckLimitsWithError</var> - method for checking limits of specified cell, with error trapping</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.CheckLimitsWithError.aCol">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.CheckLimitsWithError.aRow">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.CMMouseEnter">
|
|
<short>Control message posted when the mouse enters a cell in the grid</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.CMMouseEnter.Message">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.CMMouseLeave">
|
|
<short>
|
|
<var>CMMouseLeave</var> - Control Message for a mouse leaving a cell</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.CMMouseLeave.Message">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.ColRowDeleted">
|
|
<short>
|
|
<var>ColRowDeleted</var> - method for dealing with deletion of either a column or a row (depending on value of <var>IsCol</var>)
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.ColRowDeleted.IsColumn">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.ColRowDeleted.Index">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.ColRowExchanged">
|
|
<short>
|
|
<var>ColRowExchanged</var> - method for exchanging the current Column or Row (depending on value of <var>IsCol</var>) with the indexed other column or row
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.ColRowExchanged.IsColumn">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.ColRowExchanged.Index">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.ColRowExchanged.WithIndex">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.ColRowInserted">
|
|
<short>
|
|
<var>ColRowInserted</var> - method for dealing with insertion of a column or row (depending on value of
|
|
<var>IsCol</var>)</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.ColRowInserted.IsColumn">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.ColRowInserted.Index">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.ColRowMoved">
|
|
<short>
|
|
<var>ColRowMoved</var> - the column or row (determined by
|
|
<var>IsColumn</var>) is moved from one index to another
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.ColRowMoved.IsColumn">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.ColRowMoved.FromIndex">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.ColRowMoved.ToIndex">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TCustomGrid.ColRowToOffset">
|
|
<short>
|
|
<var>ColRowToOffset</var> - method for moving column or row (depending on value of <var>IsCol</var>); if <var>Relative</var> is True, moves by the amount of <var>Index</var>, otherwise moves from <var>StartPos</var> to <var>EndPos</var>. Returns True if successful
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.ColRowToOffset.Result">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.ColRowToOffset.IsCol">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.ColRowToOffset.Fisical">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.ColRowToOffset.Index">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.ColRowToOffset.Ini">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.ColRowToOffset.Fin">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TCustomGrid.ColumnIndexFromGridColumn">
|
|
<short>
|
|
Gets the position of the specified column relative to the first column in the grid
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>ColumnIndexFromGridColumn</var> is an Integer function used to get the position of the specified column relative to the first column in the grid. The return value contains the difference between <var>Column</var> and <var>FirstGridColumn</var> when <var>Columns</var> have been enabled in the grid control. <var>RealIndex</var> is called to translate the position used in the return value. If <var>Columns</var> have not been enabled, the return value is <b>-1</b>.
|
|
</p>
|
|
<p>
|
|
ColumnIndexFromGridColumn is used in the implementation of TCustomGrid methods like:
|
|
</p>
|
|
<ul>
|
|
<li>ColumnFromGridColumn</li>
|
|
<li>DoOPExchangeColRow</li>
|
|
<li>DoOPInsertColRow</li>
|
|
<li>DoOPMoveColRow</li>
|
|
<li>DoOPDeleteColRow</li>
|
|
</ul>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.ColumnFromGridColumn"/>
|
|
<link id="TCustomGrid.DoOPExchangeColRow"/>
|
|
<link id="TCustomGrid.DoOPInsertColRow"/>
|
|
<link id="TCustomGrid.DoOPMoveColRow"/>
|
|
<link id="TCustomGrid.DoOPDeleteColRow"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.ColumnIndexFromGridColumn.Result">
|
|
<short>Relative position for the specified column</short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.ColumnIndexFromGridColumn.Column">
|
|
<short>Column number to locate in the grid</short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TCustomGrid.ColumnFromGridColumn">
|
|
<short>
|
|
<var>ColumnFromGridColumn</var> - returns the actual grid column given its index</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.ColumnFromGridColumn.Result">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.ColumnFromGridColumn.Column">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.ColumnsChanged">
|
|
<short>
|
|
<var>ColumnsChanged</var> - method for dealing with changed columns</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.ColumnsChanged.aColumn">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.ColWidthsChanged">
|
|
<short>
|
|
<var>ColWidthsChanged</var> - method for dealing with changes in column width
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TCustomGrid.CreateColumns">
|
|
<short>
|
|
<var>CreateColumns</var> - returns the identity of the created columns</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.CreateColumns.Result">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.CheckNewCachedSizes">
|
|
<short>
|
|
<var>CheckNewCachedSizes</var> - check the new values of cached sizes</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.CheckNewCachedSizes.AGCache">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element link="#LCL.Controls.TWinControl.CreateWnd" name="TCustomGrid.CreateWnd"/>
|
|
|
|
<element link="#LCL.Controls.TWinControl.CreateParams" name="TCustomGrid.CreateParams"/>
|
|
<element name="TCustomGrid.CreateParams.Params">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element link="#LCL.Controls.TControl.Click" name="TCustomGrid.Click"/>
|
|
<element link="#LCL.Controls.TControl.DblClick" name="TCustomGrid.DblClick"/>
|
|
|
|
<element name="TCustomGrid.DefaultColWidthIsStored">
|
|
<short>
|
|
Indicates if the DefaultColWidth is available in component streaming
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.DefaultColWidthIsStored.Result">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.DefaultRowHeightIsStored">
|
|
<short>
|
|
Indicates if the DefaultRowHeight is available in component streaming
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.DefaultRowHeightIsStored.Result">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element link="#rtl.Classes.TComponent.DefineProperties" name="TCustomGrid.DefineProperties"/>
|
|
<element name="TCustomGrid.DefineProperties.Filer">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element link="#LCL.Controls.TWinControl.DestroyHandle" name="TCustomGrid.DestroyHandle"/>
|
|
|
|
<element name="TCustomGrid.DialogChar">
|
|
<short>Applies an accelerator key to a column in the grid</short>
|
|
<descr>
|
|
<p>
|
|
<var>DialogChar</var> is an overridden <var>Boolean</var> function used to apply Lazarus messages with accelerator keys for columns in the grid. Message contains the <var>TLMKey</var> instance with the message examined in the method. DialogChar examines each of the <var>Columns</var> defined for the grid to determine if the CharCode for the <var>Message</var> is an accelerator key appearing in the title for the column. When a match is found, the <var>HeaderClick</var> method is called to activate the column.
|
|
</p>
|
|
<p>
|
|
The return value contains the result from the inherited <var>DialogChar</var> method.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.Columns"/>
|
|
<link id="TCustomGrid.ColCount"/>
|
|
<link id="TCustomGrid.HeaderClick`"/>
|
|
<link id="#LCL.Controls.TWinControl.DialogChar"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TCustomGrid.DialogChar.Result">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.DialogChar.Message">
|
|
<short>Lazarus messaged examined in the method</short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TCustomGrid.DoCompareCells">
|
|
<short>
|
|
<var>DoCompareCells</var> - perform the comparison of two or more cells in a grid
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.DoCompareCells.Result">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.DoCompareCells.Acol">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.DoCompareCells.ARow">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.DoCompareCells.Bcol">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.DoCompareCells.BRow">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.DoCopyToClipboard">
|
|
<short>
|
|
<var>DoCopyToClipboard</var> - copy the selected data to the clipboard, leaving the original data in place</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.DoCutToClipboard">
|
|
<short>
|
|
<var>DoCutToClipboard</var> - cut the data from its current site and place it on the clipboard</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.DoEditButtonClick">
|
|
<short>
|
|
Performs actions needed when the button for editor control is clicked
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>DoEditButtonClick</var> is a procedure used to perform actions requires when the button for a cell editor or button column is clicked.
|
|
</p>
|
|
<p>
|
|
<var>ACol</var> and <var>ARow</var> contain the Integer coordinates for the cell where the action occurred.
|
|
</p>
|
|
<p>
|
|
DoEditButtonClick signals the <var>OnEditButtonClick</var> and <var>OnButtonClick</var> event handlers when they have been assigned for the grid control.
|
|
</p>
|
|
<p>
|
|
DoEditButtonClick is used in the implementation of the <var>EditButtonClicked</var> method used in cell editor controls, and the <var>MouseUp</var> method.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.OnEditButtonClick"/>
|
|
<link id="TCustomGrid.OnButtonClick"/>
|
|
<link id="TCustomGrid.MouseUp"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TCustomGrid.DoEditButtonClick.ACol">
|
|
<short>Column number for the affected cell</short>
|
|
</element>
|
|
<element name="TCustomGrid.DoEditButtonClick.ARow">
|
|
<short>Row number for the affected cell</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.DoEditorHide">
|
|
<short>
|
|
<var>DoEditorHide</var> - hide the data in the editor
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.DoEditorShow">
|
|
<short>
|
|
<var>DoEditorShow</var> - show the data in the editor</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element link="#LCL.Controls.TWinControl.DoExit" name="TCustomGrid.DoExit"/>
|
|
<element link="#LCL.Controls.TWinControl.DoEnter" name="TCustomGrid.DoEnter"/>
|
|
|
|
<element name="TCustomGrid.DoLoadColumn">
|
|
<short>Signals the OnLoadColumn event handler for the grid control</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.DoLoadColumn.Sender">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.DoLoadColumn.aColumn">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.DoLoadColumn.aColIndex">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.DoLoadColumn.aCfg">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.DoLoadColumn.aVersion">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.DoLoadColumn.aPath">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.DoSaveColumn">
|
|
<short>Signals the OnSaveColumn event handler for the grid control</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.DoSaveColumn.Sender">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.DoSaveColumn.aColumn">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.DoSaveColumn.aColIndex">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.DoSaveColumn.aCfg">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.DoSaveColumn.aVersion">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.DoSaveColumn.aPath">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.DoMouseWheel">
|
|
<short>Applies mouse wheel options and handles the mouse wheel operation</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.DoMouseWheel.Result">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.DoMouseWheel.Shift">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.DoMouseWheel.WheelDelta">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.DoMouseWheel.MousePos">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element link="#LCL.Controls.TControl.DoMouseWheelDown" name="TCustomGrid.DoMouseWheelDown"/>
|
|
<element name="TCustomGrid.DoMouseWheelDown.Result">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.DoMouseWheelDown.Shift">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.DoMouseWheelDown.MousePos">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element link="#LCL.Controls.TControl.DoMouseWheelUp" name="TCustomGrid.DoMouseWheelUp"/>
|
|
<element name="TCustomGrid.DoMouseWheelUp.Result">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.DoMouseWheelUp.Shift">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.DoMouseWheelUp.MousePos">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.DoMouseWheelLeft">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.DoMouseWheelLeft.Result">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.DoMouseWheelLeft.Shift">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.DoMouseWheelLeft.MousePos">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.DoMouseWheelRight">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.DoMouseWheelRight.Result">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.DoMouseWheelRight.Shift">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.DoMouseWheelRight.MousePos">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.DoAutoAdjustLayout">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.DoAutoAdjustLayout.AMode">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.DoAutoAdjustLayout.AXProportion">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.DoAutoAdjustLayout.AYProportion">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element link="#LCL.Controls.TControl.DoOnChangeBounds" name="TCustomGrid.DoOnChangeBounds"/>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.DoOPDeleteColRow">
|
|
<short>
|
|
<var>DoOPDeleteColRow</var> performs the operation for deleting a column or row (depending on value of <var>IsCol</var>)
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.DoOPDeleteColRow.IsColumn">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.DoOPDeleteColRow.Index">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.DoOPExchangeColRow">
|
|
<short>
|
|
<var>DoOPExchangeColRow</var> - perform the operation for exchanging either the current column or row (depending on value of <var>IsCol</var>) with the column or row specified by <var>WithIndex</var>
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.DoOPExchangeColRow.IsColumn">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.DoOPExchangeColRow.Index">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.DoOPExchangeColRow.WithIndex">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.DoOPInsertColRow">
|
|
<short>
|
|
<var>DoOPInsertColRow</var> - perform the operation for inserting either a column or a row (depending on the value of <var>IsCol</var>) at the indexed position
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.DoOPInsertColRow.IsColumn">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.DoOPInsertColRow.Index">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.DoOPMoveColRow">
|
|
<short>
|
|
<var>DoOPMoveColRow</var> - performs the operation for moving either a column or a row (depending on the value of <var>IsCol</var>) between <var>FromIndex</var> and <var>ToIndex</var>
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.DoOPMoveColRow.IsColumn">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.DoOPMoveColRow.FromIndex">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.DoOPMoveColRow.ToIndex">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.DoPasteFromClipboard">
|
|
<short>
|
|
<var>DoPasteFromClipboard</var> paste the data from the clipboard to the current location
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.DoPrepareCanvas">
|
|
<short>
|
|
<var>DoPrepareCanvas</var> - get the canvas ready for drawing
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.DoPrepareCanvas.aCol">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.DoPrepareCanvas.aRow">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.DoPrepareCanvas.aState">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.DoOnResize">
|
|
<short>Performs actions needed when the grid control is resized</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element link="#LCL.Controls.TControl.DoSetBounds" name="TCustomGrid.DoSetBounds"/>
|
|
<element name="TCustomGrid.DoSetBounds.ALeft">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.DoSetBounds.ATop">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.DoSetBounds.AWidth">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.DoSetBounds.AHeight">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element link="#LCL.Controls.TWinControl.DoUTF8KeyPress" name="TCustomGrid.DoUTF8KeyPress"/>
|
|
<element name="TCustomGrid.DoUTF8KeyPress.Result">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.DoUTF8KeyPress.UTF8Key">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.DrawBorder">
|
|
<short>
|
|
<var>DrawBorder</var> - draws the border of the grid
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.DrawAllRows">
|
|
<short>
|
|
<var>DrawAllRows</var> - draws all of the rows for the grid</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.DrawFillRect">
|
|
<short></short>
|
|
<descr>
|
|
Use FillRect after calc the new rect depend on Right To Left.
|
|
</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.DrawFillRect.aCanvas">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.DrawFillRect.R">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.DrawCell">
|
|
<short>
|
|
<var>DrawCell</var> - draws a cell at the given grid location (Col, Row) or in the specified Rectangle
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.DrawCell.aCol">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.DrawCell.aRow">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.DrawCell.aRect">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.DrawCell.aState">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.DrawCellGrid">
|
|
<short>
|
|
<var>DrawCellGrid</var> draws a grid of cells at the specified location
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.DrawCellGrid.aCol">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.DrawCellGrid.aRow">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.DrawCellGrid.aRect">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.DrawCellGrid.astate">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.DrawTextInCell">
|
|
<short>Draws the text for a non-fixed cell in the grid</short>
|
|
<descr>
|
|
The implementation for DrawTextInCell is empty in TCustomGrid. It is overridden in descendent classes.
|
|
</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.DrawTextInCell.aCol">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.DrawTextInCell.aRow">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.DrawTextInCell.aRect">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.DrawTextInCell.aState">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.DrawThemedCell">
|
|
<short>
|
|
Draws a cell using the theme services for the specified grid drawing state
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>DrawThemedCell</var> is a procedure used to draw the cell at the specified coordinates using the theme services for the platform or widget set.
|
|
</p>
|
|
<p>
|
|
<var>aCol</var> contains the column number for the affected cell.
|
|
</p>
|
|
<p>
|
|
<var>aRow</var> contains the row number for the affected cell.
|
|
</p>
|
|
<p>
|
|
<var>aRect</var> contains the screen coordinates for the cell rendered in the method.
|
|
</p>
|
|
<p>
|
|
<var>aState</var> contains the grid drawing state applied to the cell. aState contains a value from the <var>TGridDrawState</var> enumeration that determines the theme service element details used for the drawing operation.
|
|
</p>
|
|
<table>
|
|
<tr>
|
|
<td><b>Grid Draw State</b></td>
|
|
<td><b>Theme Element</b></td>
|
|
<td><b>Description</b></td>
|
|
</tr>
|
|
<tr>
|
|
<td>gdPushed</td>
|
|
<td>thHeaderItemPressed</td>
|
|
<td>Draws the cell using the Pressed state</td>
|
|
</tr>
|
|
<tr>
|
|
<td>gdHot</td>
|
|
<td>thHeaderItemHot</td>
|
|
<td>Draws the cell using the Hotlighted state</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Other states</td>
|
|
<td>thHeaderItemNormal</td>
|
|
<td>Draws the cell using the normal drawing state</td>
|
|
</tr>
|
|
</table>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomDrawGrid.DefaultDrawCell"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TCustomGrid.DrawThemedCell.aCol">
|
|
<short>Column number for the affected cell</short>
|
|
</element>
|
|
<element name="TCustomGrid.DrawThemedCell.aRow">
|
|
<short>Row number for the affected cell</short>
|
|
</element>
|
|
<element name="TCustomGrid.DrawThemedCell.aRect">
|
|
<short>Screen coordinates for the cell</short>
|
|
</element>
|
|
<element name="TCustomGrid.DrawThemedCell.aState">
|
|
<short>Grid drawing state for the cell</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.DrawCellText">
|
|
<short>
|
|
<var>DrawCellText</var> - draws the given text string in the cell specified by Col, Row or by Rectangle
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.DrawCellText.aCol">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.DrawCellText.aRow">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.DrawCellText.aRect">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.DrawCellText.aState">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.DrawCellText.aText">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TCustomGrid.DrawGridCheckboxBitmaps">
|
|
<short>
|
|
<var>DrawGridCheckboxBitmaps</var> - draws checkbox bitmaps in the nominated rectangle with the specified checkbox state
|
|
</short>
|
|
</element>
|
|
<element name="TCustomGrid.DrawGridCheckboxBitmaps.aCol">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.DrawGridCheckboxBitmaps.aRow">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.DrawGridCheckboxBitmaps.aRect">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.DrawGridCheckboxBitmaps.aState">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.DrawButtonCell">
|
|
<short>Draws a cell using theme servies for button styles</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.DrawButtonCell.aCol">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.DrawButtonCell.aRow">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.DrawButtonCell.aRect">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.DrawButtonCell.aState">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.DrawColRowMoving">
|
|
<short>Draws a column or row when dragging is in effect</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.DrawColumnText">
|
|
<short>
|
|
<var>DrawColumnText</var> - draw the text of the specified column
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.DrawColumnText.aCol">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.DrawColumnText.aRow">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.DrawColumnText.aRect">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.DrawColumnText.aState">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.DrawColumnTitleImage">
|
|
<short>
|
|
<var>DrawColumnTitleImage</var> - draw the title image of the specified column</short>
|
|
</element>
|
|
<element name="TCustomGrid.DrawColumnTitleImage.ARect">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.DrawColumnTitleImage.AColumnIndex">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.DrawEdges">
|
|
<short>Draws the edges for the grid control</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.DrawFocusRect">
|
|
<short>
|
|
<var>DrawFocusRect</var> - draw a rectangle with focus in the nominated cell
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.DrawFocusRect.aCol">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.DrawFocusRect.aRow">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.DrawFocusRect.ARect">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.DrawRow">
|
|
<short>
|
|
<var>DrawRow</var> - draws the specified row
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.DrawRow.aRow">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.EditButtonClicked">
|
|
<short>
|
|
<var>EditButtonClicked</var> - calls <var>OnEditButtonClick</var>
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.EditButtonClicked.Sender">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.EditorDoGetValue">
|
|
<short>
|
|
<var>EditordoGetValue</var> - method for getting a value in the Editor
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.EditorDoResetValue">
|
|
<short>Resets the value in the cell when the cell editor is cancelled or hidden</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.EditorDoSetValue">
|
|
<short>
|
|
<var>EditordoSetValue</var> - method for specifying a value in the Editor
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TCustomGrid.EditorCanAcceptKey">
|
|
<short>
|
|
<var>EditorCanAcceptKey</var> - returns True if the Editor is able to accept the nominated (UTF8) key
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.EditorCanAcceptKey.Result">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.EditorCanAcceptKey.ch">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TCustomGrid.EditorIsReadOnly">
|
|
<short>
|
|
<var>EditorIsReadOnly</var> - returns True if the Editor has Read Only status
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.EditorIsReadOnly.Result">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.EditorHide">
|
|
<short>Hides a visible cell editor in the grid control</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TCustomGrid.EditorLocked">
|
|
<short>
|
|
<var>EditorLocked</var> - returns True if the Editor is locked, i.e. unable to accept input or make changes
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.EditorLocked.Result">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.EditingAllowed">
|
|
<short></short>
|
|
<descr>
|
|
Returns True if both the grid and the current column allow editing.
|
|
</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.EditingAllowed.Result">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.EditingAllowed.ACol">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.EditorSelectAll">
|
|
<short>Selects the entire content in the cell when a cell editor is active</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.EditorShow">
|
|
<short>
|
|
Displays and enables the cell editor for the selected cell, and optionally selects all content in the cell
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.EditorShow.SetAll">
|
|
<short>
|
|
Indicates if the entire content in the cell is selected in its cell editor
|
|
</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.EditorShowInCell">
|
|
<short>
|
|
<var>EditorShowInCell</var> - shows the Editor's content
|
|
<i>in situ</i> in the Cell
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.EditorShowInCell.aCol">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.EditorShowInCell.aRow">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.EditorWidthChanged">
|
|
<short>
|
|
<var>EditorWidthChanged</var> - method for dealing with a change in editor width
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.EditorWidthChanged.aCol">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.EditorWidthChanged.aWidth">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.FirstGridColumn">
|
|
<short>Gets the position of the first column after any fixed columns in the grid</short>
|
|
<descr>
|
|
<p>
|
|
<var>FirstGridColumn</var> is an <var>Integer</var> function used to get the ordinal position of the first column appearing after any fixed column in the grid control. The return value contains the value in the <var>FixedCols</var> property.
|
|
</p>
|
|
<p>
|
|
FirstGridColumn is used in the implementation of methods including:
|
|
</p>
|
|
<ul>
|
|
<li>GetColWidths</li>
|
|
<li>GetIsCellTitle</li>
|
|
<li>ColumnIndexFromGridColumn</li>
|
|
<li>GridColumnFromColumnIndex</li>
|
|
<li>ColumnsChanged</li>
|
|
</ul>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.ColWidths"/>
|
|
<link id="TCustomGrid.FixedCols"/>
|
|
<link id="TCustomGrid.GetIsCellTitle"/>
|
|
<link id="TCustomGrid.ColumnIndexFromGridColumn"/>
|
|
<link id="TCustomGrid.GridColumnFromColumnIndex"/>
|
|
<link id="TCustomGrid.ColumnsChanged"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TCustomGrid.FirstGridColumn.Result">
|
|
<short>Position of the first column after any fixed columns in the grid</short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TCustomGrid.FixedGrid">
|
|
<short>
|
|
<var>FixedGrid</var> - returns True if the Grid is fixed
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.FixedGrid.Result">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.FontChanged">
|
|
<short>
|
|
<var>FontChanged</var> - method to deal with a change in font
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.FontChanged.Sender">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.GetAutoFillColumnInfo">
|
|
<short>
|
|
<var>GetAutoFillColumnInfo</var> - finds out information (max, min, priority) about the auto-fill properties of the indexed column
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.GetAutoFillColumnInfo.Index">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.GetAutoFillColumnInfo.aMin">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.GetAutoFillColumnInfo.aMax">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.GetAutoFillColumnInfo.aPriority">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.GetCellHintText">
|
|
<short>
|
|
Gets the hint for the specified cell using the Options enabled in the grid control
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.GetCellHintText.Result">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.GetCellHintText.ACol">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.GetCellHintText.ARow">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.GetCells">
|
|
<short>Gets the cell content at the specified column and row numbers</short>
|
|
<descr>
|
|
Always returns an empty string ('') in TCustomGrid. Overridden in descendent classes.
|
|
</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.GetCells.Result">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.GetCells.ACol">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.GetCells.ARow">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TCustomGrid.GetColumnAlignment">
|
|
<short>
|
|
<var>GetColumnAlignment</var> - returns the Alignment value for the nominated column
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.GetColumnAlignment.Result">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.GetColumnAlignment.Column">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.GetColumnAlignment.ForTitle">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TCustomGrid.GetColumnColor">
|
|
<short>
|
|
<var>GetColumnColor</var> - returns the Color for the specified column
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.GetColumnColor.Result">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.GetColumnColor.Column">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.GetColumnColor.ForTitle">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TCustomGrid.GetColumnFont">
|
|
<short>
|
|
<var>GetColumnFont</var> - returns the font for the specified column
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.GetColumnFont.Result">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.GetColumnFont.Column">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.GetColumnFont.ForTitle">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TCustomGrid.GetColumnLayout">
|
|
<short>
|
|
<var>GetColumnLayout</var> - returns the Text Layout value for the specified column
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.GetColumnLayout.Result">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.GetColumnLayout.Column">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.GetColumnLayout.ForTitle">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TCustomGrid.GetColumnReadonly">
|
|
<short>
|
|
<var>GetColumnReadonly</var> - returns True if the column is marked ReadOnly
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.GetColumnReadonly.Result">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.GetColumnReadonly.Column">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TCustomGrid.GetColumnTitle">
|
|
<short>
|
|
<var>GetColumnTitle</var> - returns the column title string
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.GetColumnTitle.Result">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.GetColumnTitle.Column">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.GetColumnWidth">
|
|
<short>
|
|
<var>GetColumnWidth</var> - returns the width of the column
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.GetColumnWidth.Result">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.GetColumnWidth.Column">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TCustomGrid.GetDeltaMoveNext">
|
|
<short>
|
|
<var>GetDeltaMoveNext</var> return the relative cell coordinate of the next cell to which movement will occur
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.GetDeltaMoveNext.Result">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.GetDeltaMoveNext.Inverse">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.GetDeltaMoveNext.ACol">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.GetDeltaMoveNext.ARow">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TCustomGrid.GetDefaultColumnAlignment">
|
|
<short>
|
|
<var>GetDefaultColumnAlignment</var> - returns the default alignment for the specified column
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.GetDefaultColumnAlignment.Result">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.GetDefaultColumnAlignment.Column">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TCustomGrid.GetDefaultColumnWidth">
|
|
<short>
|
|
<var>GetDefaultColumnWidth</var> - returns the default width for the specified column
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.GetDefaultColumnWidth.Result">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.GetDefaultColumnWidth.Column">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TCustomGrid.GetDefaultColumnLayout">
|
|
<short>
|
|
<var>GetDefaultColumnLayout</var> - returns the default text layout for the nominated column
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.GetDefaultColumnLayout.Result">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.GetDefaultColumnLayout.Column">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TCustomGrid.GetDefaultColumnReadOnly">
|
|
<short>
|
|
<var>GetDefaultColumnReadOnly</var> - returns the default setting of the ReadOnly flag for the specified column
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.GetDefaultColumnReadOnly.Result">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.GetDefaultColumnReadOnly.Column">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TCustomGrid.GetDefaultColumnTitle">
|
|
<short>
|
|
<var>GetDefaultColumnTitle</var> - returns the default title string for the specified column
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.GetDefaultColumnTitle.Result">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.GetDefaultColumnTitle.Column">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TCustomGrid.GetDefaultEditor">
|
|
<short>
|
|
<var>GetDefaultEditor</var> - returns the default cell editor for the specified column
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.GetDefaultEditor.Result">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.GetDefaultEditor.Column">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TCustomGrid.GetDefaultRowHeight">
|
|
<short>
|
|
<var>GetDefaultRowHeight</var> - returns the default row height
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.GetDefaultRowHeight.Result">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.GetGridDrawState">
|
|
<short>
|
|
Gets the grid drawing state for the cell with the specified column and row numbers
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.GetGridDrawState.Result">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.GetGridDrawState.ACol">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.GetGridDrawState.ARow">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.GetImageForCheckBox">
|
|
<short>
|
|
Gets the bitmap used to draw Checkbox columns in the grid
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>GetImageForCheckBox</var> signals the <var>OnUserCheckboxBitmap</var> event handler (when assigned) to get a bitmap used for the checkbox state. If a valid <var>TBitmap</var> instance is not assgned in the event handler, the <var>OnUserCheckBoxImage</var> event handler is signalled (when assigned) to get the <var>TImageList</var>, <var>TBitmap</var>, and <var>ImageIndex</var> used for the purpose.
|
|
</p>
|
|
<p>
|
|
GetImageForCheckBox is used in the implementation of the <var>DrawGridCheckboxBitmaps</var> and <var>DrawCellText</var> methods in <var>TCustomGrid</var>.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.OnUserCheckboxBitmap"/>
|
|
<link id="TCustomGrid.OnUserCheckboxImage"/>
|
|
<link id="TCustomGrid.DrawGridCheckboxBitmaps"/>
|
|
<link id="TCustomGrid.DrawCellText"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TCustomGrid.GetImageForCheckBox.aCol">
|
|
<short>Column number for the Checkbox cell</short>
|
|
</element>
|
|
<element name="TCustomGrid.GetImageForCheckBox.aRow">
|
|
<short>Row number for the Checkbox cell</short>
|
|
</element>
|
|
<element name="TCustomGrid.GetImageForCheckBox.CheckBoxView">
|
|
<short>Checkbox state for the cell</short>
|
|
</element>
|
|
<element name="TCustomGrid.GetImageForCheckBox.ImageList">
|
|
<short>Image list with images used for Checkbox drawing states</short>
|
|
</element>
|
|
<element name="TCustomGrid.GetImageForCheckBox.ImageIndex">
|
|
<short>Ordinbal position of the image used for the corresponding Checkbox state</short>
|
|
</element>
|
|
<element name="TCustomGrid.GetImageForCheckBox.Bitmap">
|
|
<short>Bitmap with the image drawn for the Checkbox state</short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TCustomGrid.GetScrollBarPosition">
|
|
<short>
|
|
<var>GetScrollBarPosition</var> - returns the position of the scroll bar specified by
|
|
<var>Which</var>
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.GetScrollBarPosition.Result">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.GetScrollBarPosition.Which">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.GetSmoothScroll">
|
|
<short>Checks for the smooth scroll setting in the Options for the grid</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.GetSmoothScroll.Result">
|
|
<short>True when Options contains the value goSmoothScroll</short>
|
|
</element>
|
|
<element name="TCustomGrid.GetSmoothScroll.Which">
|
|
<short>
|
|
Indicates the scrollbar checked in the method; not used in the current implementation
|
|
</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.GetSBVisibility">
|
|
<short>
|
|
<var>GetSBVisibility</var> - finds the values of the visibility flags for the scrollbars
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.GetSBVisibility.HsbVisible">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.GetSBVisibility.VsbVisible">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.GetSBRanges">
|
|
<short>
|
|
<var>GetSBRanges</var> - finds the range of values for the scrollbars when visible
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.GetSBRanges.HsbVisible">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.GetSBRanges.VsbVisible">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.GetSBRanges.HsbRange">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.GetSBRanges.VsbRange">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.GetSBRanges.HsbPage">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.GetSBRanges.VsbPage">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.GetSelectedState">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.GetSelectedState.AState">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.GetSelectedState.IsSelected">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TCustomGrid.GetEditMask">
|
|
<short>
|
|
<var>GetEditMask</var> - returns the edit mask string for the specified cell
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.GetEditMask.Result">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.GetEditMask.ACol">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.GetEditMask.ARow">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TCustomGrid.GetEditText">
|
|
<short>
|
|
<var>GetEditText</var> - returns the Edit text string for the specified cell
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.GetEditText.Result">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.GetEditText.ACol">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.GetEditText.ARow">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TCustomGrid.GetFixedColor">
|
|
<short>
|
|
<var>GetFixedcolor</var> - returns a value for the fixed color
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.GetFixedColor.Result">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.GetFirstVisibleColumn">
|
|
<short>Gets the position for the first visible non-fixed column in the grid</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.GetFirstVisibleColumn.Result">
|
|
<short>Column number for the first visible column</short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.GetFirstVisibleRow">
|
|
<short>Gets the position for the first visible non-fixed row in the grid</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.GetFirstVisibleRow.Result">
|
|
<short>Row number for the first visible row</short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.GetLastVisibleColumn">
|
|
<short>Gets the position for the last visible non-fixed column in the grid</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.GetLastVisibleColumn.Result">
|
|
<short>Position for the last visible column in the grid</short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.GetLastVisibleRow">
|
|
<short>Gets position for the last visible non-fixed row in the grid</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.GetLastVisibleRow.Result">
|
|
<short>Row number for the last visible non-fixed row</short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TCustomGrid.GetSelectedColor">
|
|
<short>
|
|
<var>GetSelectedColor</var> - returns the value for the color of items that have been selected
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.GetSelectedColor.Result">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.GetTitleShowPrefix">
|
|
<short>Gets the prefix option for titles in the specifiefd column number</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.GetTitleShowPrefix.Result">
|
|
<short>Truw when the TGridColumn is configured to use prefixes</short>
|
|
</element>
|
|
<element name="TCustomGrid.GetTitleShowPrefix.Column">
|
|
<short>Column number examined in the method</short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.GetPxTopLeft">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.GetPxTopLeft.Result">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.GetTruncCellHintText">
|
|
<short>
|
|
Gets the truncated version of a hint for the cell at the specified position
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.GetTruncCellHintText.Result">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.GetTruncCellHintText.ACol">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.GetTruncCellHintText.ARow">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TCustomGrid.GridColumnFromColumnIndex">
|
|
<short>
|
|
<var>GridColumnFromColumnIndex</var> - returns the number of the column given its column index
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.GridColumnFromColumnIndex.Result">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.GridColumnFromColumnIndex.ColumnIndex">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.GridMouseWheel">
|
|
<short>Performs actions needed when the mouse wheel is scrolled in the grid</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.MoveNextSelectable"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TCustomGrid.GridMouseWheel.Shift">
|
|
<short>Shift state modifier in effect for the action</short>
|
|
</element>
|
|
<element name="TCustomGrid.GridMouseWheel.Delta">
|
|
<short>Relative change in the current position for the action</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.HeaderClick">
|
|
<short>
|
|
<var>HeaderClick</var> - method to deal with a click on the column (if <var>IsColumn</var> is True) or row Header
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.HeaderClick.IsColumn">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.HeaderClick.Index">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.HeaderSized">
|
|
<short>
|
|
<var>HeaderSized</var> - method to deal with re-sizing of a column (IsColumn True) or row header
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.HeaderSized.IsColumn">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.HeaderSized.Index">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.HeaderSizing">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.HeaderSizing.IsColumn">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.HeaderSizing.AIndex">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.HeaderSizing.ASize">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.HideCellHintWindow">
|
|
<short>Cancels the current hint display and restores the saved hint for the grid</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.InternalSetColCount">
|
|
<short>
|
|
<var>InternalSetColCount</var> - specify the column count
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.InternalSetColCount.ACount">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.InvalidateGrid">
|
|
<short>
|
|
<var>InvalidateGrid</var> - render the whole grid non-valid</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.InvalidateFocused">
|
|
<short>
|
|
<var>InvalidateFocused</var> - render the focused item non-valid
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.IsColumnIndexValid">
|
|
<short>
|
|
Indicates if the specified index position is valid for the columns in the grid
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.IsColumnIndexValid.Result">
|
|
<short>True when Index is in range for the column definitions in the grid</short>
|
|
</element>
|
|
<element name="TCustomGrid.IsColumnIndexValid.AIndex">
|
|
<short>Index position examined in the method</short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.IsRowIndexValid">
|
|
<short>
|
|
Indicates if the specified index position is valid for the rows in the grid
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.IsRowIndexValid.Result">
|
|
<short>True when Index is in range for the rows in the grid</short>
|
|
</element>
|
|
<element name="TCustomGrid.IsRowIndexValid.AIndex">
|
|
<short>Index position examined in the method</short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.IsColumnIndexVariable">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.IsColumnIndexVariable.Result">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.IsColumnIndexVariable.AIndex">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.IsRowIndexVariable">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.IsRowIndexVariable.Result">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.IsRowIndexVariable.AIndex">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.GetIsCellTitle">
|
|
<short>
|
|
Indicates if the cell at the specified position is a fixed header for a row or column
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.GetIsCellTitle.Result">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.GetIsCellTitle.ACol">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.GetIsCellTitle.ARow">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TCustomGrid.GetIsCellSelected">
|
|
<short>
|
|
<var>GetIsCellSelected</var> - returns True if the given cell is selected
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.GetIsCellSelected.Result">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.GetIsCellSelected.aCol">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.GetIsCellSelected.aRow">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.IsEmptyRow">
|
|
<short>Indicates if the row at the specified position contains empty cells</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.GetCells"/>
|
|
<link id="TCustomGrid.FixedCols"/>
|
|
<link id="TCustomGrid.ColCount"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TCustomGrid.IsEmptyRow.Result">
|
|
<short>True when all cells in the specified row contain empty strings ('')</short>
|
|
</element>
|
|
<element name="TCustomGrid.IsEmptyRow.ARow">
|
|
<short>Row number to examine in the method</short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.IsMouseOverCellButton">
|
|
<short>
|
|
Indicates if the specified mouse position is over a button in a cell editor
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.IsMouseOverCellButton.Result">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.IsMouseOverCellButton.X">
|
|
<short>Screen coordinates for the mouse pointer</short>
|
|
</element>
|
|
<element name="TCustomGrid.IsMouseOverCellButton.Y">
|
|
<short>Screen coordinates for the mouse pointer</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element link="#LCL.Controls.TWinControl.KeyDown" name="TCustomGrid.KeyDown"/>
|
|
<element name="TCustomGrid.KeyDown.Key">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.KeyDown.Shift">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element link="#LCL.Controls.TWinControl.KeyUp" name="TCustomGrid.KeyUp"/>
|
|
<element name="TCustomGrid.KeyUp.Key">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.KeyUp.Shift">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.KeyPress">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.KeyPress.Key">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.LoadContent">
|
|
<short>
|
|
<var>LoadContent</var> - method to load a configuration</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.LoadContent.cfg">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.LoadContent.Version">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.LoadGridOptions">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.LoadGridOptions.cfg">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.LoadGridOptions.Version">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element link="#rtl.Classes.TComponent.Loaded" name="TCustomGrid.Loaded"/>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.LockEditor">
|
|
<short>
|
|
<var>LockEditor</var> - lock the editor so that it will not accept input or changes
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.MouseButtonAllowed">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.MouseButtonAllowed.Result">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.MouseButtonAllowed.Button">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element link="#LCL.Controls.TControl.MouseDown" name="TCustomGrid.MouseDown"/>
|
|
<element name="TCustomGrid.MouseDown.Button">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.MouseDown.Shift">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.MouseDown.X">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.MouseDown.Y">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element link="#LCL.Controls.TControl.MouseMove" name="TCustomGrid.MouseMove"/>
|
|
<element name="TCustomGrid.MouseMove.Shift">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.MouseMove.X">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.MouseMove.Y">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element link="#LCL.Controls.TControl.MouseUp" name="TCustomGrid.MouseUp"/>
|
|
<element name="TCustomGrid.MouseUp.Button">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.MouseUp.Shift">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.MouseUp.X">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.MouseUp.Y">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TCustomGrid.MoveExtend">
|
|
<short>
|
|
<var>MoveExtend</var> - move an extended selection; if <var>Relative</var> is true, use Delta column and row to find position; returns True if successful
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.MoveExtend.Result">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.MoveExtend.Relative">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.MoveExtend.DCol">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.MoveExtend.DRow">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TCustomGrid.MoveNextAuto">
|
|
<short>
|
|
<var>MoveNextAuto</var> - move to next cell in automatic sequence; if <var>Relative</var> is True, use delta col and row to find position; returns True if successful
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.MoveNextAuto.Result">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.MoveNextAuto.Inverse">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TCustomGrid.MoveNextSelectable">
|
|
<short>
|
|
<var>MoveNextSelectable</var> - move to next selectable cell; use delta col and row if
|
|
<var>Relative</var> is True; returns True if successful
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.MoveNextSelectable.Result">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.MoveNextSelectable.Relative">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.MoveNextSelectable.DCol">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.MoveNextSelectable.DRow">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.MoveSelection">
|
|
<short>
|
|
<var>MoveSelection</var> - moves the selected text, cell or group of cells
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TCustomGrid.OffsetToColRow">
|
|
<short>
|
|
<var>OffsetToColRow</var> - move by the value of <var>Offset</var> to another column or row (determined by the value of <var>IsCol</var>), returning True if successful
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.OffsetToColRow.Result">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.OffsetToColRow.IsCol">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.OffsetToColRow.Fisical">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.OffsetToColRow.Offset">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.OffsetToColRow.Index">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.OffsetToColRow.Rest">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element link="#LCL.Controls.TCustomControl.Paint" name="TCustomGrid.Paint"/>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.PickListItemSelected">
|
|
<short>
|
|
<var>PickListItemSelected</var> - indicates that an item was selected from the pick-list
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.PickListItemSelected.Sender">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.PrepareCanvas">
|
|
<short>
|
|
<var>PrepareCanvas</var> - method to get the canvas ready for drawing at the specified location
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.PrepareCanvas.aCol">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.PrepareCanvas.aRow">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.PrepareCanvas.aState">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.PrepareCellHints">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
<notes>
|
|
<note>Current implementation is empty.</note>
|
|
</notes>
|
|
</element>
|
|
<element name="TCustomGrid.PrepareCellHints.ACol">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.PrepareCellHints.ARow">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.ResetDefaultColWidths">
|
|
<short>Restores the default width for columns in the grid</short>
|
|
<descr>
|
|
<p>
|
|
<var>ResetDefaultColWidths</var> updates an internal member with the list of column widths currently in use for the grid. ResetDefaultColWidths calls the <var>VisualChange</var> method after resetting the column widths to their default value. No actions are performed in the method when <var>AutoFillColumns</var> contains <b>True</b>.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.VisualChange"/>
|
|
<link id="TCustomGrid.AutoFillColumns"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.ResetEditor">
|
|
<short>
|
|
<var>ResetEditor</var> - resets the current editor for the grid
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.ResetLastMove">
|
|
<short>Resets the member used to track the last row or column movement</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.ResetOffset">
|
|
<short>
|
|
<var>ResetOffset</var> - resets the offset, checking columns and rows if demanded
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.ResetOffset.chkCol">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.ResetOffset.ChkRow">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.ResetSizes">
|
|
<short>
|
|
<var>ResetSizes</var> - resets the sizes
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.ResizeColumn">
|
|
<short>
|
|
<var>ResizeColumn</var> - resizes the nominated column to the specified width
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.ResizeColumn.aCol">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.ResizeColumn.aWidth">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.ResizeRow">
|
|
<short>
|
|
<var>ResizeRow</var> - resizes the nominated row to the specified height
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.ResizeRow.aRow">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.ResizeRow.aHeight">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.RowHeightsChanged">
|
|
<short>
|
|
<var>RowHeightsChanged</var> - method invoked when row heights are changes
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.SaveContent">
|
|
<short>
|
|
<var>SaveContent</var> as specified in the XML configuration variable
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.SaveContent.cfg">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.SaveGridOptions">
|
|
<short>Saves grid options to the specified XML configuration file</short>
|
|
<descr>
|
|
<p>
|
|
Stores <var>TGridOption</var> and <var>TGridOption2</var> enumeration values found in the <var>Options</var> and <var>Options2</var> properties to the XML configuration file specified in <var>cfg</var>. Used in the implementation of the <var>SaveContent</var> method.
|
|
</p>
|
|
<p>
|
|
Use <var>LoadContent</var> to load option settings into the current grid class instance.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TGridOption"/>
|
|
<link id="TGridOption2"/>
|
|
<link id="TCustomGrid.Options"/>
|
|
<link id="TCustomGrid.Options2"/>
|
|
<link id="TCustomGrid.SaveContent"/>
|
|
<link id="TCustomGrid.LoadContent"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TCustomGrid.SaveGridOptions.cfg">
|
|
<short>XML configuration file where values are stored</short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.FixDesignFontsPPI">
|
|
<!-- TODO -->
|
|
<short></short>
|
|
<descr>
|
|
<p>
|
|
<var>FixDesignFontsPPI</var> is a procedure used to...
|
|
</p>
|
|
</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.FixDesignFontsPPI.ADesignTime">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.ScaleFontsPPI">
|
|
<!-- TODO -->
|
|
<short></short>
|
|
<descr>
|
|
<p>
|
|
<var>ScaleFontsPPI</var> is an overridden procedure used to...
|
|
</p>
|
|
</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.ScaleFontsPPI.AToPPI">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.ScaleFontsPPI.AProportion">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.ScrollBarRange">
|
|
<short>
|
|
<var>ScrollBarRange</var> - specify the range of the scrollbar;
|
|
<var>Which</var> determines whether it is horizontal or vertical
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.ScrollBarRange.Which">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.ScrollBarRange.aRange">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.ScrollBarRange.aPage">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.ScrollBarPosition">
|
|
<short>
|
|
<var>ScrollBarPosition</var> - records the position (<var>Value</var>) of the scrollbar; <var>Which</var> determines horizontal or vertical
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.ScrollBarPosition.Which">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.ScrollBarPosition.Value">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TCustomGrid.ScrollBarIsVisible">
|
|
<short>
|
|
<var>ScrollBarIsVisible</var> - Returns True if visible;
|
|
<var>Which</var> determines whether horizontal or vertical
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.ScrollBarIsVisible.Result">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.ScrollBarIsVisible.Which">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.ScrollBarPage">
|
|
<short>
|
|
<var>ScrollBarPage</var> - a Page movement of the scrollbar (specified by
|
|
<var>Which</var>)
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.ScrollBarPage.Which">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.ScrollBarPage.aPage">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.ScrollBarShow">
|
|
<short>ScrollBarShow method</short>
|
|
<descr>
|
|
<p>
|
|
<var>ScrollBarShow</var> is a procedure used to control the visibility of scrollbars in the grid.
|
|
</p>
|
|
<p>
|
|
<var>Which</var> is an <var>Integer</var> argument that specifies the scrollbar(s) affected in the method, and can include the following constant values:
|
|
</p>
|
|
<dl>
|
|
<dt>SB_HORZ</dt>
|
|
<dd>Horizontal scrollbar</dd>
|
|
<dt>SB_VERT</dt>
|
|
<dd>Vertical scrollbar</dd>
|
|
<dt>SB_BOTH</dt>
|
|
<dd>Both horizontal and vertical scrollbars</dd>
|
|
</dl>
|
|
<p>
|
|
<var>aValue</var> is a <var>Boolean</var> argument that indicates if the specified scrollbar(s) are visible or hidden. When aValue contains <b>True</b>, the corresponding scrollbar(s) are displayed. Otherwise, they are hidden.
|
|
</p>
|
|
<p>
|
|
No actions are performed in the method if a handle has not been allocated for the grid instance (<var>HandleAllocated</var> returns <b>False</b>). ScrollBarShow ensures that <var>gfUpdatingScrollbar</var> is included in the grid flags prior to calling the <var>ShowScrollBar</var> routine in the LCL interface. The flag value is removed immediately after updating the scrollbar display. Internal members used to track scrollbar visibility are set to the state requested in AValue.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TGridFlags"/>
|
|
<link id="TGridFlagsOption"/>
|
|
<link id="#LCL.Controls.TWinControl.HandleAllocated"/>
|
|
<link id="#LCL.LCLIntf.ShowScrollBar"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TCustomGrid.ScrollBarShow.Which">
|
|
<short>Scrollbar(s) affected in the method</short>
|
|
</element>
|
|
<element name="TCustomGrid.ScrollBarShow.aValue">
|
|
<short>True indicates the scrollbar(s) are visible</short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TCustomGrid.ScrollBarAutomatic">
|
|
<short></short>
|
|
<descr>
|
|
Check if scrollbars are shown automatically by the grid or not.
|
|
'Which' can be any of : SB_BOTH, SB_VERT, SB_HORZ
|
|
</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.ScrollBarAutomatic.Result">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.ScrollBarAutomatic.Which">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.ScrollBy">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.ScrollBy.DeltaX">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.ScrollBy.DeltaY">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.SelectEditor">
|
|
<short>
|
|
<var>SelectEditor</var> - chooses the cell editor for the current cell
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- 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 <var>aCol</var> and <var>aRow</var> parameters contain the column and the row of the highlighted cell.
|
|
</p>
|
|
<p>
|
|
Component developers may use the <var>SelectCell</var> method to react to focus changes. The <var>Result</var> is true if the cell can be selected. Application developers should use the <link id="TCustomDrawGrid.OnSelectCell">OnSelectCell</link> event instead.
|
|
</p>
|
|
</descr>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.SelectCell.Result">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.SelectCell.ACol">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.SelectCell.ARow">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.SetCanvasFont">
|
|
<short>
|
|
<var>SetCanvasFont</var> to specified value
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.SetCanvasFont.aFont">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.SetColCount">
|
|
<short>Sets the value in the ColCount property</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.ColCount"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TCustomGrid.SetColCount.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.SetColor">
|
|
<short>
|
|
Sets the value in the Color property
|
|
</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="#LCL.Controls.TControl.Color"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.SetColor.Value">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.SetColRow">
|
|
<short>
|
|
<var>SetColRow</var> - specifies the column and row for addressing
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.SetColRow.ACol">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.SetColRow.ARow">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.SetCursor">
|
|
<short>Changes the cursor shape in the grid to the specified value</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.ColSizingCursor"/>
|
|
<link id="TCustomGrid.RowSizingCursor"/>
|
|
<link id="TCustomGrid.CursorState"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TCustomGrid.SetCursor.AValue">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.SetEditText">
|
|
<short>
|
|
<var>SetEditText</var> - specifies the text-string to be placed in the Editor for processing
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.SetEditText.ACol">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.SetEditText.ARow">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.SetEditText.Value">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.SetBorderStyle">
|
|
<short>
|
|
<var>SetBorderStyle</var> - specifies a new border style
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.SetBorderStyle.NewStyle">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.SetFixedColor">
|
|
<short>
|
|
<var>SetFixedcolor</var> - specifies color for fixed cells
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.SetFixedColor.AValue">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.SetFixedCols">
|
|
<short>Sets the value for the FixedCols property</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.FixedCols"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TCustomGrid.SetFixedCols.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.SetFixedRows">
|
|
<short>Sets the value for the FixedRows property</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.FixedRows"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TCustomGrid.SetFixedRows.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.SetRawColWidths">
|
|
<short>Sets column widths during LCL component streaming</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.SetRawColWidths.ACol">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.SetRawColWidths.AValue">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.SetSelectedColor">
|
|
<short>
|
|
<var>SetSelectedColor</var> - specifies color for cells that have been selected
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.SetSelectedColor.AValue">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.ShowCellHintWindow">
|
|
<short>Gets and displays the cell hint(s) for the current cell in the grid</short>
|
|
<descr>
|
|
<p>
|
|
<var>ShowCellHintWindow</var> is a procedure used to gets the value(s) and display cell hint(s) for the cell located at the screen position in <var>APoint</var>. Values in the <var>Options</var> and <var>CellHintPriority</var> properties determine the text available for use as cell hints.
|
|
</p>
|
|
<p>
|
|
<var>GetCellHintText</var> and <var>GetTruncCellHintText</var> are called to get the corresponding hint text for the options and hint priority. <var>AddToHint</var> is called to apply the derived text to the values displayed in the control using its <var>Hint</var> property. <var>Application.ActivateHint</var> is called to display the hint window.
|
|
</p>
|
|
<p>
|
|
No actions are performed in the method when <var>ShowHints</var> contains <b>False</b>, when the mouse pointer is not positioned over a grid cell, when <var>EditorMode</var> is <b>True</b>, or at design-time.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.Options"/>
|
|
<link id="TCustomGrid.CellHintPriority"/>
|
|
<link id="TCustomGrid.GetCellHintText"/>
|
|
<link id="TCustomGrid.GetTruncCellHintText"/>
|
|
<link id="TCustomGrid.HideCellHintWindow"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TCustomGrid.ShowCellHintWindow.APoint">
|
|
<short>Screen coordinates for the mouse pointer</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.SizeChanged">
|
|
<short>
|
|
<var>SizeChanged</var> - specifies the old number of columns and rows
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.SizeChanged.OldColCount">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.SizeChanged.OldRowCount">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.Sort">
|
|
<short>Sorts rows or columns in the grid</short>
|
|
<descr>
|
|
<p>
|
|
<var>Sort</var> is a method used to sort all items in the grid. When <var>ColSorting</var> is True, it sorts the items in a column. Otherwise, it sorts a row. The three given indexes specify the items to be sorted.
|
|
</p>
|
|
</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.Sort.ColSorting">
|
|
<short>Indicates if the sort is performed for a column instead of a row</short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.Sort.Index">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.Sort.IndxFrom">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.Sort.IndxTo">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.StartPushCell">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.TopLeftChanged">
|
|
<short>
|
|
<var>TopLeftChanged</var> - the top left cell has changed</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TCustomGrid.TryMoveSelection">
|
|
<short>
|
|
<var>TryMoveSelection</var> - attempts to move the selection by the specified offset; returns True if successful</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.TryMoveSelection.Result">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.TryMoveSelection.Relative">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.TryMoveSelection.DCol">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.TryMoveSelection.DRow">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.UnLockEditor">
|
|
<short>
|
|
<var>UnLockEditor</var> - frees a previously locked Editor
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.UnprepareCellHints">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
<notes>
|
|
<note>Current implementation is empty in TCustomGrid.</note>
|
|
</notes>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.UpdateHorzScrollBar">
|
|
<short>
|
|
<var>UpdateHorzScrollBar</var> - updates the scrollbar in the given range by the given page, if it is visible</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.UpdateHorzScrollBar.aVisible">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.UpdateHorzScrollBar.aRange">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.UpdateHorzScrollBar.aPage">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.UpdateSelectionRange">
|
|
<short>
|
|
Updates the selection range when the cell selection or other visual aspects of the grid are changed
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.UpdateVertScrollbar">
|
|
<short>
|
|
<var>UpdateVertScrollbar</var> - updates the scrollbar in the given range by the given page, if it is visible</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.UpdateVertScrollbar.aVisible">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.UpdateVertScrollbar.aRange">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.UpdateVertScrollbar.aPage">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.UpdateBorderStyle">
|
|
<short>
|
|
<var>UpdateBorderStyle</var> - brings the border style up to date
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.ValidateEntry">
|
|
<short></short>
|
|
<descr>
|
|
<p>
|
|
<var>ValidateEntry</var> is a <var>Boolean</var> function used to a validate the value for the cell at the specified <var>Col</var> and <var>Row</var> position.
|
|
</p>
|
|
<p>
|
|
ValidateEntry signals the <var>OnValidateEntry</var> event handler (when assigned) to perform validation for the cell. The return value is <b>True</b> when <var>OnValidateEntry</var> completes successfully, or when the event handler has not been assigned.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.OnValidateEntry"/>
|
|
<link id="TCustomGrid.Col"/>
|
|
<link id="TCustomGrid.Row"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TCustomGrid.ValidateEntry.Result">
|
|
<short>True when validation completes successfully</short>
|
|
</element>
|
|
<element name="TCustomGrid.ValidateEntry.ACol">
|
|
<short>Column number for the operation</short>
|
|
</element>
|
|
<element name="TCustomGrid.ValidateEntry.ARow">
|
|
<short>Row number for the operation</short>
|
|
</element>
|
|
<element name="TCustomGrid.ValidateEntry.OldValue">
|
|
<short>Value on entry to the method</short>
|
|
</element>
|
|
<element name="TCustomGrid.ValidateEntry.NewValue">
|
|
<short>Value on exit from the method</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.VisualChange">
|
|
<short>
|
|
Updates the grid after changes to the visual properties in the control
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>VisualChange</var> is a procedure used to update the grid when visual aspects of the control have been changed. VisualChange calls <var>UpdateSizes</var> to refresh the size of cells in the gris, and calls <var>Invalidate</var> to force the control to be redrawn.
|
|
</p>
|
|
<p>
|
|
No actions are performed in the method when <var>BeginUpdate</var> has been called to buffer updates to the grid. VisualChange will resume updates when <var>EndUpdate</var> has been called to disable update buffering.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.Invalidate"/>
|
|
<link id="TCustomGrid.BeginUpdate"/>
|
|
<link id="TCustomGrid.EndUpdate"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.WMSize">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.WMSize.Message">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.WMHScroll">
|
|
<short>
|
|
<var>WMHScroll</var> - system message for horizontal scrolling</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.WMHScroll.message">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.WMVScroll">
|
|
<short>
|
|
<var>WMVScroll</var> - system message for vertical scrolling</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.WMVScroll.message">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element link="#LCL.Controls.TWinControl.WMKillFocus" name="TCustomGrid.WMKillFocus"/>
|
|
<element name="TCustomGrid.WMKillFocus.message">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element link="#LCL.Controls.TWinControl.WMSetFocus" name="TCustomGrid.WMSetFocus"/>
|
|
<element name="TCustomGrid.WMSetFocus.message">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element link="#LCL.Controls.TControl.WndProc" name="TCustomGrid.WndProc"/>
|
|
<element name="TCustomGrid.WndProc.TheMessage">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.AllowOutboundEvents">
|
|
<short>
|
|
<var>AllowOutboundEvents</var> - permits mouse click on an imaginary (out-of-bounds) cell; moves cursor to nearest valid cell
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
Normally when a user clicks on a point over the empty space after cells (for example if grid has three rows but user clicks on imaginary fourth row) the current focused cell will move to the nearest cell to clicked point; we call this an outbound event.
|
|
</p>
|
|
<p>
|
|
Default value is <b>True</b>, as this has been the grid's behavior since the beginning.
|
|
</p>
|
|
<p>
|
|
This was added to simulate Delphi behavior where outbound events are not available; to enable Delphi compatibility set this to <b>False</b>.
|
|
</p>
|
|
</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.AlternateColor">
|
|
<short>
|
|
The color to be used for the background on alternate rows of the grid. Having alternate rows in different colors can make the grid easier to read.
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.AutoAdvance">
|
|
<short>
|
|
Automatically advance down the grid on successive mouse clicks or presses of the ENTER or TAB key
|
|
</short>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.AutoEdit">
|
|
<short>Whether the Edit mode is automatically entered when a cell is selected</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.AutoFillColumns">
|
|
<short>Automatically resize columns so they fill all grid's visible area</short>
|
|
<descr>
|
|
<p>
|
|
When this option is turned on, the grid will resize all columns to fill the grid's client width. What columns are resized is determined by the following conditions:
|
|
</p>
|
|
<ol>
|
|
<li><var>Fixed Columns</var> are not resized.</li>
|
|
<li>
|
|
If the grid has <var>Custom Columns</var>, all columns with <var>SizePriority</var> set to 0 are not resized.
|
|
</li>
|
|
</ol>
|
|
<p>
|
|
Note that Custom Columns are initially created with SizePriority=1. For TDbGrid, which automatically adds <var>Custom Columns</var>, this means the user will not be able to resize such columns using the mouse.
|
|
</p>
|
|
</descr>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element link="#LCL.Controls.TWinControl.BorderStyle" name="TCustomGrid.BorderStyle">
|
|
<descr>
|
|
Only a restricted series of options is available: none or a single border.
|
|
</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.BorderColor">
|
|
<short>The color of the border for this control</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.CellHintPriority">
|
|
<short>Identifies how text is combined to form the Hint property</short>
|
|
<descr>
|
|
<p>
|
|
<var>CellHintPriority</var> is a <var>TCellHintPriority</var> that identifies how text is combined to form the Hint property. The default value for the is <var>chpAllNoDefault</var>. See <link id="TCellHintPriority"/> for a description of the enumeration values and their meanings.
|
|
</p>
|
|
<p>
|
|
CellHintPriority is used in the implementation of the <var>ShowCellHintWindow</var>, <var>MouseMove</var>, and <var>GetTruncCellHintText</var> methods.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCellHintPriority"/>
|
|
<link id="TCustomGrid.ShowCellHintWindow"/>
|
|
<link id="TCustomGrid.MouseMove"/>
|
|
<link id="TCustomGrid.GetTruncCellHintText"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.Col">
|
|
<short>Current column index.</short>
|
|
<descr>
|
|
<var>Col</var> is an Integer which holds the column index of the current grid cell cursor. The current grid column can be changed programmatically by setting a new value to this property.
|
|
</descr>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.ColCount">
|
|
<short>Number of columns of the grid.</short>
|
|
<descr>
|
|
<p>
|
|
<var>ColCount</var> is an Integer that represents the number of columns in the grid, including fixed and normal columns. Changing the value in <var>ColCount</var> after <var>Columns</var> have been created causes an <var>EGridException</var> to be raised. Use the <var>Columns</var> to add or delete columns defined in the grid.
|
|
</p>
|
|
<p>
|
|
Use <var>FixedCols</var> for the number of fixed columns in the grid.
|
|
</p>
|
|
<p>
|
|
Use <var>VisibleColCount</var> for the number of non-fixed columns in the grid.
|
|
</p>
|
|
<p>
|
|
Use <var>RowCount</var>, <var>FixedRows</var>, and <var>VisibleRowCount</var> to access the row-oriented equivalents.
|
|
</p>
|
|
</descr>
|
|
<errors>
|
|
Raises an <var>EGridException</var> when the value is changed and <var>Columns</var> already exist in the grid.
|
|
</errors>
|
|
<seealso>
|
|
<link id="TCustomGrid.FixedCols"/>
|
|
<link id="TCustomGrid.FixedRows"/>
|
|
<link id="TCustomGrid.Columns"/>
|
|
<link id="TCustomGrid.RowCount"/>
|
|
<link id="TCustomGrid.VisibleColCount"/>
|
|
<link id="TCustomGrid.VisibleRowCount"/>
|
|
<link id="TGridPropertyBackup"/>
|
|
<link id="EGridException"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.ColRow">
|
|
<short>
|
|
Provides access to current column and row numbers as a TPoint instance
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>ColRow</var> is a <var>TPoint</var> property used to provide access to the current values at the position specified in Col and Row. The <var>X</var> member in TPoint is used for the value in the <var>Col</var> property. The <var>Y</var> member in TPoint is used for the value in the <var>Row</var> property.
|
|
</p>
|
|
<p>
|
|
Setting the value for the causes the <var>CheckLimitsWithError</var> method to be called for the X and Y values when <var>AllowOutboundEvents</var> is <b>False</b>. The <var>SetColRow</var> method is called to update the values in the Col and Row properties.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.CheckLimitsWithError"/>
|
|
<link id="TCustomGrid.SetColRow"/>
|
|
<link id="TCustomGrid.AllowOutboundEvents"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.ColRowDraggingCursor">
|
|
<short>Cursor shape displayed when a column is dragged or moved</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.ColRowDragIndicatorColor">
|
|
<short>
|
|
Color used to render the indicator drawn when a column or row is dragged in the grid
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.ColSizingCursor">
|
|
<short>Cursor shape displayed when a column is resized</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.ColumnClickSorts">
|
|
<short>Indicates if clicking a column header changes its sort order</short>
|
|
<descr>
|
|
<p>
|
|
<var>ColumnClickSorts</var> is a <var>Boolean</var> used to indicate if clicking a column header changes its sort order. The default value for the is <b>False</b>.
|
|
</p>
|
|
<p>
|
|
ColumnClickSorts is used in the <var>HeaderClick</var> method to determine if the value in the <var>SortOrder</var> is toggled for a click in the header cell for SortColumn.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.HeaderClick"/>
|
|
<link id="TCustomGrid.SortColumn"/>
|
|
<link id="TCustomGrid.SortOrder"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.Columns">
|
|
<short>The properties of the columns in this grid</short>
|
|
<descr>
|
|
<p>
|
|
<var>Columns</var> is a <var>TGridColumns</var> used to represent column definitions for the grid control. Columns contains the <var>TGridColumn</var> instances which define the attributes for the column such as its size, shape, color, etc.
|
|
</p>
|
|
<p>
|
|
Columns should not be confused with the <i>COLUMNS</i> construct frequently used in <i>SQL</i> programming, which refer to <var>Fields</var> 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 color, 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.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TGridColumns"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.ColWidths">
|
|
<short>Column widths for the grid.</short>
|
|
<descr>
|
|
<p>
|
|
The column is specified with the <var>aCol</var> parameter. The <var>aCol</var> parameter must fall within the valid index range of 0 to <link id="TCustomGrid.ColCount">ColCount</link>-1.
|
|
</p>
|
|
<p>
|
|
The return value of the 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.DefaultColWidth">DefaultColWidth</link> property. After that the user may redefine this value.
|
|
</p>
|
|
<p>
|
|
If the <link id="TCustomGrid.Options">Options</link> includes the appropriate option value, the column width may also be changed by the user at run-time.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.ColCount"/>
|
|
<link id="TCustomGrid.DefaultColWidth"/>
|
|
<link id="TCustomGrid.RowHeights"/>
|
|
<link id="TCustomGrid.Options"/>
|
|
<link id="TGridOption"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.ColWidths.aCol">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- 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.ColCount">ColCount</link> property, the width of these new columns will be set to the value of the <i>DefaultColWidth</i> property.
|
|
</p>
|
|
<p>
|
|
Use 0 for auto-sized width.
|
|
</p>
|
|
<p>
|
|
Use GetRealDefaultColWidth for the real value.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.DefaultRowHeight"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- 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.RowCount">RowCount</link> property, the height of these new rows will be set to the value of the <i>DefaultRowHeight</i> property.
|
|
</p>
|
|
<p>
|
|
Use 0 for auto-sized height.
|
|
</p>
|
|
<p>
|
|
Use GetRealDefaultRowHeight for the real value.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.DefaultColWidth"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.DefaultDrawing">
|
|
<short>Is the default drawing method to be used for this grid? Default is TRUE</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.DefaultTextStyle">
|
|
<short>Default style for displaying text - includes alignment, layout, single or multi-lines</short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.DisabledFontColor">
|
|
<short>Color used to draw text in the grid when the Enabled is False</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.DragDx">
|
|
<short>
|
|
<var>DragDx</var> - the amount (DeltaX) by which an object should be dragged</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.Editor">
|
|
<short>The editor to be used for modifying information in the cells of the grid</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.EditorBorderStyle">
|
|
<short>The border style for the editor used in this grid</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.EditorMode">
|
|
<short>Is grid ready to accept edits? (EditorMode True)</short>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.EditorKey">
|
|
<short>
|
|
<var>EditorKey</var> - is the current key available to the editor?</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.EditorOptions">
|
|
<short>The set of options available for the grid's editor</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.EditorShowing">
|
|
<short>Is the editor for the grid displayed?</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.ExtendedColSizing">
|
|
<short>
|
|
<var>ExtendedColSizing</var> - the sizing to be used for extended columns</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.ExtendedRowSizing">
|
|
<short>
|
|
<var>ExtendedRowSizing</var> - the sizing to be used for extended rows
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.ExtendedSelect">
|
|
<short>
|
|
<var>ExtendedSelect</var> - the ability to select cells beyond the boundary of the visible part of the grid
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.FastEditing">
|
|
<short>Indicates if fast editing is used in the grid</short>
|
|
<descr>
|
|
<p>
|
|
<var>FastEditing</var> is a <var>Boolean</var> which indicates if cell editing initialized by a KeyDown message instead of a navigation key is used in the grid control. The value in FastEditing is used when TPickListCellEditor handles KeyDown messages.
|
|
</p>
|
|
<p>
|
|
The default value for the is <b>True</b> as assigned in the <var>Create</var> constructor.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TPickListCellEditor.KeyDown"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.AltColorStartNormal">
|
|
<short>
|
|
<var>AltColorStartNormal</var> - using a second color to display alternate rows, but starting the first row with the normal color</short>
|
|
<descr>
|
|
<p>
|
|
<var>AltColorStartNormal</var> - using a second color to display alternate rows, but starting the first row with the normal color.
|
|
</p>
|
|
<p>
|
|
Using a different color for the background of alternate rows often makes the data in a grid much easier to read.
|
|
</p>
|
|
</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.FixedCols">
|
|
<short>
|
|
Number of the fixed columns of the grid (i.e. the columns containing title or identifier material, that don't get scrolled when the rest of the grid moves).
|
|
</short>
|
|
<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"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.FixedRows">
|
|
<short>
|
|
Number of the fixed rows of the grid (i.e. the rows containing title or identifier material, that don't get scrolled when the rest of the grid moves).
|
|
</short>
|
|
<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"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.FixedColor">
|
|
<short>The color for the fixed cells of the grid.</short>
|
|
<descr>The color used by headings.</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.FixedColor"/>
|
|
<link id="TCustomGrid.FixedRows"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.FixedGridLineColor">
|
|
<short>Color used to draw lines around fixed grid cells</short>
|
|
<descr>
|
|
<p>
|
|
The default value for the is cl3DDKShadow as asssigned in the constructor. Changing the value in FixedGridLineColor causes the grid to be redrawn. The color is not used when GridLineWidth contains the value 0 (zero).
|
|
</p>
|
|
<p>
|
|
FixedGridLineColor is used in the implementation of the DrawCellGrid method.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.GridLineWidth"/>
|
|
<link id="TCustomGrid.DrawCellGrid"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.FixedHotColor">
|
|
<short>
|
|
<var>FixedHotColor</var> - the 'Hot' color for the active (selected, etc) fixed cells of the grid
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.Flat">
|
|
<short>
|
|
Is the cell to be displayed <var>Flat</var>, i.e. with no texturing or raised/lowered effect
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.FocusColor">
|
|
<short>The color to be used for the cell receiving focus</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.FocusRectVisible">
|
|
<short>
|
|
<var>FocusRectVisible</var> - is the rectangle receiving focus visible?</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.GCache">
|
|
<short>
|
|
<var>GCache</var> - the cache to be used for grid data</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.GridFlags">
|
|
<short>
|
|
<var>GridFlags</var> - the flags that are set for the grid</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.GridHeight">
|
|
<short>
|
|
<var>GridHeight</var> - the height of the grid</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.GridLineColor">
|
|
<short>Color to be used for GridLines</short>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.GridLineStyle">
|
|
<short>Style to be used for GridLines</short>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.GridLineWidth">
|
|
<short>Width (thickness) of GridLines</short>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.GridWidth">
|
|
<short>Width of the whole Grid</short>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.HeaderHotZones">
|
|
<short>
|
|
<var>HeaderHotZones</var> - the zones of the header that are under the cursor, so are capable of being selected or pushed (or not!)</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.HeaderPushZones">
|
|
<short>
|
|
<var>HeaderPushZones</var> - the zones of the header that have been selected by the cursor, or pushed</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.ImageIndexSortAsc">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
<notes>
|
|
<note>Not used in the current implementation. ???</note>
|
|
</notes>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.ImageIndexSortDesc">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
<notes>
|
|
<note>Not used in the current implementation. ???</note>
|
|
</notes>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.TabAdvance">
|
|
<short>Stores the behavior for Tab navigation used in the grid control</short>
|
|
<descr>
|
|
<p>
|
|
TabAdvance is a TAutoAdvance used to determine the behavior for Tab navigation is used in the grid control. The default value for the is aaRightDown. See TAutoAdvance for the values and their usage.
|
|
</p>
|
|
<p>
|
|
TabAdvance is used in the implementation of the KeyDown method in TCustomGrid.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TAutoAdvance"/>
|
|
<link id="TCustomGrid.KeyDown"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.TitleImageList">
|
|
<short>
|
|
<var>TitleImageList</var> - the list of images to be used with the titles
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.TitleImageListWidth">
|
|
<short>
|
|
Stores the default width for images used in the title area for fixed cells
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>TitleImageListWidth</var> is an <var>Integer</var> which stores the default width for images used in the title area for fixed cells. The default value for the is 0. Changing the value in TitleImageListWidth causes the <var>VisualChange</var> method to be called to update the grid control.
|
|
</p>
|
|
<p>
|
|
The value in TitleImageListWidth is used in methods which draw fixed cells in the grid, such as:
|
|
</p>
|
|
<ul>
|
|
<li>DrawColumnTitleImage</li>
|
|
<li>AutoAdjustColumn</li>
|
|
<li>GetSortTitleImageInfo</li>
|
|
</ul>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.DrawColumnTitleImage"/>
|
|
<link id="TCustomStringGrid.AutoAdjustColumn"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.InplaceEditor">
|
|
<short>
|
|
<var>InplaceEditor</var> - the editor to be used in-place, i.e. in the cell itself instead of outside the grid</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- function Visibility: public -->
|
|
<element name="TCustomGrid.IsCellSelected">
|
|
<short>
|
|
<var>IsCellSelected</var> - is the cell specified by
|
|
<var>aCol, aRow</var> selected?</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.IsCellSelected.Result">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.IsCellSelected.aCol">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.IsCellSelected.aRow">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.LeftCol">
|
|
<short>
|
|
<var>LeftCol</var> - the left-most column</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.MouseWheelOption">
|
|
<short>Sets the mouse wheel behavior for the grid control</short>
|
|
<descr>
|
|
<p>
|
|
<var>MouseWheelOption</var> is a <var>TMouseWheelOption</var> used to set the mouse wheel behavior for the grid control. The default value for the is <var>mwCursor</var>, and indicates that mouse wheel movements change the cursor position on the screen. Use <var>mwGrid</var> to cause mouse wheel movements to change the active selection in the grid control.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TMouseWheelOption"/>
|
|
<link id="TCustomGrid.DoMouseWheel"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.Options">
|
|
<short>
|
|
Contains the set of optional features and/or behaviors enabled for the grid
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>Options</var> is a <var>TGridOptions</var> used to store the options enabled for the grid control. Values from the <var>TGridOptions</var> enumeration are included in the set type to enable the features or behaviors. For a list of available options and their usage, see<link id="TGridOptions"/>.
|
|
</p>
|
|
<p>
|
|
The default value for the Options is the <var>DefaultGridOptions</var> set.
|
|
</p>
|
|
<p>
|
|
Use <var>Options2</var> to set scrolling behaviors enabled for the grid control.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TGridOptions"/>
|
|
<link id="DefaultGridOptions"/>
|
|
<link id="TCustomGrid.Options2"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.Options2">
|
|
<short>Contains additional options enabled for the grid control</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.RangeSelectMode">
|
|
<short>Controls the range selection mode used for the grid</short>
|
|
<descr>
|
|
<p>
|
|
<var>RangeSelectMode</var> is a <var>TRangeSelectMode</var> that controls the range selection mode used for the grid. The default value for the is <var>rsmSingle</var>, and allows selection of a single cell in a range. Use <var>rsmMulti</var> to select multiple cells in a range selection.
|
|
</p>
|
|
<p>
|
|
Changing the value in RangeSelectMode causes the <var>ClearSelections</var> method be called to remove existing selection(s) in the grid control.
|
|
</p>
|
|
<p>
|
|
RangeSelectMode is used in the implementation of methods like:
|
|
</p>
|
|
<ul>
|
|
<li>AddSelectedRange</li>
|
|
<li>GetIsCellSelected</li>
|
|
<li>MouseDown</li>
|
|
<li>InvalidateCell</li>
|
|
</ul>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TRangeSelectMode"/>
|
|
<link id="TCustomGrid.ClearSelections"/>
|
|
<link id="TCustomGrid.AddSelectedRange"/>
|
|
<link id="TCustomGrid.GetIsCellSelected"/>
|
|
<link id="TCustomGrid.MouseDown"/>
|
|
<link id="TCustomGrid.InvalidateCell"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.Row">
|
|
<short>The current <var>Row </var>(record) within the grid</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.RowCount">
|
|
<short>Number of rows in the grid</short>
|
|
<descr>This is the number of rows in the grid, including fixed and normal rows.</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.Row"/>
|
|
<link id="TCustomGrid.RowHeights"/>
|
|
<link id="TCustomGrid.RowCount"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.RowSizingCursor">
|
|
<short>Cursor shape displayed when the row height is changed</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.RowHeights">
|
|
<short>The row heights for the grid.</short>
|
|
<descr>
|
|
<p>
|
|
The row is specified with the <var>aRow</var> parameter. The <var>aRow</var> parameter must fall within the valid index range of 0 to <link id="TCustomGrid.RowCount">RowCount</link>-1.
|
|
</p>
|
|
<p>
|
|
The return value of the 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.DefaultRowHeight">DefaultRowHeight</link> property. After that the user may redefine this value. If the <link id="TCustomGrid.Options">Options</link> includes the appropriate value, the row height may also be changed by the user at run-time.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.RowCount"/>
|
|
<link id="TCustomGrid.DefaultRowHeight"/>
|
|
<link id="TCustomGrid.Options"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.RowHeights.aRow">
|
|
<short>Row number affected in the method</short>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.SaveOptions">
|
|
<short>
|
|
The set of options for saving information from the grid (design, attributes, content or position)
|
|
</short>
|
|
<descr>
|
|
These options are used when saving grid information, but also when loading grid information.
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.LoadFromFile"/>
|
|
<link id="TCustomGrid.SaveToFile"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.SelectActive">
|
|
<short>
|
|
<var>SelectActive</var> - if True, the current active cell is selected</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.SelectedColor">
|
|
<short>Color to be used for selected cells</short>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.SelectedColumn">
|
|
<short>The column (field) currently selected</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.Selection">
|
|
<short>The current selection (rows and columns) in the grid</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.ScrollBars">
|
|
<short>The <var>ScrollBars</var> to be used with this grid</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.StrictSort">
|
|
<short>
|
|
<var>StrictSort</var> - is strict sorting to be used?</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.TitleFont">
|
|
<short>The font to be used in the grid's title</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.TitleStyle">
|
|
<short>The style to be used for the grid's title</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.TopRow">
|
|
<short>The first row (record) in the grid</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.UseXORFeatures">
|
|
<short>
|
|
<var>UseXORFeatures</var>: When True, the dotted focus rectangle is painted using the XOR raster operation
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
This controls how the dotted focus rectangle appears in the grid. When <b>True</b>, the rectangle is painted using an XOR raster operation. This allows the focus rectangle to be seen regardless of the cell background color. When <b>False</b>, the user can control the color of the dotted focus rectangle using the <var>FocusColor</var> property.
|
|
</p>
|
|
<p>
|
|
It also controls the look of column/row resizing operations. When <b>True</b>, a line shows visually the size that the the column or row will have if the user ends the operation. When <b>False</b>, the column or row resizing takes effect as the user drags the mouse.
|
|
</p>
|
|
</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.ValidateOnSetSelection">
|
|
<short>
|
|
Controls whether validation is performed when the text for the selected cell is changed
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>ValidateOnSetSelection</var> is a <var>Boolean</var> property used to control validation performed when the text for the selected cell is changed in the grid. The default value for ValidateOnSetSelection is <b>False</b>, as assigned in the constructor for the class.
|
|
</p>
|
|
<p>
|
|
ValidateOnSetSelection is used in the <var>SelectionSetText</var> method to determine if the <var>ValidateEntry</var> method is called to validate the content in the cell.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.ValidateEntry"/>
|
|
<link id="TCustomGrid.OnValidateEntry"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.VisibleColCount">
|
|
<short>The number of visible columns</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.VisibleRowCount">
|
|
<short>The number of visible rows</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.OnAfterSelection">
|
|
<short>Event handler signalled after a new cell has been selected in the grid</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.OnBeforeSelection">
|
|
<short>
|
|
<var>OnBeforeSelection</var> - event handler for use before a selection is made</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.OnCheckboxToggled">
|
|
<short>Event handler signalled when the value for a Checkbox cell is toggled</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.OnCompareCells">
|
|
<short>Event handler for comparing the contents of grid cells</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.OnPrepareCanvas">
|
|
<short>Event handler to prepare the <var>Canvas</var> for drawing</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.OnDrawCell">
|
|
<short>Event handler for drawing a cell</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.OnEditButtonClick">
|
|
<short>Event handler for when the Edit button is clicked</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.OnButtonClick">
|
|
<short>Event handler signalled when a button for a column is clicked in the grid</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.OnPickListSelect">
|
|
<short>Event handler for selecting an item from a picklist (e.g. drop-down list in <var>TComboBox</var>)</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.OnSelection">
|
|
<short>
|
|
Event handler for when an area of a grid (one or a group of cells) is selected
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
The <var>Col</var> and <var>Row</var> parameters contain the column and the row of the highlighted cell.
|
|
</p>
|
|
<p>
|
|
Application developers can use the <var>OnSelection</var> and <var>OnBeforeSelection</var> events to react to focus changes. Component developers should use the ??? method instead.
|
|
</p>
|
|
</descr>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.OnSelectEditor">
|
|
<short>Event handler signalled to select a cell editor</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomGrid.OnTopLeftChanged">
|
|
<short>
|
|
Event handler signalled when the top left cell is changed (i.e. the grid has been scrolled so that a different cell occupies top left)
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.OnUserCheckboxBitmap">
|
|
<short>
|
|
<var>OnUserCheckboxBitmap</var> - event handler for a user accessing a checkbox bitmap
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.OnUserCheckboxImage">
|
|
<short>
|
|
Event handler signalled to get an image from an image list used for Checkbox cells
|
|
</short>
|
|
<descr>
|
|
</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.OnValidateEntry">
|
|
<short>Event handler used to perform validation for cells</short>
|
|
<descr>
|
|
<p>
|
|
<var>OnValidateEntry</var> is a <var>TValidateEntryEvent</var> which implements the event handler signalled to perform validation for cells in the <var>ValidateEntry</var> method.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.ValidateEntry"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.FlipRect">
|
|
<short>Flips coordinates in the rectangle when BiDi or RTL alignment is used</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.FlipRect.Result">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.FlipRect.ARect">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.FlipPoint">
|
|
<short>Flips coordinates in the point when BiDi or RTL alignment is used</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.FlipPoint.Result">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.FlipPoint.P">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.FlipX">
|
|
<short>
|
|
Flips the horizontal position in the client rectangle when BiDi or RTL alignment is used
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.FlipX.Result">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.FlipX.X">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.OnGetCellHint">
|
|
<short>Gets the individual hint for each cell</short>
|
|
<descr>
|
|
<var>OnGetCellHint</var> is a <var>TGetCellHintEvent</var> with the event handler signalled to get the hint for cells in the grid control. OnGetCellHint is signalled when the <link id="TGridOption.goCellHints"/> enumeration value is included in the <link id="TCustomGrid.Options"/> property.
|
|
</descr>
|
|
<seealso>
|
|
<link id="TGridOption.goCellHints"/>
|
|
<link id="TCustomGrid.Options"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.OnSaveColumn">
|
|
<short>Event handler signalled when a column is saved</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.DoSaveColumn"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.OnLoadColumn">
|
|
<short>Event handler signalled when a column is loaded</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- constructor Visibility: public -->
|
|
<element name="TCustomGrid.Create">
|
|
<short>
|
|
Constructor for the class instance
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>Create</var> is the constructor for <var>TCustomGrid</var>. Create calls the inherited <var>Create</var> method, allocates the lists with columns and rows, initializes many visual properties and options, creates the various cell editors, and loads any bitmaps required for the display.
|
|
</p>
|
|
<remark>
|
|
The inherited method calls SetBounds and VisualChange, so the grid needs to be fully instantiated before it is called.
|
|
</remark>
|
|
</descr>
|
|
<seealso>
|
|
<link id="#LCL.Controls.TCustomControl.Create">TCustomControl.Create</link>
|
|
</seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.Create.AOwner">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- destructor Visibility: public -->
|
|
<element name="TCustomGrid.Destroy">
|
|
<short>
|
|
Destructor for the class instance
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>Destroy</var> is the destructor for <var>TCustomGrid</var>. Destroy frees various resources including editors, columns, rows, and fonts. It calls the inherited <var>Destroy</var> method.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="#LCL.Controls.TCustomControl.Destroy">TCustomControl.Destroy</link>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: public -->
|
|
<element link="#LCL.Controls.TControl.Invalidate" name="TCustomGrid.Invalidate"/>
|
|
<element link="#LCL.Controls.TControl.EditingDone" name="TCustomGrid.EditingDone"/>
|
|
|
|
<element name="TCustomGrid.AdjustInnerCellRect">
|
|
<short>
|
|
Adjusts the cell rectangle to account for lines drawn around a cell
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.AdjustInnerCellRect.ARect">
|
|
<short>Cell rectangle adjusted in the method</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: public -->
|
|
<element name="TCustomGrid.AutoAdjustColumns">
|
|
<short>
|
|
<var>AutoAdjustColumns</var> - automatically adjust the columns according to the size of their contents.
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: public -->
|
|
<element name="TCustomGrid.BeginUpdate">
|
|
<short>Begins an update to the grid</short>
|
|
<descr>
|
|
<p>
|
|
<var>BeginUpdate</var> is a procedure used to start an update to the layout or content in a grid control. BeginUpdate increments an internal member used to prevent nested calls to the method. The protection remains in effect until the <var>EndUpdate</var> method is called. BeginUpdate is used in the implementation of methods that alter the physical appearance of the grid.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.EndUpdate"/>
|
|
<link id="TCustomGrid.VisualChange"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- function Visibility: public -->
|
|
<element name="TCustomGrid.CellRect">
|
|
<short>
|
|
The coordinates for the current cell (column, row) expressed as a standard rectangle (TRect)
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.CellRect.Result">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.CellRect.ACol">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.CellRect.ARow">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: public -->
|
|
<element name="TCustomGrid.CellToGridZone">
|
|
<short>Convert the coordinates of the current cell (col, row) to a grid zone</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.CellToGridZone.Result">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.CellToGridZone.aCol">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.CellToGridZone.aRow">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: public -->
|
|
<element name="TCustomGrid.CheckPosition">
|
|
<short>Check the position of the cursor</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.ClearCols">
|
|
<short>Clears the cached fixed columns and column count in the grid control</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.Clear"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TCustomGrid.ClearCols.Result">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.ClearRows">
|
|
<short>Clears the cached fixed rows and row count in the grid control</short>
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.Clear"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TCustomGrid.ClearRows.Result">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- 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 applies to Lazarus grids only , under Delphi/Kylix a grid can't be completely emptied.
|
|
</p>
|
|
</descr>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.ClearSelections">
|
|
<short>
|
|
Clears the current range selection(s) and invalidates the grid control
|
|
</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.MouseDown"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- function Visibility: public -->
|
|
<element name="TCustomGrid.EditorByStyle">
|
|
<short>Select a cell editor control with the specified style</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.EditorByStyle.Result">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.EditorByStyle.Style">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: public -->
|
|
<element name="TCustomGrid.EditorKeyDown">
|
|
<short>Emulate the <var>OnKeyDown</var> event handler in the cell editor</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.EditorKeyDown.Sender">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.EditorKeyDown.Key">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.EditorKeyDown.Shift">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: public -->
|
|
<element name="TCustomGrid.EditorKeyPress">
|
|
<short>Emulate the <var>OnKeyPress</var> event handler in the cell editor</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.EditorKeyPress.Sender">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.EditorKeyPress.Key">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: public -->
|
|
<element name="TCustomGrid.EditorKeyUp">
|
|
<short>Emulate the <var>OnKeyUp</var> event handler in the cell editor</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.EditorKeyUp.Sender">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.EditorKeyUp.key">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.EditorKeyUp.shift">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.EditorTextChanged">
|
|
<short>Updates the grid control when the value in a cell editor is changed</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.SetEditText"/>
|
|
<link id="TStringCellEditor.Change"/>
|
|
<link id="TPickListCellEditor.Select"/>
|
|
<link id="TPickListCellEditor.Change"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TCustomGrid.EditorTextChanged.aCol">
|
|
<short>Column number for the modified cell</short>
|
|
</element>
|
|
<element name="TCustomGrid.EditorTextChanged.aRow">
|
|
<short>Row number for the modified cell</short>
|
|
</element>
|
|
<element name="TCustomGrid.EditorTextChanged.aText">
|
|
<short>New value for the cell</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: public -->
|
|
<element name="TCustomGrid.EndUpdate">
|
|
<short>
|
|
<var>EndUpdate</var> - Finish updating the grid</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.EndUpdate.UO">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.EndUpdate.aRefresh">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: public -->
|
|
<element name="TCustomGrid.EraseBackground">
|
|
<short>Clear the background for the grid control</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.EraseBackground.DC">
|
|
<short>Device context for the drawing operation</short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.Focused">
|
|
<short>
|
|
Indicates if the grid is focused or has an active focused cell editor
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.Focused.Result">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.HasMultiSelection">
|
|
<short>
|
|
Indicates if multi-select range selection mode is enabled and in use for the grid
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>HasMultiSelection</var> is a <var>Boolean</var> function used to determine if multi-select range selection mode is enabled and in use for the grid. The return value is <b>True</b> when <var>Options</var> includes the value <var>goRangeSelect</var>, <var>RangeSelectMode</var> contains <var>rsmMulti</var>, and <var>Selections</var> contains selection cell rectangles.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.Options"/>
|
|
<link id="TCustomGrid.RangeSelectMode"/>
|
|
<link id="TGridOption.goRangeSelect"/>
|
|
<link id="TRangeSelectMode.rsmMulti"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TCustomGrid.HasMultiSelection.Result">
|
|
<short>
|
|
True when multi-select range selection mode is enabled and in use for the grid
|
|
</short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.HideSortArrow">
|
|
<short>Hide the arrow drawn for the sort indicator</short>
|
|
<descr>
|
|
<p>
|
|
<var>HideSortArrow</var> is a procedure used to hide the arrow drawn for the sort indicator defined in <var>SortColumn</var>. HideSortArrow sets the value in SortColumn to <b>-1</b> to indicate that the sort column is not defined, and calls <var>InvalidateGrid</var> to redraw the contents in the grid control.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.SortColumn"/>
|
|
<link id="TCustomGrid.InvalidateGrid"/>
|
|
<link id="TCustomGrid.Sort"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.InvalidateCell">
|
|
<short>
|
|
<var>InvalidateCell</var> - renders a cell invalid, and redraws if required</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.InvalidateCell.aCol">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.InvalidateCell.aRow">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.InvalidateCell.Redraw">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.InvalidateCol">
|
|
<short>
|
|
<var>InvalidateFromCol</var> - renders the grid invalid from the specified column onwards
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.InvalidateCol.ACol">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomGrid.InvalidateRange">
|
|
<short>
|
|
<var>InvalidateRange</var> - renders a range of the grid invalid
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.InvalidateRange.aRange">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.InvalidateRow">
|
|
<short>Invalidates the drawing rectangle for the specified row number</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.InvalidateRow.ARow">
|
|
<short>Row number affected in the method</short>
|
|
</element>
|
|
|
|
<!-- function Visibility: public -->
|
|
<element name="TCustomGrid.IsCellVisible">
|
|
<short>Finds out whether a particular cell is visible</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.IsCellVisible.Result">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.IsCellVisible.aCol">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.IsCellVisible.aRow">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.IsFixedCellVisible">
|
|
<short>Determines if the specified cell is a visible fixed cell in the grid</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.IsFixedCellVisible.Result">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.IsFixedCellVisible.ACol">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomGrid.IsFixedCellVisible.ARow">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: public -->
|
|
<element name="TCustomGrid.LoadFromFile">
|
|
<short>Load the grid data from a file with the specified name</short>
|
|
<descr>Note that the SaveOptions determines what information is loaded.</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.SaveToFile"/>
|
|
<link id="TCustomGrid.SaveOptions"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.LoadFromFile.FileName">
|
|
<short>File name with the content loaded in the method</short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.LoadFromStream">
|
|
<short>Loads the content for the grid from the specified stream</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.LoadFromStream.AStream">
|
|
<short>TStream instance with values loaded in the method</short>
|
|
</element>
|
|
|
|
<!-- function Visibility: public -->
|
|
<element name="TCustomGrid.MouseCoord">
|
|
<short>Find the mouse coordinates relative to the grid origin</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.MouseCoord.Result">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.MouseCoord.X">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.MouseCoord.Y">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: public -->
|
|
<element name="TCustomGrid.MouseToCell">
|
|
<short>Convert mouse coordinates to the position of a cell in the grid</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.MouseToCell.Result">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.MouseToCell.Mouse">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.MouseToCell.X">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.MouseToCell.Y">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.MouseToCell.ACol">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.MouseToCell.ARow">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: public -->
|
|
<element name="TCustomGrid.MouseToLogcell">
|
|
<short>Convert mouse coordinates to the position of a logical cell in the grid</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.MouseToLogcell.Result">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.MouseToLogcell.Mouse">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: public -->
|
|
<element name="TCustomGrid.MouseToGridZone">
|
|
<short>
|
|
<var>MouseToGridZone</var> - convert mouse coordinates to a grid zone</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomGrid.MouseToGridZone.Result">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.MouseToGridZone.X">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.MouseToGridZone.Y">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.MouseToGridZone.CellCoords">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: public -->
|
|
<element name="TCustomGrid.SaveToFile">
|
|
<short>Save the data in the grid to a file with specified name</short>
|
|
<descr>Note that the SaveOptions determines what information is saved.</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.LoadFromFile"/>
|
|
<link id="TCustomGrid.SaveOptions"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomGrid.SaveToFile.FileName">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.SaveToStream">
|
|
<short>Saves information for the grid to the specified stream</short>
|
|
<descr>
|
|
<p>
|
|
<var>SaveToStream</var> is a virtual procedure used to store information for the grid control in the <var>TStream</var> instance specified in <var>AStream</var>. SaveToStream creates a <var>TXMLConfig</var> class instance that is used to capture the layout, cell display settings, grid options, and range selections for the control.
|
|
</p>
|
|
<p>
|
|
SaveToStream calls the <var>SaveContent</var> method to generate the XML content for the grid control. The XML content is written to <var>AStream</var> using the <var>WriteToStream</var> method in <var>TXMLConfig</var>.
|
|
</p>
|
|
<p>
|
|
Use <var>LoadFromStream</var> to read the grid information stored in the stream.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.SaveContent"/>
|
|
<link id="TCustomGrid.doSaveColumn"/>
|
|
<link id="TCustomGrid.OnSaveColumn"/>
|
|
<link id="TCustomGrid.SaveGridOptions"/>
|
|
<link id="TCustomGrid.LoadFromStream"/>
|
|
<link id="#LazUtils.Laz2_XMLCfg.TXMLConfig"/>
|
|
<link id="#LazUtils.Laz2_XMLCfg.TXMLConfig.WriteToStream"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TCustomGrid.SaveToStream.AStream">
|
|
<short>TStream instance where grid information is stored</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: public -->
|
|
<element name="TCustomGrid.SetFocus">
|
|
<short>Sets focus to the grid control</short>
|
|
<descr>
|
|
<p>
|
|
<var>SetFocus</var> is an overridden procedure used to make the grid control the currently focused control. SetFocus ensures that pending <b>Tab</b> key navigation for an active cell editor is handled properly. If an Editor is both available and visible, it calls its SetFocus method. Otherwise, the grid control becomes the focused control.
|
|
</p>
|
|
</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.CursorState">
|
|
<short>Current cursor state for the grid control</short>
|
|
<descr>
|
|
<p>
|
|
<var>CursorState</var> is a read-only <var>TGridCursorState</var> property which contains the current cursor state or shape for the grid control. The value in CursorState is updated when methods are called which perform resizing or moving/dragging for columns and rows.
|
|
</p>
|
|
<p>
|
|
Use the <var>ColRowDraggingCursor</var>, <var>ColSizingCursor</var>, or <var>RowSizingCursor</var> properties to read or write the cursor shapes used for the corresponding actions.
|
|
</p>
|
|
<p>
|
|
Use <var>RestoreCursor</var> to set the cursor to its default value.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TGridCursorState"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.SelectedRange">
|
|
<short>
|
|
Provides indexed access to TGridRect values in the currently selected range
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>SelectedRange</var> is a read-only indexed <var>TGridRect</var> property used to get the cell rectangles in <var>Selections</var> for the grid control. SelectedRange is applicable when multi-select range mode has been enabled in the <var>RangeSelectMode</var> property. Otherwise, the current cell selection at <var>Col</var> and <var>Row</var> is returned as the selected range value.
|
|
</p>
|
|
<p>
|
|
Use <var>SelectedRangeCount</var> to get the number <var>TGridRect</var> instances in <var>SelectedRange</var>.
|
|
</p>
|
|
<p>
|
|
Use <var>AddSelectedRange</var> to add the current cell selection to the multi-select range in <var>Selections</var>.
|
|
</p>
|
|
<p>
|
|
Use <var>ClearSelections</var> to remove the cell rectangles stored in <var>Selections</var>.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.RangeSelectMode"/>
|
|
<link id="TCustomGrid.AddSelectedRange"/>
|
|
<link id="TCustomGrid.ClearSelections"/>
|
|
<link id="TCustomGrid.Col"/>
|
|
<link id="TCustomGrid.Row"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.SelectedRangeCount">
|
|
<short>Number of cell rectangles in the current selected range</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TGridRectArray"/>
|
|
<link id="TRangeSelectMode"/>
|
|
<link id="TCustomGrid.ClearSelections"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: public -->
|
|
<element name="TCustomGrid.SortOrder">
|
|
<short>Order of sorting - ascending or descending</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TSortOrder"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.SortColumn">
|
|
<short>Column position used to sort the rows in the grid</short>
|
|
<descr>
|
|
<p>
|
|
<var>SortColumn</var> is a read-only <var>Integer</var> that contains the column position used to sort content rows in the grid. SortColumn is used in the <var>HeaderClick</var> method to determine if the click occurred on the fixed header cell represented by the property. It is also used in the <var>DrawColumnTitleImage</var> method if the header cell needs to render an image representing the current sort order.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.HeaderClick"/>
|
|
<link id="TCustomGrid.DrawColumnTitleImage"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<element link="#LCL.Controls.TWinControl.TabStop" name="TCustomGrid.TabStop"/>
|
|
|
|
<element name="TCustomGrid.IMEStartComposition">
|
|
<short>Handles IME Composition start messages</short>
|
|
<descr>Defined for Windows platforms only.</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.IMEStartComposition.Message">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.IMEComposition">
|
|
<short>Handles IME Composition messages</short>
|
|
<descr>Defined for Windows platforms only.</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomGrid.IMEComposition.Msg">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomGrid.IMEEndComposition">
|
|
<short>Handles the WM_IME_ENDCOMPOSITION message</short>
|
|
<descr>
|
|
<p>
|
|
Handles the Input Method Editor API WM_IME_ENDCOMPOSITION message.
|
|
</p>
|
|
<p>
|
|
Dispatches the message specified in <var>Msg</var> in the current visible and active <var>Editor</var> for the control. Defined for the Windows platform only.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<element name="TCustomGrid.IMEEndComposition.Msg">
|
|
<short>Message handled in the method</short>
|
|
</element>
|
|
|
|
<element name="TGetEditEvent">
|
|
<short>Specifies an event handler used to get edit values or masks in a grid</short>
|
|
<descr>
|
|
<var>TGetEditEvent</var> is an object procedure type used for event handlers which get edit values or masks in a grid control. TGetEditEvent is the type used for the <var>OnGetEditMask</var> and <var>OnGetEditText</var> event handlers in <var>TCustomDrawGrid</var>.
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomDrawGrid.OnGetEditMask"/>
|
|
<link id="TCustomDrawGrid.OnGetEditText"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TGetEditEvent.Sender">
|
|
<short>Object for the event notification</short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TGetEditEvent.ACol">
|
|
<short>Column number for the notification</short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TGetEditEvent.ARow">
|
|
<short>Row number for the notification</short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TGetEditEvent.Value">
|
|
<short>Value returned from the event handler</short>
|
|
</element>
|
|
|
|
<!-- procedure type Visibility: default -->
|
|
<element name="TSetEditEvent">
|
|
<short>Specifies an event handler used to set the value for edit text in a grid</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TSetEditEvent.Sender">
|
|
<short>Object for the event notification</short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TSetEditEvent.ACol">
|
|
<short>Column number for the notification</short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TSetEditEvent.ARow">
|
|
<short>Row number for the notification</short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TSetEditEvent.Value">
|
|
<short>Value applied to the specified cell in the event handler</short>
|
|
</element>
|
|
|
|
<element name="TGetCheckboxStateEvent">
|
|
<short>
|
|
Specifies an event handler signalled to get the state for a Checkbox cell in a grid
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TGetCheckboxStateEvent.Sender">
|
|
<short></short>
|
|
</element>
|
|
<element name="TGetCheckboxStateEvent.ACol">
|
|
<short></short>
|
|
</element>
|
|
<element name="TGetCheckboxStateEvent.ARow">
|
|
<short></short>
|
|
</element>
|
|
<element name="TGetCheckboxStateEvent.Value">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TSetCheckboxStateEvent">
|
|
<short>
|
|
Specifies an event handler signalled to set the state for a Checkbox cell in a grid
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TSetCheckboxStateEvent.Sender">
|
|
<short></short>
|
|
</element>
|
|
<element name="TSetCheckboxStateEvent.ACol">
|
|
<short></short>
|
|
</element>
|
|
<element name="TSetCheckboxStateEvent.ARow">
|
|
<short></short>
|
|
</element>
|
|
<element name="TSetCheckboxStateEvent.Value">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- object Visibility: default -->
|
|
<element name="TCustomDrawGrid">
|
|
<short>
|
|
Base class for custom drawn grids
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>TCustomDrawGrid</var> is a <var>TCustomGrid</var> descendant used as the base class for custom drawn grids including <var>TDrawGrid</var> and <var>TStringGrid</var>. TCustomDrawGrid provides overridden methods needed to work with cells using the TVirtualGrid class instance in the Grid property. Applications should not create instance of TCustomDrawGrid; use of the descendent classes like <var>TDrawGrid</var> or <var>TStringGrid</var>.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="HowToUseGrids"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<element name="TCustomDrawGrid.FOnColRowDeleted"/>
|
|
<element name="TCustomDrawGrid.FOnColRowExchanged"/>
|
|
<element name="TCustomDrawGrid.FOnColRowInserted"/>
|
|
<element name="TCustomDrawGrid.FOnColRowMoved"/>
|
|
<element name="TCustomDrawGrid.FOnGetEditMask"/>
|
|
<element name="TCustomDrawGrid.FOnGetEditText"/>
|
|
<element name="TCustomDrawGrid.FOnHeaderClick"/>
|
|
<element name="TCustomDrawGrid.FOnHeaderSized"/>
|
|
<element name="TCustomDrawGrid.FOnSelectCell"/>
|
|
<element name="TCustomDrawGrid.FOnSetEditText"/>
|
|
|
|
<element name="TCustomDrawGrid.FGrid">
|
|
<short>
|
|
<var>FGrid</var> - local variable holding a virtual grid on which to work
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomDrawGrid.CalcCellExtent">
|
|
<short>
|
|
<var>CalcCellExtent</var> - calculate the dimensions required for the cell specified by the <var>aCol</var> and <var>aRow</var> arguments
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomDrawGrid.CalcCellExtent.aCol">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomDrawGrid.CalcCellExtent.aRow">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomDrawGrid.CalcCellExtent.aRect">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element link="#LCL.Grids.TCustomGrid.ColRowDeleted"
|
|
name="TCustomDrawGrid.ColRowDeleted"/>
|
|
<element name="TCustomDrawGrid.ColRowDeleted.IsColumn">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomDrawGrid.ColRowDeleted.Index">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element link="#LCL.Grids.TCustomGrid.ColRowExchanged" name="TCustomDrawGrid.ColRowExchanged"/>
|
|
<element name="TCustomDrawGrid.ColRowExchanged.IsColumn">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomDrawGrid.ColRowExchanged.Index">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomDrawGrid.ColRowExchanged.WithIndex">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element link="#LCL.Grids.TCustomGrid.ColRowInserted" name="TCustomDrawGrid.ColRowInserted"/>
|
|
<element name="TCustomDrawGrid.ColRowInserted.IsColumn">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomDrawGrid.ColRowInserted.Index">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element link="#LCL.Grids.TCustomGrid.ColRowMoved" name="TCustomDrawGrid.ColRowMoved"/>
|
|
<element name="TCustomDrawGrid.ColRowMoved.IsColumn">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomDrawGrid.ColRowMoved.FromIndex">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomDrawGrid.ColRowMoved.ToIndex">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TCustomDrawGrid.CreateVirtualGrid">
|
|
<short>
|
|
<var>CreateVirtualGrid</var> - returns the created virtual grid</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomDrawGrid.CreateVirtualGrid.Result">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element link="#LCL.Grids.TCustomGrid.DrawCell" name="TCustomDrawGrid.DrawCell"/>
|
|
<element name="TCustomDrawGrid.DrawCell.aCol">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomDrawGrid.DrawCell.aRow">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomDrawGrid.DrawCell.aRect">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomDrawGrid.DrawCell.aState">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomDrawGrid.DrawCellAutonumbering">
|
|
<short>
|
|
<var>DrawCellAutonumbering</var> - draws a cell using auto numbering</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomDrawGrid.DrawCellAutonumbering.aCol">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomDrawGrid.DrawCellAutonumbering.aRow">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomDrawGrid.DrawCellAutonumbering.aRect">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomDrawGrid.DrawCellAutonumbering.aValue">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomDrawGrid.DrawFocusRect">
|
|
<short>
|
|
<var>DrawFocusRect</var> - draws the rectangle currently receiving focus</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomDrawGrid.DrawFocusRect.aCol">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomDrawGrid.DrawFocusRect.aRow">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomDrawGrid.DrawFocusRect.ARect">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element link="#LCL.Grids.TCustomGrid.GetEditMask" name="TCustomDrawGrid.GetEditMask"/>
|
|
<element name="TCustomDrawGrid.GetEditMask.Result">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomDrawGrid.GetEditMask.aCol">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomDrawGrid.GetEditMask.aRow">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element link="#LCL.Grids.TCustomGrid.GetEditText" name="TCustomDrawGrid.GetEditText"/>
|
|
<element name="TCustomDrawGrid.GetEditText.Result">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomDrawGrid.GetEditText.aCol">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomDrawGrid.GetEditText.aRow">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element link="#LCL.Grids.TCustomGrid.HeaderClick" name="TCustomDrawGrid.HeaderClick"/>
|
|
<element name="TCustomDrawGrid.HeaderClick.IsColumn">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomDrawGrid.HeaderClick.Index">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element link="#LCL.Grids.TCustomGrid.HeaderSized" name="TCustomDrawGrid.HeaderSized"/>
|
|
<element name="TCustomDrawGrid.HeaderSized.IsColumn">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomDrawGrid.HeaderSized.Index">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomDrawGrid.NotifyColRowChange">
|
|
<short>
|
|
<var>NotifyColRowChange</var> tells the system that a column or row has been changed (determined by <var>IsColumn</var>) and whether this was an Insert
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomDrawGrid.NotifyColRowChange.WasInsert">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomDrawGrid.NotifyColRowChange.IsColumn">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomDrawGrid.NotifyColRowChange.FromIndex">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomDrawGrid.NotifyColRowChange.ToIndex">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element link="#LCL.Grids.TCustomGrid.SelectCell" name="TCustomDrawGrid.SelectCell"/>
|
|
<element name="TCustomDrawGrid.SelectCell.Result">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomDrawGrid.SelectCell.aCol">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomDrawGrid.SelectCell.aRow">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element link="#LCL.Grids.TCustomGrid.SetColor" name="TCustomDrawGrid.SetColor"/>
|
|
<element name="TCustomDrawGrid.SetColor.Value">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element link="#LCL.Grids.TCustomGrid.SetEditText" name="TCustomDrawGrid.SetEditText"/>
|
|
<element name="TCustomDrawGrid.SetEditText.ACol">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomDrawGrid.SetEditText.ARow">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomDrawGrid.SetEditText.Value">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element link="#LCL.Grids.TCustomGrid.SizeChanged" name="TCustomDrawGrid.SizeChanged"/>
|
|
<element name="TCustomDrawGrid.SizeChanged.OldColCount">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomDrawGrid.SizeChanged.OldRowCount">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- constructor Visibility: public -->
|
|
<element name="TCustomDrawGrid.Create">
|
|
<short>
|
|
<var>Create</var> - constructor for <var>TCustomDrawGrid</var>. Attaches a virtual grid then calls inherited <var>Create</var>
|
|
</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="#LCL.Grids.TCustomGrid.Create">TCustomGrid.Create</link>
|
|
</seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomDrawGrid.Create.AOwner">
|
|
<short>Owner of the grid control</short>
|
|
</element>
|
|
|
|
<!-- destructor Visibility: public -->
|
|
<element name="TCustomDrawGrid.Destroy">
|
|
<short>
|
|
<var>Destroy</var> - destructor for <var>TCustomDrawGrid</var>. Frees the grid then calls inherited <var>Destroy</var>
|
|
</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="#LCL.Grids.TCustomGrid.Destroy">TCustomGrid.Destroy</link>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: public -->
|
|
<element name="TCustomDrawGrid.DeleteColRow">
|
|
<short>
|
|
Delete either a column or a row (specified by index), depending on the value of the Boolean <var>IsColumn</var>
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomDrawGrid.DeleteColRow.IsColumn">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomDrawGrid.DeleteColRow.Index">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: public -->
|
|
<element name="TCustomDrawGrid.ExchangeColRow">
|
|
<short>
|
|
Exchange either a column or a row, specified by <var>index</var>, with the col or row specified by <var>WithIndex</var>; Boolean <var>IsColumn</var> determines whether rows or columns are to be exchanged
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomDrawGrid.ExchangeColRow.IsColumn">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomDrawGrid.ExchangeColRow.Index">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomDrawGrid.ExchangeColRow.WithIndex">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: public -->
|
|
<element name="TCustomDrawGrid.InsertColRow">
|
|
<short>
|
|
<var>InsertColRow</var> inserts a column or row (specified by
|
|
<var>Iscolumn</var>) at the stated index location
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomDrawGrid.InsertColRow.IsColumn">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomDrawGrid.InsertColRow.Index">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: public -->
|
|
<element name="TCustomDrawGrid.MoveColRow">
|
|
<short>
|
|
Move column or row from <var>FromIndex</var> to <var>ToIndex</var>; Boolean <var>IsColumn</var> specifies whether col or row is to be moved
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomDrawGrid.MoveColRow.IsColumn">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomDrawGrid.MoveColRow.FromIndex">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomDrawGrid.MoveColRow.ToIndex">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: public -->
|
|
<element name="TCustomDrawGrid.SortColRow">
|
|
<short>
|
|
Sort column or row specified by <var>index</var> and optionally by <var>FromIndex</var> and <var>ToIndex</var>; <var>IsColumn</var> specifies whether col or row is to be sorted
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomDrawGrid.SortColRow.IsColumn">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomDrawGrid.SortColRow.Index">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomDrawGrid.SortColRow.FromIndex">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomDrawGrid.SortColRow.ToIndex">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: public -->
|
|
<element name="TCustomDrawGrid.DefaultDrawCell">
|
|
<short>Use the default method for drawing a cell specified by <var>aCol</var>, <var>aRow</var>, at location <var>aRect</var> with state <var>aState</var>
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomDrawGrid.DefaultDrawCell.aCol">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomDrawGrid.DefaultDrawCell.aRow">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomDrawGrid.DefaultDrawCell.aRect">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomDrawGrid.DefaultDrawCell.aState">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- Visibility: public -->
|
|
<element link="#LCL.Grids.TCustomGrid.AllowOutboundEvents" name="TCustomDrawGrid.AllowOutboundEvents"/>
|
|
<element link="#LCL.Grids.TCustomGrid.BorderColor" name="TCustomDrawGrid.BorderColor"/>
|
|
<element link="#LCL.Controls.TCustomControl.Canvas" name="TCustomDrawGrid.Canvas"/>
|
|
<element link="#LCL.Grids.TCustomGrid.Col" name="TCustomDrawGrid.Col"/>
|
|
<element link="#LCL.Grids.TCustomGrid.ColWidths" name="TCustomDrawGrid.ColWidths"/>
|
|
<element link="#LCL.Grids.TCustomGrid.Editor" name="TCustomDrawGrid.Editor"/>
|
|
<element link="#LCL.Grids.TCustomGrid.EditorBorderStyle" name="TCustomDrawGrid.EditorBorderStyle"/>
|
|
<element link="#LCL.Grids.TCustomGrid.EditorMode" name="TCustomDrawGrid.EditorMode"/>
|
|
<element link="#LCL.Grids.TCustomGrid.ExtendedColSizing" name="TCustomDrawGrid.ExtendedColSizing"/>
|
|
<element link="#LCL.Grids.TCustomGrid.AltColorStartNormal" name="TCustomDrawGrid.AltColorStartNormal"/>
|
|
<element link="#LCL.Grids.TCustomGrid.FastEditing" name="TCustomDrawGrid.FastEditing"/>
|
|
<element link="#LCL.Grids.TCustomGrid.FocusColor" name="TCustomDrawGrid.FocusColor"/>
|
|
<element link="#LCL.Grids.TCustomGrid.FocusRectVisible" name="TCustomDrawGrid.FocusRectVisible"/>
|
|
<element link="#LCL.Grids.TCustomGrid.GridHeight" name="TCustomDrawGrid.GridHeight"/>
|
|
<element link="#LCL.Grids.TCustomGrid.GridLineColor"
|
|
name="TCustomDrawGrid.GridLineColor"/>
|
|
<element link="#LCL.Grids.TCustomGrid.GridLineStyle"
|
|
name="TCustomDrawGrid.GridLineStyle"/>
|
|
<element link="#LCL.Grids.TCustomGrid.GridWidth" name="TCustomDrawGrid.GridWidth"/>
|
|
<element link="#LCL.Grids.TCustomGrid.IsCellSelected" name="TCustomDrawGrid.IsCellSelected"/>
|
|
<element link="#LCL.Grids.TCustomGrid.LeftCol" name="TCustomDrawGrid.LeftCol"/>
|
|
<element link="#LCL.Grids.TCustomGrid.Row" name="TCustomDrawGrid.Row"/>
|
|
<element link="#LCL.Grids.TCustomGrid.RowHeights" name="TCustomDrawGrid.RowHeights"/>
|
|
<element link="#LCL.Grids.TCustomGrid.SaveOptions" name="TCustomDrawGrid.SaveOptions"/>
|
|
<element link="#LCL.Grids.TCustomGrid.SelectedColor"
|
|
name="TCustomDrawGrid.SelectedColor"/>
|
|
<element link="#LCL.Grids.TCustomGrid.SelectedColumn" name="TCustomDrawGrid.SelectedColumn"/>
|
|
<element link="#LCL.Grids.TCustomGrid.Selection" name="TCustomDrawGrid.Selection"/>
|
|
<element link="#LCL.Grids.TCustomGrid.StrictSort" name="TCustomDrawGrid.StrictSort"/>
|
|
<element link="#LCL.Grids.TCustomGrid.TopRow" name="TCustomDrawGrid.TopRow"/>
|
|
<element link="#LCL.Grids.TCustomGrid.UseXORFeatures" name="TCustomDrawGrid.UseXORFeatures"/>
|
|
<element link="#LCL.Controls.TControl.Align" name="TCustomDrawGrid.Align"/>
|
|
<element link="#LCL.Controls.TControl.Anchors" name="TCustomDrawGrid.Anchors"/>
|
|
<element link="#LCL.Grids.TCustomGrid.AutoAdvance" name="TCustomDrawGrid.AutoAdvance"/>
|
|
<element link="#LCL.Grids.TCustomGrid.AutoFillColumns" name="TCustomDrawGrid.AutoFillColumns"/>
|
|
<element link="#LCL.Controls.TControl.BorderSpacing"
|
|
name="TCustomDrawGrid.BorderSpacing"/>
|
|
<element link="#LCL.Controls.TWinControl.BorderStyle" name="TCustomDrawGrid.BorderStyle"/>
|
|
<element link="#LCL.Controls.TControl.Color" name="TCustomDrawGrid.Color"/>
|
|
<element link="#LCL.Grids.TCustomGrid.ColCount" name="TCustomDrawGrid.ColCount"/>
|
|
<element link="#LCL.Grids.TCustomGrid.Columns" name="TCustomDrawGrid.Columns"/>
|
|
<element link="#LCL.Grids.TCustomGrid.DefaultColWidth" name="TCustomDrawGrid.DefaultColWidth"/>
|
|
<element link="#LCL.Grids.TCustomGrid.DefaultDrawing" name="TCustomDrawGrid.DefaultDrawing"/>
|
|
<element link="#LCL.Grids.TCustomGrid.DefaultRowHeight" name="TCustomDrawGrid.DefaultRowHeight"/>
|
|
<element link="#LCL.Controls.TControl.Enabled" name="TCustomDrawGrid.Enabled"/>
|
|
<element link="#LCL.Grids.TCustomGrid.FixedColor" name="TCustomDrawGrid.FixedColor"/>
|
|
<element link="#LCL.Grids.TCustomGrid.FixedCols" name="TCustomDrawGrid.FixedCols"/>
|
|
<element link="#LCL.Grids.TCustomGrid.FixedHotColor"
|
|
name="TCustomDrawGrid.FixedHotColor"/>
|
|
<element link="#LCL.Grids.TCustomGrid.FixedRows" name="TCustomDrawGrid.FixedRows"/>
|
|
<element link="#LCL.Grids.TCustomGrid.Flat" name="TCustomDrawGrid.Flat"/>
|
|
<element link="#LCL.Controls.TControl.Font" name="TCustomDrawGrid.Font"/>
|
|
<element link="#LCL.Grids.TCustomGrid.GridLineWidth"
|
|
name="TCustomDrawGrid.GridLineWidth"/>
|
|
<element link="#LCL.Grids.TCustomGrid.Options" name="TCustomDrawGrid.Options"/>
|
|
<element link="#LCL.Controls.TControl.ParentShowHint" name="TCustomDrawGrid.ParentShowHint"/>
|
|
<element link="#LCL.Controls.TControl.PopupMenu" name="TCustomDrawGrid.PopupMenu"/>
|
|
<element link="#LCL.Grids.TCustomGrid.RowCount" name="TCustomDrawGrid.RowCount"/>
|
|
<element link="#LCL.Grids.TCustomGrid.ScrollBars" name="TCustomDrawGrid.ScrollBars"/>
|
|
<element link="#LCL.Controls.TControl.ShowHint" name="TCustomDrawGrid.ShowHint"/>
|
|
<element link="#LCL.Controls.TWinControl.TabOrder" name="TCustomDrawGrid.TabOrder"/>
|
|
<element link="#LCL.Controls.TWinControl.TabStop" name="TCustomDrawGrid.TabStop"/>
|
|
<element link="#LCL.Controls.TControl.Visible" name="TCustomDrawGrid.Visible"/>
|
|
<element link="#LCL.Grids.TCustomGrid.VisibleColCount" name="TCustomDrawGrid.VisibleColCount"/>
|
|
<element link="#LCL.Grids.TCustomGrid.VisibleRowCount" name="TCustomDrawGrid.VisibleRowCount"/>
|
|
<element link="#LCL.Grids.TCustomGrid.OnBeforeSelection" name="TCustomDrawGrid.OnBeforeSelection"/>
|
|
<element link="#LCL.Controls.TControl.OnClick" name="TCustomDrawGrid.OnClick"/>
|
|
|
|
<element name="TCustomDrawGrid.OnColRowDeleted">
|
|
<short>Event handler signalled when a grid column or row is deleted</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: public -->
|
|
<element name="TCustomDrawGrid.OnColRowExchanged">
|
|
<short>
|
|
Event handler signalled when a grid column or row has its position exchanged with another
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: public -->
|
|
<element name="TCustomDrawGrid.OnColRowInserted">
|
|
<short>Event handler signalled when a column or row is inserted into the grid</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: public -->
|
|
<element name="TCustomDrawGrid.OnColRowMoved">
|
|
<short>Event handler signalled when a grid column or row is moved</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: public -->
|
|
<element name="TCustomDrawGrid.OnCompareCells">
|
|
<short>Event handler signalled to compare the contents of cells</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: public -->
|
|
<element link="#LCL.Controls.TControl.OnDblClick" name="TCustomDrawGrid.OnDblClick"/>
|
|
<element link="#LCL.Grids.TCustomGrid.OnDrawCell" name="TCustomDrawGrid.OnDrawCell"/>
|
|
<element link="#LCL.Grids.TCustomGrid.OnEditButtonClick" name="TCustomDrawGrid.OnEditButtonClick"/>
|
|
<element link="#LCL.Controls.TWinControl.OnEnter" name="TCustomDrawGrid.OnEnter"/>
|
|
<element link="#LCL.Controls.TWinControl.OnExit" name="TCustomDrawGrid.OnExit"/>
|
|
|
|
<element name="TCustomDrawGrid.OnGetEditMask">
|
|
<short>Event handler signalled to get the edit mask while editing a grid cell</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: public -->
|
|
<element name="TCustomDrawGrid.OnGetEditText">
|
|
<short>Event handler signalled to get the text to be edited in a grid cell</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: public -->
|
|
<element name="TCustomDrawGrid.OnHeaderClick">
|
|
<short>Event handler signalled when a column or row header is clicked</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: public -->
|
|
<element name="TCustomDrawGrid.OnHeaderSized">
|
|
<short>Event handler signalled when a column or row header is re-sized</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: public -->
|
|
<element link="#LCL.Controls.TWinControl.OnKeyDown" name="TCustomDrawGrid.OnKeyDown"/>
|
|
<element link="#LCL.Controls.TWinControl.OnKeyPress" name="TCustomDrawGrid.OnKeyPress"/>
|
|
<element link="#LCL.Controls.TWinControl.OnKeyUp" name="TCustomDrawGrid.OnKeyUp"/>
|
|
<element link="#LCL.Controls.TControl.OnMouseDown" name="TCustomDrawGrid.OnMouseDown"/>
|
|
<element link="#LCL.Controls.TControl.OnMouseMove" name="TCustomDrawGrid.OnMouseMove"/>
|
|
<element link="#LCL.Controls.TControl.OnMouseUp" name="TCustomDrawGrid.OnMouseUp"/>
|
|
<element link="#LCL.Controls.TControl.OnMouseWheelDown" name="TCustomDrawGrid.OnMouseWheelDown"/>
|
|
<element link="#LCL.Controls.TControl.OnMouseWheelUp" name="TCustomDrawGrid.OnMouseWheelUp"/>
|
|
<element link="#LCL.Grids.TCustomGrid.OnPickListSelect" name="TCustomDrawGrid.OnPickListSelect"/>
|
|
<element link="#LCL.Grids.TCustomGrid.OnPrepareCanvas" name="TCustomDrawGrid.OnPrepareCanvas"/>
|
|
<element link="#LCL.Grids.TCustomGrid.OnSelectEditor" name="TCustomDrawGrid.OnSelectEditor"/>
|
|
<element link="#LCL.Grids.TCustomGrid.OnSelection" name="TCustomDrawGrid.OnSelection"/>
|
|
|
|
<element name="TCustomDrawGrid.OnSelectCell">
|
|
<short>Event handler signalled when a grid cell is selected</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: public -->
|
|
<element name="TCustomDrawGrid.OnSetEditText">
|
|
<short>Event handler signalled to store the text that has been edited in a cell</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- Visibility: public -->
|
|
<element link="#LCL.Grids.TCustomGrid.OnTopLeftChanged" name="TCustomDrawGrid.OnTopleftChanged">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TCustomDrawGrid.OnValidateEntry">
|
|
<short>Event handler signalled to validate the content in a cell</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element link="#LCL.Controls.TControl.Constraints" name="TCustomDrawGrid.Constraints"/>
|
|
<element link="#LCL.Controls.TControl.OnContextPopup" name="TCustomDrawGrid.OnContextPopup"/>
|
|
<element link="#LCL.Controls.TControl.OnDragDrop" name="TCustomDrawGrid.OnDragDrop"/>
|
|
<element link="#LCL.Controls.TControl.OnDragOver" name="TCustomDrawGrid.OnDragOver"/>
|
|
<element link="#LCL.Controls.TControl.OnEndDock" name="TCustomDrawGrid.OnEndDock"/>
|
|
<element link="#LCL.Controls.TControl.OnEndDrag" name="TCustomDrawGrid.OnEndDrag"/>
|
|
<element link="#LCL.Controls.TControl.OnStartDock" name="TCustomDrawGrid.OnStartDock"/>
|
|
<element link="#LCL.Controls.TControl.OnStartDrag" name="TCustomDrawGrid.OnStartDrag"/>
|
|
|
|
<element link="#LCL.Controls.TWinControl.OnUTF8KeyPress" name="TCustomDrawGrid.OnUTF8KeyPress"/>
|
|
|
|
<element name="TCustomDrawGrid.GetCheckBoxState">
|
|
<short>
|
|
<var>GetCheckBoxState</var> - returns the state of the checkbox at the specified position</short>
|
|
</element>
|
|
|
|
<element name="TCustomDrawGrid.SetCheckboxState">
|
|
<short>
|
|
<var>
|
|
SetCheckboxState</var> - specifies the state of the checkbox in the nominated cell
|
|
</short>
|
|
</element>
|
|
|
|
<element name="TCustomDrawGrid.ToggleCheckbox">
|
|
<short>
|
|
<var>ToggleCheckbox</var> - toggles checkbox state between checked and unchecked
|
|
</short>
|
|
</element>
|
|
|
|
<element name="TCustomDrawGrid.OnGetCheckboxState">
|
|
<short>
|
|
<var>OnGetCheckboxState</var> - event handler for finding checkbox state
|
|
</short>
|
|
</element>
|
|
|
|
<element name="TCustomDrawGrid.OnSetCheckboxState">
|
|
<short>
|
|
<var>OnSetCheckboxState</var> - event handler for specifying checkbox state
|
|
</short>
|
|
</element>
|
|
|
|
<!-- object Visibility: default -->
|
|
<element name="TDrawGrid">
|
|
<short>
|
|
<var>TDrawGrid</var> - a custom drawn grid. May contain images in its cells.
|
|
</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="HowToUseGrids"/>
|
|
<link id="TCustomGrid"/>
|
|
<link id="TCustomDrawGrid"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<element name="TDrawGrid.InplaceEditor" link="TCustomGrid.InplaceEditor"/>
|
|
<element name="TDrawGrid.Align" link="#LCL.Controls.TControl.Align"/>
|
|
<element name="TDrawGrid.AlternateColor" link="TCustomGrid.AlternateColor"/>
|
|
<element name="TDrawGrid.Anchors" link="#LCL.Controls.TControl.Anchors"/>
|
|
<element name="TDrawGrid.AutoAdvance" link="#LCL.Grids.TCustomGrid.AutoAdvance"/>
|
|
<element name="TDrawGrid.AutoEdit" link="#LCL.Grids.TCustomGrid.AutoEdit"/>
|
|
<element name="TDrawGrid.AutoFillColumns" link="#LCL.Grids.TCustomGrid.AutoFillColumns"/>
|
|
<element name="TDrawGrid.BorderSpacing" link="#LCL.Controls.TControl.BorderSpacing"/>
|
|
<element name="TDrawGrid.BorderStyle" link="#LCL.Controls.TWinControl.BorderStyle"/>
|
|
<element name="TDrawGrid.Color" link="#LCL.Controls.TControl.Color"/>
|
|
<element name="TDrawGrid.ColCount" link="TCustomGrid.ColCount"/>
|
|
<element name="TDrawGrid.ColRowDraggingCursor" link="TCustomGrid.ColRowDraggingCursor"/>
|
|
|
|
<element name="TDrawGrid.ColRowDragIndicatorColor" link="TCustomGrid.ColRowDragIndicatorColor"/>
|
|
|
|
<element name="TDrawGrid.ColSizingCursor" link="TCustomGrid.ColSizingCursor"/>
|
|
<element name="TDrawGrid.ColumnClickSorts" link="TCustomGrid.ColumnClickSorts"/>
|
|
<element name="TDrawGrid.Columns" link="TCustomGrid.Columns"/>
|
|
<element name="TDrawGrid.Constraints" link="#LCL.Controls.TControl.Constraints"/>
|
|
<element name="TDrawGrid.DefaultColWidth" link="TCustomGrid.DefaultColWidth"/>
|
|
<element name="TDrawGrid.DefaultDrawing" link="TCustomGrid.DefaultDrawing"/>
|
|
<element name="TDrawGrid.DefaultRowHeight" link="TCustomGrid.DefaultRowHeight"/>
|
|
<element name="TDrawGrid.DoubleBuffered" link="#LCL.Controls.TControl.DoubleBuffered"/>
|
|
<element name="TDrawGrid.DragCursor" link="#LCL.Controls.TControl.DragCursor"/>
|
|
<element name="TDrawGrid.DragKind" link="#LCL.Controls.TControl.DragKind"/>
|
|
<element name="TDrawGrid.DragMode" link="#LCL.Controls.TControl.DragMode"/>
|
|
<element name="TDrawGrid.Enabled" link="#LCL.Controls.TControl.Enabled"/>
|
|
<element name="TDrawGrid.ExtendedSelect" link="TCustomGrid.ExtendedSelect"/>
|
|
<element name="TDrawGrid.FixedColor" link="TCustomGrid.FixedColor"/>
|
|
<element name="TDrawGrid.FixedCols" link="TCustomGrid.FixedCols"/>
|
|
<element name="TDrawGrid.FixedRows" link="TCustomGrid.FixedRows"/>
|
|
<element name="TDrawGrid.Flat" link="#LCL.Controls.TControl.Flat"/>
|
|
<element name="TDrawGrid.Font" link="#LCL.Controls.TControl.Font"/>
|
|
<element name="TDrawGrid.GridLineWidth" link="TCustomGrid.GridLineWidth"/>
|
|
<element name="TDrawGrid.HeaderHotZones" link="TCustomGrid.HeaderHotZones"/>
|
|
<element name="TDrawGrid.HeaderPushZones" link="TCustomGrid.HeaderPushZones"/>
|
|
<element name="TDrawGrid.ImageIndexSortAsc" link="TCustomGrid.ImageIndexSortAsc"/>
|
|
<element name="TDrawGrid.ImageIndexSortDesc" link="TCustomGrid.ImageIndexSortDesc"/>
|
|
<element name="TDrawGrid.MouseWheelOption" link="TCustomGrid.MouseWheelOption"/>
|
|
<element name="TDrawGrid.Options" link="TCustomGrid.Options"/>
|
|
<element name="TDrawGrid.Options2" link="TCustomGrid.Options2"/>
|
|
<element name="TDrawGrid.ParentColor" link="#LCL.Controls.TControl.ParentColor"/>
|
|
|
|
<element name="TDrawGrid.ParentDoubleBuffered" link="#LCL.Controls.TControl.ParentDoubleBuffered"/>
|
|
|
|
<element name="TDrawGrid.ParentFont" link="#LCL.Controls.TControl.ParentFont"/>
|
|
<element name="TDrawGrid.ParentShowHint" link="#LCL.Controls.TControl.ParentShowHint"/>
|
|
<element name="TDrawGrid.PopupMenu" link="#LCL.Controls.TControl.PopupMenu"/>
|
|
<element name="TDrawGrid.RangeSelectMode" link="TCustomGrid.RangeSelectMode"/>
|
|
<element name="TDrawGrid.RowCount" link="TCustomGrid.RowCount"/>
|
|
<element name="TDrawGrid.RowSizingCursor" link="TCustomGrid.RowSizingCursor"/>
|
|
<element name="TDrawGrid.ScrollBars" link="TCustomGrid.ScrollBars"/>
|
|
<element name="TDrawGrid.ShowHint" link="#LCL.Controls.TControl.ShowHint"/>
|
|
<element name="TDrawGrid.TabAdvance" link="TCustomGrid.TabAdvance"/>
|
|
<element name="TDrawGrid.TabOrder" link="#LCL.Controls.TWinControl.TabOrder"/>
|
|
<element name="TDrawGrid.TabStop" link="#LCL.Controls.TWinControl.TabStop"/>
|
|
<element name="TDrawGrid.TitleFont" link="TCustomGrid.TitleFont"/>
|
|
<element name="TDrawGrid.TitleImageList" link="TCustomGrid.TitleImageList"/>
|
|
<element name="TDrawGrid.TitleImageListWidth" link="TCustomGrid.TitleImageListWidth"/>
|
|
<element name="TDrawGrid.TitleStyle" link="TCustomGrid.TitleStyle"/>
|
|
<element name="TDrawGrid.UseXORFeatures" link="TCustomGrid.UseXORFeatures"/>
|
|
<element name="TDrawGrid.Visible" link="#LCL.Controls.TControl.Visible"/>
|
|
<element name="TDrawGrid.VisibleColCount" link="TCustomGrid.VisibleColCount"/>
|
|
<element name="TDrawGrid.VisibleRowCount" link="TCustomGrid.VisibleRowCount"/>
|
|
<element name="TDrawGrid.OnAfterSelection" link="TCustomGrid.OnAfterSelection"/>
|
|
<element name="TDrawGrid.OnBeforeSelection" link="TCustomGrid.OnBeforeSelection"/>
|
|
<element name="TDrawGrid.OnCheckboxToggled" link="TCustomGrid.OnCheckboxToggled"/>
|
|
<element name="TDrawGrid.OnClick" link="#LCL.Controls.TControl.OnClick"/>
|
|
<element name="TDrawGrid.OnColRowDeleted" link="TCustomGrid.OnColRowDeleted"/>
|
|
<element name="TDrawGrid.OnColRowExchanged" link="TCustomGrid.OnColRowExchanged"/>
|
|
<element name="TDrawGrid.OnColRowInserted" link="TCustomGrid.OnColRowInserted"/>
|
|
<element name="TDrawGrid.OnColRowMoved" link="TCustomGrid.OnColRowMoved"/>
|
|
<element name="TDrawGrid.OnCompareCells" link="TCustomGrid.OnCompareCells"/>
|
|
<element name="TDrawGrid.OnContextPopup" link="#LCL.Controls.TControl.OnContextPopup"/>
|
|
<element name="TDrawGrid.OnDblClick" link="#LCL.Controls.TControl.OnDblClick"/>
|
|
<element name="TDrawGrid.OnDragDrop" link="#LCL.Controls.TControl.OnDragDrop"/>
|
|
<element name="TDrawGrid.OnDragOver" link="#LCL.Controls.TControl.OnDragOver"/>
|
|
<element name="TDrawGrid.OnDrawCell" link="TCustomGrid.OnDrawCell"/>
|
|
<element name="TDrawGrid.OnEditButtonClick" link="TCustomGrid.OnEditButtonClick"/>
|
|
<element name="TDrawGrid.OnButtonClick" link="TCustomGrid.OnButtonClick"/>
|
|
<element name="TDrawGrid.OnEditingDone" link="TCustomGrid.OnEditingDone"/>
|
|
<element name="TDrawGrid.OnEndDock" link="#LCL.Controls.TControl.OnEndDock"/>
|
|
<element name="TDrawGrid.OnEndDrag" link="#LCL.Controls.TControl.OnEndDrag"/>
|
|
<element name="TDrawGrid.OnEnter" link="#LCL.Controls.TWinControl.OnEnter"/>
|
|
<element name="TDrawGrid.OnExit" link="#LCL.Controls.TWinControl.OnExit"/>
|
|
<element name="TDrawGrid.OnGetCellHint" link="TCustomGrid.OnGetCellHint"/>
|
|
<element name="TDrawGrid.OnGetCheckboxState" link="TCustomGrid.OnGetCheckboxState"/>
|
|
<element name="TDrawGrid.OnGetEditMask" link="TCustomGrid.OnGetEditMask"/>
|
|
<element name="TDrawGrid.OnGetEditText" link="TCustomGrid.OnGetEditText"/>
|
|
<element name="TDrawGrid.OnHeaderClick" link="TCustomGrid.OnHeaderClick"/>
|
|
<element name="TDrawGrid.OnHeaderSized" link="TCustomGrid.OnHeaderSized"/>
|
|
<element name="TDrawGrid.OnHeaderSizing" link="TCustomGrid.OnHeaderSizing"/>
|
|
<element name="TDrawGrid.OnKeyDown" link="#LCL.Controls.TWinControl.OnKeyDown"/>
|
|
<element name="TDrawGrid.OnKeyPress" link="#LCL.Controls.TWinControl.OnKeyPress"/>
|
|
<element name="TDrawGrid.OnKeyUp" link="#LCL.Controls.TWinControl.OnKeyUp"/>
|
|
<element name="TDrawGrid.OnMouseDown" link="#LCL.Controls.TControl.OnMouseDown"/>
|
|
<element name="TDrawGrid.OnMouseEnter" link="#LCL.Controls.TControl.OnMouseEnter"/>
|
|
<element name="TDrawGrid.OnMouseLeave" link="#LCL.Controls.TControl.OnMouseLeave"/>
|
|
<element name="TDrawGrid.OnMouseMove" link="#LCL.Controls.TControl.OnMouseMove"/>
|
|
<element name="TDrawGrid.OnMouseUp" link="#LCL.Controls.TControl.OnMouseUp"/>
|
|
<element name="TDrawGrid.OnMouseWheel" link="TCustomGrid.OnMouseWheel"/>
|
|
<element name="TDrawGrid.OnMouseWheelDown" link="TCustomGrid.OnMouseWheelDown"/>
|
|
<element name="TDrawGrid.OnMouseWheelUp" link="TCustomGrid.OnMouseWheelUp"/>
|
|
<element name="TDrawGrid.OnMouseWheelHorz" link="TCustomGrid.OnMouseWheelHorz"/>
|
|
<element name="TDrawGrid.OnMouseWheelLeft" link="TCustomGrid.OnMouseWheelLeft"/>
|
|
<element name="TDrawGrid.OnMouseWheelRight" link="TCustomGrid.OnMouseWheelRight"/>
|
|
<element name="TDrawGrid.OnPickListSelect" link="TCustomGrid.OnPickListSelect"/>
|
|
<element name="TDrawGrid.OnPrepareCanvas" link="TCustomGrid.OnPrepareCanvas"/>
|
|
<element name="TDrawGrid.OnSelectEditor" link="TCustomGrid.OnSelectEditor"/>
|
|
<element name="TDrawGrid.OnSelection" link="TCustomGrid.OnSelection"/>
|
|
<element name="TDrawGrid.OnSelectCell" link="TCustomDrawGrid.OnSelectCell"/>
|
|
<element name="TDrawGrid.OnSetCheckboxState" link="TCustomGrid.OnSetCheckboxState"/>
|
|
<element name="TDrawGrid.OnSetEditText" link="TCustomGrid.OnSetEditText"/>
|
|
<element name="TDrawGrid.OnStartDock" link="#LCL.Controls.TControl.OnStartDock"/>
|
|
<element name="TDrawGrid.OnStartDrag" link="#LCL.Controls.TControl.OnStartDrag"/>
|
|
<element name="TDrawGrid.OnTopleftChanged" link="TCustomGrid.OnTopLeftChanged"/>
|
|
<element name="TDrawGrid.OnUserCheckboxBitmap" link="TCustomGrid.OnUserCheckboxBitmap"/>
|
|
<element name="TDrawGrid.OnUserCheckboxImage" link="TCustomGrid.OnUserCheckBoxImage"/>
|
|
<element name="TDrawGrid.OnUTF8KeyPress" link="#LCL.Controls.TWinControl.OnUTF8KeyPress"/>
|
|
<element name="TDrawGrid.OnValidateEntry" link="TCustomGrid.OnValidateEntry"/>
|
|
|
|
<!-- object Visibility: default -->
|
|
<element name="TStringGridStrings">
|
|
<short>
|
|
Repesents strings used as the cell values in TStringGrid
|
|
</short>
|
|
<descr>
|
|
<var>TStringGridStrings</var> is a TStrings descendant that represents the strings used to populate the cells of a <var>TStringGrid</var>.
|
|
</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<element name="TStringGridStrings.FAddedCount"/>
|
|
<element name="TStringGridStrings.FGrid"/>
|
|
<element name="TStringGridStrings.FIsCol"/>
|
|
<element name="TStringGridStrings.FIndex"/>
|
|
<element name="TStringGridStrings.FOwner"/>
|
|
|
|
<element name="TStringGridStrings.ConvertIndexLineCol">
|
|
<short>
|
|
Converts an index position to line and column numbers for Cells in the grid
|
|
</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TStringGridStrings.Add"/>
|
|
<link id="TStringGridStrings.Get"/>
|
|
<link id="TStringGridStrings.GetObject"/>
|
|
<link id="TStringGridStrings.Put"/>
|
|
<link id="TStringGridStrings.PutObject"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TStringGridStrings.ConvertIndexLineCol.Result">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TStringGridStrings.ConvertIndexLineCol.Index">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TStringGridStrings.ConvertIndexLineCol.Line">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TStringGridStrings.ConvertIndexLineCol.Col">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TStringGridStrings.Get">
|
|
<short>Gets the string at the specified index position</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TStringGridStrings.Get.Result">
|
|
<short></short>
|
|
</element>
|
|
<element name="TStringGridStrings.Get.Index">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TStringGridStrings.GetCount">
|
|
<short>Gets the number of strings in the class instance</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="#RTL.Classes.TStringList.GetCount"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TStringGridStrings.GetCount.Result">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element name="TStringGridStrings.GetObject">
|
|
<short>Gets the object stored at the specified index position</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="#RTL.Classes.TStringList.GetObject"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TStringGridStrings.GetObject.Result">
|
|
<short></short>
|
|
</element>
|
|
<element name="TStringGridStrings.GetObject.Index">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TStringGridStrings.Put">
|
|
<short>Stores a string at the specified index position</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="#RTL.Classes.TStringList.Put"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TStringGridStrings.Put.Index">
|
|
<short></short>
|
|
</element>
|
|
<element name="TStringGridStrings.Put.S">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TStringGridStrings.PutObject">
|
|
<short>Stores an Object at the specified index position</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="#RTL.Classes.TStringList.PutObject"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TStringGridStrings.PutObject.Index">
|
|
<short></short>
|
|
</element>
|
|
<element name="TStringGridStrings.PutObject.aObject">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- constructor Visibility: public -->
|
|
<element name="TStringGridStrings.Create">
|
|
<short>
|
|
<var>Create</var> - constructor for <var>TStringGridStrings</var>: calls inherited <var>Create</var> and initializes some local variables
|
|
</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="#rtl.System.TObject.Create">TObject.Create</link>
|
|
</seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TStringGridStrings.Create.aGrid">
|
|
<short>Grid for the string values</short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TStringGridStrings.Create.OwnerMap">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TStringGridStrings.Create.aIsCol">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TStringGridStrings.Create.aIndex">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- destructor Visibility: public -->
|
|
<element name="TStringGridStrings.Destroy">
|
|
<short>Destructor for the class instance</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="#rtl.Classes.TStrings.Destroy"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<element name="TStringGridStrings.Add">
|
|
<short>Adds the specified string to the class instance</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="#rtl.Classes.TStrings.Add"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TStringGridStrings.Add.Result">
|
|
<short></short>
|
|
</element>
|
|
<element name="TStringGridStrings.Add.S">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: public -->
|
|
<element name="TStringGridStrings.Assign">
|
|
<short>Stores values from Source in the current class instance</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="#rtl.Classes.TStrings.Assign"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TStringGridStrings.Assign.Source">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TStringGridStrings.Clear">
|
|
<short>
|
|
Removes all values for the column or row represented by he class instance
|
|
</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="#rtl.Classes.TStrings.Clear"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: public -->
|
|
<element name="TStringGridStrings.Delete">
|
|
<short>Deletes a value stored in the class instance</short>
|
|
<descr>
|
|
Raises an <var>EGridException</var> exception with the message <b>'Cannot delete value.'</b>
|
|
</descr>
|
|
<seealso>
|
|
<link id="#rtl.Classes.TStrings.Delete"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TStringGridStrings.Delete.Index">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: public -->
|
|
<element name="TStringGridStrings.Insert">
|
|
<short>Inserts a value in the class instance</short>
|
|
<descr>
|
|
Raises an <var>EGridException</var> exception with the message <b>'Cannot insert value.'</b>
|
|
</descr>
|
|
<seealso>
|
|
<link id="#rtl.Classes.TStrings.Insert"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TStringGridStrings.Insert.Index">
|
|
<short></short>
|
|
</element>
|
|
<element name="TStringGridStrings.Insert.S">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- object Visibility: default -->
|
|
<element name="TCustomStringGrid">
|
|
<short>
|
|
<var>TCustomStringGrid</var> - base class for <var>TStringGrid</var>
|
|
</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="HowToUseGrids"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- variable Visibility: private -->
|
|
<element name="TCustomStringGrid.FModified"/>
|
|
<element name="TCustomStringGrid.FColsMap"/>
|
|
<element name="TCustomStringGrid.FRowsMap"/>
|
|
<element name="TCustomStringGrid.FOnCellProcess"/>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TCustomStringGrid.GetCols">
|
|
<short>
|
|
Gets the values in the specified column number as a TStrings instance
|
|
</short>
|
|
<descr>
|
|
GetCols is the read access specifier for the indexed Cols property.
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomStringGrid.Cols"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomStringGrid.GetCols.Result">
|
|
<short>TStrings with row values for the specified column number</short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomStringGrid.GetCols.Index">
|
|
<short>Column number retrieved in the method</short>
|
|
</element>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TCustomStringGrid.GetObjects">
|
|
<short>Gets the value for the indexed Objects property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomStringGrid.GetObjects.Result">
|
|
<short>Value for the property</short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomStringGrid.GetObjects.ACol">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomStringGrid.GetObjects.ARow">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TCustomStringGrid.GetRows">
|
|
<short>Gets the value for the indexed Rows property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomStringGrid.GetRows.Result">
|
|
<short>Value for the property</short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomStringGrid.GetRows.Index">
|
|
<short>Ordinal position for the requested row</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TCustomStringGrid.MapFree">
|
|
<short>Frees the TStringGridStrings instances in the spefied Map</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomStringGrid.MapFree.aMap">
|
|
<short>TMap instance examined and updated in the method</short>
|
|
</element>
|
|
|
|
<!-- function Visibility: private -->
|
|
<element name="TCustomStringGrid.MapGetColsRows">
|
|
<short>Gets the column or row at the specified index fom the map instance</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TCustomStringGrid.MapGetColsRows.Result">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomStringGrid.MapGetColsRows.IsCols">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomStringGrid.MapGetColsRows.Index">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomStringGrid.MapGetColsRows.AMap">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TCustomStringGrid.ReadCells">
|
|
<short>Reads string values for the Cells property using a TReader instance</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomStringGrid.ReadCells.Reader">
|
|
<short>TReader instance used to read values during LCL streaming</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TCustomStringGrid.SetCols">
|
|
<short>Sets the value for the indexed Cols property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomStringGrid.SetCols.Index">
|
|
<short>Ordinal position for the affected column </short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomStringGrid.SetCols.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TCustomStringGrid.SetObjects">
|
|
<short>Sets the value for the indexed Objects property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomStringGrid.SetObjects.ACol">
|
|
<short>Ordinal position for the column</short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomStringGrid.SetObjects.ARow">
|
|
<short>Ordinal position for the row</short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomStringGrid.SetObjects.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TCustomStringGrid.SetRows">
|
|
<short>Sets the value for the indexed Rows property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomStringGrid.SetRows.Index">
|
|
<short>Ordinal position for the row affected</short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomStringGrid.SetRows.AValue">
|
|
<short>New value for the property</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TCustomStringGrid.WriteCells">
|
|
<short>
|
|
Writes string values in the Cells property using the specified TWriter instance
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomStringGrid.WriteCells.Writer">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomStringGrid.CopyCellRectToClipboard">
|
|
<short>
|
|
Copies the content from cell(s) in the specied selection rectangle to the clipboard
|
|
</short>
|
|
<descr>
|
|
<remark>
|
|
Only visible cells in the selection rectangle are included in the copied values. Others are quietly discarded. HTML TABLE formatting is used to gather the cell values. Line Ending and HTML reserve characters are translated in to HTML-safe tags or character entities.
|
|
</remark>
|
|
</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomStringGrid.CopyCellRectToClipboard.R">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomStringGrid.AssignTo">
|
|
<short>
|
|
Assigns values from the current class instance, including Cells, to the target class instance
|
|
</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.AssignTo"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TCustomStringGrid.AssignTo.Dest" link="TCustomGrid.AssignTo.Dest"/>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomStringGrid.AutoAdjustColumn">
|
|
<short>Adjusts and renders the font, text and images for the specified column</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="#LCL.Grids.TCustomGrid.AutoAdjustColumn"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TCustomStringGrid.AutoAdjustColumn.aCol">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element link="#LCL.Grids.TCustomDrawGrid.CalcCellExtent" name="TCustomStringGrid.CalcCellExtent"/>
|
|
<element name="TCustomStringGrid.CalcCellExtent.acol">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomStringGrid.CalcCellExtent.aRow">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomStringGrid.CalcCellExtent.aRect">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element link="#rtl.Classes.TComponent.DefineProperties" name="TCustomStringGrid.DefineProperties"/>
|
|
<element name="TCustomStringGrid.DefineProperties.Filer">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomStringGrid.DefineCellsProperty">
|
|
<short>
|
|
Defines the Cells property for the TFiler instance used in LCL streaming
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomStringGrid.DefineCellsProperty.Filer">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element link="TCustomGrid.DoCompareCells" name="TCustomStringGrid.DoCompareCells"/>
|
|
<element name="TCustomStringGrid.DoCompareCells.Result">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomStringGrid.DoCompareCells.Acol">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomStringGrid.DoCompareCells.ARow">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomStringGrid.DoCompareCells.Bcol">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomStringGrid.DoCompareCells.BRow">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomStringGrid.DoCopyToClipboard" link="TCustomGrid.DoCopyToClipboard"/>
|
|
<element name="TCustomStringGrid.DoCutToClipboard" link="TCustomGrid.DoCutToClipboard"/>
|
|
<element name="TCustomStringGrid.DoPasteFromClipboard" link="TCustomGrid.DoPasteFromClipboard"/>
|
|
|
|
<element name="TCustomStringGrid.DoCellProcess">
|
|
<short>Signals the OnCellProcess event handler when assigned</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomStringGrid.DoCellProcess.aCol">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomStringGrid.DoCellProcess.aRow">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomStringGrid.DoCellProcess.processType">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomStringGrid.DoCellProcess.aValue">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomStringGrid.DrawColumnText">
|
|
<short>Draws the title image and cell content for the specified column and row</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomStringGrid.DrawColumnText.aCol">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomStringGrid.DrawColumnText.aRow">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomStringGrid.DrawColumnText.aRect">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomStringGrid.DrawColumnText.aState">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomStringGrid.DrawTextInCell">
|
|
<short>Calls DrawCellText using the specified arguments</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomStringGrid.DrawTextInCell.aCol">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomStringGrid.DrawTextInCell.aRow">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomStringGrid.DrawTextInCell.aRect">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomStringGrid.DrawTextInCell.aState">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomStringGrid.DrawCellAutonumbering">
|
|
<short>Performs auto-numbering for non-empty cells in the grid</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomStringGrid.DrawCellAutonumbering.aCol">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomStringGrid.DrawCellAutonumbering.aRow">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomStringGrid.DrawCellAutonumbering.aRect">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomStringGrid.DrawCellAutonumbering.aValue">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomStringGrid.GetCells">
|
|
<short>Gets the value for the indexed Cells property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomStringGrid.GetCells.Result">
|
|
<short>Value for the indexed property</short>
|
|
</element>
|
|
<element name="TCustomStringGrid.GetCells.ACol">
|
|
<short>Column number for the cell</short>
|
|
</element>
|
|
<element name="TCustomStringGrid.GetCells.ARow">
|
|
<short>Row number for the cell</short>
|
|
</element>
|
|
|
|
<element name="TCustomStringGrid.GetCheckBoxState">
|
|
<short>Gets the state for a cell displayed as a Checkbox</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomStringGrid.GetCheckBoxState.aCol">
|
|
<short>Column number for the cell</short>
|
|
</element>
|
|
<element name="TCustomStringGrid.GetCheckBoxState.aRow">
|
|
<short>Row number for the cell</short>
|
|
</element>
|
|
<element name="TCustomStringGrid.GetCheckBoxState.aState">
|
|
<short>Checkbox state derived for the specified cell</short>
|
|
</element>
|
|
|
|
<!-- function Visibility: protected -->
|
|
<element link="#LCL.Grids.TCustomGrid.GetEditText" name="TCustomStringGrid.GetEditText"/>
|
|
<element name="TCustomStringGrid.GetEditText.Result">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomStringGrid.GetEditText.aCol">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomStringGrid.GetEditText.aRow">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element link="#LCL.Grids.TCustomGrid.LoadContent" name="TCustomStringGrid.LoadContent"/>
|
|
<element name="TCustomStringGrid.LoadContent.cfg">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomStringGrid.LoadContent.Version">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element link="#rtl.Classes.TComponent.Loaded" name="TCustomStringGrid.Loaded"/>
|
|
<element name="TCustomStringGrid.SaveContent" link="#LCL.Grids.TCustomGrid.SaveContent"/>
|
|
<element name="TCustomStringGrid.SaveContent.cfg" link="#LCL.Grids.TCustomGrid.SaveContent.cfg"/>
|
|
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TCustomStringGrid.SelectionSetText">
|
|
<short>
|
|
<var>SelectionSetText</var> - stores the text in the selection</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomStringGrid.SelectionSetText.TheText">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomStringGrid.SelectionSetHTML">
|
|
<short>Sets the value for the current Selection to the specified HTML content</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomStringGrid.SelectionSetHTML.TheHTML">
|
|
<short>HTML stored in the current selection</short>
|
|
</element>
|
|
<element name="TCustomStringGrid.SelectionSetHTML.TheText">
|
|
<short>Textual representation for the HTML content</short>
|
|
</element>
|
|
|
|
<element name="TCustomStringGrid.SetCells">
|
|
<short>Sets the value for the indexed Cells property</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomStringGrid.SetCells.ACol">
|
|
<short>Column number for the affected cell</short>
|
|
</element>
|
|
<element name="TCustomStringGrid.SetCells.ARow">
|
|
<short>Row number for the affected cell</short>
|
|
</element>
|
|
<element name="TCustomStringGrid.SetCells.AValue">
|
|
<short>New value for the indexed property</short>
|
|
</element>
|
|
|
|
<element name="TCustomStringGrid.SetCheckboxState">
|
|
<short>Sets the state for a Checkbox in the specified cell</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomStringGrid.SetCheckboxState.aCol">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomStringGrid.SetCheckboxState.aRow">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomStringGrid.SetCheckboxState.aState">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomStringGrid.SetEditText">
|
|
<short>
|
|
Locks, updates, and unlocks the editor and text for a cell at the specified coordinates
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomStringGrid.SetEditText.aCol">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomStringGrid.SetEditText.aRow">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomStringGrid.SetEditText.aValue">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- Visibility: protected -->
|
|
<element name="TCustomStringGrid.Modified">
|
|
<short>
|
|
Indicates if the content in the grid cells has been changed
|
|
</short>
|
|
<descr>
|
|
The value in Modified is set to False when Loaded using the LCL streaming mechanism. The value in Modified is changed to True when a cell is updated in the SetCells method, or when the Cells property is updated.
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomStringGrid.SetCells"/>
|
|
<link id="TCustomStringGrid.Cells"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<element name="TCustomStringGrid.OnCellProcess">
|
|
<short>
|
|
Event handler signalled when copying or pasting content for Cells in the grid
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- constructor Visibility: public -->
|
|
<element name="TCustomStringGrid.Create">
|
|
<short>
|
|
<var>Create</var> - constructor for <var>TCustomStringGrid</var>: calls inherited <var>Create</var> then sets up default styles, layout and alignment
|
|
</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="#LCL.Grids.TCustomDrawGrid.Create">TCustomDrawGrid.Create</link>
|
|
</seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomStringGrid.Create.AOwner">
|
|
<short>Owner of the class instance</short>
|
|
</element>
|
|
|
|
<!-- destructor Visibility: public -->
|
|
<element name="TCustomStringGrid.Destroy">
|
|
<short>
|
|
<var>Destroy</var> - destructor for <var>TCustomStringGrid</var>: frees maps of columns and rows, then calls inherited <var>Destroy</var>
|
|
</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="#LCL.Grids.TCustomDrawGrid.Destroy"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: public -->
|
|
<element name="TCustomStringGrid.AutoSizeColumn">
|
|
<short>
|
|
<var>AutoSizeColumn</var> - automatically adjust width of column to accommodate widest text
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
This procedure sets the column width to the size of the widest text it finds in all rows for the column <var>aCol.</var>
|
|
</p>
|
|
<p>
|
|
Tip: see the <var>goDblClickAutoSize</var> option to allow columns to be automatically resized when doubleClicking the column border.
|
|
</p>
|
|
</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomStringGrid.AutoSizeColumn.aCol">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: public -->
|
|
<element name="TCustomStringGrid.AutoSizeColumns">
|
|
<short>
|
|
<var>AutoSizeColumns</var> - automatically resizes all columns by adjusting them to fit in the longest text in each column
|
|
</short>
|
|
<descr>
|
|
Automatically resizes all columns by adjusting them to fit in the longest text in each column. This is a quick method of applying the <var>AutoSizeColumn</var> method for every column in the grid.
|
|
</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: public -->
|
|
<element name="TCustomStringGrid.Clean">
|
|
<short>
|
|
Cleans all cells in the grid using the specified CleanOptions
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
Cleans all cells in the grid subject to the given <var>CleanOptions</var>, optionally specifying a range of cells or a rectangular region. See <link id="TGridZoneSet"/> for more information.
|
|
</p>
|
|
<p>
|
|
The cleaning operation does not change the number of rows and columns. It only replaces the cell content by empty strings.
|
|
</p>
|
|
<p>
|
|
Some examples:
|
|
</p>
|
|
<ul>
|
|
<li>Clean all cells: grid.Clean([]); (the same as grid.clean)</li>
|
|
<li>Clean all non fixed cells: grid.Clean([gzNormal]);</li>
|
|
<li>Clean all cells but don't touch grid column headers: Grid.Clean([gzNormal, gzFixedRows]);</li>
|
|
</ul>
|
|
</descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomStringGrid.Clean.CleanOptions">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomStringGrid.Clean.aRect">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomStringGrid.Clean.StartCol">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomStringGrid.Clean.StartRow">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomStringGrid.Clean.EndCol">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomStringGrid.Clean.EndRow">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomStringGrid.CopyToClipboard">
|
|
<short>
|
|
<var>CopyToClipboard</var> - copy a range of cells to clipboard
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>CopyToClipboard</var> will copy a range of cells into the clipboard; the cells values are TAB separated. The range is defined based on optional <var>AUseSelection</var> parameter (which is <b>False</b> by default) and indicates the range is set to the whole grid, including fixed cols/rows. If <var>AUseSelection</var> is <b>True</b>, the range of cells is set to the current <link id="TCustomGrid.Selection"/>.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomGrid.Selection"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<element name="TCustomStringGrid.InsertRowWithValues">
|
|
<short>
|
|
Inserts a row at the specified position with the specified cell values
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomStringGrid.InsertRowWithValues.Index">
|
|
<short></short>
|
|
</element>
|
|
<element name="TCustomStringGrid.InsertRowWithValues.Values">
|
|
<short></short>
|
|
</element>
|
|
|
|
<element name="TCustomStringGrid.LoadFromCSVStream">
|
|
<short>Loads the content in the grid from the comma-separated values in AStream</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomStringGrid.LoadFromCSVStream.AStream">
|
|
<short>Stream with the content loaded in the method</short>
|
|
</element>
|
|
<element name="TCustomStringGrid.LoadFromCSVStream.ADelimiter">
|
|
<short>Delimiter between cell data in the stream; default is Comma (',')</short>
|
|
</element>
|
|
<element name="TCustomStringGrid.LoadFromCSVStream.UseTitles">
|
|
<short>Indicates if Column captions are loaded from values in the stream</short>
|
|
</element>
|
|
<element name="TCustomStringGrid.LoadFromCSVStream.FromLine">
|
|
<short>Initial line number in the stream included in the grid content; default is 0</short>
|
|
</element>
|
|
<element name="TCustomStringGrid.LoadFromCSVStream.SkipEmptyLines">
|
|
<short>Indicates if empty lines in the stream are ignored in the method</short>
|
|
</element>
|
|
|
|
<element name="TCustomStringGrid.LoadFromCSVFile">
|
|
<short>Loads the grid from a file using comma-separated value format</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomStringGrid.LoadFromCSVFile.AFilename">
|
|
<short>File name with the content loaded in the method</short>
|
|
</element>
|
|
<element name="TCustomStringGrid.LoadFromCSVFile.ADelimiter">
|
|
<short>Delimiter between cell values in the file; default is Comma (',')</short>
|
|
</element>
|
|
<element name="TCustomStringGrid.LoadFromCSVFile.UseTitles">
|
|
<short>Indicates if column captions are loaded from values in the file</short>
|
|
</element>
|
|
<element name="TCustomStringGrid.LoadFromCSVFile.FromLine">
|
|
<short>Initial line number from the file loaded in the method</short>
|
|
</element>
|
|
<element name="TCustomStringGrid.LoadFromCSVFile.SkipEmptyLines">
|
|
<short>Indicates if empty lines in the file are ignored in the method</short>
|
|
</element>
|
|
|
|
<element name="TCustomStringGrid.SaveToCSVStream">
|
|
<short>
|
|
Saves content in the grid as comma-separated values to the specified stream instance
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomStringGrid.SaveToCSVStream.AStream">
|
|
<short>Stream where grid content is stored</short>
|
|
</element>
|
|
<element name="TCustomStringGrid.SaveToCSVStream.ADelimiter">
|
|
<short>Delimiter between cell values; default is Comma (',')</short>
|
|
</element>
|
|
<element name="TCustomStringGrid.SaveToCSVStream.WriteTitles">
|
|
<short>Indicates that column captions are stored as the first row of CSV data</short>
|
|
</element>
|
|
<element name="TCustomStringGrid.SaveToCSVStream.VisibleColumnsOnly">
|
|
<short>
|
|
Indicates if only visible columns are included in the CSV output
|
|
</short>
|
|
</element>
|
|
|
|
<element name="TCustomStringGrid.SaveToCSVFile">
|
|
<short>
|
|
Saves grid content as comma-separated values to the specified file name
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="TCustomStringGrid.SaveToCSVFile.AFileName">
|
|
<short>File name (with optional path) where CSV data is stored</short>
|
|
</element>
|
|
<element name="TCustomStringGrid.SaveToCSVFile.ADelimiter">
|
|
<short>
|
|
Delimiter used between cell values in CSV output; default is Comma (',')
|
|
</short>
|
|
</element>
|
|
<element name="TCustomStringGrid.SaveToCSVFile.WriteTitles">
|
|
<short>
|
|
Indicates if column captions are written as the first row of CSV data in the file
|
|
</short>
|
|
</element>
|
|
<element name="TCustomStringGrid.SaveToCSVFile.VisibleColumnsOnly">
|
|
<short>Indicates if only visible columns are included in the CSV output</short>
|
|
</element>
|
|
|
|
<element name="TCustomStringGrid.Cells">
|
|
<short>
|
|
<var>Cells</var> - the text content of a cell or cells, indexed by
|
|
<var>aCol, aRow</var>
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>Cells</var> is an indexed <var>String</var> property used to read or write the content for a cell in the grid. The ACol and ARow indexes are used the access a value stored at the requested column and row position.
|
|
</p>
|
|
<p>
|
|
Reading the value causes the pointer to the cell in <var>Celda</var> to return its Text value.
|
|
</p>
|
|
<p>
|
|
Setting the value causes the pointer to the cell in Celda to be updated at the specified coordinates. An active cell editor will be cancelled if it is not locked, and the value in <var>Modified</var> is reset to <b>False</b>.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCustomStringGrid.Modified"/>
|
|
<link id="TVirtualGrid.Celda"/>
|
|
</seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomStringGrid.Cells.ACol">
|
|
<short>Column number for the cell value</short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomStringGrid.Cells.ARow">
|
|
<short>Row number for the cell value</short>
|
|
</element>
|
|
|
|
<!-- Visibility: public -->
|
|
<element name="TCustomStringGrid.Cols">
|
|
<short>
|
|
<var>Cols</var> - get or set a list of strings for column names as specified by the
|
|
<var>index</var>
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomStringGrid.Cols.Index">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- Visibility: public -->
|
|
<element link="#LCL.Grids.TCustomGrid.DefaultTextStyle" name="TCustomStringGrid.DefaultTextStyle"/>
|
|
|
|
<element link="#LCL.Grids.TCustomGrid.EditorMode" name="TCustomStringGrid.EditorMode"/>
|
|
|
|
<element link="#LCL.Grids.TCustomGrid.ExtendedSelect" name="TCustomStringGrid.ExtendedSelect"/>
|
|
|
|
<element name="TCustomStringGrid.Objects">
|
|
<short>The <var>Objects</var> present in the specified cell</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomStringGrid.Objects.ACol">
|
|
<short></short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomStringGrid.Objects.ARow">
|
|
<short></short>
|
|
</element>
|
|
|
|
<!-- Visibility: public -->
|
|
<element name="TCustomStringGrid.Rows">
|
|
<short>
|
|
<var>Rows</var> - gets or sets a list of strings for row names as specified by
|
|
<var>index</var>
|
|
</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TCustomStringGrid.Rows.Index">
|
|
<short></short>
|
|
</element>
|
|
<!-- Visibility: public -->
|
|
<element link="#LCL.Grids.TCustomGrid.UseXORFeatures" name="TCustomStringGrid.UseXORFeatures"/>
|
|
|
|
<element name="TCustomStringGrid.ValidateOnSetSelection">
|
|
<short></short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<!-- object Visibility: default -->
|
|
<element name="TStringGrid">
|
|
<short>
|
|
<var>TStringGrid</var> - a specialized grid for displaying strings (textual content) in a matrix of columns and rows
|
|
</short>
|
|
<descr></descr>
|
|
<seealso>
|
|
<link id="HowToUseGrids"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<element name="TStringGrid.WSRegisterClass" link="#LCL.LCLClasses.TLCLComponent.WSRegisterClass"/>
|
|
|
|
<element link="#LCL.Grids.TCustomStringGrid.Modified" name="TStringGrid.Modified"/>
|
|
<element link="TCustomGrid.InplaceEditor" name="TStringGrid.InplaceEditor"/>
|
|
<element link="#LCL.Controls.TControl.Align" name="TStringGrid.Align"/>
|
|
<element link="#LCL.Grids.TCustomGrid.AlternateColor" name="TStringGrid.AlternateColor"/>
|
|
<element link="#LCL.Controls.TControl.Anchors" name="TStringGrid.Anchors"/>
|
|
<element link="#LCL.Grids.TCustomGrid.AutoAdvance" name="TStringGrid.AutoAdvance"/>
|
|
<element link="#LCL.Grids.TCustomGrid.AutoEdit" name="TStringGrid.AutoEdit"/>
|
|
<element link="#LCL.Grids.TCustomGrid.AutoFillColumns"
|
|
name="TStringGrid.AutoFillColumns"/>
|
|
<element link="#LCL.Controls.TControl.BiDiMode" name="TStringGrid.BiDiMode"/>
|
|
<element link="#LCL.Controls.TControl.BorderSpacing" name="TStringGrid.BorderSpacing"/>
|
|
<element link="#LCL.Controls.TWinControl.BorderStyle" name="TStringGrid.BorderStyle"/>
|
|
|
|
<element name="TStringGrid.CellHintPriority"/>
|
|
|
|
<element link="#LCL.Controls.TControl.Color" name="TStringGrid.Color"/>
|
|
<element link="#LCL.Grids.TCustomGrid.ColCount" name="TStringGrid.ColCount"/>
|
|
<element name="TStringGrid.ColRowDraggingCursor"/>
|
|
<element name="TStringGrid.ColRowDragIndicatorColor"/>
|
|
<element name="TStringGrid.ColSizingCursor"/>
|
|
<element name="TStringGrid.ColumnClickSorts"/>
|
|
<element link="#LCL.Grids.TCustomGrid.Columns" name="TStringGrid.Columns"/>
|
|
<element name="TStringGrid.Constraints" link="#LCL.Controls.TControl.Constraints"/>
|
|
<element link="#LCL.Grids.TCustomGrid.DefaultColWidth"
|
|
name="TStringGrid.DefaultColWidth"/>
|
|
<element link="#LCL.Grids.TCustomGrid.DefaultDrawing" name="TStringGrid.DefaultDrawing"/>
|
|
<element link="#LCL.Grids.TCustomGrid.DefaultRowHeight" name="TStringGrid.DefaultRowHeight"/>
|
|
<element name="TStringGrid.DoubleBuffered" link="#LCL.Controls.TControl.DoubleBuffered"/>
|
|
<element name="TStringGrid.DragCursor" link="#LCL.Controls.TControl.DragCursor"/>
|
|
<element name="TStringGrid.DragKind" link="#LCL.Controls.TControl.DragKind"/>
|
|
<element name="TStringGrid.DragMode" link="#LCL.Controls.TControl.DragMode"/>
|
|
<element link="#LCL.Controls.TControl.Enabled" name="TStringGrid.Enabled"/>
|
|
<element name="TStringGrid.ExtendedSelect" link="TCustomGrid.ExtendedSelect"/>
|
|
<element link="#LCL.Grids.TCustomGrid.FixedColor" name="TStringGrid.FixedColor"/>
|
|
<element link="#LCL.Grids.TCustomGrid.FixedCols" name="TStringGrid.FixedCols"/>
|
|
<element link="#LCL.Grids.TCustomGrid.FixedRows" name="TStringGrid.FixedRows"/>
|
|
<element link="#LCL.Grids.TCustomGrid.Flat" name="TStringGrid.Flat"/>
|
|
<element name="TStringGrid.Font" link="LCL.Controls.TControl.Font"/>
|
|
<element link="#LCL.Grids.TCustomGrid.GridLineWidth" name="TStringGrid.GridLineWidth"/>
|
|
<element name="TStringGrid.HeaderHotZones" link="TCustomGrid.HeaderHotZones"/>
|
|
<element name="TStringGrid.HeaderPushZones" link="TCustomGrid.HeaderPushZones"/>
|
|
<element name="TStringGrid.ImageIndexSortAsc" link="TCustomGrid.ImageIndexSortAsc"/>
|
|
<element name="TStringGrid.ImageIndexSortDesc" link="TCustomGrid.ImageIndexSortDesc"/>
|
|
<element name="TStringGrid.MouseWheelOption" link="TCustomGrid.MouseWheelOption"/>
|
|
<element link="#LCL.Grids.TCustomGrid.Options" name="TStringGrid.Options"/>
|
|
<element link="#LCL.Grids.TCustomGrid.Options2" name="TStringGrid.Options2"/>
|
|
<element name="TStringGrid.ParentBiDiMode" link="#LCL.Controls.TControl.ParentBiDiMode"/>
|
|
<element name="TStringGrid.ParentColor" link="#LCL.Controls.TControl.ParentColor"/>
|
|
<element name="TStringGrid.ParentDoubleBuffered" link="#LCL.Controls.TControl.ParentDoubleBuffered"/>
|
|
<element name="TStringGrid.ParentFont" link="#LCL.Controls.TControl.ParentFont"/>
|
|
<element link="#LCL.Controls.TControl.ParentShowHint" name="TStringGrid.ParentShowHint"/>
|
|
<element link="#LCL.Controls.TControl.PopupMenu" name="TStringGrid.PopupMenu"/>
|
|
<element name="TStringGrid.RangeSelectMode" link="TCustomGrid.RangeSelectMode"/>
|
|
<element link="#LCL.Grids.TCustomGrid.RowCount" name="TStringGrid.RowCount"/>
|
|
<element name="TStringGrid.RowSizingCursor" link="TCustomGrid.RowSizingCursor"/>
|
|
<element link="#LCL.Grids.TCustomGrid.ScrollBars" name="TStringGrid.ScrollBars"/>
|
|
<element link="#LCL.Controls.TControl.ShowHint" name="TStringGrid.ShowHint"/>
|
|
<element name="TStringGrid.TabAdvance" link="TCustomGrid.TabAdvance"/>
|
|
<element link="#LCL.Controls.TWinControl.TabOrder" name="TStringGrid.TabOrder"/>
|
|
<element link="#LCL.Controls.TWinControl.TabStop" name="TStringGrid.TabStop"/>
|
|
<element link="#LCL.Grids.TCustomGrid.TitleFont" name="TStringGrid.TitleFont"/>
|
|
<element name="TStringGrid.TitleImageList" link="TCustomGrid.TitleImageList"/>
|
|
<element link="#LCL.Grids.TCustomGrid.TitleStyle" name="TStringGrid.TitleStyle"/>
|
|
<element link="#LCL.Grids.TCustomGrid.UseXORFeatures" name="TStringGrid.UseXORFeatures"/>
|
|
<element link="#LCL.Controls.TControl.Visible" name="TStringGrid.Visible"/>
|
|
<element link="#LCL.Grids.TCustomGrid.VisibleColCount"
|
|
name="TStringGrid.VisibleColCount"/>
|
|
<element link="#LCL.Grids.TCustomGrid.VisibleRowCount" name="TStringGrid.VisibleRowCount"/>
|
|
<element link="#LCL.Grids.TCustomGrid.OnAfterSelection" name="TStringGrid.OnAfterSelection"/>
|
|
<element link="#LCL.Grids.TCustomGrid.OnBeforeSelection" name="TStringGrid.OnBeforeSelection"/>
|
|
<element name="TStringGrid.OnCellProcess" link="TCustomGrid.OnCellProcess"/>
|
|
<element link="#LCL.Controls.TControl.OnChangeBounds" name="TStringGrid.OnChangeBounds"/>
|
|
<element name="TStringGrid.OnCheckboxToggled" link="TCustomGrid.OnCheckboxToggled"/>
|
|
<element link="#LCL.Controls.TControl.OnClick" name="TStringGrid.OnClick"/>
|
|
<element link="#LCL.Grids.TCustomDrawGrid.OnColRowDeleted" name="TStringGrid.OnColRowDeleted"/>
|
|
<element link="#LCL.Grids.TCustomDrawGrid.OnColRowExchanged" name="TStringGrid.OnColRowExchanged"/>
|
|
<element link="#LCL.Grids.TCustomDrawGrid.OnColRowInserted" name="TStringGrid.OnColRowInserted"/>
|
|
<element link="#LCL.Grids.TCustomDrawGrid.OnColRowMoved"
|
|
name="TStringGrid.OnColRowMoved"/>
|
|
<element link="#LCL.Grids.TCustomDrawGrid.OnCompareCells" name="TStringGrid.OnCompareCells"/>
|
|
<element link="#LCL.Controls.TControl.OnContextPopup" name="TStringGrid.OnContextPopup"/>
|
|
<element link="#LCL.Controls.TControl.OnDragDrop" name="TStringGrid.OnDragDrop"/>
|
|
<element link="#LCL.Controls.TControl.OnDragOver" name="TStringGrid.OnDragOver"/>
|
|
<element link="#LCL.Controls.TControl.OnDblClick" name="TStringGrid.OnDblClick"/>
|
|
<element link="#LCL.Grids.TCustomGrid.OnDrawCell" name="TStringGrid.OnDrawCell"/>
|
|
|
|
<element link="#LCL.Grids.TCustomGrid.OnEditButtonClick" name="TStringGrid.OnEditButtonClick">
|
|
<short>Deprecated</short>
|
|
</element>
|
|
|
|
<element name="TStringGrid.OnButtonClick" link="TCustomGrid.OnButtonClick"/>
|
|
<element link="#LCL.Controls.TControl.OnEditingDone" name="TStringGrid.OnEditingDone"/>
|
|
<element name="TStringGrid.OnEndDock" link="#LCL.Controls.TControl.OnEndDock"/>
|
|
<element name="TStringGrid.OnEndDrag" link="#LCL.Controls.TControl.OnEndDrag"/>
|
|
<element link="#LCL.Controls.TWinControl.OnEnter" name="TStringGrid.OnEnter"/>
|
|
<element link="#LCL.Controls.TWinControl.OnExit" name="TStringGrid.OnExit"/>
|
|
<element name="TStringGrid.OnGetCellHint" link="#LCL.Grids.TCustomGrid.OnGetCellHint"/>
|
|
<element name="TStringGrid.OnGetCheckboxState" link="TCustomGrid.OnGetCheckboxState"/>
|
|
<element link="#LCL.Grids.TCustomDrawGrid.OnGetEditMask"
|
|
name="TStringGrid.OnGetEditMask"/>
|
|
<element link="#LCL.Grids.TCustomDrawGrid.OnGetEditText"
|
|
name="TStringGrid.OnGetEditText"/>
|
|
<element link="#LCL.Grids.TCustomDrawGrid.OnHeaderClick"
|
|
name="TStringGrid.OnHeaderClick"/>
|
|
<element link="#LCL.Grids.TCustomDrawGrid.OnHeaderSized"
|
|
name="TStringGrid.OnHeaderSized"/>
|
|
<element name="TStringGrid.OnHeaderSizing" link="TCustomGrid.OnHeaderSizing"/>
|
|
<element link="#LCL.Controls.TWinControl.OnKeyDown" name="TStringGrid.OnKeyDown"/>
|
|
<element link="#LCL.Controls.TWinControl.OnKeyPress" name="TStringGrid.OnKeyPress"/>
|
|
<element link="#LCL.Controls.TWinControl.OnKeyUp" name="TStringGrid.OnKeyUp"/>
|
|
<element link="#LCL.Controls.TControl.OnMouseDown" name="TStringGrid.OnMouseDown"/>
|
|
<element link="#LCL.Controls.TControl.OnMouseEnter" name="TStringGrid.OnMouseEnter"/>
|
|
<element link="#LCL.Controls.TControl.OnMouseLeave" name="TStringGrid.OnMouseLeave"/>
|
|
<element link="#LCL.Controls.TControl.OnMouseMove" name="TStringGrid.OnMouseMove"/>
|
|
<element link="#LCL.Controls.TControl.OnMouseUp" name="TStringGrid.OnMouseUp"/>
|
|
<element link="#LCL.Controls.TControl.OnMouseWheel" name="TStringGrid.OnMouseWheel"/>
|
|
<element link="#LCL.Controls.TControl.OnMouseWheelDown" name="TStringGrid.OnMouseWheelDown"/>
|
|
<element link="#LCL.Controls.TControl.OnMouseWheelUp" name="TStringGrid.OnMouseWheelUp"/>
|
|
<element link="#LCL.Controls.TControl.OnMouseWheelHorz" name="TStringGrid.OnMouseWheelHorz"/>
|
|
<element link="#LCL.Controls.TControl.OnMouseWheelLeft" name="TStringGrid.OnMouseWheelLeft"/>
|
|
<element link="#LCL.Controls.TControl.OnMouseWheelRight" name="TStringGrid.OnMouseWheelRight"/>
|
|
<element link="#LCL.Grids.TCustomGrid.OnPickListSelect" name="TStringGrid.OnPickListSelect"/>
|
|
<element link="#LCL.Grids.TCustomGrid.OnPrepareCanvas"
|
|
name="TStringGrid.OnPrepareCanvas"/>
|
|
<element link="#LCL.Controls.TControl.OnResize" name="TStringGrid.OnResize"/>
|
|
<element link="#LCL.Grids.TCustomGrid.OnSelectEditor" name="TStringGrid.OnSelectEditor"/>
|
|
<element link="#LCL.Grids.TCustomGrid.OnSelection" name="TStringGrid.OnSelection"/>
|
|
<element link="#LCL.Grids.TCustomDrawGrid.OnSelectCell" name="TStringGrid.OnSelectCell"/>
|
|
<element name="TStringGrid.OnSetCheckboxState" link="TCustomDrawGrid.OnSetCheckboxState"/>
|
|
<element link="#LCL.Grids.TCustomDrawGrid.OnSetEditText"
|
|
name="TStringGrid.OnSetEditText"/>
|
|
<element link="#LCL.Controls.TControl.OnShowHint" name="TStringGrid.OnShowHint"/>
|
|
<element link="#LCL.Controls.TControl.OnStartDock" name="TStringGrid.OnStartDock"/>
|
|
<element link="#LCL.Controls.TControl.OnStartDrag" name="TStringGrid.OnStartDrag"/>
|
|
<element link="#LCL.Grids.TCustomGrid.OnTopLeftChanged" name="TStringGrid.OnTopLeftChanged"/>
|
|
<element name="TStringGrid.OnUserCheckboxBitmap" link="TCustomGrid.OnUserCheckboxBitmap"/>
|
|
<element link="#LCL.Controls.TWinControl.OnUTF8KeyPress" name="TStringGrid.OnUTF8KeyPress"/>
|
|
<element name="TStringGrid.OnValidateEntry" link="TCustomGrid.OnValidateEntry"/>
|
|
|
|
<!-- procedure Visibility: default -->
|
|
<element name="DrawRubberRect">
|
|
<short>Draw rubberband rectangle</short>
|
|
<descr>
|
|
<p>
|
|
Draws a dotted rubberbanding rectangle around the provided cell rectangle.
|
|
</p>
|
|
<p>
|
|
<var>DrawBits</var> contains a <var>Byte</var> value that indicates the rectangle sides drawn in the routine. By default, all sides for the rectangle are drawn. Use the following byte values or-ed together in <var>DrawBits</var> to specify the sides drawn:
|
|
</p>
|
|
<dl>
|
|
<dt>BF_LEFT</dt>
|
|
<dd>Draws the left side of the rectangle.</dd>
|
|
<dt>BF_RIGHT</dt>
|
|
<dd>Draws the right side of the rectangle.</dd>
|
|
<dt>BF_TOP</dt>
|
|
<dd>Draws the top of the rectangle.</dd>
|
|
<dt>BF_BOTTOM</dt>
|
|
<dd>Draws the bottom of the rectangle.</dd>
|
|
</dl>
|
|
</descr>
|
|
<seealso>
|
|
</seealso>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="DrawRubberRect.Canvas">
|
|
<short>Canvas where the rubberband rectangle is drawn</short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="DrawRubberRect.aRect">
|
|
<short>Coordinates for the rubberband rectangle</short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="DrawRubberRect.Color">
|
|
<short>Color for the rubberband rectangle</short>
|
|
</element>
|
|
|
|
<element name="DrawRubberRect.DrawBits">
|
|
<short>Sides drawn for the rubberband rectangle</short>
|
|
</element>
|
|
|
|
<element name="GetWorkingCanvas">
|
|
<short>Ensures that a valid handle for a device context exists for the canvas</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="GetWorkingCanvas.Result">
|
|
<short>The canvas instance with a valid handle</short>
|
|
</element>
|
|
<element name="GetWorkingCanvas.Canvas">
|
|
<short>Canvas examined in the routine</short>
|
|
</element>
|
|
|
|
<element name="FreeWorkingCanvas">
|
|
<short>Ensures a canvas handle for a device context is freed</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
<element name="FreeWorkingCanvas.canvas">
|
|
<short>Canvas examined in the routine</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: default -->
|
|
<element name="Register">
|
|
<short>Registers components in the Lazarus IDE</short>
|
|
<descr></descr>
|
|
<seealso></seealso>
|
|
</element>
|
|
|
|
<topic name="HowToUseGrids">
|
|
<short>
|
|
How to use <var>Grids</var> including <var>StringGrids</var>, <var>DrawGrids</var> and <var>DbGrids</var>
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<b>Customizing Grids</b>
|
|
</p>
|
|
<p>
|
|
Grids are components derived from the <var>TCustomControl</var> class and do not have a native widget associated with them. So they are not restricted by the look of the current interface theme. This can be both an advantage and a disadvantage: usually programmers want to create a uniform-look application. Lazarus grids are flexible enough to allow programmers to make them look similar to other native controls; alternatively they can customize the grid to obtain almost the same look in any platform or widget interface (with the exception of scrollbars, whose look is still determined by the current theme).
|
|
</p>
|
|
<p>
|
|
Some properties can affect the way the grid looks by acting when the cell is about to be painted in <var>PrepareCanvas/OnPrepareCanvas</var> by changing default canvas properties like brush color or font. Following is a list of such properties:
|
|
</p>
|
|
<table>
|
|
<caption>Properties and Events for Customizing Grids</caption>
|
|
<th>
|
|
<td>Property</td>
|
|
<td>Meaning</td>
|
|
</th>
|
|
<tr>
|
|
<td>AlternateColor</td>
|
|
<td>The user can change the background color that appears on alternate rows. This is to allow easy reading of grid rows data.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Color</td>
|
|
<td>Sets the primary color used to draw non fixed cells' background.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>FixedColor</td>
|
|
<td>The color used to draw fixed cells' background.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Flat</td>
|
|
<td>Eliminates the 3d look of fixed cells.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>TitleFont</td>
|
|
<td>Font used to draw the text in fixed cells.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>TitleStyle</td>
|
|
<td>
|
|
<p>Changes the 3D look of fixed cells. There are 3 settings:</p>
|
|
<dl>
|
|
<dt>tsLazarus</dt>
|
|
<dd>The default look</dd>
|
|
<dt>tsNative</dt>
|
|
<dd>Tries to use an appearance that is in concordance with the current widgetset theme</dd>
|
|
<dt>tsStandard</dt>
|
|
<dd>A more contrasted look, like Delphi grids</dd>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>AltColorStartNormal</td>
|
|
<td>
|
|
If true, alternate color is always in the second row after fixed rows; the first row after fixed rows will always be the default color. If false, default color is set to the first row as if there were no fixed rows.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>BorderColor</td>
|
|
<td>
|
|
Sets the grid's border color used when <var>Flat</var>=True and <var>BorderStyle</var>=bsSingle;
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>EditorBorderStyle</td>
|
|
<td>
|
|
If set to <var>bsNone</var> under Windows the cell editors will not have the border, like in Delphi; set to <var>bsSingle</var> by default because the border can be theme specific in some widgetsets and to allow a uniform look.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>FocusColor</td>
|
|
<td>The color used to draw the current focused cell if <var>UseXORFeatures</var> is not set; by default this is <var>clRed</var>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>FocusRectVisible</td>
|
|
<td>Turns on/off the drawing of focused cell.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>GridLineColor</td>
|
|
<td>Color of grid lines in non fixed area.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>GridLineStyle</td>
|
|
<td>
|
|
Pen style used to draw lines in non fixed area, possible choices are: <var>psSolid</var>, <var>psDash</var>, <var>psDot</var>, <var>psDashDot</var>, <var>psDashDotDot</var>, <var>psinsideFrame</var>, <var>psPattern</var>, <var>psClear</var>; default is <var>psSolid</var>.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>SelectedColor</td>
|
|
<td>Color used to draw cell background on selected cells.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>UseXORFeatures</td>
|
|
<td>If set, focus rect is drawn using XOR mode so it should make visible the focus rect in combination with any cell color background. It also affects the way that moving columns look.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>DefaultDrawing</td>
|
|
<td>
|
|
Normally the grid prepares its grid canvas using properties according to the kind of cell that is being painted. If the user has written an <var>OnDrawCell</var> event handler, <var>DefaultDrawing</var> (if set) also paints the cell background; if the user is taking full responsibility for drawing the cell it is better to turn off this so painting is not duplicated. In a StringGrid, if DefaultDrawing is set it draws the text in each cell.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>AutoAdvance</td>
|
|
<td>Where the cell cursor will go when pressing enter or tab/shift tab, or after editing.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>ExtendedColSizing</td>
|
|
<td>If true, the user can resize columns, not just at the headers, but anywhere along the column's height.</td>
|
|
</tr>
|
|
</table>
|
|
<p>
|
|
<b>Other Properties that Affect Grid Appearance:</b>
|
|
</p>
|
|
<p>
|
|
<var>Options</var>
|
|
</p>
|
|
<p>
|
|
This is a set of zero or more choices, with some elements that enable diverse functionality but others that are related directly with grid's look. Options can be set at design-time or run-time.
|
|
</p>
|
|
<dl>
|
|
<dt>
|
|
<var>goFixedVertLine, goFixedHorzLine</var>
|
|
</dt>
|
|
<dd>
|
|
Draws a vertical or horizontal line respectively, delimiting cells or columns in the fixed area; active by default.
|
|
</dd>
|
|
<dt>
|
|
<var>goVertLine, goHorzLine</var>
|
|
</dt>
|
|
<dd>
|
|
The same as previous, but for the normal browseable area. A grid can be made to simulate a listbox by unsetting both of these options.
|
|
</dd>
|
|
<dt>
|
|
<var>goDrawFocusSelected</var>
|
|
</dt>
|
|
<dd>
|
|
If this option is enabled, a selection background is painted in the focused cell in addition to the focused dotted rectangle. Please note: this doesn't work when the <var>goRowSelect</var> option is set; in such case the row is always painted as if <var>goDrawFocusSelected</var> is set.
|
|
</dd>
|
|
<dt>
|
|
<var>goRowSelect</var>
|
|
</dt>
|
|
<dd>
|
|
Selects the full row instead of individual cells.
|
|
</dd>
|
|
<dt>
|
|
<var>goFixedRowNumbering</var>
|
|
</dt>
|
|
<dd>
|
|
If set, grid will do numbering of rows in first fixed column.
|
|
</dd>
|
|
<dt>
|
|
<var>goHeaderHotTracking</var>
|
|
</dt>
|
|
<dd>
|
|
If set, the grid will try to show a different look when the mouse cursor is over any fixed cell. In order for this to work, desired cell zone needs to be enabled with the <var>HeaderHotZones</var>. Try combining this option with <var>TitleStyle</var>= <var>tsNative</var> to get themed hot tracking look.
|
|
</dd>
|
|
<dt>
|
|
<var>goHeaderPushedLook</var>
|
|
</dt>
|
|
<dd>
|
|
If set, this option enables a pushed look when clicking any fixed cell. The zone of "pushable" cells is enabled using <var>HeaderPushedZones</var> property.
|
|
</dd>
|
|
</dl>
|
|
<p>
|
|
<b>Description of the Grid Drawing Process</b>
|
|
</p>
|
|
<p>
|
|
Like other custom controls, the grid is drawn using the paint method. In general terms the grid is drawn by painting all rows, and each row by painting its individual cells. The process is as follows:
|
|
</p>
|
|
<ul>
|
|
<li>First, the visible cells area is determined: each row is tested to see if it intersects the canvas clipping region; if it's OK, then the visible area is painted by drawing columns of each row.
|
|
</li>
|
|
<li>
|
|
The column and row values are used to identify the cell that is about to be painted and again each column is tested for intersection with the clipping region; if everything is OK, some additional properties like the cell's rectangular extent and visual state are passed as arguments to the DrawCell method.
|
|
</li>
|
|
<li>
|
|
<p>
|
|
As the drawing process is running, the visual state of each cell is adjusted according to grid options and position within grid. The visual state is retained in a variable of type <var>TGridDrawState</var> which is a set with following elements:
|
|
</p>
|
|
<table>
|
|
<tr>
|
|
<td>gdSelected</td>
|
|
<td>The cell will have a selected look.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>gdFocused</td>
|
|
<td>The cell will have a focused look.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>gdFixed</td>
|
|
<td>Cell have to be painted with fixed cell look.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>gdHot</td>
|
|
<td>the mouse is over this cell, so paint it with hot tracking look</td>
|
|
</tr>
|
|
<tr>
|
|
<td>gdPushed</td>
|
|
<td>the cell is being clicked, paint it with pushed look </td>
|
|
</tr>
|
|
</table>
|
|
</li>
|
|
<li>
|
|
<p>
|
|
<var>DrawCell</var> - The DrawCell method is virtual and may be overridden in descendent grids to do custom drawing. The information passed to <var>DrawCell</var> helps to identify which particular cell is being painted, the physical area occupied on the screen and its visible status. See <link id="TCustomGrid.DrawCell">DrawCell</link> reference for details. For each cell the following occurs:
|
|
</p>
|
|
<ul>
|
|
<li>
|
|
<b>PrepareCanvas</b> - If the DefaultDrawing is set, the grid canvas is setup with default properties for brush and font based on current visual state. For several design and run-time properties, the text alignment is set to match programmer selection in custom columns if they exists. If DefaultDrawing is false, brush color is set to clWindow and Font color to clWindowText, the text alignment is set with grids defaultTextStyle value.
|
|
</li>
|
|
<li>
|
|
<b>OnPrepareCanvas</b> - If the programmer wrote an event handler for the
|
|
<var>OnPrepareCanvas</var> event, it is called at this point. This event can be used for doing simple customization like changing a cell's background color, font's properties like color, font face and style, Text layout like different combinations of left, center, top, bottom, right alignment, etc. Any change made to the canvas for a particular cell in this event would be lost, because the next cell drawing will reset canvas again to a default state. So it's safe doing changes only for a particular cell or cells and forget about it for the rest. Using this event sometimes helps to avoid using the <var>OnDrawCell</var> grid event, where users would be forced to duplicate the grid's drawing code.
|
|
</li>
|
|
<li>
|
|
<b>OnDrawCell</b> - Next, if no handler for the <var>OnDrawCell</var> event was specified, the grid calls the <var>DefaultDrawCell</var> method which simply paints the cell background using the current canvas brush color and style. If the <var>OnDrawCell</var> handler exists, the grid first paints the cell background, but only if the <var>DefaultDrawing</var> was set; then it calls the <var>OnDrawCell</var> event to do custom cell painting. Usually programmers want to do custom drawing only for particular cells, but standard drawing for others: in this case, they can restrict custom operation to certain cell or cells by looking into <var>ACol, ARow</var> and <var>AState</var> arguments, and for other cells simply call the <var>DefaultDrawCell</var> method and let the grid to take care of it.
|
|
</li>
|
|
<li>
|
|
<b>Text</b> - At this point, if the <var>DefaultDrawing</var> is true, the cell's text content is painted (only for <var>TStringGrid</var>).
|
|
</li>
|
|
<li>
|
|
<b>Grid lines</b> - The last step for each cell is to paint the grid lines: if grid options <var>goVertLine, goHorzLine, goFixedVertLine</var> and
|
|
<var>goFixedHorzLine</var> are specified the cell grid is drawn at this point. Grids with only rows or only cols can be obtained by changing these options. If the programmer elected to have a "themed" look it is done at this point also (see TitleStyle).
|
|
</li>
|
|
<li>
|
|
<b>FocusRect</b> - When all columns of the current row have been painted it is time to draw the focus rectangle for the current selected cell or for the whole row if the <var>goRowSelect</var> option is set.
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<p>
|
|
<b>Grid Cell Selection</b>
|
|
</p>
|
|
<p>
|
|
The location of a grid's current (focused) cell (or row) can be changed using keyboard, mouse or through code. In order to change cell focus successfully to another position, we must test the target position to see if it is allowed to receive cell focus. When using the keyboard, <var>AutoAdvance</var> performs part of the process by finding what should be the next focused cell. When using mouse clicks or moving by code, focus will not move from the current cell unless the target cell is permitted to receive focus.
|
|
</p>
|
|
<p>
|
|
The grid calls <var>SelectCell</var> to see if a cell is focusable: if this function returns true, then the target cell identified with arguments <var>aCol</var> and <var>aRow</var> is focusable (the current implementation of <var>TCustomGrid</var> simply returns true). <var>TCustomDrawGrid</var> and hence <var>TDrawGrid</var> and <var>TStringGrid</var> override this method and check first if a cell is any wider than 0; normally you don't want a 0 width cell selected so a cell with this characteristics is skipped automatically in the process of finding a suitable cell. The overridden method <var>SelectCell</var> also calls the user configurable event <var>OnSelectCell</var>: this event receives the cell coordinates as arguments and always returns a default result of True.
|
|
</p>
|
|
<p>
|
|
Once a cell is known to be focusable and we are sure a movement will take place, the method <var>BeforeMoveSelection</var> is called; this in turns triggers the <var>OnBeforeSelection</var> event. This method's arguments are the coordinates for the new focused cell; at this point any visible editor is hidden too. The "before" word means that selection is not yet changed and current focused coordinates can be accessed with <var>grid.Col</var> and <var>grid.Row</var> properties.
|
|
</p>
|
|
<p>
|
|
After that, the internal focused cell coordinates are changed and <var>MoveSelection</var> is called; this method's purpose (if set) is to trigger the <var>OnSelection</var> event (this is a notification that the focused cell has changed and the new cell coordinates are available through grid.row and grid.col properties).
|
|
</p>
|
|
<p>
|
|
Note that is not good to use the <var>OnSelectCell</var> event to detect cell focus changes, as this event will be triggered several times even for the same cell in the process of finding a suitable cell. Is better to use <var>OnBeforeSelection</var> or <var>OnSelection</var> events for this purpose.
|
|
</p>
|
|
<p>
|
|
<b>Using Cell Editors</b>
|
|
</p>
|
|
<p>
|
|
Users can specify what editor will be used for a cell using one of two methods.
|
|
</p>
|
|
<ol>
|
|
<li>
|
|
<b>Using a custom column and selecting the ButtonStyle of the column.</b> In this method the user can select the style of the editor that will be shown. Available values are: <var>cbsAuto, cbsEllipsis, cbsNone, cbsPickList, cbsCheckboxColumn</var>.
|
|
</li>
|
|
<li>
|
|
<p>
|
|
<b>Using the OnSelectEditor Grid Event</b>
|
|
</p>
|
|
<p>
|
|
Here the user specifies in the <var>Editor</var> parameter which editor to use for a cell identified by <var>aCol</var>, <var>ARow</var> in a <var>TCustomDrawGrid</var> derived grid or <var>TColumn</var> in <var>TCustomDBGrid</var>. The public <var>EditorByStyle()</var> function takes as parameter one of the following values: <var>cbsAuto, cbsEllipsis, cbsNone, cbsPickList, cbsCheckboxColumn</var>.
|
|
</p>
|
|
<p>
|
|
This method takes precedence over the first one using custom columns. A Custom cell editor can be specified here, with values specific to the cell, row or column.
|
|
</p>
|
|
</li>
|
|
</ol>
|
|
<p>
|
|
<b>Description of Editor Styles</b>
|
|
</p>
|
|
<p>
|
|
The following is a description of the editor styles. They are enumerated values of type <var>TColumnButtonStyle</var> and so they are prefixed by 'cbs'. This type was used to remain compatible with Delphi's <var>DBGrid</var>.
|
|
</p>
|
|
<ul>
|
|
<li>
|
|
<b>cbsAuto</b> - This is the default editor style for TCustomGrid derived grids. The TStringCellEditor derived from TCustomMaskEdit is specialized to edit single line strings and is used by default in TStringGrid and TDrawGrid. When using Custom Columns, if the programmer filled the Column's PickList property, this behaves as if cbsPickList editor style was set. For a TCustomDBGrid that has a field of type Boolean, it behaves as if cbsCheckBoxColumn editor style was specified. This is the recommended value for custom cell editors. TODO: related OnEditingDone.
|
|
</li>
|
|
<li>
|
|
<p>
|
|
<b>cbsEllipsis</b> - This editor style is the most generic one. A button with ellipsis (...) appears in the editing cell and the programmer can use the OnEditButtonClick grid event to take any programmed action when the user presses the button. For example a calendar dialog could pop up to allow the user to select a specific date, a file open dialog could appear to find files, or a calculator could appear so the user could enter the numeric result of calculations, etc.
|
|
</p>
|
|
<ul>
|
|
<li>
|
|
OnEditButtonClick is just a notification, to find out in which cell a button has been clicked by taking a look at the grid.Row and grid.Col properties.
|
|
</li>
|
|
<li>
|
|
A DBGrid has specific properties to retrieve the active column or field and because this event occurs in the active record, it could update the information in the active field.
|
|
</li>
|
|
<li>
|
|
This editor style is implemented using TButtonCellEditor, a direct descendant of TButton.
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<b>cbsNone</b> - This editor style instructs the grid not to use any editor for a specific cell or column; it behaves then, as if the grid were read-only for such a cell or column.
|
|
</li>
|
|
<li>
|
|
<p>
|
|
<b>cbsPickList</b> - Used to present the user with a list of values that can be entered. This editor style is implemented using TPickListCellEditor, a component derived from TCustomComboBox. The list of values that are shown is filled in one of two ways depending on the method used to select the editor style.
|
|
</p>
|
|
<p>
|
|
When using custom columns, programmers can enter a list of values using the column's PickList property. [FOR BEGINNERS: TODO: exact procedure to edit the list]
|
|
</p>
|
|
</li>
|
|
<li>
|
|
<p>
|
|
<b>cbsCheckboxColumn</b> - This editor style is at the moment only available in TDBGrid. If a field's contents associated with the column are restricted to a pair of values, for example, yes-no, true-false, on-off, 1-0, etc then cbsCheckboxColumn is used to modify the appearance of a column by using a checkbox representation that the user can toggle by using a mouse click or pressing the SPACE key.
|
|
</p>
|
|
<ul>
|
|
<li>
|
|
If a ButtonStyle for a column is set to cbsAuto and DBGrid detects that the field associated with the column is a Boolean field, then the grid uses this editor style automatically. This automatic selection can be disabled or enabled using DBGrid's OptionsExtra property; setting dgeCheckboxColumn element to false disables this feature.
|
|
</li>
|
|
<li>
|
|
The values that are used to recognize the checked or unchecked states are set in a column's properties ValueChecked and ValueUnchecked.
|
|
</li>
|
|
<li>
|
|
At any moment, the field value can be in one to three states: Unchecked, Checked or Grayed.
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</descr>
|
|
<notes>
|
|
<note>ToDo: samples of what can be made and what to leave for OnDrawCell?</note>
|
|
</notes>
|
|
</topic>
|
|
|
|
</module>
|
|
<!-- Grids -->
|
|
</package>
|
|
</fpdoc-descriptions>
|