Version: 3.1.4
wxPropertyGridPopulator Class Referenceabstract

#include <wx/propgrid/propgrid.h>

Detailed Description

Allows populating wxPropertyGrid from arbitrary text source.

Public Member Functions

 wxPropertyGridPopulator ()
 Default constructor. More...
 
virtual ~wxPropertyGridPopulator ()
 Destructor. More...
 
void SetState (wxPropertyGridPageState *state)
 
void SetGrid (wxPropertyGrid *pg)
 
wxPGPropertyAdd (const wxString &propClass, const wxString &propLabel, const wxString &propName, const wxString *propValue, wxPGChoices *pChoices=NULL)
 Appends a new property under bottommost parent. More...
 
void AddChildren (wxPGProperty *property)
 Pushes property to the back of parent array (ie it becomes bottommost parent), and starts scanning/adding children for it. More...
 
bool AddAttribute (const wxString &name, const wxString &type, const wxString &value)
 Adds attribute to the bottommost property. More...
 
virtual void DoScanForChildren ()=0
 Called once in AddChildren. More...
 
wxPGPropertyGetCurParent () const
 Returns id of parent property for which children can currently be added. More...
 
wxPropertyGridPageStateGetState ()
 
const wxPropertyGridPageStateGetState () const
 
wxPGChoices ParseChoices (const wxString &choicesString, const wxString &idString)
 Parses strings of format "choice1"[=value1] ... More...
 
virtual void ProcessError (const wxString &msg)
 Implement in derived class to do custom process when an error occurs. More...
 

Static Public Member Functions

static bool ToLongPCT (const wxString &s, long *pval, long max)
 Like wxString::ToLong, except allows N% in addition of N. More...
 

Constructor & Destructor Documentation

wxPropertyGridPopulator::wxPropertyGridPopulator ( )

Default constructor.

virtual wxPropertyGridPopulator::~wxPropertyGridPopulator ( )
virtual

Destructor.

Member Function Documentation

wxPGProperty* wxPropertyGridPopulator::Add ( const wxString propClass,
const wxString propLabel,
const wxString propName,
const wxString propValue,
wxPGChoices pChoices = NULL 
)

Appends a new property under bottommost parent.

Parameters
propClassProperty class as string.
propLabelProperty label.
propNameProperty name.
propValueProperty value.
pChoicesSet of choices for the property (optional).
bool wxPropertyGridPopulator::AddAttribute ( const wxString name,
const wxString type,
const wxString value 
)

Adds attribute to the bottommost property.

Parameters
nameAttribute name.
typeAllowed values: "string", (same as string), "int", "bool". Empty string means autodetect.
valueAttribute value.
void wxPropertyGridPopulator::AddChildren ( wxPGProperty property)

Pushes property to the back of parent array (ie it becomes bottommost parent), and starts scanning/adding children for it.

When finished, parent array is returned to the original state.

virtual void wxPropertyGridPopulator::DoScanForChildren ( )
pure virtual

Called once in AddChildren.

wxPGProperty* wxPropertyGridPopulator::GetCurParent ( ) const

Returns id of parent property for which children can currently be added.

wxPropertyGridPageState* wxPropertyGridPopulator::GetState ( )
const wxPropertyGridPageState* wxPropertyGridPopulator::GetState ( ) const
wxPGChoices wxPropertyGridPopulator::ParseChoices ( const wxString choicesString,
const wxString idString 
)

Parses strings of format "choice1"[=value1] ...

"choiceN"[=valueN] into wxPGChoices. Registers parsed result using idString (if not empty). Also, if choices with given id already registered, then don't parse but return those choices instead.

virtual void wxPropertyGridPopulator::ProcessError ( const wxString msg)
virtual

Implement in derived class to do custom process when an error occurs.

Default implementation uses wxLogError.

void wxPropertyGridPopulator::SetGrid ( wxPropertyGrid pg)
void wxPropertyGridPopulator::SetState ( wxPropertyGridPageState state)
static bool wxPropertyGridPopulator::ToLongPCT ( const wxString s,
long *  pval,
long  max 
)
static

Like wxString::ToLong, except allows N% in addition of N.