From d85635c5d84b392ea9dbf5596d1678cc49217adb Mon Sep 17 00:00:00 2001 From: Jaakko Salli Date: Tue, 17 Feb 2009 18:36:35 +0000 Subject: [PATCH] Improved documentation for GetProperty(), GetPropertyByName() git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@58973 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- include/wx/propgrid/propgridiface.h | 12 +++++------- interface/wx/propgrid/propgridiface.h | 14 ++++++++++++-- 2 files changed, 17 insertions(+), 9 deletions(-) diff --git a/include/wx/propgrid/propgridiface.h b/include/wx/propgrid/propgridiface.h index ca8a678be9..7694e80027 100644 --- a/include/wx/propgrid/propgridiface.h +++ b/include/wx/propgrid/propgridiface.h @@ -352,14 +352,12 @@ public: } /** - 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. - If there is no property with such name, returned property id is invalid - ( i.e. it will return false with IsOk method). - @remarks - - Sub-properties (i.e. properties which have parent that is not - category or root) can not be accessed globally by their name. - Instead, use "." in place of "". + @remarks Properties which have non-category, non-root parent + can not be accessed globally by their name. Instead, use + "." instead of "". */ wxPGProperty* GetProperty( const wxString& name ) const { diff --git a/interface/wx/propgrid/propgridiface.h b/interface/wx/propgrid/propgridiface.h index 83bc402577..4303403a13 100644 --- a/interface/wx/propgrid/propgridiface.h +++ b/interface/wx/propgrid/propgridiface.h @@ -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 + "." instead of "". */ 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 + "." instead of "". */ wxPGProperty* GetPropertyByName( const wxString& name ) const; -- 2.45.2