From 87318ec4eed96fd6f27196af1097660b6f8f7323 Mon Sep 17 00:00:00 2001 From: Artur Wieczorek Date: Mon, 22 Apr 2019 13:55:27 +0200 Subject: [PATCH] Update documentation bout querying for property attributes Describe what is returned when corresponding functions are queried for values of built-in attributes and wxPG_EX_WRITEONLY_BUILTIN_ATTRIBUTES style is set. --- interface/wx/propgrid/property.h | 32 ++++++++++++++++++++++++++++---- 1 file changed, 28 insertions(+), 4 deletions(-) diff --git a/interface/wx/propgrid/property.h b/interface/wx/propgrid/property.h index ad98d42629..934222321f 100644 --- a/interface/wx/propgrid/property.h +++ b/interface/wx/propgrid/property.h @@ -1386,28 +1386,52 @@ public: /** Returns property attribute value, null variant if not found. + + @remarks + For built-in atrribute returns null variant if extra style + ::wxPG_EX_WRITEONLY_BUILTIN_ATTRIBUTES is set. */ wxVariant GetAttribute( const wxString& name ) const; - /** Returns named attribute, as string, if found. Otherwise defVal is returned. + /** Returns named attribute, as string, if found. Otherwise @a defVal is returned. + + @remarks + For built-in atrribute returns @a defVal if extra style + ::wxPG_EX_WRITEONLY_BUILTIN_ATTRIBUTES is set. */ wxString GetAttribute( const wxString& name, const wxString& defVal ) const; - /** Returns named attribute, as long, if found. Otherwise defVal is returned. + /** Returns named attribute, as long, if found. Otherwise @a defVal is returned. + + @remarks + For built-in atrribute returns @a defVal if extra style + ::wxPG_EX_WRITEONLY_BUILTIN_ATTRIBUTES is set. */ long GetAttributeAsLong( const wxString& name, long defVal ) const; - /** Returns named attribute, as double, if found. Otherwise defVal is returned. + /** Returns named attribute, as double, if found. Otherwise @a defVal is returned. + + @remarks + For built-in atrribute returns @a defVal if extra style + ::wxPG_EX_WRITEONLY_BUILTIN_ATTRIBUTES is set. */ double GetAttributeAsDouble( const wxString& name, double defVal ) const; /** - Returns comma-delimited string of property attributes. + Returns map-like storage of property's attributes. + + @remarks + If extra style wxPG_EX_WRITEONLY_BUILTIN_ATTRIBUTES is set, + then builtin-attributes are not included in the storage. */ const wxPGAttributeStorage& GetAttributes() const; /** Returns attributes as list wxVariant. + + @remarks + If extra style ::wxPG_EX_WRITEONLY_BUILTIN_ATTRIBUTES is set, + then builtin-attributes are not included in the list. */ wxVariant GetAttributesAsList() const;