X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/526954c5968baa29218c994ec48e476ae2bd4b9f..726cc8697cd44a41b43257f05ca8cdd42b71a711:/include/wx/propgrid/propgridiface.h?ds=sidebyside diff --git a/include/wx/propgrid/propgridiface.h b/include/wx/propgrid/propgridiface.h index 839ade4774..9cc773d493 100644 --- a/include/wx/propgrid/propgridiface.h +++ b/include/wx/propgrid/propgridiface.h @@ -1,5 +1,5 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: wx/propgeid/propgridiface.h +// Name: wx/propgrid/propgridiface.h // Purpose: wxPropertyGridInterface class // Author: Jaakko Salli // Modified by: @@ -12,6 +12,8 @@ #ifndef __WX_PROPGRID_PROPGRIDIFACE_H__ #define __WX_PROPGRID_PROPGRIDIFACE_H__ +#include "wx/defs.h" + #if wxUSE_PROPGRID #include "wx/propgrid/property.h" @@ -267,7 +269,11 @@ public: */ wxPGProperty* RemoveProperty( wxPGPropArg id ); - /** Disables property. */ + /** + Disables a property. + + @see EnableProperty(), wxPGProperty::Enable() + */ bool DisableProperty( wxPGPropArg id ) { return EnableProperty(id,false); } /** @@ -280,7 +286,14 @@ public: /** Enables or disables property, depending on whether enable is true or - false. + false. Disabled property usually appears as having grey text. + + @param id + Name or pointer to a property. + @param enable + If @false, property is disabled instead. + + @see wxPGProperty::Enable() */ bool EnableProperty( wxPGPropArg id, bool enable = true ); @@ -368,7 +381,7 @@ public: 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 + cannot be accessed globally by their name. Instead, use "." instead of "". */ wxPGProperty* GetProperty( const wxString& name ) const @@ -866,7 +879,7 @@ public: wxString SaveEditableState( int includedStates = AllStates ) const; /** - Lets user to set the strings listed in the choice dropdown of a + Lets user set the strings listed in the choice dropdown of a wxBoolProperty. Defaults are "True" and "False", so changing them to, say, "Yes" and "No" may be useful in some less technical applications. */ @@ -876,7 +889,7 @@ public: /** Set proportion of a auto-stretchable column. wxPG_SPLITTER_AUTO_CENTER window style needs to be used to indicate that columns are auto- - resizeable. + resizable. @returns Returns @false on failure. @@ -1372,7 +1385,8 @@ private: { if ( !m_pState ) return NULL; - return static_cast(m_pState->GetGrid()); + + return m_pState->GetGrid(); } friend class wxPropertyGrid;