Improved documentation for GetProperty(), GetPropertyByName()

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@58973 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Jaakko Salli
2009-02-17 18:36:35 +00:00
parent 0c35994d50
commit d85635c5d8
2 changed files with 17 additions and 9 deletions

View File

@@ -245,7 +245,12 @@ public:
wxPGProperty* GetFirst( int flags = wxPG_ITERATE_ALL );
/**
Returns id of property with given name (case-sensitive).
Returns pointer to a property with given name (case-sensitive).
If there is no property with such name, @NULL pointer is returned.
@remarks Properties which have non-category, non-root parent
can not be accessed globally by their name. Instead, use
"<property>.<subproperty>" instead of "<subproperty>".
*/
wxPGProperty* GetProperty( const wxString& name ) const;
@@ -296,7 +301,12 @@ public:
wxPGProperty* GetPropertyByLabel( const wxString& label ) const;
/**
Returns property with given name. @NULL if none found.
Returns pointer to a property with given name (case-sensitive).
If there is no property with such name, @NULL pointer is returned.
@remarks Properties which have non-category, non-root parent
can not be accessed globally by their name. Instead, use
"<property>.<subproperty>" instead of "<subproperty>".
*/
wxPGProperty* GetPropertyByName( const wxString& name ) const;