Update documentation of some flags used by wxPropertyGridInterface methods.
This commit is contained in:
@@ -317,29 +317,35 @@ WX_DEFINE_TYPEARRAY_WITH_DECL_PTR(wxObject*, wxArrayPGObject,
|
|||||||
|
|
||||||
// -----------------------------------------------------------------------
|
// -----------------------------------------------------------------------
|
||||||
|
|
||||||
enum wxPG_GETPROPERTYVALUES_FLAGS
|
enum wxPG_PROPERTYVALUES_FLAGS
|
||||||
{
|
{
|
||||||
/** Flags for wxPropertyGrid::SetPropertyAttribute() etc */
|
// Flag for wxPropertyGridInterface::SetProperty* functions,
|
||||||
|
// wxPropertyGridInterface::HideProperty(), etc.
|
||||||
|
// Apply changes only for the property in question.
|
||||||
wxPG_DONT_RECURSE = 0x00000000,
|
wxPG_DONT_RECURSE = 0x00000000,
|
||||||
|
|
||||||
/** Flags for wxPropertyGridInterface::GetPropertyValues */
|
// Flag for wxPropertyGridInterface::GetPropertyValues().
|
||||||
|
// Use this flag to retain category structure; each sub-category
|
||||||
|
// will be its own wxVariantList of wxVariant.
|
||||||
wxPG_KEEP_STRUCTURE = 0x00000010,
|
wxPG_KEEP_STRUCTURE = 0x00000010,
|
||||||
|
|
||||||
/** Flags for wxPropertyGrid::SetPropertyAttribute() etc */
|
// Flag for wxPropertyGridInterface::SetProperty* functions,
|
||||||
|
// wxPropertyGridInterface::HideProperty(), etc.
|
||||||
|
// Apply changes recursively for the property and all its children.
|
||||||
wxPG_RECURSE = 0x00000020,
|
wxPG_RECURSE = 0x00000020,
|
||||||
|
|
||||||
/** Include attributes for GetPropertyValues. */
|
// Flag for wxPropertyGridInterface::GetPropertyValues().
|
||||||
|
// Use this flag to include property attributes as well.
|
||||||
wxPG_INC_ATTRIBUTES = 0x00000040,
|
wxPG_INC_ATTRIBUTES = 0x00000040,
|
||||||
|
|
||||||
/** Used when first starting recursion. */
|
// Used when first starting recursion.
|
||||||
wxPG_RECURSE_STARTS = 0x00000080,
|
wxPG_RECURSE_STARTS = 0x00000080,
|
||||||
|
|
||||||
/** Force value change. */
|
// Force value change.
|
||||||
wxPG_FORCE = 0x00000100,
|
wxPG_FORCE = 0x00000100,
|
||||||
|
|
||||||
/** Only sort categories and their immediate children.
|
// Only sort categories and their immediate children.
|
||||||
Sorting done by wxPG_AUTO_SORT option uses this.
|
// Sorting done by wxPG_AUTO_SORT option uses this.
|
||||||
*/
|
|
||||||
wxPG_SORT_TOP_LEVEL_ONLY = 0x00000200
|
wxPG_SORT_TOP_LEVEL_ONLY = 0x00000200
|
||||||
};
|
};
|
||||||
|
|
||||||
|
@@ -6,6 +6,70 @@
|
|||||||
/////////////////////////////////////////////////////////////////////////////
|
/////////////////////////////////////////////////////////////////////////////
|
||||||
|
|
||||||
// -----------------------------------------------------------------------
|
// -----------------------------------------------------------------------
|
||||||
|
/**
|
||||||
|
@section propgrid_property_values_attributes wxPropertyGrid Property Values Attribute Identifiers
|
||||||
|
|
||||||
|
Many wxPropertyGridInterface and wxPropertyGrid methods to set property
|
||||||
|
value or to modify its state use these flags to specify additional details
|
||||||
|
of the operation.
|
||||||
|
|
||||||
|
@{
|
||||||
|
*/
|
||||||
|
enum wxPG_PROPERTYVALUES_FLAGS
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
Flag for wxPropertyGridInterface::SetProperty* functions,
|
||||||
|
wxPropertyGridInterface::HideProperty(), etc.
|
||||||
|
Apply changes only for the property in question.
|
||||||
|
@hideinitializer
|
||||||
|
*/
|
||||||
|
wxPG_DONT_RECURSE = 0x00000000,
|
||||||
|
|
||||||
|
/**
|
||||||
|
Flag for wxPropertyGridInterface::GetPropertyValues().
|
||||||
|
Use this flag to retain category structure; each sub-category
|
||||||
|
will be its own wxVariantList of wxVariant.
|
||||||
|
@hideinitializer
|
||||||
|
*/
|
||||||
|
wxPG_KEEP_STRUCTURE = 0x00000010,
|
||||||
|
|
||||||
|
/**
|
||||||
|
Flag for wxPropertyGridInterface::SetProperty* functions,
|
||||||
|
wxPropertyGridInterface::HideProperty(), etc.
|
||||||
|
Apply changes recursively for the property and all its children.
|
||||||
|
@hideinitializer
|
||||||
|
*/
|
||||||
|
wxPG_RECURSE = 0x00000020,
|
||||||
|
|
||||||
|
/**
|
||||||
|
Flag for wxPropertyGridInterface::GetPropertyValues().
|
||||||
|
Use this flag to include property attributes as well.
|
||||||
|
@hideinitializer
|
||||||
|
*/
|
||||||
|
wxPG_INC_ATTRIBUTES = 0x00000040,
|
||||||
|
|
||||||
|
/**
|
||||||
|
Used when first starting recursion.
|
||||||
|
@hideinitializer
|
||||||
|
*/
|
||||||
|
wxPG_RECURSE_STARTS = 0x00000080,
|
||||||
|
|
||||||
|
/**
|
||||||
|
Force value change.
|
||||||
|
@hideinitializer
|
||||||
|
*/
|
||||||
|
wxPG_FORCE = 0x00000100,
|
||||||
|
|
||||||
|
/**
|
||||||
|
Only sort categories and their immediate children.
|
||||||
|
Sorting done by wxPG_AUTO_SORT option uses this.
|
||||||
|
@hideinitializer
|
||||||
|
*/
|
||||||
|
wxPG_SORT_TOP_LEVEL_ONLY = 0x00000200
|
||||||
|
};
|
||||||
|
|
||||||
|
/** @}
|
||||||
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@class wxPropertyGridInterface
|
@class wxPropertyGridInterface
|
||||||
|
Reference in New Issue
Block a user