Grids unit

Classes for displaying tabular data as a series of rows and columns.

grids.pas contains classes, types, constants, variables, and routines used to implement grid controls for the Lazarus Component Library ( LCL). Classes include:

TVirtualGrid
TCustomGrid
TDrawGrid
TStringGrid

Original author: Jesus Reyes Aguilar (jesusrmx@yahoo.com.mx) [2002]

Classes and records

`EGridException`	class	Exception raised when an error has occurred in a Grid class.
`TButtonCellEditor`	class	The editor used for button-style cells in a grid.
`TCellProps`	record	Contains attributes, data, and text for grid cells.
`TColRowProps`	record	Contains the size and display attributes for a column or row in a grid.
`TCompositeCellEditor`	class	Implements a composite cell editor with combines one or more of the predefined cell editors types.
`TCustomDrawGrid`	class	The base class for a custom-drawn grid control.
`TCustomGrid`	class	Implements the base class for grid controls.
`TCustomStringGrid`	class	The base class for TStringGrid.
`TDrawGrid`	class	Implements a custom-drawn grid control.
`TEditorItem`	record	Represents one of the editors used in a TCompositeCellEditor instance.
`TGridColumn`	class	Implements a column definition used for tabular data in TCustomGrid.
`TGridColumns`	class	Collection used to store column definitions for a grid control.
`TGridColumnTitle`	class	Provides properties and methods need to represent a column title in a grid.
`TGridDataCache`	record	Stores cached information about a grid control.
`TGridMessage`	record	Contains a LCL message and its auxiliary values.
`TGridPropertyBackup`	record	Stores data about rows and columns used in a TCustomGrid class instance.
`TGridScroller`	class	Scrolls an associated grid when a column or row is dragged beyond the client area for the control.
`TPickListCellEditor`	class	Implements a cell editor control which displays a pick list.
`TSizingRec`	record	Stores size and movement data for columns or rows in a grid.
`TStringCellEditor`	class	Implements the default editor for cells in TCustomGrid.
`TStringGrid`	class	Implements a grid specialized for textual content.
`TStringGridStrings`	class	Represents strings used as the cell values in TCustomStringGrid / TStringGrid.
`TVirtualGrid`	class	Implements a grid with metadata where rows and columns are stored as Pointer arrays.

Procedures and functions

`DrawRubberRect`	procedure	Draws a rubber banding rectangle.
`FreeWorkingCanvas`	procedure	Ensures a canvas handle for a device context is freed.
`GetWorkingCanvas`	function	Ensures that a valid handle for a device context exists for the canvas.
`Register`	procedure	Registers components in the Lazarus IDE.

Types

`PCellProps`	type	Pointer to a TCellProps type.
`PColRowProps`	type	Pointer to a TColRowProps type.
`PGridMessage`	type	Pointer to a TGridMessage type.
`TAutoAdvance`	enumeration	Enumerated type with values controlling grid auto advance behavior.
`TCellHintPriority`	enumeration	Represents the cell hint display priorities.
`TCellProcessEvent`	procedure type	Specifies an event handler used to process the value in a grid cell.
`TCellProcessType`	enumeration	Identifies the action performed for cell content.
`TColumnButtonStyle`	enumeration	Enumeration with cell editor types available in a grid control.
`TGetCellHintEvent`	procedure type	Event used to get cell hints.
`TGetCheckboxStateEvent`	procedure type	Specifies an event handler signalled to get the state for a check box cell in a grid.
`TGetEditEvent`	procedure type	Specifies an event handler used to get edit values or masks in a grid.
`TGridCoord`	type	Stores mouse coordinates in screen pixels.
`TGridCursorState`	enumeration	Enumerated type with cursor states available in a grid.
`TGridDrawState`	set	Enumeration with Grid draw state values.
`TGridFlags`	set	Set type used to store TGridFlagsOption enumeration values.
`TGridFlagsOption`	enumeration	Represents state flags used in a grid control.
`TGridOperationEvent`	procedure type	Defines the event handler signalled when rows or columns are added, deleted or moved in a grid.
`TGridOption`	enumeration	Represents grid option values available for grid controls.
`TGridOption2`	enumeration	Represents grid options introduced in Version 2 (or higher) of grid controls.
`TGridOptions`	set	Set type used to store enabled grid options.
`TGridOptions2`	set	Set type used to store enabled grid options from the TGridOption2 enumeration.
`TGridRect`	type	Alias for the TRect type in RTL.
`TGridRectArray`	type	Array type used to store TGridRect instances.
`TGridSaveOptions`	enumeration	Represents the save options available for LCL grid controls.
`TGridScrollerDoScroll`	procedure type	Specifies an event handler routine used to scroll a grid control when a column or row is dragged beyond the grid client area.
`TGridState`	enumeration	Enumerated type with grid state values.
`TGridZone`	enumeration	Enumerated type with values which represent the zones or areas on a grid control.
`TGridZoneSet`	set	Set type used to store TGridZone enumeration values.
`THdrEvent`	procedure type	Specifies an event handler signalled when an event occurs in a fixed header cell.
`THeaderSizingEvent`	procedure type	Specifies an event handler signalled when a fixed cell header in a grid is resized.
`TItemType`	enumeration	Not used in the current LCL implementation.
`TMouseWheelOption`	enumeration	Enumerated type with values that control mouse wheel operation in a grid control.
`TOnCompareCells`	procedure type	Specifies an event handler signalled to compare cell values.
`TOnDrawCell`	procedure type	Defines the event handler signalled to draw a cell on a grid control.
`TOnPrepareCanvasEvent`	procedure type	Specifies an event handler signalled when preparing the canvas for a grid control.
`TOnSelectCellEvent`	procedure type	Specifies the event handler signalled when a cell is selected in a grid control.
`TOnSelectEvent`	procedure type	Specifies an event handler signalled for a selection in a grid control.
`TPrefixOption`	enumeration	Indicates how accelerator keys in column titles are handled for a grid control.
`TRangeSelectMode`	enumeration	Enumerated type with the Range selection mode used in a grid control.
`TSaveColumnEvent`	procedure type	Specifies an event handler used to load/save the configuration for a grid column.
`TSaveOptions`	set	Set type used to store TGridSaveOptions values.
`TSelectEditorEvent`	procedure type	Specifies an event handler signalled to get an editor control for the specified cell.
`TSetCheckboxStateEvent`	procedure type	Specifies an event handler signalled to set the state for a check box cell in a grid.
`TSetEditEvent`	procedure type	Specifies an event handler used to set the value for edit text in a grid.
`TSortOrder`	enumeration	Enumerated type with sort orders supported in a grid control.
`TTitleStyle`	enumeration	Enumeration with values that control the display style for fixed title cells.
`TToggledCheckboxEvent`	procedure type	Specifies an event handler signalled when the value in a check box cell is changed.
`TUserCheckBoxBitmapEvent`	procedure type	Specifies an event handler signalled to get the user-supplied bitmap for a check box cell.
`TUserCheckBoxImageEvent`	procedure type	Specifies the event handler used to get the image drawn for a check box column.
`TValidateEntryEvent`	procedure type	Specifies the event handler used to validate the content in a grid cell.

Constants

`constCellPadding`	constant	Default padding for the content in grid cells.
`constColRowBorderTolerance`	constant	Minimum proximity to row or column borders for resizing operations.
`constRubberSpace`	constant	Default spacing around rubber band rectangles.
`DefaultGridOptions`	constant	Set with the default grid options enabled for instances of the grid control.
`DefaultGridOptions2`	constant	Default grid options enabled for version 2 of the grid control.
`DEFBUTTONWIDTH`	constant	Default width for edit control buttons in a grid.
`DEFCOLWIDTH`	constant	Default width for columns in a grid control.
`DEFIMAGEPADDING`	constant	Default padding used for title images displayed in a grid.
`DEFMAXSIZE`	constant	Default value used as the maximum grid column size.
`DEFMINSIZE`	constant	Default value used as the minimum grid column size.
`DEFSIZEPRIORITY`	constant	Default value for SizePriority property in a grid column.
`EO_AUTOSIZE`	constant	Represents the auto-size editor option in a grid message.
`EO_HOOKKEYDOWN`	constant	Represents the hook key down editor option in a grid message.
`EO_HOOKKEYPRESS`	constant	Represents the hook key press editor option in a grid message.
`EO_HOOKKEYUP`	constant	Represents the hook key up editor option in a grid message.
`EO_IMPLEMENTED`	constant	Represents the implemented editor option in a grid message.
`EO_SELECTALL`	constant	Represents the select all content editor option in a grid message.
`GM_GETGRID`	constant	Lazarus message used to get the grid for an editing control.
`GM_GETVALUE`	constant	Lazarus message for getting the value in a grid edit control.
`GM_READY`	constant	Lazarus message sent when the grid can display its editing controls.
`GM_SELECTALL`	constant	Lazarus message for selecting the content in a grid edit control.
`GM_SETBOUNDS`	constant	Lazarus message for setting the bounds for a grid edit control.
`GM_SETGRID`	constant	Lazarus message for setting the grid for an edit control.
`GM_SETMASK`	constant	Lazarus message for setting the edit mask used in a grid edit control.
`GM_SETPOS`	constant	Lazarus message for setting the position of a grid edit control.
`GM_SETVALUE`	constant	Lazarus message for setting the value in a grid edit control.
`GRIDFILEVERSION`	constant	Current revision level for the grids.pas file.
`soAll`	constant	All save options available for grid controls.

Variables

`varCellpadding`	variable	Default padding for the content in grid cells.
`varColRowBorderTolerance`	variable	Proximity threshold for a mouse click near a column boundary.
`varRubberSpace`	variable	Default padding for the rubber banding rectangle in grid cells.

Topics

HowToUseGrids topic How to use Grids including StringGrids, DrawGrids and DbGrids.

Uses

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.