* lyxtext.h: add comments to checkInsetHit() and editXY()

git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@17611 a592a061-630c-0410-9148-cb99ea01b6c8

diff --git a/src/lyxtext.h b/src/lyxtext.h
index e1c4dc378b20708439e0c999f6d8d20fbd7a1dcf..0adb4b29510ad62ea81ae50935e5b920357b79a8 100644 (file)
--- a/src/lyxtext.h
+++ b/src/lyxtext.h
@@ -191,6 +191,8 @@ public:
        \retval inset is non-null if the cursor is positionned inside
        */
        /// FIXME: move to TextMetrics.
+       /// FIXME: cleanup to use BufferView::getCoveringInset() and
+       /// setCursorFromCoordinates() instead of checkInsetHit().
        InsetBase * editXY(LCursor & cur, int x, int y);
        
        /// Move cursor one line up.
@@ -283,6 +285,9 @@ public:
        void insertStringAsParagraphs(LCursor & cur, docstring const & str);
 
        /// Returns an inset if inset was hit, or 0 if not.
+       /// \warning This method is not recursive! It will return the
+       /// outermost inset within this LyXText.
+       /// \sa BufferView::getCoveringInset() to get the innermost inset.
        InsetBase * checkInsetHit(BufferView &, int x, int y);
 
        ///