wxPropertyGridState Class Reference

#include <propgrid.h>

Inheritance diagram for wxPropertyGridState:

wxPropertyGridPage

List of all members.


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.

Public Member Functions

wxPGPropertyBaseGetPropertyByName (const wxString &name) const
void CalculateFontAndBitmapStuff (int vspacing)
void CheckColumnWidths (int widthChange=0)
void ClearModifiedStatus (wxPGProperty *p)
bool ClearSelection ()
wxPGPropertyDoAppend (wxPGProperty *property)
void DoClear ()
bool DoClearSelection ()
bool DoCollapse (wxPGProperty *p)
virtual void DoDelete (wxPGProperty *item)
bool DoEnableProperty (wxPGProperty *p, bool enable)
bool DoExpand (wxPGProperty *p)
wxSize DoFitColumns (bool allowGridResize=false)
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)
void DoLimitPropertyEditing (wxPGProperty *p, bool limit=true)
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)
void DoSetPropertyValueUnspecified (wxPGProperty *p)
bool DoSetPropertyValueWxObjectPtr (wxPGProperty *p, wxObject *value)
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
wxPropertyGridGetGrid () const
const wxPGPropertyGetLastItem (int flags=wxPG_ITERATE_DEFAULT) const
wxPGPropertyGetLastItem (int flags=wxPG_ITERATE_DEFAULT)
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
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 SetSelection (wxPGProperty *p)
void SetSplitterLeft (bool subProps=false)
void SetVirtualWidth (int width)
void Sort ()
void Sort (wxPGProperty *p)
void VirtualHeightChanged ()
 wxPropertyGridState ()
virtual ~wxPropertyGridState ()

Protected Member Functions

int DoGetSplitterPosition (int splitterIndex=0) const
int HitTestH (int x, int *pSplitterHit, int *pSplitterHitOffset) const


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.

void wxPropertyGridState::CheckColumnWidths ( int  widthChange = 0  ) 

Makes sure all columns have minimum width.

wxPGProperty* wxPropertyGridState::DoAppend ( wxPGProperty property  ) 

Base append.

void wxPropertyGridState::DoClear (  ) 

Called in, for example, wxPropertyGrid::Clear.

virtual void wxPropertyGridState::DoDelete ( wxPGProperty item  )  [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.

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

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

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.

void wxPropertyGridState::EnsureVirtualHeight (  ) 

Make sure virtual height is up-to-date.

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

unsigned int wxPropertyGridState::GetVirtualHeight (  ) 

Returns (precalculated) height of contained visible properties.

unsigned int wxPropertyGridState::GetVirtualHeight (  )  const

Returns (precalculated) height of contained visible properties.

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

Returns information about arbitrary position in the grid.

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::OnClientWidthChange ( int  newWidth,
int  widthChange,
bool  fromOnResize = false 
)

widthChange is non-client.

void wxPropertyGridState::RecalculateVirtualHeight (  ) 

Recalculates m_virtualHeight.

void wxPropertyGridState::SetVirtualWidth ( int  width  ) 

Set virtual width for this particular page.

void wxPropertyGridState::VirtualHeightChanged (  ) 

Called after virtual height needs to be recalculated.


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