Updated documentation for some wxPropertyGrid classes.

Updated documentation for wxPGEditor, wxPropertyGridPage, wxPropertyGridManager, wx*Property classes.
Removed doxygen-style comments from header files.
This commit is contained in:
Artur Wieczorek
2016-07-23 23:38:39 +02:00
parent b3d4c870da
commit cd96c664dd
10 changed files with 579 additions and 771 deletions

View File

@@ -80,6 +80,16 @@ public:
*/
int GetSplitterPosition( int col = 0 ) const;
/**
Returns pointer to contained property grid state.
*/
wxPropertyGridPageState* GetStatePtr();
/**
Returns pointer to contained property grid state.
*/
const wxPropertyGridPageState* GetStatePtr() const;
/**
Returns id of the tool bar item that represents this page on
wxPropertyGridManager's wxToolBar.
@@ -95,7 +105,7 @@ public:
virtual void Init();
/**
Return false here to indicate unhandled events should be
Return @false here to indicate unhandled events should be
propagated to manager's parent, as normal.
*/
virtual bool IsHandlingAllEvents() const;
@@ -200,6 +210,21 @@ public:
class wxPropertyGridManager : public wxPanel, public wxPropertyGridInterface
{
public:
/**
The default constructor. The styles to be used are styles valid for
the wxWindow.
*/
wxPropertyGridManager( wxWindow *parent, wxWindowID id = wxID_ANY,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = wxPGMAN_DEFAULT_STYLE,
const wxString& name = wxPropertyGridManagerNameStr );
/**
Destructor.
*/
virtual ~wxPropertyGridManager();
/**
Creates new property page. Note that the first page is not created
automatically.
@@ -259,7 +284,7 @@ public:
Enables or disables (shows/hides) categories according to parameter enable.
@remarks
Calling his may not properly update toolbar buttons.
Calling this may not properly update toolbar buttons.
*/
bool EnableCategories( bool enable );
@@ -291,7 +316,7 @@ public:
wxPropertyGrid* GetGrid();
/**
Similar to GetIterator, but instead returns wxPGVIterator instance,
Similar to GetIterator(), but instead returns wxPGVIterator instance,
which can be useful for forward-iterating through arbitrary property
containers.
*/
@@ -318,6 +343,12 @@ public:
*/
int GetPageByName( const wxString& name ) const;
/**
Returns index for a relevant propertygrid state.
If no match is found, wxNOT_FOUND is returned.
*/
int GetPageByState( const wxPropertyGridPageState* pstate ) const;
/**
Returns number of managed pages.
*/
@@ -365,7 +396,7 @@ public:
@param pageObj
wxPropertyGridPage instance. Manager will take ownership of this
object. If NULL, default page object is constructed.
object. If @NULL, default page object is constructed.
@return Returns pointer to created page.
*/