wxPropertyGridPage Class Reference

#include <manager.h>

Inheritance diagram for wxPropertyGridPage:

wxPropertyGridInterface wxPropertyGridState

List of all members.


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.

Public Member Functions

virtual void Clear ()
wxSize FitColumns ()
int GetIndex () const
wxPGPropertyGetRoot () const
int GetSplitterPosition (int col=0) const
const wxPropertyGridStateGetStatePtr () const
wxPropertyGridStateGetStatePtr ()
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)

Protected Member Functions

virtual void DoSetSplitterPosition (int pos, int splitterColumn=0, bool allPages=false)
void DoSetSplitterPositionThisPage (int pos, int splitterColumn=0)

Protected Attributes

int m_id
wxString m_label
wxPropertyGridManagerm_manager


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 
) [protected, virtual]

Propagate to other pages.

void wxPropertyGridPage::DoSetSplitterPositionThisPage ( int  pos,
int  splitterColumn = 0 
) [protected]

Propagate to other pages.

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

Returns page index in manager;.

wxPGProperty* wxPropertyGridPage::GetRoot (  )  const

Returns "root property".

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

int wxPropertyGridPage::GetSplitterPosition ( int  col = 0  )  const

Returns x-coordinate position of splitter on a page.

const wxPropertyGridState* wxPropertyGridPage::GetStatePtr (  )  const

Return pointer to contained property grid state.

wxPropertyGridState* wxPropertyGridPage::GetStatePtr (  ) 

Return pointer to contained property grid state.

int wxPropertyGridPage::GetToolId (  )  const

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

virtual void wxPropertyGridPage::Init (  )  [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.

virtual bool wxPropertyGridPage::IsHandlingAllEvents (  )  const [virtual]

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

virtual void wxPropertyGridPage::OnShow (  )  [virtual]

Called every time page is about to be shown.

Useful, for instance, creating properties just-in-time.

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.


Member Data Documentation

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.


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

Generated on Sun Nov 2 12:30:02 2008 for wxPropertyGrid by  doxygen 1.5.5