Amend cab46ff9d1ea3

[lyx.git] / src / BufferView.h

diff --git a/src/BufferView.h b/src/BufferView.h
index e6a29dee6b9961ffe81bf99fb7bfe68317ec0030..1089781ffdb79ab5d0f64ad6e12f1c34accf0253 100644 (file)
--- a/src/BufferView.h
+++ b/src/BufferView.h
@@ -16,6 +16,7 @@
 #define BUFFER_VIEW_H
 
 #include "DocumentClassPtr.h"
+#include "TexRow.h"
 #include "update_flags.h"
 
 #include "support/strfwd.h"
@@ -40,10 +41,11 @@ class FuncRequest;
 class FuncStatus;
 class Intl;
 class Inset;
-class PainterInfo;
+class Length;
 class ParIterator;
 class ParagraphMetrics;
 class Point;
+class Row;
 class TexRow;
 class Text;
 class TextMetrics;
@@ -104,17 +106,26 @@ public:
        /// left margin
        int leftMargin() const;
 
+       /// return the on-screen size of this length
+       /*
+        *  This is a wrapper around Length::inPixels that uses the
+        *  bufferview width as width and the EM value of the default
+        *  document font.
+        */
+       int inPixels(Length const & len) const;
+
        /// \return true if the BufferView is at the top of the document.
        bool isTopScreen() const;
 
        /// \return true if the BufferView is at the bottom of the document.
        bool isBottomScreen() const;
 
-       /// perform pending metrics updates.
-       /** \c Update::FitCursor means first to do a FitCursor, and to
+       /// Add \p flags to current update flags and trigger an update.
+       /* If this method is invoked several times before the update
+        * actually takes place, the effect is cumulative.
+        * \c Update::FitCursor means first to do a FitCursor, and to
         * force an update if screen position changes.
         * \c Update::Force means to force an update in any case.
-        * \retval true if a screen redraw is needed
         */
        void processUpdateFlags(Update::flags flags);
 
@@ -162,9 +173,9 @@ public:
        void gotoLabel(docstring const & label);
 
        /// set the cursor based on the given TeX source row.
-       void setCursorFromRow(int row);
-       ///
-       void setCursorFromRow(int row, TexRow const & texrow);
+       bool setCursorFromRow(int row);
+       /// set the cursor based on the given start and end TextEntries.
+       bool setCursorFromEntries(TexRow::TextEntry start, TexRow::TextEntry end);
 
        /// set cursor to the given inset. Return true if found.
        bool setCursorFromInset(Inset const *);
@@ -247,7 +258,7 @@ public:
        /// access to full cursor.
        Cursor const & cursor() const;
        /// sets cursor.
-       /// This will also open all relevant collapsable insets.
+       /// This will also open all relevant collapsible insets.
        void setCursor(DocIterator const &);
        /// set the selection up to dit.
        void setCursorSelectionTo(DocIterator const & dit);
@@ -273,6 +284,10 @@ public:
        /// update the internal \c ViewMetricsInfo.
        void updateMetrics();
 
+       // this is the "nodraw" drawing stage: only set the positions of the
+       // insets in metrics cache.
+       void updatePosCache();
+
        ///
        TextMetrics const & textMetrics(Text const * t) const;
        TextMetrics & textMetrics(Text const * t);
@@ -290,12 +305,13 @@ public:
        bool paragraphVisible(DocIterator const & dit) const;
        /// is the cursor currently visible in the view
        bool cursorInView(Point const & p, int h) const;
-       /// get the position and height of the cursor
-       void cursorPosAndHeight(Point & p, int & h) const;
-
+       /// set the ascent and descent of the caret
+       void setCaretAscentDescent(int asc, int des);
+       /// get the position and height of the caret
+       void caretPosAndHeight(Point & p, int & h) const;
 
        ///
-       void draw(frontend::Painter & pain);
+       void draw(frontend::Painter & pain, bool paint_caret);
 
        /// get this view's keyboard map handler.
        Intl & getIntl();
@@ -351,13 +367,15 @@ private:
        /// Update current paragraph metrics.
        /// \return true if no further update is needed.
        bool singleParUpdate();
+       /// do the work for the public updateMetrics()
+       void updateMetrics(Update::flags & update_flags);
 
        // Set the row on which the cursor lives.
        void setCurrentRowSlice(CursorSlice const & rowSlice);
 
        // Check whether the row where the cursor lives needs to be scrolled.
        // Update the drawing strategy if needed.
-       void checkCursorScrollOffset(PainterInfo & pi);
+       void checkCursorScrollOffset();
 
        /// The minimal size of the document that is visible. Used
        /// when it is allowed to scroll below the document.