wxPropertyGridPage Class Reference

Holder of property grid page information. You can subclass this and give instance in wxPropertyGridManager::AddPage. It inherits from wxEvtHandler and can be used to process events specific to this page (id of events will still be same as manager's). If you don't want to use it to process all events of the page, you need to return false in the derived wxPropertyGridPage::IsHandlingAllEvents. More...

#include <manager.h>

Inheritance diagram for wxPropertyGridPage:

[legend]

List of all members.

Public Member Functions
virtual void	Clear ()
wxSize	FitColumns ()
int	GetIndex () const
wxPGProperty *	GetRoot () const
int	GetSplitterPosition (int col=0) const
const wxPropertyGridState *	GetStatePtr () const
wxPropertyGridState *	GetStatePtr ()
int	GetToolId () const
virtual void	Init ()
virtual bool	IsHandlingAllEvents () const
virtual void	OnShow ()
virtual void	RefreshProperty (wxPGProperty *p)
void	SetSplitterPosition (int splitterPos, int col=0)
	wxPropertyGridPage ()
virtual	~wxPropertyGridPage ()
Protected Member Functions
virtual void	DoSetSplitterPosition (int pos, int splitterColumn=0, bool allPages=false, bool fromAutoCenter=false)
Protected Attributes
int	m_id
wxString	m_label
wxPropertyGridManager *	m_manager
Private Attributes
bool	m_isDefault
Friends
class	wxPropertyGridManager

---

Detailed Description

Holder of property grid page information. You can subclass this and give instance in wxPropertyGridManager::AddPage. It inherits from wxEvtHandler and can be used to process events specific to this page (id of events will still be same as manager's). If you don't want to use it to process all events of the page, you need to return false in the derived wxPropertyGridPage::IsHandlingAllEvents.

Please note that wxPropertyGridPage lacks many non-const property manipulation functions found in wxPropertyGridManager. Please use parent manager (m_manager member variable) when needed.

Please note that most member functions are inherited and as such not documented on this page. This means you will probably also want to read wxPropertyGridInterface class reference.

Derived from

wxPropertyGridInterface
wxPropertyGridState
wxEvtHandler
wxObject

Include files

<wx/propgrid/manager.h>

Event handling

wxPropertyGridPage receives events emitted by its wxPropertyGridManager, but only those events that are specific to that page. If wxPropertyGridPage::IsHandlingAllEvents returns false, then unhandled events are sent to the manager's parent, as usual.

Definition at line 68 of file manager.h.

---

Constructor & Destructor Documentation

wxPropertyGridPage::wxPropertyGridPage

(

)

virtual wxPropertyGridPage::~wxPropertyGridPage

(

)

[virtual]

---

Member Function Documentation

virtual void wxPropertyGridPage::Clear

(

)

[virtual]

Deletes all properties on page.

Implements wxPropertyGridInterface.

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

Propagate to other pages.

Reimplemented from wxPropertyGridState.

wxSize wxPropertyGridPage::FitColumns

(

)

Reduces column sizes to minimum possible that contents are still visibly (naturally some margin space will be applied as well).

Return values:

Minimum

size for the page to still display everything.

Remarks:

This function only works properly if size of containing grid was already fairly large.

Note that you can also get calculated column widths by calling GetColumnWidth() immediately after this function returns.

int wxPropertyGridPage::GetIndex

(

)

const [inline]

Returns page index in manager;

Definition at line 935 of file manager.h.

wxPGProperty* wxPropertyGridPage::GetRoot

(

)

const [inline]

Returns "root property". It does not have name, etc. and it is not visible. It is only useful for accessing its children.

Definition at line 110 of file manager.h.

int wxPropertyGridPage::GetSplitterPosition

(

int

col = 0

)

const [inline]

Returns x-coordinate position of splitter on a page.

Definition at line 105 of file manager.h.

const wxPropertyGridState* wxPropertyGridPage::GetStatePtr

(

)

const [inline]

Return pointer to contained property grid state.

Definition at line 121 of file manager.h.

wxPropertyGridState* wxPropertyGridPage::GetStatePtr

(

)

[inline]

Return pointer to contained property grid state.

Definition at line 114 of file manager.h.

int wxPropertyGridPage::GetToolId

(

)

const [inline]

Returns id of the tool bar item that represents this page on wxPropertyGridManager's wxToolBar.

Definition at line 128 of file manager.h.

virtual void wxPropertyGridPage::Init

(

)

[inline, virtual]

Do any member initialization in this method.

Remarks:

• Called every time the page is added into a manager.
• You can add properties to the page here.

Definition at line 138 of file manager.h.

virtual bool wxPropertyGridPage::IsHandlingAllEvents

(

)

const [inline, virtual]

Return false here to indicate unhandled events should be propagated to manager's parent, as normal.

Definition at line 143 of file manager.h.

virtual void wxPropertyGridPage::OnShow

(

)

[virtual]

Called every time page is about to be shown. Useful, for instance, creating properties just-in-time.

virtual void wxPropertyGridPage::RefreshProperty

(

wxPGProperty *

p

)

[virtual]

Implements wxPropertyGridInterface.

void wxPropertyGridPage::SetSplitterPosition	(	int	splitterPos,
		int	col = 0
	)

Sets splitter position on page.

Remarks:

Splitter position cannot exceed grid size, and therefore setting it during form creation may fail as initial grid size is often smaller than desired splitter position, especially when sizers are being used.

---

Friends And Related Function Documentation

friend class wxPropertyGridManager [friend]

Reimplemented from wxPropertyGridState.

Definition at line 72 of file manager.h.

---

Member Data Documentation

int wxPropertyGridPage::m_id [protected]

Definition at line 181 of file manager.h.

bool wxPropertyGridPage::m_isDefault [private]

Definition at line 184 of file manager.h.

wxString wxPropertyGridPage::m_label [protected]

Page label (may be referred as name in some parts of documentation). Can be set in constructor, or passed in wxPropertyGridManager::AddPage(), but *not* in both.

Definition at line 173 of file manager.h.

wxPropertyGridManager* wxPropertyGridPage::m_manager [protected]

Definition at line 179 of file manager.h.

---

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

• manager.h