Clarified wxPropertyGrid::HitTest() docs

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@58884 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Jaakko Salli
2009-02-13 16:15:12 +00:00
parent 496e7ec647
commit e276acb530
3 changed files with 17 additions and 20 deletions

View File

@@ -885,10 +885,13 @@ public:
bool IsEditorsValueModified() const bool IsEditorsValueModified() const
{ return ( m_iFlags & wxPG_FL_VALUE_MODIFIED ) ? true : false; } { return ( m_iFlags & wxPG_FL_VALUE_MODIFIED ) ? true : false; }
/** Returns information about arbitrary position in the grid. /**
Returns information about arbitrary position in the grid.
For wxPropertyGridHitTestResult definition, see @param pt
wxPropertyGridPageState::HitTest(). Logical coordinates in the virtual grid space. Use
wxScrolledWindow::CalcUnscrolledPosition() if you need to
translate a scrolled position into a logical one.
*/ */
wxPropertyGridHitTestResult HitTest( const wxPoint& pt ) const; wxPropertyGridHitTestResult HitTest( const wxPoint& pt ) const;

View File

@@ -542,24 +542,13 @@ public:
unsigned int col, unsigned int col,
bool subProps) const; bool subProps) const;
/** Returns information about arbitrary position in the grid. /**
Returns information about arbitrary position in the grid.
wxPropertyGridHitTestResult definition: @param pt
@code Logical coordinates in the virtual grid space. Use
struct wxPropertyGridHitTestResult wxScrolledWindow::CalcUnscrolledPosition() if you need to
{ translate a scrolled position into a logical one.
wxPGProperty* GetProperty() const;
// column. -1 for margin
int column;
// Index of splitter hit, -1 for none.
int splitter;
// If splitter hit, then offset to that.
int splitterHitOffset;
};
@endcode
*/ */
wxPropertyGridHitTestResult HitTest( const wxPoint& pt ) const; wxPropertyGridHitTestResult HitTest( const wxPoint& pt ) const;

View File

@@ -672,6 +672,11 @@ public:
/** /**
Returns information about arbitrary position in the grid. Returns information about arbitrary position in the grid.
@param pt
Logical coordinates in the virtual grid space. Use
wxScrolledWindow::CalcUnscrolledPosition() if you need to
translate a scrolled position into a logical one.
*/ */
wxPropertyGridHitTestResult HitTest( const wxPoint& pt ) const; wxPropertyGridHitTestResult HitTest( const wxPoint& pt ) const;