MGUI::CTRL_GRID Class Reference

Grid user interface class. More...

#include <mgui/grid.h>

Inheritance diagram for MGUI::CTRL_GRID:

Classes
struct	CUSTOMDRAW
	Structure passed to OnDrawItem(). More...
struct	DISPINFO
	Structure passed to OnGetDispInfo Note: for the present, only the m_text member is supported by X. More...
Public Types
enum	CELLTYPE { CELLTYPE_Text = 0, CELLTYPE_Button = 1, CELLTYPE_DropDown = 2, CELLTYPE_Icon = 3, CELLTYPE_IconButton = 4, CELLTYPE_BigText = 5, CELLTYPE_PopUp = 6, CELLTYPE_Color = 7 }
typedef fastdelegate::FastDelegate < bool(int row, int col)>	DELEGATE_ONBEGINLABELEDIT
typedef fastdelegate::FastDelegate < void(int startcol, int endcol)>	DELEGATE_ONCHANGECOLUMNORDER
typedef fastdelegate::FastDelegate < void(int row, int col, KEYSTATE keystate)>	DELEGATE_ONCLICK
typedef fastdelegate::FastDelegate < bool(CUSTOMDRAW &customdraw)>	DELEGATE_ONDRAWITEM
typedef fastdelegate::FastDelegate < bool(int row, int col, MISTRING &)>	DELEGATE_ONENDLABELEDIT
typedef fastdelegate::FastDelegate < bool(int row, int col, DISPINFO &)>	DELEGATE_ONGETDISPINFO
typedef fastdelegate::FastDelegate < int(UINT32 row1, UINT32 row2, int col, bool bAscending)>	DELEGATE_ONITEMCOMPARE
typedef fastdelegate::FastDelegate < void(int row, int col)>	DELEGATE_ONITEMSELECT
typedef fastdelegate::FastDelegate < void(int row, int col)>	DELEGATE_ONITEMUNSELECT
typedef fastdelegate::FastDelegate < void(int col, int width)>	DELEGATE_ONRESIZECOLUMN
typedef fastdelegate::FastDelegate < void(int row, int col, const LPOINT2D &point, KEYSTATE keystate)>	DELEGATE_ONRIGHTCLICK
typedef fastdelegate::FastDelegate < bool(MGUI::CTRL_TOOLTIP &, int row, int col)>	DELEGATE_ONTOOLTIP
enum	FORMAT { FORMAT_Left = 0, FORMAT_Right = 1, FORMAT_Center = 2 }
enum	IMAGELISTTYPE { IMAGELISTTYPE_Normal = 0, IMAGELISTTYPE_Small = 1, IMAGELISTTYPE_State = 2 }
enum	STYLE { STYLE_AlignTop = 0x0000, STYLE_NoGridLines = 0x0001, STYLE_MultiSelect = 0x0002, STYLE_SingleSel = 0x0004, STYLE_ShowSelAlways = 0x0008, STYLE_SortAscending = 0x0010, STYLE_SortDescending = 0x0020, STYLE_NoSelect = 0x0040, STYLE_NoOuterFrame = 0x0080, STYLE_AutoArrange = 0x0100, STYLE_EditLabels = 0x0200, STYLE_SizeInPixels = 0x0400, STYLE_AlignLeft = 0x0800, STYLE_OwnerData = 0x1000, STYLE_NoScroll = 0x2000, STYLE_NoColumnHeader = 0x4000, STYLE_NoSortHeader = 0x8000 }
enum	VIEWMODE { VIEWMODE_Icon = 0, VIEWMODE_Report = 1, VIEWMODE_SmallIcon = 2, VIEWMODE_List = 3 }
Public Member Functions
	CTRL_GRID ()
virtual	~CTRL_GRID ()
void	Create (MGUI::LAYOUT_PANE_BASE &ParentPane, int height=10, int width=40, VIEWMODE viewmode=VIEWMODE_Report, STYLE style=STYLE_AlignTop, MGUI::LAYOUT_SIZEALIGN sizealign=MGUI::LAYOUT_SIZEALIGN_Expand)
void	DeleteAllColumns ()
void	DeleteAllItems ()
void	DeleteColumn (int col)
void	DeleteItem (int itemnum, bool redrawnow)
void	DeleteItem (int itemnum)
void	DeleteItemByData (ID id)
void	DeselectAllItems ()
void	EditFinish ()
bool	EditItem (int itemnum, int column, const MIUNICODE *initstr, bool selectall=true)
bool	EditItem (int itemnum, int column=0, bool selectall=true)
void	EnsureVisible (int itemnum, bool PartialOK=false)
int	FindItemByData (ID data) const
int	FindItemByData (const void *value) const
int	GetBottomRow () const
bool	GetCellRect (int itemnum, int col, LRECT2D &rect) const
int	GetColumnCount () const
bool	GetColumnLabel (int column, MISTRING &label) const
ERRVALUE	GetColumnOrderArray (SIMPLE_ARRAY< INT32 > &array) const
int	GetColumnWidth (int column) const
int	GetCountPerPage () const
int	GetHeadingHeight () const
int	GetItemCount () const
MGUI::ID	GetItemData (int itemnum) const
MISTRING	GetItemText (int itemnum, int subitem) const
int	GetNextSelectedItem (int startitem=-1) const
int	GetSelectedCount () const
int	GetTopRow () const
int	InsertColumn (int colnum, const MISTRING &string, FORMAT format=FORMAT_Left, int width=-1)
int	InsertColumnComboBox (int colnum, const MISTRING &label, const MISTRING &menu, int width=-1)
int	InsertItem (int pos, const MISTRING &string)
int	InsertItem (const MISTRING &string)
bool	IsItemSelected (int itemnum) const
void	Redraw (bool updatenow=true)
void	RedrawDisable ()
void	RedrawEnable ()
void	RedrawItems (int firstitemnum, int lastitemnum, bool updatenow=true)
bool	SetColumnLabel (int column, const MISTRING &label)
void	SetColumnOrderArray (SIMPLE_ARRAY< INT32 > &array)
void	SetColumnWidth (int column, int width)
void	SetDelegateOnBeginLabelEdit (DELEGATE_ONBEGINLABELEDIT DelegateOnBeginLabelEdit)
void	SetDelegateOnChangeColumnOrder (DELEGATE_ONCHANGECOLUMNORDER DelegateOnChangeColumnOrder)
void	SetDelegateOnClickColumn (DELEGATE_ONCLICK DelegateOnClickColumn)
void	SetDelegateOnClickItem (DELEGATE_ONCLICK DelegateOnClickItem)
void	SetDelegateOnDoubleClickItem (DELEGATE_ONCLICK DelegateOnDoubleClickItem)
void	SetDelegateOnDrawItem (DELEGATE_ONDRAWITEM DelegateOnDrawItem)
void	SetDelegateOnEndLabelEdit (DELEGATE_ONENDLABELEDIT DelegateOnEndLabelEdit)
void	SetDelegateOnGetDispInfo (DELEGATE_ONGETDISPINFO DelegateOnGetDispInfo)
void	SetDelegateOnItemCompare (DELEGATE_ONITEMCOMPARE DelegateOnItemCompare)
void	SetDelegateOnItemSelect (DELEGATE_ONITEMSELECT DelegateOnItemSelect)
void	SetDelegateOnItemUnselect (DELEGATE_ONITEMUNSELECT DelegateOnItemUnselect)
void	SetDelegateOnResizeColumn (DELEGATE_ONRESIZECOLUMN DelegateOnResizeColumn)
void	SetDelegateOnRightClick (DELEGATE_ONRIGHTCLICK DelegateOnRightClick)
void	SetDelegateOnSize (DELEGATE_ONSIZE DelegateOnSize)
void	SetDelegateOnToolTip (DELEGATE_ONTOOLTIP DelegateOnToolTip)
void	SetImageList (IMAGELIST &imagelist, IMAGELISTTYPE listtype=IMAGELISTTYPE_Small, bool shared=false)
int	SetItemCount (int NumItems)
void	SetItemData (int itemnum, ID value)
void	SetItemImage (int itemnum, int imageindex)
void	SetItemSelected (int itemnum, bool selected=true)
void	SetItemText (int itemnum, int subitem, const MISTRING &string)
void	SetRowHeight (int pixels)
void	SortItems (int column=0, bool bAscending=true)
void	Update (int itemnum)
Protected Member Functions
STYLE	GetStyle () const
virtual bool	OnBeginLabelEdit (int itemnum, int subitemnum)
virtual void	OnChangeColumnOrder (int fromCol, int toCol)
virtual void	OnClickColumn (int itemnum, int column, KEYSTATE state)
virtual void	OnClickItem (int itemnum, int column, KEYSTATE state)
virtual void	OnDoubleClickItem (int itemnum, int column, KEYSTATE state)
virtual bool	OnDrawItem (CUSTOMDRAW &drawinfo)
virtual bool	OnEndLabelEdit (int row, int col, MISTRING &string)
virtual bool	OnGetDispInfo (int row, int col, CTRL_GRID::DISPINFO &dispinfo)
virtual void	OnItemActivate ()
virtual int	OnItemCompare (UINT32 rowitem1, UINT32 rowitem2, int colnum, bool bAscending)
virtual void	OnItemSelect (int itemnum, int subitemnum)
virtual void	OnItemUnselect (int itemnum, int subitemnum)
virtual void	OnOwnerDataCacheHint (int from, int to)
virtual void	OnRightClickItem (int itemnum, int column, const LPOINT2D &, KEYSTATE state)
virtual void	OnUserResizeColumn (int column, int width)
virtual bool	v_OnToolTip (MGUI::CTRL_TOOLTIP &tooltip, int row, int col)

Detailed Description

Grid user interface class.

There are two general ways to work with lists, "standard" and "owner-data" (virtual). In the standard configuration the list control itself contains all of the data (strings, icons, states) for each list entry. In the "owner-data" configuration, the data is stored outside the list and the OnGetDispInfo and OnOwnerDataCacheHint methods are overridden (or set when using the template) and will be called by the list control when data is needed to be displayed in the list.

Member Typedef Documentation

typedef fastdelegate::FastDelegate<bool(int row, int col)> MGUI::CTRL_GRID::DELEGATE_ONBEGINLABELEDIT

typedef fastdelegate::FastDelegate<void(int startcol, int endcol)> MGUI::CTRL_GRID::DELEGATE_ONCHANGECOLUMNORDER

typedef fastdelegate::FastDelegate<void(int row, int col, KEYSTATE keystate)> MGUI::CTRL_GRID::DELEGATE_ONCLICK

typedef fastdelegate::FastDelegate<bool(CUSTOMDRAW& customdraw)> MGUI::CTRL_GRID::DELEGATE_ONDRAWITEM

typedef fastdelegate::FastDelegate<bool(int row, int col, MISTRING&)> MGUI::CTRL_GRID::DELEGATE_ONENDLABELEDIT

typedef fastdelegate::FastDelegate<bool(int row, int col, DISPINFO&)> MGUI::CTRL_GRID::DELEGATE_ONGETDISPINFO

typedef fastdelegate::FastDelegate<int(UINT32 row1, UINT32 row2, int col, bool bAscending)> MGUI::CTRL_GRID::DELEGATE_ONITEMCOMPARE

typedef fastdelegate::FastDelegate<void(int row, int col)> MGUI::CTRL_GRID::DELEGATE_ONITEMSELECT

typedef fastdelegate::FastDelegate<void(int row, int col)> MGUI::CTRL_GRID::DELEGATE_ONITEMUNSELECT

typedef fastdelegate::FastDelegate<void(int col, int width)> MGUI::CTRL_GRID::DELEGATE_ONRESIZECOLUMN

typedef fastdelegate::FastDelegate<void(int row, int col, const LPOINT2D&point, KEYSTATE keystate)> MGUI::CTRL_GRID::DELEGATE_ONRIGHTCLICK

typedef fastdelegate::FastDelegate<bool(MGUI::CTRL_TOOLTIP&, int row, int col)> MGUI::CTRL_GRID::DELEGATE_ONTOOLTIP

Member Enumeration Documentation

enum MGUI::CTRL_GRID::CELLTYPE

Enumerator:

CELLTYPE_Text
CELLTYPE_Button
CELLTYPE_DropDown
CELLTYPE_Icon
CELLTYPE_IconButton
CELLTYPE_BigText
CELLTYPE_PopUp
CELLTYPE_Color

enum MGUI::CTRL_GRID::FORMAT

Enumerator:

FORMAT_Left	Left-align values.
FORMAT_Right	Right-align values.
FORMAT_Center	Center values in column.

enum MGUI::CTRL_GRID::IMAGELISTTYPE

Enumerator:

IMAGELISTTYPE_Normal	LVSIL_NORMAL.
IMAGELISTTYPE_Small	LVSIL_SMALL.
IMAGELISTTYPE_State	LVSIL_STATE.

enum MGUI::CTRL_GRID::STYLE

Enumerator:

STYLE_AlignTop
STYLE_NoGridLines	Don't show grid lines.
STYLE_MultiSelect	Allow multiple selection.
STYLE_SingleSel	Allow only single selection (default).
STYLE_ShowSelAlways	Show selection even when don't have focus.
STYLE_SortAscending	Sort in ascending order.
STYLE_SortDescending	Sort in descending order.
STYLE_NoSelect	Don't allow selection.
STYLE_NoOuterFrame	Don't include outer frame.
STYLE_AutoArrange
STYLE_EditLabels	Allow editings.
STYLE_SizeInPixels	Sizes parameters for Create() specified in pixels.
STYLE_AlignLeft
STYLE_OwnerData
STYLE_NoScroll	Don't show scroll bars.
STYLE_NoColumnHeader	Don't show column headers.
STYLE_NoSortHeader	Don't allow sorting by pressing header.

enum MGUI::CTRL_GRID::VIEWMODE

Enumerator:

VIEWMODE_Icon	LVS_ICON, NOTE: Not implemented in X case.
VIEWMODE_Report	LVS_REPORT,.
VIEWMODE_SmallIcon	LVS_SMALLICON NOTE: Not implemented in X case.
VIEWMODE_List	LVS_LIST,.

Constructor & Destructor Documentation

MGUI::CTRL_GRID::CTRL_GRID ( )

Constructor.

virtual MGUI::CTRL_GRID::~CTRL_GRID ( ) [virtual]

Destructor.

Member Function Documentation

void MGUI::CTRL_GRID::Create	(	MGUI::LAYOUT_PANE_BASE &	ParentPane,
		int	height = `10`,
		int	width = `40`,
		VIEWMODE	viewmode = `VIEWMODE_Report`,
		STYLE	style = `STYLE_AlignTop`,
		MGUI::LAYOUT_SIZEALIGN	sizealign = `MGUI::LAYOUT_SIZEALIGN_Expand`
	)

Create the control.

Parameters:

	ParentPane	Parent pane
	height	Height in rows,
	width	Width in 'em' characters
	viewmode	Initial viewing mode
	style	List style

void MGUI::CTRL_GRID::DeleteAllColumns ( )

Delete all columns.

void MGUI::CTRL_GRID::DeleteAllItems ( )

Delete all items.

void MGUI::CTRL_GRID::DeleteColumn ( int col )

Delete specified column.

void MGUI::CTRL_GRID::DeleteItem	(	int	itemnum,
		bool	redrawnow
	)

void MGUI::CTRL_GRID::DeleteItem ( int itemnum )

Delete specified item.

void MGUI::CTRL_GRID::DeleteItemByData ( ID id )

Delete specified item given assigned data value.

void MGUI::CTRL_GRID::DeselectAllItems ( )

Deselect all items.

void MGUI::CTRL_GRID::EditFinish ( )

Finish any edits, used if need to save changes.

bool MGUI::CTRL_GRID::EditItem	(	int	itemnum,
		int	column,
		const MIUNICODE *	initstr,
		bool	selectall = `true`
	)

Begin editing specified item, starting with specified string.

Returns:: true if successful, false if not.

Parameters:

	initstr	String to replace with prior to editing
	selectall	Select all existing text so typing will replace

bool MGUI::CTRL_GRID::EditItem	(	int	itemnum,
		int	column = `0`,
		bool	selectall = `true`
	)

Begin editing specified item, starting with currently displayed value.

Returns:: true if successful, false if not.

Parameters:

selectall

Select all existing text so typing will replace

void MGUI::CTRL_GRID::EnsureVisible	(	int	itemnum,
		bool	PartialOK = `false`
	)

Ensures that an item is visible.

int MGUI::CTRL_GRID::FindItemByData ( ID data ) const [inline]

Find item by matching specified data value as ID.

Returns:: Item number or -1 if none found.

int MGUI::CTRL_GRID::FindItemByData ( const void * value ) const

Find item by matching specified data value as pointer.

Returns:: Item number or -1 if none found.

int MGUI::CTRL_GRID::GetBottomRow ( ) const [inline]

Get the index (row number) of the bottom-most visible item.

Note: Return value may be greater than number of rows of data if more rows are visible than there are data for.

bool MGUI::CTRL_GRID::GetCellRect	(	int	itemnum,
		int	col,
		LRECT2D &	rect
	)			const

Get the bounding rectangle of a single cell.

int MGUI::CTRL_GRID::GetColumnCount ( ) const

Get number of columns in the list.

bool MGUI::CTRL_GRID::GetColumnLabel	(	int	column,
		MISTRING &	label
	)			const

Get the label for a column.

Returns:: true if successful, false otherwise

ERRVALUE MGUI::CTRL_GRID::GetColumnOrderArray ( SIMPLE_ARRAY< INT32 > & array ) const

Get the order of columns in the list.

Columns can be reordered by dragging them around if you call SetExtendedStyle() with LVS_EX_HEADERDRAGDROP

int MGUI::CTRL_GRID::GetColumnWidth ( int column ) const

Get the width of a column in pixels.

int MGUI::CTRL_GRID::GetCountPerPage ( ) const

Get number of items that can fit vertically in the visible area of control (in report mode only).

int MGUI::CTRL_GRID::GetHeadingHeight ( ) const

Get height of heading in pixels.

int MGUI::CTRL_GRID::GetItemCount ( ) const

Get number of items in list.

MGUI::ID MGUI::CTRL_GRID::GetItemData ( int itemnum ) const

Get data value associated with item.

MISTRING MGUI::CTRL_GRID::GetItemText	(	int	itemnum,
		int	subitem
	)			const

int MGUI::CTRL_GRID::GetNextSelectedItem ( int startitem = -1 ) const

Get next selected item in list.

Returns:: Index of next item or -1 if no more items.

Parameters:

startitem

Starting item for search, starting item is excluded

int MGUI::CTRL_GRID::GetSelectedCount ( ) const

Get number of selected items.

STYLE MGUI::CTRL_GRID::GetStyle ( ) const [inline, protected]

int MGUI::CTRL_GRID::GetTopRow ( ) const

Get the index (row number) of the top-most visible item.

int MGUI::CTRL_GRID::InsertColumn	(	int	colnum,
		const MISTRING &	string,
		FORMAT	format = `FORMAT_Left`,
		int	width = `-1`
	)

Insert new column with label from MISTRING;.

Parameters:

	colnum	Column number and subitem
	string	String for column heading
	format	Column format
	width	Width of column in PIXELS

int MGUI::CTRL_GRID::InsertColumnComboBox	(	int	colnum,
		const MISTRING &	label,
		const MISTRING &	menu,
		int	width = `-1`
	)

Insert new column with label from MIUNICODE* string.

Every cell in the column is a combo box. The menu parameter is an MISTRING of newline-seperated entries to use when populating the drop down menu. Note that other than having a fixed set of options in a dropdown menu, this column type still returns its current value as text, not as anything numeric.

Parameters:

	colnum	Column number and subitem
	label	String for column heading
	width	Width of column in PIXELS

int MGUI::CTRL_GRID::InsertItem	(	int	pos,
		const MISTRING &	string
	)

Insert new item at specified position.

Returns:: Item number of inserted item if successful, < 0 if error.

Parameters:

	pos	Item position in list
	string	Item string

int MGUI::CTRL_GRID::InsertItem ( const MISTRING & string )

Insert new item.

Returns:: Item number of inserted item if successful, < 0 if error.

Parameters:

string

Item string

bool MGUI::CTRL_GRID::IsItemSelected ( int itemnum ) const

Determine if specified item is currently "selected".

Returns:: 'true' if selected, 'false' if not.

virtual bool MGUI::CTRL_GRID::OnBeginLabelEdit	(	int	itemnum,
		int	subitemnum
	)			`[protected, virtual]`

Called when user clicks on label to begin editing.

Returns:: 'false' if editing is NOT allowed or 'true' if editing is allowed. Default implementation always returns 'true' if the grid was created with STYLE_EditLabels or 'false' if not.

virtual void MGUI::CTRL_GRID::OnChangeColumnOrder	(	int	fromCol,
		int	toCol
	)			`[protected, virtual]`

Called when the order of the columns are changed.

virtual void MGUI::CTRL_GRID::OnClickColumn	(	int	itemnum,
		int	column,
		KEYSTATE	state
	)			`[protected, virtual]`

Called when user clicks on column heading.

virtual void MGUI::CTRL_GRID::OnClickItem	(	int	itemnum,
		int	column,
		KEYSTATE	state
	)			`[protected, virtual]`

Called when user left-clicks on a list item.

virtual void MGUI::CTRL_GRID::OnDoubleClickItem	(	int	itemnum,
		int	column,
		KEYSTATE	state
	)			`[protected, virtual]`

Called when user double-left-clicks on a list item.

virtual bool MGUI::CTRL_GRID::OnDrawItem ( CUSTOMDRAW & drawinfo ) [protected, virtual]

Called before an item is drawn.

Override if you want to do the drawing yourself. Should return true if you did all the drawing. Return false to let the base class draw the item.

virtual bool MGUI::CTRL_GRID::OnEndLabelEdit	(	int	row,
		int	col,
		MISTRING &	string
	)			`[protected, virtual]`

Called when user clicks on label to begin editing.

Returns:: 'true' if to accept changes or 'false' to reject changes. Default implementation always returns 'true' if the grid was created with STYLE_EditLabels or 'false' if not.

virtual bool MGUI::CTRL_GRID::OnGetDispInfo	(	int	row,
		int	col,
		CTRL_GRID::DISPINFO &	dispinfo
	)			`[protected, virtual]`

Called by list to request information stored by owner rather than list.

Derived implementation should return true if it actually filled in anything. Return false to behave as if OnGetDispInfo wasn't overridden.

virtual void MGUI::CTRL_GRID::OnItemActivate ( ) [protected, virtual]

Called when an item is "activated" (normally via a double click).

virtual int MGUI::CTRL_GRID::OnItemCompare	(	UINT32	rowitem1,
		UINT32	rowitem2,
		int	colnum,
		bool	bAscending
	)			`[protected, virtual]`

Called by SortItems() to compare items.

Should return < 0 if rowitem1 should precede rowitem2 and > 0 if rowitem1 should follow rowitem2 and 0 if the two items are equivalent. if bAscending is false, you should reverse the order.

virtual void MGUI::CTRL_GRID::OnItemSelect	(	int	itemnum,
		int	subitemnum
	)			`[protected, virtual]`

Called when an item is "selected".

virtual void MGUI::CTRL_GRID::OnItemUnselect	(	int	itemnum,
		int	subitemnum
	)			`[protected, virtual]`

Called when an item is "unselected".

virtual void MGUI::CTRL_GRID::OnOwnerDataCacheHint	(	int	from,
		int	to
	)			`[protected, virtual]`

Called for owner-data list to provide hints about what to cache.

virtual void MGUI::CTRL_GRID::OnRightClickItem	(	int	itemnum,
		int	column,
		const LPOINT2D &	,
		KEYSTATE	state
	)			`[protected, virtual]`

Called when user right-clicks on a list item.

virtual void MGUI::CTRL_GRID::OnUserResizeColumn	(	int	column,
		int	width
	)			`[protected, virtual]`

Called when user release mouse after dragging column header.

void MGUI::CTRL_GRID::Redraw ( bool updatenow = true )

Force the control to repaint all items.

void MGUI::CTRL_GRID::RedrawDisable ( )

Disable redraw, incrementing disable count.

void MGUI::CTRL_GRID::RedrawEnable ( )

Enable redraw, decrementing disable count.

Will redraw control if was disabled and is no longer.

void MGUI::CTRL_GRID::RedrawItems	(	int	firstitemnum,
		int	lastitemnum,
		bool	updatenow = `true`
	)

Force the control to repaint a range of items.

bool MGUI::CTRL_GRID::SetColumnLabel	(	int	column,
		const MISTRING &	label
	)

Set column label.

Returns:: true if successful, false otherwise

void MGUI::CTRL_GRID::SetColumnOrderArray ( SIMPLE_ARRAY< INT32 > & array )

Set the order of columns within the list.

void MGUI::CTRL_GRID::SetColumnWidth	(	int	column,
		int	width
	)

Set the width of a column.

The width can be in pixels or one of the constants LVSCW_AUTOSIZE or LVSCW_AUTOSIZE_USE_HEADER as described in LVM_SETCOLUMNWIDTH in the Platform SDK documentation.

void MGUI::CTRL_GRID::SetDelegateOnBeginLabelEdit ( DELEGATE_ONBEGINLABELEDIT DelegateOnBeginLabelEdit ) [inline]

void MGUI::CTRL_GRID::SetDelegateOnChangeColumnOrder ( DELEGATE_ONCHANGECOLUMNORDER DelegateOnChangeColumnOrder ) [inline]

void MGUI::CTRL_GRID::SetDelegateOnClickColumn ( DELEGATE_ONCLICK DelegateOnClickColumn ) [inline]

void MGUI::CTRL_GRID::SetDelegateOnClickItem ( DELEGATE_ONCLICK DelegateOnClickItem ) [inline]

Set delegate to call when click on item.

Will be called after any selection operations have been done.

void MGUI::CTRL_GRID::SetDelegateOnDoubleClickItem ( DELEGATE_ONCLICK DelegateOnDoubleClickItem ) [inline]

void MGUI::CTRL_GRID::SetDelegateOnDrawItem ( DELEGATE_ONDRAWITEM DelegateOnDrawItem ) [inline]

void MGUI::CTRL_GRID::SetDelegateOnEndLabelEdit ( DELEGATE_ONENDLABELEDIT DelegateOnEndLabelEdit ) [inline]

void MGUI::CTRL_GRID::SetDelegateOnGetDispInfo ( DELEGATE_ONGETDISPINFO DelegateOnGetDispInfo ) [inline]

void MGUI::CTRL_GRID::SetDelegateOnItemCompare ( DELEGATE_ONITEMCOMPARE DelegateOnItemCompare ) [inline]

void MGUI::CTRL_GRID::SetDelegateOnItemSelect ( DELEGATE_ONITEMSELECT DelegateOnItemSelect ) [inline]

void MGUI::CTRL_GRID::SetDelegateOnItemUnselect ( DELEGATE_ONITEMUNSELECT DelegateOnItemUnselect ) [inline]

void MGUI::CTRL_GRID::SetDelegateOnResizeColumn ( DELEGATE_ONRESIZECOLUMN DelegateOnResizeColumn ) [inline]

void MGUI::CTRL_GRID::SetDelegateOnRightClick ( DELEGATE_ONRIGHTCLICK DelegateOnRightClick ) [inline]

void MGUI::CTRL_GRID::SetDelegateOnSize ( DELEGATE_ONSIZE DelegateOnSize ) [inline]

void MGUI::CTRL_GRID::SetDelegateOnToolTip ( DELEGATE_ONTOOLTIP DelegateOnToolTip ) [inline]

void MGUI::CTRL_GRID::SetImageList	(	IMAGELIST &	imagelist,
		IMAGELISTTYPE	listtype = `IMAGELISTTYPE_Small`,
		bool	shared = `false`
	)

Set image list.

Parameters:

	imagelist	Image list
	listtype	Type of image list, IMAGELISTTYPE_Normal, IMAGELISTTYPE_Small or IMAGELISTTYPE_State
	shared	'true' if image list is shared, 'false' if control should take ownership

int MGUI::CTRL_GRID::SetItemCount ( int NumItems )

Set number of items in list.

void MGUI::CTRL_GRID::SetItemData	(	int	itemnum,
		ID	value
	)

Set application-specific data to associate with list item.

Parameters:

	itemnum	Item number
	value	Value to associate with item

void MGUI::CTRL_GRID::SetItemImage	(	int	itemnum,
		int	imageindex
	)

Set the image index to use for a givem item.

Pass -1 for imageindex to have no icon imageindex is a 0-based index into the IMAGELIST set via SetImageList()

void MGUI::CTRL_GRID::SetItemSelected	(	int	itemnum,
		bool	selected = `true`
	)

Set whether item is 'selected or not.

Parameters:

itemnum

Item number

void MGUI::CTRL_GRID::SetItemText	(	int	itemnum,
		int	subitem,
		const MISTRING &	string
	)

Set item or subitem text.

Parameters:

	itemnum	Item number
	subitem	Sub item, 0 for item
	string	Item or subitem string

void MGUI::CTRL_GRID::SetRowHeight ( int pixels )

Set the height of the rows in pixels.

void MGUI::CTRL_GRID::SortItems	(	int	column = `0`,
		bool	bAscending = `true`
	)

Sort the data in the list on a given column.

Parameters:

column

Column to sort on

void MGUI::CTRL_GRID::Update ( int itemnum )

Force the control to repaint a specified item.

virtual bool MGUI::CTRL_GRID::v_OnToolTip	(	MGUI::CTRL_TOOLTIP &	tooltip,
		int	row,
		int	col
	)			`[protected, virtual]`

Called to get tooltip for a cell.

The documentation for this class was generated from the following file:

mgui/grid.h

MGUI::CTRL_GRID Class Reference

Classes

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation