wxPropertyGrid
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
wxPropertyGridPopulator Class Referenceabstract

Allows populating wxPropertyGrid from arbitrary text source. More...

#include <propgrid.h>

Public Member Functions

wxPGPropertyAdd (const wxString &propClass, const wxString &propLabel, const wxString &propName, const wxString *propValue, wxPGChoices *pChoices=NULL)
 Appends a new property under bottommost parent. More...
 
bool AddAttribute (const wxString &name, const wxString &type, const wxString &value)
 Adds attribute to the bottommost property. More...
 
void AddChildren (wxPGProperty *property)
 Pushes property to the back of parent array (ie. More...
 
virtual void DoScanForChildren ()=0
 Called once in AddChildren.
 
wxPGPropertyGetCurParent () const
 Returns id of parent property for which children can currently be added. More...
 
wxPropertyGridStateGetState ()
 
const wxPropertyGridStateGetState () 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...
 
void SetGrid (wxPropertyGrid *pg)
 
void SetState (wxPropertyGridState *state)
 
 wxPropertyGridPopulator ()
 Default constructor.
 
virtual ~wxPropertyGridPopulator ()
 Destructor. 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.
 

Protected Attributes

wxPGHashMapS2P m_dictIdChoices
 Hashmap for string-id to wxPGChoicesData mapping. More...
 
wxPropertyGridm_pg
 Used property grid. More...
 
wxArrayPGProperty m_propHierarchy
 Tree-hierarchy of added properties (that can have children). More...
 
wxPropertyGridStatem_state
 Used property grid state. More...
 

Detailed Description

Allows populating wxPropertyGrid from arbitrary text source.

Constructor & Destructor Documentation

◆ ~wxPropertyGridPopulator()

virtual wxPropertyGridPopulator::~wxPropertyGridPopulator ( )
virtual

Destructor.

Member Function Documentation

◆ Add()

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.

◆ AddAttribute()

bool wxPropertyGridPopulator::AddAttribute ( const wxString &  name,
const wxString &  type,
const wxString &  value 
)

Adds attribute to the bottommost property.

Parameters
typeAllowed values: "string", (same as string), "int", "bool". Empty string mean autodetect.

◆ AddChildren()

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.

◆ GetCurParent()

wxPGProperty* wxPropertyGridPopulator::GetCurParent ( ) const

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

◆ ParseChoices()

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.

◆ ProcessError()

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

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

Default implementation uses wxLogError.

Member Data Documentation

◆ m_dictIdChoices

wxPGHashMapS2P wxPropertyGridPopulator::m_dictIdChoices
protected

Hashmap for string-id to wxPGChoicesData mapping.

◆ m_pg

wxPropertyGrid* wxPropertyGridPopulator::m_pg
protected

Used property grid.

◆ m_propHierarchy

wxArrayPGProperty wxPropertyGridPopulator::m_propHierarchy
protected

Tree-hierarchy of added properties (that can have children).

◆ m_state

wxPropertyGridState* wxPropertyGridPopulator::m_state
protected

Used property grid state.


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