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

Update documentation bout querying for property attributes

Browse Source 
Describe what is returned when corresponding functions are queried for values of built-in attributes and wxPG_EX_WRITEONLY_BUILTIN_ATTRIBUTES style is set.
This commit is contained in:
Artur Wieczorek
2019-04-22 13:55:27 +02:00
parent cbfff9c944
commit 87318ec4ee
1 changed files with 28 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
interface/wx/propgrid/property.h
View File

@@ -1386,28 +1386,52 @@ public:
/** /**
Returns property attribute value, null variant if not found. 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; 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; 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; 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; 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; const wxPGAttributeStorage& GetAttributes() const;
/** /**
Returns attributes as list wxVariant. 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; wxVariant GetAttributesAsList() const;