From: Abdelrazak Younes <younes@lyx.org>
Date: Wed, 28 Mar 2007 15:00:34 +0000 (+0000)
Subject: * lyxtext.h: add comments to checkInsetHit() and editXY()
X-Git-Tag: 1.6.10~10446
X-Git-Url: https://git.lyx.org/gitweb/?a=commitdiff_plain;h=d5bedcb8748ac4e003515550c853d40a82592526;p=features.git

* 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 e1c4dc378b..0adb4b2951 100644
--- 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);
 
 	///