propgriddefs.h File Reference

Macros
#define	wxPG_LABEL
	Used to tell wxPGProperty to use label as name as well. More...
#define	wxPG_COLOUR(R, G, B)
	Convert Red, Green and Blue to a single 32-bit value. More...
#define	wxPG_DEFAULT_IMAGE_SIZE
	If property is supposed to have custom-painted image, then returning this in wxPGProperty::OnMeasureImage() will usually be enough. More...

Typedefs
typedef int(*	wxPGSortCallback) (wxPropertyGrid *propGrid, wxPGProperty *p1, wxPGProperty *p2)
	This callback function is used for sorting properties. More...

Enumerations
enum class	wxPGPropertyValuesFlags : int {   DontRecurse ,   KeepStructure ,   Recurse ,   IncAttributes ,   RecurseStarts ,   Force ,   SortTopLevelOnly }
enum class	wxPGPropValFormatFlags : int {   Null ,   FullValue ,   ReportError ,   PropertySpecific ,   EditableValue ,   CompositeFragment ,   UneditableCompositeFragment ,   ValueIsCurrent ,   ProgrammaticValue }
	Miscellaneous property value format flags. More...
enum class	wxPGSetValueFlags : int {   RefreshEditor ,   Aggregated ,   FromParent ,   ByUser }
	wxPGProperty::SetValue() flags More...

Variables
constexpr int	wxPG_INVALID_VALUE
	Used to indicate wxPGChoices::Add() etc that the value is actually not given by the caller. More...
constexpr long	wxPG_BASE_OCT
	Constant for wxPG_UINT_BASE attribute. More...
constexpr long	wxPG_BASE_DEC
	Constant for wxPG_UINT_BASE attribute. More...
constexpr long	wxPG_BASE_HEX
	Constant for wxPG_UINT_BASE attribute. More...
constexpr long	wxPG_BASE_HEXL
	Constant for wxPG_UINT_BASE attribute. More...
constexpr long	wxPG_PREFIX_NONE
	Constant for wxPG_UINT_PREFIX attribute. More...
constexpr long	wxPG_PREFIX_0x
	Constant for wxPG_UINT_PREFIX attribute. More...
constexpr long	wxPG_PREFIX_DOLLAR_SIGN
	Constant for wxPG_UINT_PREFIX attribute. More...

Macro Definition Documentation

wxPG_COLOUR

#define wxPG_COLOUR	(		R,
			G,
			B
	)

Convert Red, Green and Blue to a single 32-bit value.

wxPG_DEFAULT_IMAGE_SIZE

#define wxPG_DEFAULT_IMAGE_SIZE

If property is supposed to have custom-painted image, then returning this in wxPGProperty::OnMeasureImage() will usually be enough.

wxPG_LABEL

#define wxPG_LABEL

Used to tell wxPGProperty to use label as name as well.

Typedef Documentation

wxPGSortCallback

typedef int(* wxPGSortCallback) (wxPropertyGrid *propGrid, wxPGProperty *p1, wxPGProperty *p2)

This callback function is used for sorting properties.

Call wxPropertyGrid::SetSortFunction() to set it.

Sort function should return a value greater than 0 if position of p1 is after p2. So, for instance, when comparing property names, you can use following implementation:

@code
    int MyPropertySortFunction(wxPropertyGrid* propGrid,
                               wxPGProperty* p1,
                               wxPGProperty* p2)
    {
        return p1->GetBaseName().compare( p2->GetBaseName() );
    }
@endcode

Enumeration Type Documentation

wxPGPropertyValuesFlags

enum wxPGPropertyValuesFlags : int

strong

Enumerator
DontRecurse	Flag for wxPropertyGridInterface::SetProperty* functions, wxPropertyGridInterface::HideProperty(), etc. Apply changes only for the property in question.
KeepStructure	Flag for wxPropertyGridInterface::GetPropertyValues(). Use this flag to retain category structure; each sub-category will be its own wxVariantList of wxVariant.
Recurse	Flag for wxPropertyGridInterface::SetProperty* functions, wxPropertyGridInterface::HideProperty(), etc. Apply changes recursively for the property and all its children.
IncAttributes	Flag for wxPropertyGridInterface::GetPropertyValues(). Use this flag to include property attributes as well.
RecurseStarts	Used when first starting recursion.
Force	Force value change.
SortTopLevelOnly	Only sort categories and their immediate children. Sorting done by wxPG_AUTO_SORT option uses this.

wxPGPropValFormatFlags

enum wxPGPropValFormatFlags : int

strong

Miscellaneous property value format flags.

Enumerator
Null	No flags.
FullValue	Get/Store full value instead of displayed value.
ReportError	Perform special action in case of unsuccessful conversion.
PropertySpecific
EditableValue	Get/Store editable value instead of displayed one (should only be different in the case of common values).
CompositeFragment	Used when dealing with fragments of composite string value.
UneditableCompositeFragment	Means property for which final string value is for cannot really be edited.
ValueIsCurrent	wxPGProperty::ValueToString() called from wxPGProperty::GetValueAsString() (guarantees that input wxVariant value is current own value)
ProgrammaticValue	Value is being set programmatically (i.e. not by user)

wxPGSetValueFlags

enum wxPGSetValueFlags : int

strong

wxPGProperty::SetValue() flags

Enumerator
RefreshEditor
Aggregated
FromParent
ByUser	Set if value changed by user.

Variable Documentation

wxPG_BASE_DEC

constexpr long wxPG_BASE_DEC

constexpr

Constant for wxPG_UINT_BASE attribute.

wxPG_BASE_HEX

constexpr long wxPG_BASE_HEX

constexpr

Constant for wxPG_UINT_BASE attribute.

wxPG_BASE_HEXL

constexpr long wxPG_BASE_HEXL

constexpr

Constant for wxPG_UINT_BASE attribute.

wxPG_BASE_OCT

constexpr long wxPG_BASE_OCT

constexpr

Constant for wxPG_UINT_BASE attribute.

wxPG_INVALID_VALUE

constexpr int wxPG_INVALID_VALUE

constexpr

Used to indicate wxPGChoices::Add() etc that the value is actually not given by the caller.

wxPG_PREFIX_0x

constexpr long wxPG_PREFIX_0x

constexpr

Constant for wxPG_UINT_PREFIX attribute.

wxPG_PREFIX_DOLLAR_SIGN

constexpr long wxPG_PREFIX_DOLLAR_SIGN

constexpr

Constant for wxPG_UINT_PREFIX attribute.

wxPG_PREFIX_NONE

constexpr long wxPG_PREFIX_NONE

constexpr

Constant for wxPG_UINT_PREFIX attribute.