Detailed Description

Table (data model for grid control)

The table is actually a container which manages set of values arranged in a two-dimensional matrix of cells. It serves as a back-end for the grid control (MC_WC_GRID).

To set or get an information about a cell, application uses the structure MC_TABLECELL.

Column and Row Headers

The table also manages a cell for each column and row. The grid uses data of these cells as headers for columns and rows (with its default styles; the control provides some styles changing this behavior).

The cells are manipulated the same way as ordinary cells, but special value MC_TABLE_HEADER has to be used as a column index or row index. I.e. to address cell for 2nd column, use column index 1 (because indexes are zero-based), and row index MC_TABLE_HEADER.

Data Structures
struct	MC_TABLECELLW
	Structure describing a table cell (Unicode variant). More...

struct	MC_TABLECELLA
	Structure describing a table cell (ANSI variant). More...

Macros
#define	MC_TABLE_HEADER 0xffff
	ID of column/row headers. More...

Typedefs
typedef void *	MC_HTABLE
	Opaque table handle. More...

MC_TABLECELL::fMask Bits

#define	MC_TCMF_TEXT 0x00000001
	Set if MC_TABLECELLW::pszText or MC_TABLECELLA::pszText is valid. More...

#define	MC_TCMF_PARAM 0x00000004
	Set if MC_TABLECELLW::lParam or MC_TABLECELLA::lParam is valid. More...

#define	MC_TCMF_FLAGS 0x00000008
	Set if MC_TABLECELLW::dwFlags or MC_TABLECELLA::dwFlags is valid. More...

MC_TABLECELL::dwFlags Bits

#define	MC_TCF_ALIGNDEFAULT 0x00000000
	Paint the cell value aligned horizontally as default for the value type. More...

#define	MC_TCF_ALIGNLEFT 0x00000001
	Paint the cell value aligned horizontally to left. More...

#define	MC_TCF_ALIGNCENTER 0x00000003
	Paint the cell value aligned horizontally to center. More...

#define	MC_TCF_ALIGNRIGHT 0x00000002
	Paint the cell value aligned horizontally to right. More...

#define	MC_TCF_ALIGNVDEFAULT 0x00000000
	Paint the cell value aligned vertically as normal for the value type. More...

#define	MC_TCF_ALIGNTOP 0x00000004
	Paint the cell value aligned vertically to top. More...

#define	MC_TCF_ALIGNVCENTER 0x0000000C
	Paint the cell value aligned vertically to center. More...

#define	MC_TCF_ALIGNBOTTOM 0x00000008
	Paint the cell value aligned vertically to bottom. More...

#define	MC_TCF_ALIGNMASKHORZ
	Bitmask for all cell flags specifying horizontal alignment. More...

#define	MC_TCF_ALIGNMASKVERT
	Bitmask for all cell flags specifying vertical alignment. More...

Functions
MC_HTABLE	mcTable_Create (WORD wColumnCount, WORD wRowCount, DWORD dwReserved)
	Create new table. More...

void	mcTable_AddRef (MC_HTABLE hTable)
	Increment reference counter of the table. More...

void	mcTable_Release (MC_HTABLE hTable)
	Decrement reference counter of the table. More...

WORD	mcTable_ColumnCount (MC_HTABLE hTable)
	Retrieve count of table columns. More...

WORD	mcTable_RowCount (MC_HTABLE hTable)
	Retrieve count of table rows. More...

BOOL	mcTable_Resize (MC_HTABLE hTable, WORD wColumnCount, WORD wRowCount)
	Resize the table. More...

void	mcTable_Clear (MC_HTABLE hTable, DWORD dwWhat)
	Clear the table. More...

BOOL	mcTable_SetCellW (MC_HTABLE hTable, WORD wCol, WORD wRow, MC_TABLECELLW *pCell)
	Set contents of a cell (Unicode variant). More...

BOOL	mcTable_SetCellA (MC_HTABLE hTable, WORD wCol, WORD wRow, MC_TABLECELLA *pCell)
	Set contents of a cell (ANSI variant). More...

BOOL	mcTable_GetCellW (MC_HTABLE hTable, WORD wCol, WORD wRow, MC_TABLECELLW *pCell)
	Get contents of a cell (Unicode variant). More...

BOOL	mcTable_GetCellA (MC_HTABLE hTable, WORD wCol, WORD wRow, MC_TABLECELLA *pCell)
	Get contents of a cell (ANSI variant). More...

Unicode Resolution
#define	MC_TABLECELL MCTRL_NAME_AW(MC_TABLECELL)

#define	mcTable_SetCell MCTRL_NAME_AW(mcTable_SetCell)

#define	mcTable_GetCell MCTRL_NAME_AW(mcTable_GetCell)

Data Structure Documentation

struct MC_TABLECELLW

Structure describing a table cell (Unicode variant).

Note that only members corresponding to the set bits of the fMask are considered valid. (fMask itself is always valid of course.)

See also: mcTable_SetCell mcTable_GetCell

Data Fields
DWORD	fMask	Bitmask specifying what other members are valid. See MC_TCMF_xxxx.
WCHAR *	pszText	Cell text.
int	cchTextMax	Number of characters in `pszText`. Used only on output.
LPARAM	lParam	User data.
DWORD	dwFlags	Cell flags. See MC_TCF_xxxx.

struct MC_TABLECELLA

Structure describing a table cell (ANSI variant).

Note that only members corresponding to the set bits of the fMask are considered valid. (fMask itself is always valid of course.)

See also: mcTable_SetCell mcTable_GetCell

Data Fields
DWORD	fMask	Bitmask specifying what other members are valid. See MC_TCMF_xxxx.
char *	pszText	Cell text.
int	cchTextMax	Number of characters in `pszText`. Used only on output.
LPARAM	lParam	User data.
DWORD	dwFlags	Cell flags. See MC_TCF_xxxx.

Macro Definition Documentation

#define MC_TABLE_HEADER 0xffff

ID of column/row headers.

To set or get a contents of column or row header, specify this constant as row/column index.

For example, to set value label of a column identified with wCol:

1 mcTable_SetCell(hTable, wCol, MC_TABLE_HEADER, pCell);

#define MC_TCMF_TEXT 0x00000001

Set if MC_TABLECELLW::pszText or MC_TABLECELLA::pszText is valid.

#define MC_TCMF_PARAM 0x00000004

Set if MC_TABLECELLW::lParam or MC_TABLECELLA::lParam is valid.

#define MC_TCMF_FLAGS 0x00000008

Set if MC_TABLECELLW::dwFlags or MC_TABLECELLA::dwFlags is valid.

#define MC_TCF_ALIGNDEFAULT 0x00000000

Paint the cell value aligned horizontally as default for the value type.

#define MC_TCF_ALIGNLEFT 0x00000001

Paint the cell value aligned horizontally to left.

#define MC_TCF_ALIGNCENTER 0x00000003

Paint the cell value aligned horizontally to center.

#define MC_TCF_ALIGNRIGHT 0x00000002

Paint the cell value aligned horizontally to right.

#define MC_TCF_ALIGNVDEFAULT 0x00000000

Paint the cell value aligned vertically as normal for the value type.

#define MC_TCF_ALIGNTOP 0x00000004

Paint the cell value aligned vertically to top.

#define MC_TCF_ALIGNVCENTER 0x0000000C

Paint the cell value aligned vertically to center.

#define MC_TCF_ALIGNBOTTOM 0x00000008

Paint the cell value aligned vertically to bottom.

#define MC_TCF_ALIGNMASKHORZ

Value:

(MC_TCF_ALIGNDEFAULT | MC_TCF_ALIGNLEFT | \

MC_TCF_ALIGNCENTER | MC_TCF_ALIGNRIGHT)

MC_TCF_ALIGNLEFT

#define MC_TCF_ALIGNLEFT

Paint the cell value aligned horizontally to left.

Definition: table.h:100

MC_TCF_ALIGNRIGHT

#define MC_TCF_ALIGNRIGHT

Paint the cell value aligned horizontally to right.

Definition: table.h:104

MC_TCF_ALIGNDEFAULT

#define MC_TCF_ALIGNDEFAULT

Paint the cell value aligned horizontally as default for the value type.

Definition: table.h:98

Bitmask for all cell flags specifying horizontal alignment.

#define MC_TCF_ALIGNMASKVERT

Value:

(MC_TCF_ALIGNVDEFAULT | MC_TCF_ALIGNTOP | \

MC_TCF_ALIGNVCENTER | MC_TCF_ALIGNBOTTOM)

MC_TCF_ALIGNVDEFAULT

#define MC_TCF_ALIGNVDEFAULT

Paint the cell value aligned vertically as normal for the value type.

Definition: table.h:106

MC_TCF_ALIGNBOTTOM

#define MC_TCF_ALIGNBOTTOM

Paint the cell value aligned vertically to bottom.

Definition: table.h:112

MC_TCF_ALIGNTOP

#define MC_TCF_ALIGNTOP

Paint the cell value aligned vertically to top.

Definition: table.h:108

Bitmask for all cell flags specifying vertical alignment.

#define MC_TABLECELL MCTRL_NAME_AW(MC_TABLECELL)

Unicode-resolution alias.

See also: MC_TABLECELLW MC_TABLECELLA

#define mcTable_SetCell MCTRL_NAME_AW(mcTable_SetCell)

Unicode-resolution alias.

See also: mcTable_SetCellW mcTable_SetCellA

#define mcTable_GetCell MCTRL_NAME_AW(mcTable_GetCell)

Unicode-resolution alias.

See also: mcTable_GetCellW mcTable_GetCellA

Typedef Documentation

typedef void* MC_HTABLE

Opaque table handle.

Function Documentation

MC_HTABLE mcTable_Create	(	WORD	wColumnCount,
		WORD	wRowCount,
		DWORD	dwReserved
	)

Create new table.

The table is initially empty and has its reference counter set to 1.

Parameters

[in]	wColumnCount	Column count.
[in]	wRowCount	Row count.
	dwReserved	Reserved. Set to zero.

Returns: Handle of the new table or NULL on failure.

void mcTable_AddRef ( MC_HTABLE hTable )

Increment reference counter of the table.

Parameters

[in] hTable The table.

void mcTable_Release ( MC_HTABLE hTable )

Decrement reference counter of the table.

If the reference counter drops to zero, all resources allocated for the table are released.

Parameters

[in] hTable The table.

WORD mcTable_ColumnCount ( MC_HTABLE hTable )

Retrieve count of table columns.

Parameters

[in] hTable The table.

Returns: The count.

WORD mcTable_RowCount ( MC_HTABLE hTable )

Retrieve count of table rows.

Parameters

[in] hTable The table.

Returns: The count.

BOOL mcTable_Resize	(	MC_HTABLE	hTable,
		WORD	wColumnCount,
		WORD	wRowCount
	)

Resize the table.

If a table dimension decreases, the values from excessive cells are destroyed. If a table dimension increases, the new cells are initialized to empty values (in case of heterogeneous table) or to NULL values (for homogeneous table).

Parameters

[in]	hTable	The table.
[in]	wColumnCount	Column count.
[in]	wRowCount	Row count.

Returns: TRUE on success, FALSE otherwise.

void mcTable_Clear	(	MC_HTABLE	hTable,
		DWORD	dwWhat
	)

Clear the table.

Clears all cells of the table satisfying the condition as specified by dwWhat.

Parameters

[in]	hTable	The table.
[in]	dwWhat	Specification of the cells to be cleared. When set to zero, all table contents (including header cells) is cleared. When non-zero, the value is interpreted as a bit-mask of cells to clear: Set bit `0x1` to clear all ordinary cells, `0x2` to clear column headers and bit `0x4` to clear row cells.

BOOL mcTable_SetCellW	(	MC_HTABLE	hTable,
		WORD	wCol,
		WORD	wRow,
		MC_TABLECELLW *	pCell
	)

Set contents of a cell (Unicode variant).

Parameters

[in]	hTable	The table.
[in]	wCol	Column index.
[in]	wRow	Row index.
[in]	pCell	Specifies attributes of the cell to set.

Returns: TRUE on success, FALSE otherwise.

BOOL mcTable_SetCellA	(	MC_HTABLE	hTable,
		WORD	wCol,
		WORD	wRow,
		MC_TABLECELLA *	pCell
	)

Set contents of a cell (ANSI variant).

Parameters

[in]	hTable	The table.
[in]	wCol	Column index.
[in]	wRow	Row index.
[in]	pCell	Specifies attributes of the cell to set.

Returns: TRUE on success, FALSE otherwise.

BOOL mcTable_GetCellW	(	MC_HTABLE	hTable,
		WORD	wCol,
		WORD	wRow,
		MC_TABLECELLW *	pCell
	)

Get contents of a cell (Unicode variant).

Before calling this function, the member pCell->fMask must specify what attributes of the cell to retrieve.

Parameters

[in]	hTable	The table.
[in]	wCol	Column index.
[in]	wRow	Row index.
[out]	pCell	Specifies retrieved attributes of the cell.

Returns: TRUE on success, FALSE otherwise.

BOOL mcTable_GetCellA	(	MC_HTABLE	hTable,
		WORD	wCol,
		WORD	wRow,
		MC_TABLECELLA *	pCell
	)

Get contents of a cell (ANSI variant).

Before calling this function, the member pCell->fMask must specify what attributes of the cell to retrieve.

Parameters

[in]	hTable	The table.
[in]	wCol	Column index.
[in]	wRow	Row index.
[out]	pCell	Specifies retrieved attributes of the cell.

Returns: TRUE on success, FALSE otherwise.

Detailed Description

Column and Row Headers

Data Structures

Macros

Typedefs

MC_TABLECELL::fMask Bits

MC_TABLECELL::dwFlags Bits

Functions

Unicode Resolution

Data Structure Documentation

Macro Definition Documentation

Typedef Documentation

Function Documentation