X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f231df8aa87a1f2a3a68bdaa62e1ee5f07de5ddf..0a7ee6e0f400f0d10b158bc0396be22f59d6ad8f:/include/wx/propgrid/propgridiface.h diff --git a/include/wx/propgrid/propgridiface.h b/include/wx/propgrid/propgridiface.h index 7b4041b4ca..9cc773d493 100644 --- a/include/wx/propgrid/propgridiface.h +++ b/include/wx/propgrid/propgridiface.h @@ -1,17 +1,19 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: wx/propgeid/propgridiface.h +// Name: wx/propgrid/propgridiface.h // Purpose: wxPropertyGridInterface class // Author: Jaakko Salli // Modified by: // Created: 2008-08-24 // RCS-ID: $Id$ // Copyright: (c) Jaakko Salli -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// #ifndef __WX_PROPGRID_PROPGRIDIFACE_H__ #define __WX_PROPGRID_PROPGRIDIFACE_H__ +#include "wx/defs.h" + #if wxUSE_PROPGRID #include "wx/propgrid/property.h" @@ -64,13 +66,11 @@ public: m_ptr.charName = str; m_flags = IsCharPtr; } -#if wxUSE_WCHAR_T wxPGPropArgCls( const wchar_t* str ) { m_ptr.wcharName = str; m_flags = IsWCharPtr; } -#endif /** This constructor is required for NULL. */ wxPGPropArgCls( int ) { @@ -100,9 +100,7 @@ private: { wxPGProperty* property; const char* charName; -#if wxUSE_WCHAR_T const wchar_t* wcharName; -#endif const wxString* stringName; } m_ptr; unsigned char m_flags; @@ -271,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); } /** @@ -284,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 ); @@ -372,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 @@ -870,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. */ @@ -880,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. @@ -1171,12 +1180,10 @@ public: wxVariant v(value); SetPropVal( id, v ); } -#if wxUSE_WCHAR_T void SetPropertyValue( wxPGPropArg id, const wchar_t* value ) { SetPropertyValueString( id, wxString(value) ); } -#endif void SetPropertyValue( wxPGPropArg id, const char* value ) { SetPropertyValueString( id, wxString(value) ); @@ -1378,7 +1385,8 @@ private: { if ( !m_pState ) return NULL; - return static_cast(m_pState->GetGrid()); + + return m_pState->GetGrid(); } friend class wxPropertyGrid;