Unit msegrids

Description

Uses

Classes, Interfaces, Objects and Records

Functions and Procedures

Types

Constants

Variables

Description

Overview

Classes, Interfaces, Objects and Records

Name	Description
Class `tgridexception`
Record `celleventinfoty`
Class `tcellframe`
Class `tfixcellframe`
Class `tcellface`
Class `tfixcellface`
Record `rowfoldinfoty`
Record `cellinfoty`
Class `tgridpropfont`
Class `tgridprop`
Record `colpaintinfoty`
Record `rangety`
Record `cellaxisrangety`
Record `rowpaintinfoty`
Record `rowspaintinfoty`
Class `tcolselectfont`
Class `tcol`
Class `tdatacol`
Class `tcelldragobject`
Class `tdrawcol`
Class `tstringcoldatalist`
Class `tcustomstringcol`
Class `tstringcol`
Class `tfixcol`
Class `tcolheaderfont`
Class `tcolheader`
Class `tdatacolheader`
Class `tcolheaders`
Class `tfixcolheaders`
Class `tdatacolheaders`
Class `tfixrow`
Class `tgridarrayprop`
Class `tcolsfont`
Class `tcolsfontselect`
Class `tcols`
Class `trowstatelist`
Class `tdatacols`
Class `tdrawcols`
Class `tstringcols`
Class `tfixcols`
Class `tfixrows`
Class `tgridframe`
Class `trowfontarrayprop`
Class `tcustomgrid`
Class `tcellgrid`
Class `tdrawgrid`
Class `tcustomstringgrid`
Class `tstringgrid`

Functions and Procedures

function gridcoordtotext(const coord: gridcoordty): string;

function isequalgridcoord(const a,b: gridcoordty): boolean;

function iscellkeypress(const info: celleventinfoty; const akey: keyty = key_none; const shiftstatemustinclude: shiftstatesty = []; const shiftstatemustnotinclude: shiftstatesty = []): boolean;

function iscellclick(const info: celleventinfoty; const restrictions: cellclickrestrictionsty = []; const shiftstatemustinclude: shiftstatesty = []; const shiftstatemustnotinclude: shiftstatesty = [ss_repeat]): boolean;

function isrowenter(const info: celleventinfoty; const noentergrid: boolean = false): boolean;

function isrowexit(const info: celleventinfoty; const noexitgrid: boolean = false): boolean;

function isrowchange(const info: celleventinfoty): boolean;

function wasrowenter(const info: celleventinfoty; const noentergrid: boolean = false): boolean;

function wasrowexit(const info: celleventinfoty; const noexitgrid: boolean = false): boolean;

function cellkeypress(const info: celleventinfoty): keyty;

Types

coloptionty = (...);

coloptionsty = set of coloptionty;

coloption1ty = (...);

coloptions1ty = set of coloption1ty;

fixcoloptionty = (...);

fixcoloptionsty = set of fixcoloptionty;

fixrowoptionty = (...);

fixrowoptionsty = set of fixrowoptionty;

optiongridty = (...);

optionsgridty = set of optiongridty;

optiongrid1ty = (...);

optionsgrid1ty = set of optiongrid1ty;

pickobjectkindty = (...);

stringcoleditoptionty = (...);

stringcoleditoptionsty = set of stringcoleditoptionty;

gridstatety = (...);

gridstatesty = set of gridstatety;

gridstate1ty = (...);

gridstates1ty = set of gridstate1ty;

cellkindty = (...);

griderrorty = (...);

pcelleventinfoty = ˆcelleventinfoty;

prowfoldinfoty = ˆrowfoldinfoty;

rowfoldinfoarty = array of rowfoldinfoty;

rowfoldinfoaty = array[0..0] of rowfoldinfoty;

prowfoldinfoaty = ˆrowfoldinfoaty;

celldrawstatety = (...);

celldrawstatesty = set of celldrawstatety;

pcellinfoty = ˆcellinfoty;

gridpropstatety = (...);

gridpropstatesty = set of gridpropstatety;

gridpropclassty = class of tgridprop;

celleventty = procedure(const sender: tobject; var info: celleventinfoty) of object;

drawcelleventty = procedure(const sender: tcol; const canvas: tcanvas; var cellinfo: cellinfoty) of object;

beforedrawcelleventty = procedure(const sender: tcol; const canvas: tcanvas; var cellinfo: cellinfoty; var processed: boolean) of object;

showcolhinteventty = procedure(const sender: tdatacol; const arow: integer; var info: hintinfoty) of object;

datacoleventty = procedure(const sender: tdatacol) of object;

datacolchangeeventty = procedure(const sender: tdatacol; const aindex: integer) of object;

datacolaty = array[0..0] of tdatacol;

pdatacolaty = ˆdatacolaty;

celldrageventty = procedure(const cellinfo: cellinfoty; var draginfo: draginfoty; var dragobject: tcelldragobject; var accept: boolean; var processed: boolean) of object;

stringcolclassty = class of tcustomstringcol;

fixcolclassty = class of tfixcol;

cellmergeflagty = (...);

cellmergeflagsty = set of cellmergeflagty;

datacolheaderoptionty = (...);

datacolheaderoptionsty = set of datacolheaderoptionty;

beforefixdrawcelleventty = procedure(const sender: tfixrow; const canvas: tcanvas; var cellinfo: cellinfoty; var processed: boolean) of object;

drawfixcelleventty = procedure(const sender: tfixrow; const canvas: tcanvas; const cellinfo: cellinfoty) of object;

cellinnerlevelty = (...);

cellselectmodety = (...);

selectcellmodety = (...);

optionfoldty = (...);

optionsfoldty = set of optionfoldty;

gridnotifyeventty = procedure(const sender: tcustomgrid) of object;

griddataeventty = procedure(const sender: tcustomgrid; const acell: gridcoordty) of object;

griddatablockeventty = procedure(const sender: tcustomgrid; const acell: gridcoordty; const acount: integer) of object;

gridblockmovingeventty = procedure(const sender: tcustomgrid; var fromindex,toindex,acount: integer) of object;

gridblockmovedeventty = procedure(const sender: tcustomgrid; const fromindex,toindex,acount: integer) of object;

gridbeforeblockeventty = procedure(const sender: tcustomgrid; var aindex,acount: integer) of object;

gridblockeventty = procedure(const sender: tcustomgrid; const aindex: integer; const acount: integer) of object;

gridsorteventty = procedure(const sender: tcustomgrid; const lindex,rindex: integer; var aresult: integer) of object;

gridmorerowseventty = procedure(const sender: tcustomgrid; const count: integer) of object;

gridscrolleventty = procedure(const sender: tcustomgrid; var step: integer) of object;

copyselectioneventty = procedure(const sender: tcustomgrid; var handled: boolean) of object;

pasteselectioneventty = procedure(const sender: tcustomgrid; var handled: boolean) of object;

cellclickrestrictionty = (...);

cellclickrestrictionsty = set of cellclickrestrictionty;

Constants

deprecatedcoloptions = [];

invisiblecoloptions = [];

fixcoloptionsshift1 = ord(fco_rowfont)-ord(co1_rowfont);

fixcoloptionsmask: coloptions1ty =
                 [co1_rowfont,co1_rowcolor,co1_zebracolor];

defaultfixcoloptions = [];

defaultgridskinoptions = [osk_framebuttononly];

sortglyphwidth = 11;

defaultwheelscrollheight = 0;

rowstatefoldleveltag = 0;

rowstateissumtag = 1;

rowstatefoldhiddentag = 2;

gridautosizetag = 3;

rowstateoptions = [og_colmerged,og_rowheight];

invisibleoptionsgrid = [];

newcomponentoptionsgridadd = [og_rowinserting,og_rowdeleting,
                                      og_autofirstrow,og_autoappend];

stringcoloptionseditmask: optionseditty = [
                    oe_exitoncursor,
                    oe_nofirstarrownavig,
                    oe_endonenter,
                    oe_homeonenter,
                    oe_autoselect, 
                    oe_autoselectonfirstclick,
                    oe_caretonreadonly,
                    oe_focusrectonreadonly,
                    oe_trimright,
                    oe_trimleft,
                    oe_uppercase,
                    oe_lowercase,
                    oe_hintclippedtext,
                    oe_locate,
                    oe_casesensitive];

stringcoloptionseditshift = ord(oe_exitoncursor) - 
                            ord(scoe_exitoncursor);

gridvaluevarname = 'values';

pickobjectstep = integer(high(pickobjectkindty)) + 1;

layoutchangedcoloptions: coloptionsty = [co_fill,co_proportional,co_invisible,
                              co_nohscroll];

layoutchangedcoloptions1: coloptions1ty = 
         [co1_rowcoloractive,co1_rowcolorfocused,
          co1_autorowheight,co1_autocolwidth,co1_autoheaderwidth];

notfixcoloptions = [co_fixwidth,co_fixpos,co_fill,co_proportional,co_nohscroll,
                     co_rowdatachange];

defaultoptionsgrid = [og_autopopup,og_colchangeontabkey,og_focuscellonenter,
                       og_mousescrollcol,og_wrapcol];

mousescrolldist = 5;

griddefaultcolwidth = 50;

griddefaultrowheight = 20;

defaultcoltextflags = [tf_ycentered,tf_noselect];

defaultactivecoltextflags = defaultcoltextflags - [tf_noselect];

defaultgridlinewidth = 1;

defaultdatalinecolor = cl_gridline;

defaultfixlinecolor = cl_gridlinefix;

defaultselectedcellcolor = cl_gridselect;

defaultdatacoloptions = [co_savestate,co_savevalue,
                          co_mousescrollrow];

defaultdatacoloptions1 = [co1_rowfont,co1_rowcolor,co1_zebracolor,
                           co1_rowcoloractive,co1_rowcolorfocused,co1_rowreadonly];

defaultfixcoltextflags = [tf_ycentered,tf_xcentered];

defaultstringcoleditoptions = [scoe_exitoncursor,scoe_undoonesc,scoe_autoselect,
                                scoe_autoselectonfirstclick,scoe_eatreturn,
                                scoe_focusrectonreadonly];

slowrepeat = 200000;

fastrepeat = 100000;

defaultgridwidgetoptions = defaultoptionswidgetmousewheel + 
                                        [ow_focusbackonesc];

defaultgridwidgetoptions1 = defaultoptionswidget1 + 
                                        [ow1_fontglyphheight];

mousecellevents = [cek_mousemove,cek_mousepark,cek_firstmousepark,
                    cek_buttonpress,cek_buttonrelease];

repeaterstates = [gs_scrollup,gs_scrolldown,gs_scrollleft,gs_scrollright];

Description

Functions and Procedures

function gridcoordtotext(const coord: gridcoordty): string;

function isequalgridcoord(const a,b: gridcoordty): boolean;

function iscellkeypress(const info: celleventinfoty; const akey: keyty = key_none; const shiftstatemustinclude: shiftstatesty = []; const shiftstatemustnotinclude: shiftstatesty = []): boolean;

function iscellclick(const info: celleventinfoty; const restrictions: cellclickrestrictionsty = []; const shiftstatemustinclude: shiftstatesty = []; const shiftstatemustnotinclude: shiftstatesty = [ss_repeat]): boolean;

function isrowenter(const info: celleventinfoty; const noentergrid: boolean = false): boolean;

function isrowexit(const info: celleventinfoty; const noexitgrid: boolean = false): boolean;

function isrowchange(const info: celleventinfoty): boolean;

function wasrowenter(const info: celleventinfoty; const noentergrid: boolean = false): boolean;

function wasrowexit(const info: celleventinfoty; const noexitgrid: boolean = false): boolean;

function cellkeypress(const info: celleventinfoty): keyty;

Types

coloptionty = (...);

Values

co_readonly
co_nofocus
co_invisible
co_disabled
co_drawfocus
co_mousemovefocus
co_leftbuttonfocusonly
co_middlebuttonfocus
co_noctrlmousefocus
co_focusselect
co_mouseselect
co_keyselect
co_multiselect
co_resetselectonexit
co_rowselect
co_fixwidth
co_fixpos
co_fill
co_proportional
co_nohscroll
co_savevalue
co_savestate
co_nosort
co_sortdescend
co_sortcaseinsensitive
co_norearange
co_cancopy
co_canpaste
co_mousescrollrow
co_rowdatachange

coloptionsty = set of coloptionty;

coloption1ty = (...);

Values

co1_rowfont
co1_rowcolor
co1_zebracolor
co1_rowcoloractive
co1_rowcolorfocused
co1_rowreadonly
co1_autorowheight
co1_autocolwidth
co1_noautocolwidth
co1_autoheaderwidth

coloptions1ty = set of coloption1ty;

fixcoloptionty = (...);

Values

fco_invisible
fco_mousefocus
fco_mouseselect
fco_rowfont
fco_rowcolor
fco_zebracolor

fixcoloptionsty = set of fixcoloptionty;

fixrowoptionty = (...);

Values

fro_invisible
fro_mousefocus
fro_mouseselect

fixrowoptionsty = set of fixrowoptionty;

optiongridty = (...);

Values

og_colsizing
og_colmoving
og_keycolmoving
og_rowsizing
og_rowmoving
og_keyrowmoving
og_rowinserting
og_rowdeleting
og_selectedrowsdeleting
og_focuscellonenter
og_containerfocusbackonesc
og_autofirstrow
og_autoappend
og_appendempty
og_noinsertempty
og_savestate
og_nosaveremoveappendedrow
og_sorted
og_nodefaultsort
og_noreorderrow
og_customsort
og_folded
og_colmerged
og_rowheight
og_colchangeontabkey
og_colchangeonreturnkey
og_wraprow
og_wrapcol
og_visiblerowpagestep
og_autopopup
og_mousescrollcol

optionsgridty = set of optiongridty;

optiongrid1ty = (...);

Values

og1_norowdeletequery
og1_swaprowinsertappend
og1_forcerowsmodified
og1_focusmorerows
og1_scrollmorerows
og1_noresetselect
og1_pasteinselection

optionsgrid1ty = set of optiongrid1ty;

pickobjectkindty = (...);

Values

pok_none
pok_fixcolsize
pok_fixcol
pok_datacolsize
pok_datacol
pok_fixrowsize
pok_fixrow
pok_datarowsize
pok_datarow

stringcoleditoptionty = (...);

Values

scoe_undoonesc
scoe_forcereturncheckvalue
scoe_eatreturn
scoe_exitoncursor
scoe_nofirstarrownavig
scoe_endonenter
scoe_homeonenter
scoe_autoselect
scoe_autoselectonfirstclick
scoe_caretonreadonly
scoe_focusrectonreadonly
scoe_trimright
scoe_trimleft
scoe_uppercase
scoe_lowercase
scoe_hintclippedtext
scoe_locate
scoe_casesensitive
scoe_checkbox

stringcoleditoptionsty = set of stringcoleditoptionty;

gridstatety = (...);

Values

gs_layoutvalid
gs_layoutupdating
gs_updatelocked
gs_changelock
gs_cellentered
gs_cellclicked
gs_emptyrowremoved
gs_rowcountinvalid
gs_rowreadonly
gs_scrollup
gs_scrolldown
gs_scrollleft
gs_scrollright
gs_selectionchanged
gs_rowdatachanged
gs_focusedcellchanged
gs_invalidated
gs_mouseentered
gs_childmousecaptured
gs_child
gs_mousecellredirected
gs_restorerow
gs_cellexiting
gs_rowremoving
gs_appending
gs_hasactiverowcolor
gs_needszebraoffset
gs_needsrowheight
gs_islist
gs_isdb

gridstatesty = set of gridstatety;

gridstate1ty = (...);

Values

gs1_showcellinvalid
gs1_sortvalid
gs1_rowsortinvalid
gs1_sortmoving
gs1_sortchangelock
gs1_rowinserted
gs1_gridsorted
gs1_dbsorted
gs1_customsort
gs1_rowdeleting
gs1_autoappending
gs1_autoremoving
gs1_autosizepending
gs1_focuscellonenterlock
gs1_mousecaptureendlock
gs1_forcenullcheck
gs1_cellsizesyncing
gs1_userinput
gs1_autoappendlock
gs1_scrolllimit
gs1_nocellassistive

gridstates1ty = set of gridstate1ty;

cellkindty = (...);

Values

ck_invalid
ck_data
ck_fixcol
ck_fixrow
ck_fixcolrow

griderrorty = (...);

Values

gre_ok
gre_invaliddatacell
gre_differentrowcount
gre_rowindex
gre_colindex
gre_invalidwidget

pcelleventinfoty = ˆcelleventinfoty;

prowfoldinfoty = ˆrowfoldinfoty;

rowfoldinfoarty = array of rowfoldinfoty;

rowfoldinfoaty = array[0..0] of rowfoldinfoty;

prowfoldinfoaty = ˆrowfoldinfoaty;

celldrawstatety = (...);

Values

cds_selected
cds_readonly
cds_focused
cds_active
cds_notext
cds_usecoloractive
cds_ismousecell

celldrawstatesty = set of celldrawstatety;

pcellinfoty = ˆcellinfoty;

gridpropstatety = (...);

Values

gps_fix
gps_selected
gps_noinvalidate
gps_edited
gps_readonlyupdating
gps_selectionchanged
gps_changelock
gps_datalistvalid
gps_needsrowheight
gps_maxsizevalid
gps_autosizevalid

gridpropstatesty = set of gridpropstatety;

gridpropclassty = class of tgridprop;

celleventty = procedure(const sender: tobject; var info: celleventinfoty) of object;

drawcelleventty = procedure(const sender: tcol; const canvas: tcanvas; var cellinfo: cellinfoty) of object;

beforedrawcelleventty = procedure(const sender: tcol; const canvas: tcanvas; var cellinfo: cellinfoty; var processed: boolean) of object;

showcolhinteventty = procedure(const sender: tdatacol; const arow: integer; var info: hintinfoty) of object;

datacoleventty = procedure(const sender: tdatacol) of object;

datacolchangeeventty = procedure(const sender: tdatacol; const aindex: integer) of object;

datacolaty = array[0..0] of tdatacol;

pdatacolaty = ˆdatacolaty;

celldrageventty = procedure(const cellinfo: cellinfoty; var draginfo: draginfoty; var dragobject: tcelldragobject; var accept: boolean; var processed: boolean) of object;

stringcolclassty = class of tcustomstringcol;

fixcolclassty = class of tfixcol;

cellmergeflagty = (...);

Values

cmf_h
cmf_v
cmf_rline

cellmergeflagsty = set of cellmergeflagty;

datacolheaderoptionty = (...);

Values

dco_colsort
dco_wholecellsortclick
dco_nodisabledsortindicator
dco_hintclippedtext
dco_noautowidth

datacolheaderoptionsty = set of datacolheaderoptionty;

beforefixdrawcelleventty = procedure(const sender: tfixrow; const canvas: tcanvas; var cellinfo: cellinfoty; var processed: boolean) of object;

drawfixcelleventty = procedure(const sender: tfixrow; const canvas: tcanvas; const cellinfo: cellinfoty) of object;

cellinnerlevelty = (...);

Values

cil_all
cil_noline
cil_paint
cil_inner

cellselectmodety = (...);

Values

csm_select
csm_deselect
csm_reverse

selectcellmodety = (...);

Values

scm_cell
scm_row
scm_col

optionfoldty = (...);

Values

of_insertsamelevel
of_deletetree
of_shiftdeltoparent
of_shiftchildren
of_validatelevel