Unit
IB_Grid

Declaration
TIB_CustomGrid = class(TCustomGrid)

Description
This is the absract base class for the IB_Grid.

It has been desinged to work with buffered datasets only. This could be the IB_Query component or any other TIB_BDataset descendant.

This class has the properties, methods and events with their descriptions.

Introduced Public Properties

AllowDropFiles	This property makes the necessary API calls to enable one to drag files from the explorer/desktop/etc.
AllowIncSearch	If this property is true and there are OrderingLinks for the dataset defined then it is possible to have the grid automatically incremental search for records by pressing keys.
AllowLockSession	By default IB_Grid does not permit the session to flicker the cursor when doing simple record navigations.
AllowTimeout	Used in conjunction with built-in incremental searching.
AlwaysShowEditor	This makes the editor appear even when editing is not being performed.
BorderCols	This property indicated how many extra border columnss of cells that should be placed in the title section of the grid.
BorderColWidth	Gives control over the width of the border cells.
BorderRowHeight	Gives control over the height of the border cells.
BorderRows	This property indicated how many extra border rows of cells that should be placed in the title section of the grid.
BuffFields	Index to the TIB_Column objects for each column in the grid.
ColLines	This property makes thin lines appear between each column.
ColMoving	This property determins whether or not column can be changed in their order one to another.
ColSizing	This property determins if individual columns can be resized or not.
Ctl3DShallow	This controls the depth of the 3D appearance of the fixed and border cells.
CurrentRowColor	Color of the current row.
CurrentRowFont	Font of the current row.
CustomGlyphs
CustomGlyphsSupplied
DataCol	Get the column index of the dataset from the column of the grid.
DataRow	Pass in as input the Row of the grid and the RowNum of the dataset will be returned.
DataSource	Reference to the dataset to which this control is bound.
DrawCellTextOptions	Control how the default drawing of Cell text is performed.
DrawFocusSelected	This property makes the focused cell be painted as though it were also a selected cell.
DrawTitleTextOptions	Control how the default drawing of Title text is performed.
EditLinkAutoClicked	Check the state of this read-only flag in the OnEditButtonClick event to see if the event was caused by automatic processing due to having enabled the gnOnEditDoEditClick (in NavigateOptions).
EditLinks	This property allows columns to be flagged so that they will make a little button appear when the cell gets focused so that the user can click on this button and have a dialog appear or some other defined action.
EditLinksAuto	When EditLinksAuto is true then edit link buttons will appear automatically for all text blob columns.
EditorBorderStyle	The property controls the border style assigned to all editor components that are dropped on the grid (it has no effect on the default/InplaceEditor).
FirstTabCol	First column that can be tabbed to or -1 if none.
FixedColLines	This property makes thin lines appear between each column header.
FixedCols	Number of fixed columns before the data columns.
FixedDataCols	This property will cause data columns to be included in the Fixed portion of the grid's cells.
FixedFont	Font of the text in the title and border of the grid.
FixedRowLines	This property makes thin lines appear between each row header..
FixedRows	Number of Fixed rows before the data rows.
FocusedCell	This property tells which cell currently has the focus in the grid.
GridCol	Get the column of the grid from the column index of the dataset.
GridFieldCount	Number of data columns in the grid.
GridFields	Index to the TIB_Column objects for each column in the grid.
GridLinks	This property determines a custom list of fields that should be displayed in the grid.
GridRow	Pass in as input the RowNum of the dataset and the Row of the grid will be returned.
IgnoreColorScheme	This property causes the control to ignore the coloring scheme and allow its color to be maintained manually by the application developer.
IncSearchHotKey	This makes it so that a special key to put the grid into incremental search mode can be configured.
IncSearchState	WIP
IncSearchText	WIP
IndicateBooleans	This property will enable or disable the usage of checkbox glyphs to interact with a column that has been declared as a BOOLEAN in the ColumnAttributes property of the dataset.
IndicateHighlight	This allows the grid to display the highlighting of rows.
IndicateLongCellText	Being phased-out.
IndicateLongTitle	Being phased-out.
IndicateNearest	This property determins whether or not the nearest matching record of an incremental search is shown in the grid without having it become selected.
IndicateOrdering	This property is used to determine if the column header will display a glyph to indicate if the dataset is sorted according to that column.
IndicateRow	This property determins whether or not there should be a small column at the left side of the grid to show what row is the current row.
IndicateSelected	This allows the grid to display and participate in the selecting of rows.
IndicateTitles	This property determins whether or not the column headers should appear or not.
InGridLayout	Tells if the grid is currently busy adjusting various internal layouts.
LastTabCol	last column that can be tabbed to or -1.
ListBoxStyle	This property determins if the grid should behave like a list box.
MouseDownPoint	Tells where the mouse went down in pixels.
NavigateOptions	The property allows you to change some of the key-stroke and navigation behaviour for the grid.
OnPrepareSQL	This event allows for custom alterations to be made to the SELECT statement's WHERE clause at prepare time.
Options	Read-only access to the Options property from the inherited TCustomGrid class.
OrderingColor	This property determins the color the column should be if it is the current column that the dataset is ordered by.
OrderingFont	This property determins the font of the text for the column that the dataset is currently ordered by.
PreventDeleting	Determines if the control can initiate the deletion of records.
PreventEditing	Determines if any editing changes can be made through this control.
PreventInserting	Determines if any inserting changes can be made through this control.
PreventSearching	Determines if any search criteria changes can be made through this control.
ReadOnly	Determins if any modifications can be entered through this control.
RowIndicatorColWidth	This property determines the width of the column used to display the row indicator.
RowLines	This property makes thin lines appear between each row.
RowSelect	This property makes the whole selected row appear highlighted or not.
ScrollBars	I need to make some adjustments to how this property is handled.
SearchKeyByKey	When incremental searching is activated this will cause it to respond to each individual key press.
SeekNearest	When incremental searching it is possible to tell it to only locate those records that produce an exact match.
SelectedField	The currently selected TIB_Column for the grid cell.
StretchColNum	Reference to the grid's Col that is to be resized in order to maintain the ListBoxStyle of keeping the column widths just inside the ClientWidth of the grid.
StretchColRef	Reference to the column that is to be resized in order to maintain the ListBoxStyle of keeping the column widths just inside the ClientWidth of the grid.
StretchColumn	When using ListBoxStyle it is possible to declare a custom column to be resized instead of the last one in the list.
TabMovesOut	The property makes TAB presses move focus through and out of the grid in a single row without requiring that all rows be scrolled through first.
TabStopLinks	This property allows columns to be flagged so that they will be included in the TabStops[] array even though they are calculated or readonly.
ThumbTracking	While the trackbar on the right side is slid up and down the current record pointer can follow it or wait until the trackbar handle is released.
TitleAlignment	Determine the alignment of the grid column title headers.
ToggleOnDblClick	If this property is true then a Double Click change the state of a embedded checkbox.
TopRow	First grid row to appear below the fixed rows.
TrackGridRow	If this property is true then you can scroll up and down through the dataset without actually moving the record pointer.

Introduced Public Methods

CanModify
DefaultDrawCell	Default method to handle the drawing of the data cells.
DefaultDrawFocusedCell	Default method to handle the drawing of the focused cell.
DefaultDrawTitle	Default method to handle the drawing of the title row cells.
GetCellAlignment	This method can be used to get the default text alignment when painting a cell.
GetCellColor	This method can be used to get the default color when painting a cell.
GetCellDisplayText	This method can be used to get the default text when painting a cell.
GetCellProps	This method can be used to get the default font when painting a cell.
HeightForGridRows	Returns the height necessary in order to have a certain number of rows.
Invalidate
InvalidateCol
InvalidateRow
MoveCol	Adjust which column has the focus.
ShowMemoEditor	You can use this procedure to call the memo editor (dialog with TIB_Memo) for the currently selected field.
StretchGridColumns	This procedure adjusts the columns widths so that they all will fit within the current width of the grid.
VisibleGridRows	Returns the number of visible GridRows.
WidthForAllCols	Returns the width necessary in order to display all columns.

Introduced Public Events

OnBorderClick	When the Border row is clicked on this event will be triggered.
OnCellClick	When any grid data cell is clicked on this event will be triggered.
OnCellDblClick	When any grid data cell is doubleclicked on this event will be triggered.
OnCellGainFocus	This event is triggered as soon as a new cell is to gain the focus.
OnCellLoseFocus	This event is triggered as soon as a new cell is about to become focused.
OnColEnter
OnColExit
OnDrawBorder	This event allows you to provide a custom painting method to paint the border cell that is currently needing to be repainted.
OnDrawCell	This event allows you to provide a custom painting method to paint the grid cell that is currently needing to be repainted.
OnDrawFocusedCell	This event allows you to provide a custom painting method to paint the grid cell that is currently focused.
OnDrawTitle	This event allows you to provide a custom painting method to paint the title cell that is currently needing to be repainted.
OnDropFiles	This event is used to give the name of the files dropped.
OnEditButtonClick	If EditingLinks has been set up properly then there should be a small button appear in the cell of a corresponding column.
OnGetCellColor	This method allows you to override the color of a cell.
OnGetCellFont	This method allows you to override the font of a cell.
OnGetCellProps	Work in progress.
OnGetDisplayText	This property is used to customize the text that is displayed in the cell.
OnGetEditMask	Gets the edit mask that should be used by the inplace editor.
OnGetEditText	Gets the text that should be used for editing by the inplace editor.
OnIncSearch	This event is used to provide custom incsearch handling.
OnSetColumnText	Event to customize or validate the text being assigned to the SelectedField for the current row and col.
OnSetEditText	Sets the text that was used by the inplace editor before it is assigned back to the field.
OnTitleClick	When the title row is clicked on this event will be triggered.
OnTopLeftChanged	Event that is triggered when the top left corner of the grid is changed.