Rename a couple routines in preparation for more.

[lyx.git] / src / TextMetrics.h

diff --git a/src/TextMetrics.h b/src/TextMetrics.h
index 78825c39852b5fb7eeda060d306649fb70f86aa3..9dd68558e910b719919933c6943f4535088cafc5 100644 (file)
--- a/src/TextMetrics.h
+++ b/src/TextMetrics.h
@@ -4,7 +4,7 @@
  * This file is part of LyX, the document processor.
  * Licence details can be found in the file COPYING.
  *
- * \author Lars Gullik Bjønnes
+ * \author Lars Gullik Bjønnes
  * \author John Levon
  * \author Abdelrazak Younes
  *
@@ -176,11 +176,11 @@ public:
        // FIXME: is there a need for this?
        //int pos2x(pit_type pit, pos_type pos) const;
 
-       /** returns row near the specified
-         * y-coordinate in given paragraph (relative to the screen).
-         */
-       Row const & getRowNearY(int y,
-               pit_type pit) const;
+       /// returns the row near the specified y-coordinate in a given paragraph
+       /// (relative to the screen). If assert_in_view is true, it is made sure
+       /// that the row is on screen completely; this might change the given pit.
+       Row const & getPitAndRowNearY(int y, pit_type & pit,
+               bool assert_in_view, bool up);
 
        /// returns the paragraph number closest to screen y-coordinate.
        /// This method uses the BufferView CoordCache to locate the
@@ -193,11 +193,16 @@ public:
        /**
        \return the inset pointer if x,y is covering that inset
        \param x,y are absolute screen coordinates.
+       \param assert_in_view if true the cursor will be set on a row
+           that is completely visible
+    \param up whether we are going up or down (only used when
+           assert_in_view is true
        \retval inset is non-null if the cursor is positionned inside
        */
        /// FIXME: cleanup to use BufferView::getCoveringInset() and
        /// setCursorFromCoordinates() instead of checkInsetHit().
-       Inset * editXY(Cursor & cur, int x, int y);
+       Inset * editXY(Cursor & cur, int x, int y,
+               bool assert_in_view = false, bool up = true);
 
        /// sets cursor only within this Text.
        /// x,y are screen coordinates