Update wxPG documentation to get rid of doxygen warnings
This commit is contained in:
Artur Wieczorek
@@ -582,7 +582,7 @@ public:
|
||||
void AddActionTrigger( int action, int keycode, int modifiers = 0 );
|
||||
|
||||
/**
|
||||
Adds given property into selection. If wxPG_EX_MULTIPLE_SELECTION
|
||||
Adds given property into selection. If ::wxPG_EX_MULTIPLE_SELECTION
|
||||
extra style is not used, then this has same effect as
|
||||
calling SelectProperty().
|
||||
|
||||
@@ -591,7 +591,7 @@ public:
|
||||
add category to selection, and also if you have category
|
||||
selected, you cannot add other properties to selection.
|
||||
This member function will fail silently in these cases,
|
||||
even returning true.
|
||||
even returning @true.
|
||||
*/
|
||||
bool AddToSelection( wxPGPropArg id );
|
||||
|
||||
@@ -600,7 +600,7 @@ public:
|
||||
wxGetTranslation() for following strings: wxEnumProperty list labels,
|
||||
wxFlagsProperty child property labels.
|
||||
|
||||
Default is false.
|
||||
Default is @false.
|
||||
*/
|
||||
static void AutoGetTranslation( bool enable );
|
||||
|
||||
@@ -624,7 +624,7 @@ public:
|
||||
SetPropertyValue() if you need the value to run through validation
|
||||
process, and also send the property change event.
|
||||
|
||||
@return Returns true if value was successfully changed.
|
||||
@return Returns @true if value was successfully changed.
|
||||
*/
|
||||
bool ChangePropertyValue( wxPGPropArg id, wxVariant newValue );
|
||||
|
||||
@@ -633,7 +633,7 @@ public:
|
||||
|
||||
@param enableAutoResizing
|
||||
If @true, automatic column resizing is enabled (only applicable
|
||||
if window style wxPG_SPLITTER_AUTO_CENTER is used).
|
||||
if window style ::wxPG_SPLITTER_AUTO_CENTER is used).
|
||||
*/
|
||||
void CenterSplitter( bool enableAutoResizing = false );
|
||||
|
||||
@@ -687,7 +687,7 @@ public:
|
||||
enable.
|
||||
|
||||
@remarks This functions deselects selected property, if any. Validation
|
||||
failure option wxPG_VFB_STAY_IN_PROPERTY is not respected, i.e.
|
||||
failure option ::wxPG_VFB_STAY_IN_PROPERTY is not respected, i.e.
|
||||
selection is cleared even if editor had invalid value.
|
||||
*/
|
||||
bool EnableCategories( bool enable );
|
||||
@@ -716,7 +716,7 @@ public:
|
||||
|
||||
@return Minimum size for the grid to still display everything.
|
||||
|
||||
@remarks Does not work well with wxPG_SPLITTER_AUTO_CENTER window style.
|
||||
@remarks Does not work well with ::wxPG_SPLITTER_AUTO_CENTER window style.
|
||||
|
||||
This function only works properly if grid size prior to call was
|
||||
already fairly large.
|
||||
@@ -918,7 +918,7 @@ public:
|
||||
wxPropertyGridHitTestResult HitTest( const wxPoint& pt ) const;
|
||||
|
||||
/**
|
||||
Returns true if any property has been modified by the user.
|
||||
Returns @true if any property has been modified by the user.
|
||||
*/
|
||||
bool IsAnyModified() const;
|
||||
|
||||
@@ -928,7 +928,7 @@ public:
|
||||
bool IsEditorFocused() const;
|
||||
|
||||
/**
|
||||
Returns true if updating is frozen (i.e. Freeze() called but not
|
||||
Returns @true if updating is frozen (i.e. Freeze() called but not
|
||||
yet Thaw() ).
|
||||
*/
|
||||
bool IsFrozen() const;
|
||||
@@ -997,7 +997,7 @@ public:
|
||||
|
||||
@param enableAutoResizing
|
||||
If @true, automatic column resizing is enabled (only applicable
|
||||
if window style wxPG_SPLITTER_AUTO_CENTER is used).
|
||||
if window style ::wxPG_SPLITTER_AUTO_CENTER is used).
|
||||
|
||||
@see wxPropertyGridInterface::SetColumnProportion()
|
||||
*/
|
||||
@@ -1011,7 +1011,7 @@ public:
|
||||
|
||||
/**
|
||||
Selects a property. Editor widget is automatically created, but
|
||||
not focused unless focus is true.
|
||||
not focused unless focus is @true.
|
||||
|
||||
@param id
|
||||
Property to select (name or pointer).
|
||||
@@ -1231,10 +1231,15 @@ public:
|
||||
virtual wxStatusBar* GetStatusBar();
|
||||
|
||||
/** Override to customize property validation failure behaviour.
|
||||
|
||||
@param
|
||||
property Property with entered an invalid value
|
||||
|
||||
@param invalidValue
|
||||
Value which failed in validation.
|
||||
|
||||
@return
|
||||
Return true if user is allowed to change to another property even
|
||||
Return @true if user is allowed to change to another property even
|
||||
if current has invalid value.
|
||||
*/
|
||||
virtual bool DoOnValidationFailure( wxPGProperty* property,
|
||||
@@ -1242,7 +1247,7 @@ public:
|
||||
|
||||
/** Override to customize resetting of property validation failure status.
|
||||
@remarks
|
||||
Property is guaranteed to have flag wxPG_PROP_INVALID_VALUE set.
|
||||
Property is guaranteed to have flag ::wxPG_PROP_INVALID_VALUE set.
|
||||
*/
|
||||
virtual void DoOnValidationFailureReset( wxPGProperty* property );
|
||||
|
||||
@@ -1283,7 +1288,7 @@ public:
|
||||
wxVariant GetUncommittedPropertyValue();
|
||||
|
||||
/**
|
||||
Returns true if editor's value was marked modified.
|
||||
Returns @true if editor's value was marked modified.
|
||||
*/
|
||||
bool IsEditorsValueModified() const;
|
||||
|
||||
@@ -1294,7 +1299,7 @@ public:
|
||||
|
||||
/**
|
||||
Call this from wxPGProperty::OnEvent() to cause property value to be
|
||||
changed after the function returns (with true as return value).
|
||||
changed after the function returns (with @true as return value).
|
||||
ValueChangeInEvent() must be used if you wish the application to be
|
||||
able to use wxEVT_PG_CHANGING to potentially veto the given value.
|
||||
*/
|
||||
@@ -1307,7 +1312,7 @@ public:
|
||||
if was value was changed using wxPGProperty::SetValueInEvent(), which
|
||||
is usually used when a 'picker' dialog is displayed. If value was
|
||||
written by "normal means" in wxPGProperty::StringToValue() or
|
||||
IntToValue(), then this function will return false (on the other hand,
|
||||
IntToValue(), then this function will return @false (on the other hand,
|
||||
wxPGProperty::OnEvent() is not even called in those cases).
|
||||
*/
|
||||
bool WasValueChangedInEvent() const;
|
||||
@@ -1339,7 +1344,7 @@ public:
|
||||
~wxPropertyGridEvent();
|
||||
|
||||
/**
|
||||
Returns true if you can veto the action that the event is signaling.
|
||||
Returns @true if you can veto the action that the event is signaling.
|
||||
*/
|
||||
bool CanVeto() const;
|
||||
|
||||
@@ -1419,14 +1424,14 @@ public:
|
||||
|
||||
/**
|
||||
Sets custom failure message for this time only. Only applies if
|
||||
wxPG_VFB_SHOW_MESSAGE is set in validation failure flags.
|
||||
::wxPG_VFB_SHOW_MESSAGE is set in validation failure flags.
|
||||
*/
|
||||
void SetValidationFailureMessage( const wxString& message );
|
||||
|
||||
/**
|
||||
Call this from your event handler to veto action that the event is
|
||||
signaling. You can only veto a shutdown if wxPropertyGridEvent::CanVeto()
|
||||
returns true.
|
||||
returns @true.
|
||||
|
||||
@remarks Currently only @c wxEVT_PG_CHANGING supports vetoing.
|
||||
*/
|
||||
@@ -1479,8 +1484,21 @@ public:
|
||||
|
||||
/**
|
||||
Appends a new property under bottommost parent.
|
||||
|
||||
@param propClass
|
||||
Property class as string.
|
||||
Property class as string.
|
||||
|
||||
@param propLabel
|
||||
Property label.
|
||||
|
||||
@param propName
|
||||
Property name.
|
||||
|
||||
@param propValue
|
||||
Property value.
|
||||
|
||||
@param pChoices
|
||||
Set of choices for the property (optional).
|
||||
*/
|
||||
wxPGProperty* Add( const wxString& propClass,
|
||||
const wxString& propLabel,
|
||||
@@ -1498,9 +1516,16 @@ public:
|
||||
|
||||
/**
|
||||
Adds attribute to the bottommost property.
|
||||
|
||||
@param name
|
||||
Attribute name.
|
||||
|
||||
@param type
|
||||
Allowed values: "string", (same as string), "int", "bool". Empty string
|
||||
mean autodetect.
|
||||
Allowed values: @c "string", (same as string), @c "int", @c "bool".
|
||||
Empty string means autodetect.
|
||||
|
||||
@param value
|
||||
Attribute value.
|
||||
*/
|
||||
bool AddAttribute( const wxString& name,
|
||||
const wxString& type,
|
||||
|
||||
Reference in New Issue
Block a user