AuroraMiddleware/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Synchronize wxPropertyGrid documentation with the real API.

Browse Source 
Document DoRegisterEditorClass() (even though it's not really clear whether it
should be documented); remove the inexistent SetButtonShortcut() documentation
and other minor fixes.

Closes #13995.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70638 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin 2012-02-20 21:56:03 +00:00
parent f030ce0cff
commit 5aabd64cf2
1 changed files with 7 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
interface/wx/propgrid/propgrid.h
View File

@ -481,7 +481,7 @@ public:
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = wxPG_DEFAULT_STYLE,
const wxChar* name = wxPropertyGridNameStr );
const wxString& name = wxPropertyGridNameStr );
/** Destructor */
virtual ~wxPropertyGrid();
@ -597,7 +597,7 @@ public:
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = wxPG_DEFAULT_STYLE,
const wxChar* name = wxPropertyGridNameStr );
const wxString& name = wxPropertyGridNameStr );
/**
Dedicates a specific keycode to wxPropertyGrid. This means that such
@ -892,12 +892,16 @@ public:
*/
virtual void RefreshProperty( wxPGProperty* p );
/** Forwards to DoRegisterEditorClass with empty name. */
static wxPGEditor* RegisterEditorClass( wxPGEditor* editor,
bool noDefCheck = false );
/**
Registers a new editor class.
@return Returns pointer to the editor class instance that should be used.
*/
static wxPGEditor* RegisterEditorClass( wxPGEditor* editor,
static wxPGEditor* DoRegisterEditorClass( wxPGEditor* editor,
const wxString& name,
bool noDefCheck = false );
@ -946,14 +950,6 @@ public:
*/
bool SelectProperty( wxPGPropArg id, bool focus = false );
/**
Changes keyboard shortcut to push the editor button.
@remarks You can set default with keycode 0. Good value for the platform
is guessed, but don't expect it to be very accurate.
*/
void SetButtonShortcut( int keycode, bool ctrlDown = false, bool altDown = false );
/**
Sets category caption background colour.
*/