wxPropertyGridPage Class Reference

Holder of property grid page information. More...

#include <manager.h>

Inheritance diagram for wxPropertyGridPage:

wxPropertyContainerMethods wxPropertyGridState List of all members.

Public Member Functions

void AddPropertyChoice (const wxString &name, const wxString &label, int value=INT_MAX)
void AddPropertyChoice (wxPGId id, const wxString &label, int value=INT_MAX)
wxPGId Append (wxPGProperty *property)
wxPGId AppendIn (wxPGPropertyWithChildren *pwc, const wxString &label, const wxString &propname, wxVariant &value)
wxPGId AppendIn (const wxString &name, wxPGProperty *property)
wxPGId AppendIn (wxPGId id, wxPGProperty *property)
wxPGId BaseGetPropertyByName (const wxString &name) const
void BeginAddChildren (const wxString &name)
void BeginAddChildren (wxPGId id)
void Clear ()
void ClearModifiedStatus (wxPGProperty *p)
bool ClearPropertyValue (wxPGProperty *p)
bool ClearSelection ()
bool Collapse (wxPGProperty *p)
void Delete (const wxString &name)
void Delete (wxPGId id)
void DeletePropertyChoice (const wxString &name, int index)
void DeletePropertyChoice (wxPGId id, int index)
virtual void DoDelete (wxPGProperty *item)
virtual wxPGId DoInsert (wxPGPropertyWithChildren *parent, int index, wxPGProperty *property)
bool DoSelectProperty (wxPGProperty *p, unsigned int flags=0)
bool EnableCategories (bool enable)
bool EnableProperty (wxPGProperty *p, bool enable)
void EndAddChildren (const wxString &name)
void EndAddChildren (wxPGId id)
bool Expand (wxPGProperty *p)
bool ExpandAll (unsigned char do_expand)
wxPGId GetFirst () const
wxPGId GetFirstCategory () const
wxPGId GetFirstChild (const wxString &name)
wxPGId GetFirstChild (wxPGId id)
wxPGId GetFirstProperty () const
wxPropertyGridGetGrid () const
int GetLeftSplitterPos (wxClientDC &dc, wxPGPropertyWithChildren *pwc, bool subProps)
wxPGId GetNextCategory (wxPGId id) const
wxPGId GetNextProperty (wxPGId id) const
wxPGId GetNextSibling (const wxString &name)
wxPGId GetNextSibling (wxPGId id)
wxPGId GetPrevProperty (wxPGId id) const
wxString GetPropertyAttributes (wxPGId id, unsigned int flagmask=0xFFFF) const
wxPGId GetPropertyByLabel (const wxString &name, wxPGPropertyWithChildren *parent=(wxPGPropertyWithChildren *) NULL) const
wxPGId GetPropertyByName (const wxString &name, const wxString &subname) const
wxPGId GetPropertyByName (const wxString &name) const
wxPGId GetPropertyByNameA (const wxString &name) const
wxPGChoicesGetPropertyChoices (const wxString &name)
wxPGChoicesGetPropertyChoices (wxPGId id)
const wxChar * GetPropertyClassName (const wxString &name) const
const wxChar * GetPropertyClassName (wxPGId id) const
void * GetPropertyClientData (const wxString &name) const
void * GetPropertyClientData (wxPGId id) const
const wxPGEditorGetPropertyEditor (const wxString &name) const
const wxPGEditorGetPropertyEditor (wxPGId id) const
wxString GetPropertyHelpString (const wxString &name) const
wxString GetPropertyHelpString (wxPGId id) const
wxBitmap * GetPropertyImage (const wxString &name) const
wxBitmap * GetPropertyImage (wxPGId id) const
unsigned int GetPropertyIndex (const wxString &name)
unsigned int GetPropertyIndex (wxPGId id)
const wxString & GetPropertyLabel (const wxString &name)
const wxString & GetPropertyLabel (wxPGId id)
const wxString & GetPropertyName (wxPGId id)
wxPGId GetPropertyParent (const wxString &name)
wxPGId GetPropertyParent (wxPGId id)
int GetPropertyPriority (const wxString &name)
int GetPropertyPriority (wxPGId id)
wxPGPropertyGetPropertyPtr (const wxString &name) const
wxPGPropertyGetPropertyPtr (wxPGId id) const
wxValidator * GetPropertyValidator (const wxString &name)
wxValidator * GetPropertyValidator (wxPGId id)
wxVariant GetPropertyValue (const wxString &name)
wxVariant GetPropertyValue (wxPGId id)
const wxArrayInt & GetPropertyValueAsArrayInt (const wxString &name) const
const wxArrayString & GetPropertyValueAsArrayString (const wxString &name) const
bool GetPropertyValueAsBool (const wxString &name) const
wxDateTime GetPropertyValueAsDateTime (const wxString &name) const
double GetPropertyValueAsDouble (const wxString &name) const
int GetPropertyValueAsInt (const wxString &name) const
long GetPropertyValueAsLong (const wxString &name) const
const wxPoint & GetPropertyValueAsPoint (const wxString &name) const
const wxSize & GetPropertyValueAsSize (const wxString &name) const
wxString GetPropertyValueAsString (const wxString &name) const
const wxObject * GetPropertyValueAsWxObjectPtr (const wxString &name) const
wxVariant GetPropertyValues (const wxString &listname, wxPGId baseparent, long flags) const
const wxPGValueTypeGetPropertyValueType (const wxString &name)
const wxPGValueTypeGetPropertyValueType (wxPGId id)
size_t GetPVTI (const wxString &name)
size_t GetPVTI (wxPGId id)
wxString GetPVTN (const wxString &name)
wxString GetPVTN (wxPGId id)
wxPGPropertyGetSelection () const
wxPropertyGridStateGetState () const
wxPropertyGridStateGetStatePtr ()
bool HideProperty (const wxString &name)
bool HideProperty (wxPGId id, bool hide=true)
virtual void Init ()
void InitNonCatMode ()
wxPGId Insert (const wxString &name, int index, wxPGProperty *property)
wxPGId Insert (wxPGId id, int index, wxPGProperty *property)
void InsertPropertyChoice (const wxString &name, const wxString &label, int index, int value=INT_MAX)
void InsertPropertyChoice (wxPGId id, const wxString &label, int index, int value=INT_MAX)
bool IsDisplayed () const
virtual bool IsHandlingAllEvents () const
bool IsInNonCatMode () const
bool IsModified (const wxString &name)
bool IsModified (wxPGId id) const
bool IsPropertyCategory (const wxString &name)
bool IsPropertyCategory (wxPGId id) const
bool IsPropertyEnabled (const wxString &name)
bool IsPropertyEnabled (wxPGId id) const
bool IsPropertyExpanded (const wxString &name)
bool IsPropertyKindOf (const wxString &name, wxPGPropertyClassInfo &info)
bool IsPropertyModified (const wxString &name)
bool IsPropertyModified (wxPGId id) const
bool IsPropertyShown (const wxString &name)
bool IsPropertyShown (wxPGId id) const
bool IsPropertyUnspecified (const wxString &name)
bool IsPropertyUnspecified (wxPGId id) const
bool IsPropertyValueType (const wxString &name, const wxClassInfo *classinfo)
bool IsPropertyValueType (const wxString &name, const wxPGValueType *valuetype)
bool IsPropertyValueType (const wxString &name, const wxChar *typestr)
bool IsPropertyValueType (wxPGId id, const wxClassInfo *classinfo)
bool IsPropertyValueType (wxPGId id, const wxPGValueType *valuetype)
bool IsPropertyValueType (wxPGId id, const wxChar *typestr)
void LimitPropertyEditing (wxPGProperty *p, bool limit=true)
wxPGId ReplaceProperty (const wxString &name, wxPGProperty *property)
wxPGId ReplaceProperty (wxPGId id, wxPGProperty *property)
void SetPropertyAttribute (const wxString &name, int attrid, wxVariant value, long argFlags=0)
void SetPropertyAttribute (wxPGId id, int attrid, wxVariant value, long argFlags=0)
void SetPropertyAttributes (const wxString &name, const wxString &attributes) const
void SetPropertyChoices (const wxString &name, wxPGChoices &choices)
void SetPropertyChoicesExclusive (const wxString &name)
void SetPropertyChoicesExclusive (wxPGId id)
void SetPropertyClientData (const wxString &name, void *clientData)
void SetPropertyClientData (wxPGId id, void *clientData)
void SetPropertyEditor (const wxString &name, const wxString &editorName)
void SetPropertyEditor (wxPGId id, const wxString &editorName)
void SetPropertyEditor (const wxString &name, const wxPGEditor *editor)
void SetPropertyEditor (wxPGId id, const wxPGEditor *editor)
void SetPropertyHelpString (const wxString &name, const wxString &helpString)
void SetPropertyHelpString (wxPGId id, const wxString &helpString)
void SetPropertyImage (const wxString &name, wxBitmap &bmp)
void SetPropertyImage (wxPGId id, wxBitmap &bmp)
void SetPropertyLabel (wxPGProperty *p, const wxString &newlabel)
bool SetPropertyMaxLength (const wxString &name, int maxLen)
bool SetPropertyMaxLength (wxPGId id, int maxLen)
bool SetPropertyPriority (wxPGProperty *p, int priority)
bool SetPropertyPriority (const wxString &name, int priority)
bool SetPropertyPriority (wxPGId id, int priority)
void SetPropertyUnspecified (wxPGProperty *p)
void SetPropertyValidator (const wxString &name, const wxValidator &validator)
void SetPropertyValidator (wxPGId id, const wxValidator &validator)
void SetPropertyValue (wxPGProperty *p, const wxULongLong &value)
void SetPropertyValue (wxPGProperty *p, const wxLongLong &value)
void SetPropertyValue (wxPGProperty *p, const wxDateTime &value)
void SetPropertyValue (wxPGProperty *p, const wxArrayInt &value)
void SetPropertyValue (wxPGProperty *p, const wxSize &value)
void SetPropertyValue (wxPGProperty *p, const wxPoint &value)
void SetPropertyValue (wxPGProperty *p, void *value)
void SetPropertyValue (wxPGProperty *p, const wxArrayString &value)
void SetPropertyValue (wxPGProperty *p, bool value)
void SetPropertyValue (wxPGProperty *p, double value)
void SetPropertyValue (wxPGProperty *p, int value)
void SetPropertyValue (wxPGProperty *p, long value)
bool SetPropertyValue (wxPGProperty *p, wxObject *value)
bool SetPropertyValue (wxPGProperty *p, wxVariant &value)
bool SetPropertyValue (wxPGProperty *p, const wxString &value)
bool SetPropertyValue (wxPGProperty *p, const wxChar *typestring, const wxPGVariant &value)
bool SetPropertyValue (wxPGProperty *p, const wxPGValueType *typeclass, const wxPGVariant &value)
void SetPropertyValues (const wxList &list, wxPGId default_category)
void SetPropVal (wxPGProperty *p, const wxPGVariant &value)
void Sort ()
void Sort (wxPGProperty *p)
void TogglePropertyPriority (const wxString &name)
void TogglePropertyPriority (wxPGId id)

Static Public Member Functions

static void ClearPropertyAndChildrenFlags (wxPGProperty *p, long flags)
static wxPGPropertyCreatePropertyByClass (const wxString &classname, const wxString &label, const wxString &name)
static wxPGPropertyCreatePropertyByType (const wxString &valuetype, const wxString &label, const wxString &name)
static wxPGEditorGetEditorByName (const wxString &editorName)
static wxPGId GetNextSibling (wxPGId id)
static wxPGId GetPrevSibling (wxPGId id)
static wxString GetPropertyShortClassName (wxPGId id)
static const wxArrayInt & GetPropertyValueAsArrayInt (wxPGId id)
static const wxArrayString & GetPropertyValueAsArrayString (wxPGId id)
static bool GetPropertyValueAsBool (wxPGId id)
static wxDateTime GetPropertyValueAsDateTime (wxPGId id)
static double GetPropertyValueAsDouble (wxPGId id)
static int GetPropertyValueAsInt (wxPGId id)
static long GetPropertyValueAsLong (wxPGId id)
static const wxLongLong & GetPropertyValueAsLongLong (wxPGId id)
static const wxPoint & GetPropertyValueAsPoint (wxPGId id)
static const wxSize & GetPropertyValueAsSize (wxPGId id)
static wxString GetPropertyValueAsString (wxPGId id)
static const wxULongLong & GetPropertyValueAsULongLong (wxPGId id)
static void * GetPropertyValueAsVoidPtr (wxPGId id)
static const wxObject * GetPropertyValueAsWxObjectPtr (wxPGId id)
static wxPGValueTypeGetValueType (const wxString &type)
static void InitAllTypeHandlers ()
static bool IsPropertyExpanded (wxPGId id)
static bool IsPropertyKindOf (wxPGId id, wxPGPropertyClassInfo &info)
static void RegisterAdditionalEditors ()
static void RegisterAdvancedPropertyClasses ()
static bool RegisterPropertyClass (const wxChar *name, wxPGPropertyClassInfo *classinfo)
static void SetBoolChoices (const wxChar *true_choice, const wxChar *false_choice)
static void SetPropertyAndChildrenFlags (wxPGProperty *p, long flags)
static void SetPropertyAttributes (wxPGId id, const wxString &attributes)
static void SetPropertyChoices (wxPGId id, wxPGChoices &choices)

Protected Member Functions

virtual wxPGId DoGetPropertyByName (const wxString &name) const
virtual void RefreshProperty (wxPGProperty *p)

Static Protected Member Functions

static void DoSetPropertyAttribute (wxPGId id, int attrid, wxVariant &value, long argFlags)

Protected Attributes

wxString m_emptyString
int m_id
wxString m_label
wxPropertyGridManagerm_manager
wxPropertyGridStatem_pState

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.

Derived from

wxPropertyGridState
wxPropertyContainerMethods
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.


Member Function Documentation

void wxPropertyContainerMethods::AddPropertyChoice ( wxPGId  id,
const wxString &  label,
int  value = INT_MAX 
) [inherited]

Adds choice to a property that can accept one.

Remarks:
  • If you need to make sure that you modify only the set of choices of a single property (and not also choices of other properties with initially identical set), call wxPropertyGrid::SetPropertyChoicesPrivate.
  • This usually only works for wxEnumProperty and derivatives (wxFlagsProperty can get accept new items but its items may not get updated).

wxPGId wxPropertyGridState::Append ( wxPGProperty property  )  [inherited]

Base append.

wxPGId wxPropertyGridPage::AppendIn ( const wxString &  name,
wxPGProperty property 
) [inline]

See wxPropertyGrid::AppendIn.

wxPGId wxPropertyGridPage::AppendIn ( wxPGId  id,
wxPGProperty property 
) [inline]

See wxPropertyGrid::AppendIn.

wxPGId wxPropertyGridState::BaseGetPropertyByName ( const wxString &  name  )  const [inherited]

Returns property by its name.

void wxPropertyContainerMethods::BeginAddChildren ( wxPGId  id  )  [inherited]

Inorder to add new items into a property with fixed children (for instance, wxFlagsProperty), you need to call this method.

After populating has been finished, you need to call EndAddChildren.

void wxPropertyGridState::Clear (  )  [inherited]

Called in, for example, wxPropertyGrid::Clear.

static wxPGProperty* wxPropertyContainerMethods::CreatePropertyByClass ( const wxString &  classname,
const wxString &  label,
const wxString &  name 
) [static, inherited]

Constructs a property.

Class used is given as the first string argument. It may be either normal property class name, such as "wxIntProperty" or a short one such as "Int".

static wxPGProperty* wxPropertyContainerMethods::CreatePropertyByType ( const wxString &  valuetype,
const wxString &  label,
const wxString &  name 
) [static, inherited]

Constructs a property.

Value type name used is given as the first string argument. It may be "string", "long", etc. Any value returned by wxVariant::GetType fits there.

Otherwise, this is similar as CreatePropertyByClass.

Remarks:
Cannot generate property category.

void wxPropertyContainerMethods::Delete ( const wxString &  name  )  [inline, inherited]

Deletes a property by name.

void wxPropertyContainerMethods::Delete ( wxPGId  id  )  [inherited]

Deletes a property by id.

If category is deleted, all children are automatically deleted as well.

void wxPropertyContainerMethods::DeletePropertyChoice ( wxPGId  id,
int  index 
) [inherited]

Deletes choice from a property.

If selected item is deleted, then the value is set to unspecified.

See AddPropertyChoice for more details.

virtual void wxPropertyGridState::DoDelete ( wxPGProperty item  )  [virtual, inherited]

Override this member function to add custom behaviour on property deletion.

virtual wxPGId wxPropertyGridState::DoInsert ( wxPGPropertyWithChildren parent,
int  index,
wxPGProperty property 
) [virtual, inherited]

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

bool wxPropertyGridState::EnableProperty ( wxPGProperty p,
bool  enable 
) [inherited]

Enables or disables given property and its subproperties.

void wxPropertyContainerMethods::EndAddChildren ( wxPGId  id  )  [inherited]

Called after population of property with fixed children has finished.

wxPGId wxPropertyGridState::GetFirst (  )  const [inline, inherited]

Returns id of first item, whether it is a category or property.

wxPGId wxPropertyContainerMethods::GetFirstChild ( wxPGId  id  )  [inline, inherited]

Returns id of first child of given property.

Remarks:
Does not return sub-properties!

int wxPropertyGridState::GetLeftSplitterPos ( wxClientDC &  dc,
wxPGPropertyWithChildren pwc,
bool  subProps 
) [inherited]

Used by SetSplitterLeft.

wxPGId wxPropertyContainerMethods::GetNextSibling ( wxPGId  id  )  [inline, inherited]

Returns next item under the same parent.

wxString wxPropertyContainerMethods::GetPropertyAttributes ( wxPGId  id,
unsigned int  flagmask = 0xFFFF 
) const [inline, inherited]

Returns comma-delimited string with property's attributes (both pseudo-attributes such as "Disabled" and "Modified" and real attributes such as "BoolUseCheckbox" - actual names may vary).

Parameters:
flagmask Combination of property flags that should be included (in addition to any other attributes). For example, to avoid adding Modified attribute use ~(wxPG_PROP_MODIFIED).
Remarks:
Atleast in 1.2.x and earlier this does not return complete list of attributes (for example, no floating point precision) and some attributes have generic names (such as "Special1" instead of "UseCheckbox" etc)

wxPGId wxPropertyContainerMethods::GetPropertyByName ( const wxString &  name,
const wxString &  subname 
) const [inherited]

Returns id of a sub-property 'subname' of property 'name'.

Same as calling GetPropertyByNameI(wxT("name.subname")), albeit slightly faster.

wxPGId wxPropertyContainerMethods::GetPropertyByName ( const wxString &  name  )  const [inherited]

Returns id of property with given name (case-sensitive).

If there is no property with such name, returned property id is invalid ( i.e. it will return false with IsOk method).

Remarks:
  • Sub-properties (i.e. properties which have parent that is not category or root) can not be accessed globally by their name. Instead, use "<property>.<subproperty>" in place of "<subproperty>".

wxPGChoices& wxPropertyContainerMethods::GetPropertyChoices ( wxPGId  id  )  [inherited]

Returns writable reference to property's list of choices (and relevant values).

If property does not have any choices, will return reference to an invalid set of choices that will return false on IsOk call.

const wxChar* wxPropertyContainerMethods::GetPropertyClassName ( const wxString &  name  )  const [inline, inherited]

Gets name of property's constructor function.

const wxChar* wxPropertyContainerMethods::GetPropertyClassName ( wxPGId  id  )  const [inline, inherited]

Gets name of property's constructor function.

void* wxPropertyContainerMethods::GetPropertyClientData ( const wxString &  name  )  const [inline, inherited]

Returns client data (void*) of a property.

void* wxPropertyContainerMethods::GetPropertyClientData ( wxPGId  id  )  const [inline, inherited]

Returns client data (void*) of a property.

const wxPGEditor* wxPropertyContainerMethods::GetPropertyEditor ( wxPGId  id  )  const [inline, inherited]

Returns property's editor.

wxString wxPropertyContainerMethods::GetPropertyHelpString ( const wxString &  name  )  const [inline, inherited]

Returns help string associated with a property.

wxString wxPropertyContainerMethods::GetPropertyHelpString ( wxPGId  id  )  const [inline, inherited]

Returns help string associated with a property.

wxBitmap* wxPropertyContainerMethods::GetPropertyImage ( wxPGId  id  )  const [inline, inherited]

Returns property's custom value image (NULL of none).

unsigned int wxPropertyContainerMethods::GetPropertyIndex ( const wxString &  name  )  [inline, inherited]

Returns property's position under its parent.

unsigned int wxPropertyContainerMethods::GetPropertyIndex ( wxPGId  id  )  [inline, inherited]

Returns property's position under its parent.

const wxString& wxPropertyContainerMethods::GetPropertyLabel ( wxPGId  id  )  [inline, inherited]

Returns label of a property.

const wxString& wxPropertyContainerMethods::GetPropertyName ( wxPGId  id  )  [inline, inherited]

Returns name of a property.

Note that obviously there is no name-version of this member function.

wxPGId wxPropertyContainerMethods::GetPropertyParent ( const wxString &  name  )  [inline, inherited]

Returns parent item of a property.

wxPGId wxPropertyContainerMethods::GetPropertyParent ( wxPGId  id  )  [inline, inherited]

Returns parent item of a property.

int wxPropertyContainerMethods::GetPropertyPriority ( const wxString &  name  )  [inline, inherited]

Returns priority of a property (wxPG_HIGH or wxPG_LOW).

int wxPropertyContainerMethods::GetPropertyPriority ( wxPGId  id  )  [inline, inherited]

Returns priority of a property (wxPG_HIGH or wxPG_LOW).

wxPGProperty* wxPropertyContainerMethods::GetPropertyPtr ( const wxString &  name  )  const [inline, inherited]

Returns pointer to a property.

wxPGProperty* wxPropertyContainerMethods::GetPropertyPtr ( wxPGId  id  )  const [inline, inherited]

Returns pointer to a property.

static wxString wxPropertyContainerMethods::GetPropertyShortClassName ( wxPGId  id  )  [static, inherited]

Returns short name for property's class.

For example, "wxPropertyCategory" translates to "Category" and "wxIntProperty" to "Int".

wxValidator* wxPropertyContainerMethods::GetPropertyValidator ( wxPGId  id  )  [inline, inherited]

Returns validator of a property as a reference, which you can pass to any number of SetPropertyValidator.

wxVariant wxPropertyContainerMethods::GetPropertyValue ( const wxString &  name  )  [inline, inherited]

Returns value as wxVariant.

To get wxObject pointer from it, you will have to use WX_PG_VARIANT_TO_WXOBJECT(VARIANT,CLASSNAME) macro.

If property value is unspecified, Null variant is returned.

wxVariant wxPropertyContainerMethods::GetPropertyValue ( wxPGId  id  )  [inline, inherited]

Returns value as wxVariant.

To get wxObject pointer from it, you will have to use WX_PG_VARIANT_TO_WXOBJECT(VARIANT,CLASSNAME) macro.

If property value is unspecified, Null variant is returned.

const wxPGValueType* wxPropertyContainerMethods::GetPropertyValueType ( wxPGId  id  )  [inline, inherited]

Returns a wxPGValueType class instance that describes the property's data type.

size_t wxPropertyContainerMethods::GetPVTI ( wxPGId  id  )  [inline, inherited]

Returns property value type identifier.

wxString wxPropertyContainerMethods::GetPVTN ( wxPGId  id  )  [inline, inherited]

Returns property value type name.

wxPropertyGridState* wxPropertyGridPage::GetStatePtr (  )  [inline]

Return pointer to contained property grid state.

static wxPGValueType* wxPropertyContainerMethods::GetValueType ( const wxString &  type  )  [static, inherited]

Returns value type class instance for given type name.

bool wxPropertyContainerMethods::HideProperty ( wxPGId  id,
bool  hide = true 
) [inherited]

Hides or reveals a property.

Parameters:
hide If true, hides property, otherwise reveals it.
Remarks:
Hiding properties is not compatible with priority system. Using both at the same time will yield unpredictable results.

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

static void wxPropertyContainerMethods::InitAllTypeHandlers (  )  [static, inherited]

Initializes *all* property types.

Causes references to most object files in the library, so calling this may cause significant increase in executable size when linking with static library.

Reimplemented in wxPropertyGridManager.

void wxPropertyGridState::InitNonCatMode (  )  [inherited]

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

wxPGId wxPropertyGridPage::Insert ( const wxString &  name,
int  index,
wxPGProperty property 
)

See wxPropertyGrid::Insert.

wxPGId wxPropertyGridPage::Insert ( wxPGId  id,
int  index,
wxPGProperty property 
)

See wxPropertyGrid::Insert.

void wxPropertyContainerMethods::InsertPropertyChoice ( wxPGId  id,
const wxString &  label,
int  index,
int  value = INT_MAX 
) [inherited]

Inserts choice to a property that can accept one.

See AddPropertyChoice for more details.

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

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

bool wxPropertyContainerMethods::IsModified ( wxPGId  id  )  const [inline, inherited]

Returns true if property has been modified after value set or modify flag clear by software.

NOTE: Try to use IsPropertyModified instead.

bool wxPropertyContainerMethods::IsPropertyCategory ( wxPGId  id  )  const [inline, inherited]

Returns true if property is a category.

bool wxPropertyContainerMethods::IsPropertyEnabled ( const wxString &  name  )  [inline, inherited]

Returns true if property is enabled.

bool wxPropertyContainerMethods::IsPropertyEnabled ( wxPGId  id  )  const [inline, inherited]

Returns true if property is enabled.

static bool wxPropertyContainerMethods::IsPropertyExpanded ( wxPGId  id  )  [static, inherited]

Returns true if given property is expanded.

Naturally, always returns false for properties that cannot be expanded.

static bool wxPropertyContainerMethods::IsPropertyKindOf ( wxPGId  id,
wxPGPropertyClassInfo info 
) [inline, static, inherited]

Returns true if property is of certain type.

Parameters:
info Preferably use WX_PG_CLASSINFO(PROPERTYNAME). Alternative is PROPERTYNAMEClassInfo.

bool wxPropertyContainerMethods::IsPropertyModified ( wxPGId  id  )  const [inline, inherited]

Returns true if property has been modified after value set or modify flag clear by software.

bool wxPropertyContainerMethods::IsPropertyShown ( const wxString &  name  )  [inline, inherited]

Returns true if property is shown (ie.

hideproperty with true not called for it).

bool wxPropertyContainerMethods::IsPropertyShown ( wxPGId  id  )  const [inline, inherited]

Returns true if property is shown (ie.

hideproperty with true not called for it).

bool wxPropertyContainerMethods::IsPropertyUnspecified ( wxPGId  id  )  const [inline, inherited]

Returns true if property value is set to unspecified.

bool wxPropertyContainerMethods::IsPropertyValueType ( const wxString &  name,
const wxClassInfo *  classinfo 
) [inline, inherited]

Returns true if property's value type has same name as a class.

bool wxPropertyContainerMethods::IsPropertyValueType ( const wxString &  name,
const wxPGValueType valuetype 
) [inline, inherited]

Returns true if property's value type is valuetype.

bool wxPropertyContainerMethods::IsPropertyValueType ( const wxString &  name,
const wxChar *  typestr 
) [inline, inherited]

Returns true if property's value type has name typestr.

bool wxPropertyContainerMethods::IsPropertyValueType ( wxPGId  id,
const wxClassInfo *  classinfo 
) [inline, inherited]

Returns true if property's value type has same name as a class.

bool wxPropertyContainerMethods::IsPropertyValueType ( wxPGId  id,
const wxPGValueType valuetype 
) [inline, inherited]

Returns true if property's value type is valuetype.

bool wxPropertyContainerMethods::IsPropertyValueType ( wxPGId  id,
const wxChar *  typestr 
) [inline, inherited]

Returns true if property's value type has name typestr.

static void wxPropertyContainerMethods::RegisterAdditionalEditors (  )  [static, inherited]

Initializes additional property editors (SpinCtrl etc.

). Causes references to most object files in the library, so calling this may cause significant increase in executable size when linking with static library.

static void wxPropertyContainerMethods::RegisterAdvancedPropertyClasses (  )  [static, inherited]

Basic property classes are registered by the default, but this registers advanced ones as well.

static bool wxPropertyContainerMethods::RegisterPropertyClass ( const wxChar *  name,
wxPGPropertyClassInfo classinfo 
) [static, inherited]

Registers property class info with specific name.

Preferably use wxPGRegisterPropertyClass(PROPERTYNAME) macro.

wxPGId wxPropertyContainerMethods::ReplaceProperty ( wxPGId  id,
wxPGProperty property 
) [inherited]

Replaces property with id with newly created property.

For example, this code replaces existing property named "Flags" with one that will have different set of items:

            pg->ReplaceProperty(wxT("Flags"),
                wxFlagsProperty(wxT("Flags"),wxPG_LABEL,newItems))
For more info, see wxPropertyGrid::Insert.

static void wxPropertyContainerMethods::SetBoolChoices ( const wxChar *  true_choice,
const wxChar *  false_choice 
) [static, inherited]

Lets user to set the strings listed in the choice dropdown of a wxBoolProperty.

Defaults are "True" and "False", so changing them to, say, "Yes" and "No" may be useful in some less technical applications.

void wxPropertyContainerMethods::SetPropertyAttribute ( wxPGId  id,
int  attrid,
wxVariant  value,
long  argFlags = 0 
) [inline, inherited]

Sets an attribute of a property.

Ids and relevants values are totally specific to property classes and may affect either the given instance or all instances of that class. See wxPropertyGrid Property Attribute Identifiers for list of built-in attributes.

Parameters:
argFlags Optional. Use wxPG_RECURSE to set the attribute to child properties as well.
Remarks:
wxVariant doesn't have int constructor (as of 2.5.4), so you will need to cast int values (including most numeral constants) to long.

static void wxPropertyContainerMethods::SetPropertyAttributes ( wxPGId  id,
const wxString &  attributes 
) [inline, static, inherited]

Sets attributes from a string generated by GetPropertyAttributes.

Remarks:
Performance may not be top-notch.

void wxPropertyContainerMethods::SetPropertyChoices ( const wxString &  name,
wxPGChoices choices 
) [inline, inherited]

Set choices of a property to specified set of labels and values.

static void wxPropertyContainerMethods::SetPropertyChoices ( wxPGId  id,
wxPGChoices choices 
) [inline, static, inherited]

Set choices of a property to specified set of labels and values.

void wxPropertyContainerMethods::SetPropertyChoicesExclusive ( wxPGId  id  )  [inline, inherited]

If property's set of choices is shared, then calling this method converts it to private.

void wxPropertyContainerMethods::SetPropertyClientData ( const wxString &  name,
void *  clientData 
) [inline, inherited]

Sets client data (void*) of a property.

Remarks:
This untyped client data has to be deleted manually.

void wxPropertyContainerMethods::SetPropertyClientData ( wxPGId  id,
void *  clientData 
) [inline, inherited]

Sets client data (void*) of a property.

Remarks:
This untyped client data has to be deleted manually.

void wxPropertyContainerMethods::SetPropertyEditor ( wxPGId  id,
const wxString &  editorName 
) [inline, inherited]

Sets editor control of a property.

As editor argument, use editor name string, such as wxT("TextCtrl") or wxT("Choice").

void wxPropertyContainerMethods::SetPropertyEditor ( wxPGId  id,
const wxPGEditor editor 
) [inline, inherited]

Sets editor control of a property.

As editor argument, use wxPG_EDITOR(EditorName), where basic built-in editor names are TextCtrl, Choice, ComboBox, CheckBox, TextCtrlAndButton, and ChoiceAndButton. Additional editors include SpinCtrl and DatePickerCtrl, which also require wxPropertyGrid::RegisterAdditionalEditors() call prior using.

void wxPropertyContainerMethods::SetPropertyHelpString ( wxPGId  id,
const wxString &  helpString 
) [inline, inherited]

Associates the help string with property.

Remarks:
By default, text is shown either in the manager's "description" text box or in the status bar. If extra window style wxPG_EX_HELP_AS_TOOLTIPS is used, then the text will appear as a tooltip.

void wxPropertyContainerMethods::SetPropertyImage ( wxPGId  id,
wxBitmap &  bmp 
) [inline, inherited]

Set wxBitmap in front of the value.

Remarks:

bool wxPropertyContainerMethods::SetPropertyMaxLength ( const wxString &  name,
int  maxLen 
) [inline, inherited]

Sets max length of property's text.

bool wxPropertyContainerMethods::SetPropertyMaxLength ( wxPGId  id,
int  maxLen 
) [inherited]

Sets max length of property's text.

bool wxPropertyContainerMethods::SetPropertyPriority ( const wxString &  name,
int  priority 
) [inline, inherited]

Property is to be hidden/shown when hider button is toggled or when wxPropertyGrid::Compact is called.

bool wxPropertyContainerMethods::SetPropertyPriority ( wxPGId  id,
int  priority 
) [inherited]

Property is to be hidden/shown when hider button is toggled or when wxPropertyGrid::Compact is called.

void wxPropertyContainerMethods::SetPropertyValidator ( wxPGId  id,
const wxValidator &  validator 
) [inline, inherited]

Sets validator of a property.

For example

          // Allow property's value range from -100 to 100
          wxIntPropertyValidator validator(-100,100);
          wxPGId id = pg->Append( wxIntProperty(wxT("Value 1",wxPG_LABEL,0)) );
          pg->SetPropertyValidator( id, validator );

void wxPropertyGridState::SetPropertyValue ( wxPGProperty p,
const wxULongLong &  value 
) [inline, inherited]

Sets value (wxULongLong&) of a property.

void wxPropertyGridState::SetPropertyValue ( wxPGProperty p,
const wxLongLong &  value 
) [inline, inherited]

Sets value (wxLongLong&) of a property.

void wxPropertyGridState::SetPropertyValue ( wxPGProperty p,
const wxDateTime &  value 
) [inline, inherited]

Sets value (wxDateTime&) of a property.

void wxPropertyGridState::SetPropertyValue ( wxPGProperty p,
const wxArrayInt &  value 
) [inline, inherited]

Sets value (wxArrayInt&) of a property.

void wxPropertyGridState::SetPropertyValue ( wxPGProperty p,
const wxSize &  value 
) [inline, inherited]

Sets value (wxSize&) of a property.

void wxPropertyGridState::SetPropertyValue ( wxPGProperty p,
const wxPoint &  value 
) [inline, inherited]

Sets value (wxPoint&) of a property.

void wxPropertyGridState::SetPropertyValue ( wxPGProperty p,
void *  value 
) [inline, inherited]

Sets value (void*) of a property.

void wxPropertyGridState::SetPropertyValue ( wxPGProperty p,
const wxArrayString &  value 
) [inline, inherited]

Sets value (wxArrayString) of a property.

void wxPropertyGridState::SetPropertyValue ( wxPGProperty p,
bool  value 
) [inline, inherited]

Sets value (bool) of a property.

void wxPropertyGridState::SetPropertyValue ( wxPGProperty p,
double  value 
) [inline, inherited]

Sets value (floating point) of a property.

void wxPropertyGridState::SetPropertyValue ( wxPGProperty p,
int  value 
) [inline, inherited]

Sets value (integer) of a property.

void wxPropertyGridState::SetPropertyValue ( wxPGProperty p,
long  value 
) [inline, inherited]

Sets value (long integer) of a property.

void wxPropertyContainerMethods::TogglePropertyPriority ( const wxString &  name  )  [inline, inherited]

Toggles priority of a property between wxPG_HIGH and wxPG_LOW.

void wxPropertyContainerMethods::TogglePropertyPriority ( wxPGId  id  )  [inline, inherited]

Toggles priority of a property between wxPG_HIGH and wxPG_LOW.


The documentation for this class was generated from the following file:
Generated on Sun Mar 11 11:38:14 2007 for wxPropertyGrid by  doxygen 1.5.1-p1