Public API Reference

                 

---

Grid
[Components]

Compounds
class	csGrid
	This is the grid object itself. More...
class	csGridCell
	The following class collects properties for drawing the cell and acts as a container for the csComponent (i.e. More...
class	csGridView
	The GridView displays a continuous rectangular region of the grid. More...
class	csSparseGrid
	If cells are populated with data or components, we need to store this somewhere and thats what the SparseGrid is for. More...
GridView styles
#define	CSGVS_HSCROLL   0x00000001
	View has a horizontal scrollbar.
#define	CSGVS_VSCROLL   0x00000002
	View has a vertical scrollbar.
#define	CSGVS_DEFAULTVALUE   (CSGVS_HSCROLL | CSGVS_VSCROLL)
	default value
Grid style flags
The csGrid object accepts both CSGS_XXX and CSGVS_XXX styles; the CSGVS_XXX styles are passed to newly-created grid view components.
#define	CSGS_HSPLIT   0x00000004
	Show a horizontal splitter handle.
#define	CSGS_VSPLIT   0x00000008
	Splitter can be subdivided further (vertical).
#define	CSGS_DEFAULTVALUE   (CSGS_HSPLIT | CSGS_VSPLIT)
	Default grid style.
#define	CSGCS_NONE   1
	no cursor
#define	CSGCS_CELL   2
	cell cursor
#define	CSGCS_ROW   3
	row cursor
#define	CSGCS_COLUMN   4
	column cursor
Defines
#define	CSS_GRIDCELL_SELECTED   0x00010000
	Additional state flag used to mark selected cell.
Typedefs
typedef bool(*	csRegionTreeFunc )(void *node, void *databag)
	Functions of this type can be used when traversing the tree.
Enumerations
enum	csGridCellBorderStyle {   gcbsNone = 0, gcbsDash, gcbsDashPoint, gcbsDashPointPoint,   gcbsDashDashPoint, gcbsLine }
	The possible border styles for grid cells. More...
enum	{ cscmdGridCursorChanged = 0x00000F00 }
	Grid messages. More...

:

We see the whole grid as a set of cells. Since it makes no sense to actually create an instance for every cell, we simply create an object that holds all properties for a rectangular region of cells that are all even.

---

Define Documentation

#define CSGCS_CELL   2

cell cursor Definition at line 359 of file csgrid.h.

#define CSGCS_COLUMN   4

column cursor Definition at line 363 of file csgrid.h.

#define CSGCS_NONE   1

no cursor Definition at line 357 of file csgrid.h.

#define CSGCS_ROW   3

row cursor Definition at line 361 of file csgrid.h.

#define CSGS_DEFAULTVALUE   (CSGS_HSPLIT | CSGS_VSPLIT)

Default grid style. Definition at line 354 of file csgrid.h.

#define CSGS_HSPLIT   0x00000004

Show a horizontal splitter handle. Definition at line 350 of file csgrid.h.

#define CSGS_VSPLIT   0x00000008

Splitter can be subdivided further (vertical). Definition at line 352 of file csgrid.h.

#define CSGVS_DEFAULTVALUE   (CSGVS_HSCROLL | CSGVS_VSCROLL)

default value Definition at line 256 of file csgrid.h.

#define CSGVS_HSCROLL   0x00000001

View has a horizontal scrollbar. Definition at line 252 of file csgrid.h.

#define CSGVS_VSCROLL   0x00000002

View has a vertical scrollbar. Definition at line 254 of file csgrid.h.

#define CSS_GRIDCELL_SELECTED   0x00010000

Additional state flag used to mark selected cell. Definition at line 199 of file csgrid.h.

---

Typedef Documentation

typedef bool(* csRegionTreeFunc)(void* node, void* databag)

Functions of this type can be used when traversing the tree. return true if you want to dive deeper into tree, false otherwise. Definition at line 50 of file csgrid.h.

---

Enumeration Type Documentation

anonymous enum

Grid messages. Enumeration values: cscmdGridCursorChanged  This message is sent to the grids parent to notify whenever the cursor changes (moves). Definition at line 367 of file csgrid.h.

enum csGridCellBorderStyle

The possible border styles for grid cells. Enumeration values: gcbsNone  No border ( ). gcbsDash  Dashed border (- - - - -). gcbsDashPoint  Interleaved dash-and-point border (- * - * - * -). gcbsDashPointPoint  Dash-point-point border (- * * - * * -). gcbsDashDashPoint  Dash-dash-point border (- - * - - * - -). gcbsLine  Solid line border (----------). Definition at line 182 of file csgrid.h.

---