Detailed Description

Base class for wxPropertyGrid cell renderers.

Public Types
enum	{ Selected, ChoicePopup, Control, Disabled, DontUseCellFgCol, DontUseCellBgCol, DontUseCellColours }

Public Member Functions
	wxPGCellRenderer ()

virtual	~wxPGCellRenderer ()

virtual bool	Render (wxDC &dc, const wxRect &rect, const wxPropertyGrid propertyGrid, wxPGProperty property, int column, int item, int flags) const =0
	Returns true if rendered something in the foreground (text or bitmap). More...

virtual wxSize	GetImageSize (const wxPGProperty *property, int column, int item) const
	Returns size of the image in front of the editable area. More...

virtual void	DrawCaptionSelectionRect (wxDC &dc, int x, int y, int w, int h) const
	Paints property category selection rectangle. More...

void	DrawText (wxDC &dc, const wxRect &rect, int imageWidth, const wxString &text) const
	Utility to draw vertically centered text. More...

void	DrawEditorValue (wxDC &dc, const wxRect &rect, int xOffset, const wxString &text, wxPGProperty property, const wxPGEditor editor) const
	Utility to draw editor's value, or vertically aligned text if editor is NULL. More...

int	PreDrawCell (wxDC &dc, const wxRect &rect, const wxPGCell &cell, int flags) const
	Utility to render cell bitmap and set text colour plus bg brush colour. More...

void	PostDrawCell (wxDC &dc, const wxPropertyGrid *propGrid, const wxPGCell &cell, int flags) const
	Utility to be called after drawing is done, to revert whatever changes PreDrawCell() did. More...

Member Enumeration Documentation

anonymous enum

Enumerator
Selected	We are painting selected item.
ChoicePopup	We are painting item in choice popup.
Control	We are rendering wxOwnerDrawnComboBox control or other owner drawn control, but that is only officially supported one ATM).
Disabled	We are painting a disable property.
DontUseCellFgCol	We are painting selected, disabled, or similar item that dictates fore- and background colours, overriding any cell values.
DontUseCellBgCol
DontUseCellColours

wxPGCellRenderer::wxPGCellRenderer ( )

virtual wxPGCellRenderer::~wxPGCellRenderer ( )

virtual

virtual void wxPGCellRenderer::DrawCaptionSelectionRect	(	wxDC &	dc,
		int	x,
		int	y,
		int	w,
		int	h
	)		const

virtual

Paints property category selection rectangle.

void wxPGCellRenderer::DrawEditorValue	(	wxDC &	dc,
		const wxRect &	rect,
		int	xOffset,
		const wxString &	text,
		wxPGProperty *	property,
		const wxPGEditor *	editor
	)		const

Utility to draw editor's value, or vertically aligned text if editor is NULL.

void wxPGCellRenderer::DrawText	(	wxDC &	dc,
		const wxRect &	rect,
		int	imageWidth,
		const wxString &	text
	)		const

Utility to draw vertically centered text.

virtual wxSize wxPGCellRenderer::GetImageSize	(	const wxPGProperty *	property,
		int	column,
		int	item
	)		const

virtual

Returns size of the image in front of the editable area.

Remarks: If property is NULL, then this call is for a custom value. In that case the item is index to wxPropertyGrid's custom values.

void wxPGCellRenderer::PostDrawCell	(	wxDC &	dc,
		const wxPropertyGrid *	propGrid,
		const wxPGCell &	cell,
		int	flags
	)		const

Utility to be called after drawing is done, to revert whatever changes PreDrawCell() did.

Parameters

flags Same as those passed to PreDrawCell(). See list of render flags.

int wxPGCellRenderer::PreDrawCell	(	wxDC &	dc,
		const wxRect &	rect,
		const wxPGCell &	cell,
		int	flags
	)		const

Utility to render cell bitmap and set text colour plus bg brush colour.

Parameters

flags See list of render flags.

Returns: Returns image width, which, for instance, can be passed to DrawText.

virtual bool wxPGCellRenderer::Render	(	wxDC &	dc,
		const wxRect &	rect,
		const wxPropertyGrid *	propertyGrid,
		wxPGProperty *	property,
		int	column,
		int	item,
		int	flags
	)		const

pure virtual

Returns true if rendered something in the foreground (text or bitmap).

Parameters

flags See list of render flags.