Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update wxPropertyGrid documentation

Browse Source 
Mention that ChangePropertyValue() shouldn't be called from wxEVT_PG_CHANGED handler.

See #18502.
This commit is contained in:
Artur Wieczorek
2019-10-02 00:06:58 +02:00
parent 203e265d9b
commit 4489ddc13c
2 changed files with 10 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
interface/wx/propgrid/propgrid.h
View File

@@ -570,7 +570,10 @@ public:
/** /**
Changes value of a property, as if from an editor. Use this instead of Changes value of a property, as if from an editor. Use this instead of
SetPropertyValue() if you need the value to run through validation SetPropertyValue() if you need the value to run through validation
process, and also send the property change event. process, and also send @c wxEVT_PG_CHANGED.
@remarks Since this function sends @c wxEVT_PG_CHANGED, it should not
be called from @c EVT_PG_CHANGED handler.
@return Returns @true if value was successfully changed. @return Returns @true if value was successfully changed.
*/ */

9
interface/wx/propgrid/propgridiface.h
View File

@@ -225,7 +225,10 @@ public:
/** /**
Changes value of a property, as if by user. Use this instead of Changes value of a property, as if by user. Use this instead of
SetPropertyValue() if you need the value to run through validation SetPropertyValue() if you need the value to run through validation
process, and also send the property change event. process, and also send @c wxEVT_PG_CHANGED.
@remarks Since this function sends @c wxEVT_PG_CHANGED, it should not
be called from @c EVT_PG_CHANGED handler.
@return Returns @true if value was successfully changed. @return Returns @true if value was successfully changed.
*/ */
@@ -1157,8 +1160,8 @@ public:
/** /**
Sets value (wxVariant) of a property. Sets value (wxVariant) of a property.
@remarks Use wxPropertyGrid::ChangePropertyValue() instead if you need to @remarks Use ChangePropertyValue() instead if you need to
run through validation process and send property change event. run through validation process and send property change event.
*/ */
void SetPropertyValue( wxPGPropArg id, wxVariant value ); void SetPropertyValue( wxPGPropArg id, wxVariant value );