wxPropertyGridState Class Reference

Contains information of a single wxPropertyGrid page. Generally you should not use this class directly, but instead methods in wxPropertyGridInterface, wxPropertyGrid, wxPropertyGridPage, and wxPropertyGridManager. More...

#include <propgrid.h>

Inheritance diagram for wxPropertyGridState:

[legend]

List of all members.

Public Member Functions
wxPGProperty *	BaseGetPropertyByName (wxPGPropNameStr name) const
void	CalculateFontAndBitmapStuff (int vspacing)
void	CheckColumnWidths (int widthChange=0)
void	ClearModifiedStatus (wxPGProperty *p)
wxPGProperty *	DoAppend (wxPGProperty *property)
void	DoClear ()
bool	DoClearSelection ()
bool	DoCollapse (wxPGProperty *p)
virtual void	DoDelete (wxPGProperty *item, bool doDelete=true)
bool	DoEnableProperty (wxPGProperty *p, bool enable)
bool	DoExpand (wxPGProperty *p)
wxSize	DoFitColumns (bool allowGridResize=false)
wxPGProperty *	DoGetItemAtY (int y) const
wxVariant	DoGetPropertyValues (const wxString &listname, wxPGProperty *baseparent, long flags) const
wxPGProperty *	DoGetRoot () const
bool	DoHideProperty (wxPGProperty *p, bool hide, int flags=wxPG_RECURSE)
virtual wxPGProperty *	DoInsert (wxPGProperty parent, int index, wxPGProperty property)
bool	DoIsPropertySelected (wxPGProperty *prop) const
void	DoLimitPropertyEditing (wxPGProperty *p, bool limit=true)
void	DoRemoveFromSelection (wxPGProperty *prop)
bool	DoSelectProperty (wxPGProperty *p, unsigned int flags=0)
bool	DoSetPropertyValue (wxPGProperty *p, wxVariant &value)
void	DoSetPropertyValues (const wxVariantList &list, wxPGProperty *default_category)
bool	DoSetPropertyValueString (wxPGProperty *p, const wxString &value)
bool	DoSetPropertyValueWxObjectPtr (wxPGProperty p, wxObject value)
void	DoSetSelection (wxPGProperty *prop)
virtual void	DoSetSplitterPosition (int pos, int splitterColumn=0, bool allPages=false, bool fromAutoCenter=false)
bool	EnableCategories (bool enable)
void	EnsureVirtualHeight ()
unsigned int	GetActualVirtualHeight () const
unsigned int	GetColumnCount () const
int	GetColumnFitWidth (wxClientDC &dc, wxPGProperty *pwc, unsigned int col, bool subProps) const
int	GetColumnMinWidth (int column) const
int	GetColumnWidth (unsigned int column) const
wxPropertyGrid *	GetGrid () const
const wxPGProperty *	GetLastItem (int flags=wxPG_ITERATE_DEFAULT) const
wxPGProperty *	GetLastItem (int flags=wxPG_ITERATE_DEFAULT)
wxPGProperty *	GetPropertyByLabel (const wxString &name, wxPGProperty *parent=NULL) const
wxPropertyCategory *	GetPropertyCategory (const wxPGProperty *p) const
wxPGProperty *	GetSelection () const
unsigned int	GetVirtualHeight ()
unsigned int	GetVirtualHeight () const
int	GetVirtualWidth () const
wxPropertyGridHitTestResult	HitTest (const wxPoint &pt) const
void	InitNonCatMode ()
bool	IsDisplayed () const
bool	IsInNonCatMode () const
void	OnClientWidthChange (int newWidth, int widthChange, bool fromOnResize=false)
void	PropagateColSizeDec (int column, int decrease, int dir)
void	RecalculateVirtualHeight ()
void	SetColumnCount (int colCount)
void	SetSplitterLeft (bool subProps=false)
void	SetVirtualWidth (int width)
void	Sort ()
void	Sort (wxPGProperty *p)
void	VirtualHeightChanged ()
	wxPropertyGridState ()
virtual	~wxPropertyGridState ()
Protected Member Functions
bool	ArePropertiesAdjacent (wxPGProperty prop1, wxPGProperty prop2, int iterFlags=wxPG_ITERATE_VISIBLE) const
int	DoGetSplitterPosition (int splitterIndex=0) const
int	HitTestH (int x, int pSplitterHit, int pSplitterHitOffset) const
int	PrepareToAddItem (wxPGProperty property, wxPGProperty scheduledParent)
Protected Attributes
wxPGRootProperty *	m_abcArray
unsigned char	m_anyModified
wxArrayInt	m_colWidths
wxPropertyCategory *	m_currentCategory
wxPGHashMapS2P	m_dictName
wxArrayInt	m_editableColumns
double	m_fSplitterX
unsigned char	m_itemsAdded
unsigned char	m_lastCaptionBottomnest
wxPropertyGrid *	m_pPropGrid
wxPGProperty *	m_properties
wxPGRootProperty	m_regularArray
wxArrayPGProperty	m_selection
unsigned char	m_vhCalcPending
unsigned int	m_virtualHeight
int	m_width
Friends
class	wxPGCanvas
class	wxPGProperty
class	wxPropertyGrid
class	wxPropertyGridInterface
class	wxPropertyGridManager
class	wxPropertyGridPage

Detailed Description

Contains information of a single wxPropertyGrid page. Generally you should not use this class directly, but instead methods in wxPropertyGridInterface, wxPropertyGrid, wxPropertyGridPage, and wxPropertyGridManager.

Definition at line 4306 of file propgrid.h.

Constructor & Destructor Documentation

wxPropertyGridState::wxPropertyGridState ( )

Constructor.

virtual wxPropertyGridState::~wxPropertyGridState ( ) [virtual]

Destructor.

Member Function Documentation

bool wxPropertyGridState::ArePropertiesAdjacent	(	wxPGProperty *	prop1,
		wxPGProperty *	prop2,
		int	iterFlags = `wxPG_ITERATE_VISIBLE`
	)			const `[protected]`

wxPGProperty* wxPropertyGridState::BaseGetPropertyByName ( wxPGPropNameStr name ) const

Returns property by its name.

void wxPropertyGridState::CalculateFontAndBitmapStuff ( int vspacing )

void wxPropertyGridState::CheckColumnWidths ( int widthChange = 0 )

Makes sure all columns have minimum width.

void wxPropertyGridState::ClearModifiedStatus ( wxPGProperty * p )

wxPGProperty* wxPropertyGridState::DoAppend ( wxPGProperty * property )

Base append.

void wxPropertyGridState::DoClear ( )

Called in, for example, wxPropertyGrid::Clear.

bool wxPropertyGridState::DoClearSelection ( ) [inline]

Definition at line 4335 of file propgrid.h.

bool wxPropertyGridState::DoCollapse ( wxPGProperty * p )

virtual void wxPropertyGridState::DoDelete	(	wxPGProperty *	item,
		bool	doDelete = `true`
	)			`[virtual]`

Override this member function to add custom behavior on property deletion.

bool wxPropertyGridState::DoEnableProperty	(	wxPGProperty *	p,
		bool	enable
	)

Enables or disables given property and its subproperties.

bool wxPropertyGridState::DoExpand ( wxPGProperty * p )

wxSize wxPropertyGridState::DoFitColumns ( bool allowGridResize = false )

wxPGProperty* wxPropertyGridState::DoGetItemAtY ( int y ) const

wxVariant wxPropertyGridState::DoGetPropertyValues	(	const wxString &	listname,
		wxPGProperty *	baseparent,
		long	flags
	)			const

wxPGProperty* wxPropertyGridState::DoGetRoot ( ) const [inline]

Definition at line 4450 of file propgrid.h.

int wxPropertyGridState::DoGetSplitterPosition ( int splitterIndex = 0 ) const [protected]

bool wxPropertyGridState::DoHideProperty	(	wxPGProperty *	p,
		bool	hide,
		int	flags = `wxPG_RECURSE`
	)

virtual wxPGProperty* wxPropertyGridState::DoInsert	(	wxPGProperty *	parent,
		int	index,
		wxPGProperty *	property
	)			`[virtual]`

Override this member function to add custom behavior on property insertion.

bool wxPropertyGridState::DoIsPropertySelected ( wxPGProperty * prop ) const

void wxPropertyGridState::DoLimitPropertyEditing	(	wxPGProperty *	p,
		bool	limit = `true`
	)			`[inline]`

Definition at line 4500 of file propgrid.h.

void wxPropertyGridState::DoRemoveFromSelection ( wxPGProperty * prop )

bool wxPropertyGridState::DoSelectProperty	(	wxPGProperty *	p,
		unsigned int	flags = `0`
	)

bool wxPropertyGridState::DoSetPropertyValue	(	wxPGProperty *	p,
		wxVariant &	value
	)

void wxPropertyGridState::DoSetPropertyValues	(	const wxVariantList &	list,
		wxPGProperty *	default_category
	)

bool wxPropertyGridState::DoSetPropertyValueString	(	wxPGProperty *	p,
		const wxString &	value
	)

bool wxPropertyGridState::DoSetPropertyValueWxObjectPtr	(	wxPGProperty *	p,
		wxObject *	value
	)

void wxPropertyGridState::DoSetSelection ( wxPGProperty * prop ) [inline]

Definition at line 4475 of file propgrid.h.

virtual void wxPropertyGridState::DoSetSplitterPosition	(	int	pos,
		int	splitterColumn = `0`,
		bool	allPages = `false`,
		bool	fromAutoCenter = `false`
	)			`[virtual]`

This needs to be overridden in grid used the manager so that splitter changes can be propagated to other pages.

Reimplemented in wxPropertyGridPage.

bool wxPropertyGridState::EnableCategories ( bool enable )

void wxPropertyGridState::EnsureVirtualHeight ( ) [inline]

Make sure virtual height is up-to-date.

Definition at line 4373 of file propgrid.h.

unsigned int wxPropertyGridState::GetActualVirtualHeight ( ) const [inline]

Returns actual height of contained visible properties.

Remarks:: Mostly used for internal diagnostic purposes.

Definition at line 8032 of file propgrid.h.

unsigned int wxPropertyGridState::GetColumnCount ( ) const [inline]

Definition at line 4407 of file propgrid.h.

int wxPropertyGridState::GetColumnFitWidth	(	wxClientDC &	dc,
		wxPGProperty *	pwc,
		unsigned int	col,
		bool	subProps
	)			const

Returns minimal width for given column so that all images and texts will fit entirely.

Used by SetSplitterLeft() and DoFitColumns().

int wxPropertyGridState::GetColumnMinWidth ( int column ) const

int wxPropertyGridState::GetColumnWidth ( unsigned int column ) const [inline]

Definition at line 4414 of file propgrid.h.

wxPropertyGrid* wxPropertyGridState::GetGrid ( ) const [inline]

Definition at line 4419 of file propgrid.h.

const wxPGProperty* wxPropertyGridState::GetLastItem ( int flags = wxPG_ITERATE_DEFAULT ) const [inline]

Definition at line 4427 of file propgrid.h.

wxPGProperty* wxPropertyGridState::GetLastItem ( int flags = wxPG_ITERATE_DEFAULT )

Returns last item which could be iterated using given flags.

Parameters:

flags

List of iterator flags

wxPGProperty* wxPropertyGridState::GetPropertyByLabel	(	const wxString &	name,
		wxPGProperty *	parent = `NULL`
	)			const

wxPropertyCategory* wxPropertyGridState::GetPropertyCategory ( const wxPGProperty * p ) const

wxPGProperty* wxPropertyGridState::GetSelection ( ) const [inline]

Returns currently selected property.

Definition at line 4468 of file propgrid.h.

unsigned int wxPropertyGridState::GetVirtualHeight ( ) [inline]

Returns (precalculated) height of contained visible properties.

Definition at line 4395 of file propgrid.h.

unsigned int wxPropertyGridState::GetVirtualHeight ( ) const [inline]

Returns (precalculated) height of contained visible properties.

Definition at line 4387 of file propgrid.h.

int wxPropertyGridState::GetVirtualWidth ( ) const [inline]

Definition at line 4453 of file propgrid.h.

wxPropertyGridHitTestResult wxPropertyGridState::HitTest ( const wxPoint & pt ) const

Returns information about arbitrary position in the grid.

Parameters:

pt

Coordinates in the virtual grid space. You may need to use wxScrolledWindow::CalcScrolledPosition() for translating wxPropertyGrid client coordinates into something this member function can use.