wxPropertyGridState Class Reference

Contains information of a single wxPropertyGrid page. More...

#include <propgrid.h>

Inheritance diagram for wxPropertyGridState:
wxPropertyGridPage

List of all members.

Public Member Functions

wxPGPropertyBaseGetPropertyByName (const wxString &name) const
 Returns property by its name.
void CalculateFontAndBitmapStuff (int vspacing)
void CheckColumnWidths (int widthChange=0)
 Makes sure all columns have minimum width.
void ClearModifiedStatus (wxPGProperty *p)
wxPGPropertyDoAppend (wxPGProperty *property)
 Base append.
void DoClear ()
 Called in, for example, wxPropertyGrid::Clear.
bool DoClearSelection ()
bool DoCollapse (wxPGProperty *p)
virtual void DoDelete (wxPGProperty *item, bool doDelete=true)
 Override this member function to add custom behavior on property deletion.
bool DoEnableProperty (wxPGProperty *p, bool enable)
 Enables or disables given property and its subproperties.
bool DoExpand (wxPGProperty *p)
wxSize DoFitColumns (bool allowGridResize=false)
int DoGetColumnProportion (unsigned int column) const
wxPGPropertyDoGetItemAtY (int y) const
wxVariant DoGetPropertyValues (const wxString &listname, wxPGProperty *baseparent, long flags) const
wxPGPropertyDoGetRoot () const
bool DoHideProperty (wxPGProperty *p, bool hide, int flags=wxPG_RECURSE)
virtual wxPGPropertyDoInsert (wxPGProperty *parent, int index, wxPGProperty *property)
 Override this member function to add custom behavior on property insertion.
bool DoIsPropertySelected (wxPGProperty *prop) const
void DoLimitPropertyEditing (wxPGProperty *p, bool limit=true)
void DoRemoveFromSelection (wxPGProperty *prop)
bool DoSelectProperty (wxPGProperty *p, unsigned int flags=0)
void DoSetColumnProportion (unsigned int column, int proportion)
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)
 This needs to be overridden in grid used the manager so that splitter changes can be propagated to other pages.
bool EnableCategories (bool enable)
void EnsureVirtualHeight ()
 Make sure virtual height is up-to-date.
unsigned int GetActualVirtualHeight () const
 Returns actual height of contained visible properties.
unsigned int GetColumnCount () const
int 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.
int GetColumnMinWidth (int column) const
int GetColumnWidth (unsigned int column) const
wxPropertyGridGetGrid () const
const wxPGPropertyGetLastItem (int flags=wxPG_ITERATE_DEFAULT) const
wxPGPropertyGetLastItem (int flags=wxPG_ITERATE_DEFAULT)
 Returns last item which could be iterated using given flags.
wxPGPropertyGetNextCategory (wxPGProperty *id) const
wxPGPropertyGetNextProperty (wxPGProperty *id)
wxPGPropertyGetNextSiblingProperty (wxPGProperty *id)
wxPGPropertyGetPrevProperty (wxPGProperty *id)
wxPGPropertyGetPrevSiblingProperty (wxPGProperty *id)
wxPGPropertyGetPropertyByLabel (const wxString &name, wxPGProperty *parent=NULL) const
wxPropertyCategoryGetPropertyCategory (const wxPGProperty *p) const
wxPGPropertyGetSelection () const
 Returns currently selected property.
unsigned int GetVirtualHeight ()
 Returns (precalculated) height of contained visible properties.
unsigned int GetVirtualHeight () const
 Returns (precalculated) height of contained visible properties.
int GetVirtualWidth () const
wxPropertyGridHitTestResult HitTest (const wxPoint &pt) const
 Returns information about arbitrary position in the grid.
void InitNonCatMode ()
 Only inits arrays, doesn't migrate things or such.
bool IsDisplayed () const
bool IsInNonCatMode () const
void OnClientWidthChange (int newWidth, int widthChange, bool fromOnResize=false)
 widthChange is non-client.
void PropagateColSizeDec (int column, int decrease, int dir)
void RecalculateVirtualHeight ()
 Recalculates m_virtualHeight.
void ResetColumnSizes (bool fromAutoCenter)
void SetColumnCount (int colCount)
void SetSplitterLeft (bool subProps=false)
void SetVirtualWidth (int width)
 Set virtual width for this particular page.
void Sort ()
void Sort (wxPGProperty *p)
void VirtualHeightChanged ()
 Called after virtual height needs to be recalculated.
 wxPropertyGridState ()
 Constructor.
virtual ~wxPropertyGridState ()
 Destructor.

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
 Returns column at x coordinate (in GetGrid()->GetPanel()).

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.


Constructor & Destructor Documentation

wxPropertyGridState::wxPropertyGridState (  ) 

Constructor.

virtual wxPropertyGridState::~wxPropertyGridState (  )  [virtual]

Destructor.


Member Function Documentation

wxPGProperty* wxPropertyGridState::BaseGetPropertyByName ( const wxString &  name  )  const

Returns property by its name.

wxPGProperty* wxPropertyGridState::DoAppend ( wxPGProperty property  ) 

Base append.

void wxPropertyGridState::DoClear (  ) 

Called in, for example, wxPropertyGrid::Clear.

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

Enables or disables given property and its subproperties.

unsigned int wxPropertyGridState::GetActualVirtualHeight (  )  const

Returns actual height of contained visible properties.

Remarks:
Mostly used for internal diagnostic purposes.
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().

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

Returns last item which could be iterated using given flags.

Parameters:
flags List of iterator flags
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.
int wxPropertyGridState::HitTestH ( int  x,
int *  pSplitterHit,
int *  pSplitterHitOffset 
) const [protected]

Returns column at x coordinate (in GetGrid()->GetPanel()).

Parameters:
pSplitterHit Give pointer to int that receives index to splitter that is at x.
pSplitterHitOffset Distance from said splitter.
void wxPropertyGridState::InitNonCatMode (  ) 

Only inits arrays, doesn't migrate things or such.

void wxPropertyGridState::SetVirtualWidth ( int  width  ) 

Set virtual width for this particular page.


The documentation for this class was generated from the following file:
 All Classes Functions Variables Enumerations Enumerator
Generated on Sun Aug 22 12:42:15 2010 for wxPropertyGrid by  doxygen 1.6.3