Collapsable -> Collapsible (part 1)

[lyx.git] / src / BufferView.h

diff --git a/src/BufferView.h b/src/BufferView.h
index a144aee136971a57368ce78feeeb6ff3998def24..a5222599f2cf983f7dc514c53d39ffee8e6e6a48 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"
@@ -32,6 +33,7 @@ class Buffer;
 class Change;
 class CoordCache;
 class Cursor;
+class CursorSlice;
 class DispatchResult;
 class DocIterator;
 class DocumentClass;
@@ -39,9 +41,12 @@ class FuncRequest;
 class FuncStatus;
 class Intl;
 class Inset;
+class Length;
 class ParIterator;
 class ParagraphMetrics;
 class Point;
+class Row;
+class TexRow;
 class Text;
 class TextMetrics;
 
@@ -54,15 +59,15 @@ enum CursorStatus {
 /// Scrollbar Parameters.
 struct ScrollbarParameters
 {
+       // These parameters are normalized against the screen geometry and pixel
+       // coordinates. Position 0 corresponds to the top the the screen.
        ScrollbarParameters()
-               : min(0), max(0), position(0), single_step(1), page_step(1)
+               : min(0), max(0), single_step(1), page_step(1)
        {}
        /// Minimum scrollbar position in pixels.
        int min;
        /// Maximum scrollbar position in pixels.
        int max;
-       /// Current position in the document in pixels.
-       int position;
        /// Line-scroll amount in pixels.
        int single_step;
        /// Page-scroll amount in pixels.
@@ -101,6 +106,14 @@ 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;
 
@@ -115,9 +128,26 @@ public:
         */
        void processUpdateFlags(Update::flags flags);
 
-       /// move the screen to fit the cursor.
+       /// return true if one shall move the screen to fit the cursor.
        /// Only to be called with good y coordinates (after a bv::metrics)
-       bool fitCursor();
+       bool needsFitCursor() const;
+
+       /// returns true if this row needs to be repainted (to erase caret)
+       bool needRepaint(Text const * text, Row const & row) const;
+
+       // Returns the amount of horizontal scrolling applied to the
+       // top-level row where the cursor lies
+       int horizScrollOffset() const;
+       // Returns the amount of horizontal scrolling applied to the
+       // row of text starting at (pit, pos)
+       int horizScrollOffset(Text const * text,
+                             pit_type pit, pos_type pos) const;
+
+       // Returns true if the row of text starting at (pit, pos) was scrolled
+       // at the last draw event.
+       bool hadHorizScrollOffset(Text const * text,
+                              pit_type pit, pos_type pos) const;
+
        /// reset the scrollbar to reflect current view position.
        void updateScrollbar();
        /// return the Scrollbar Parameters.
@@ -145,7 +175,9 @@ public:
        void gotoLabel(docstring const & label);
 
        /// set the cursor based on the given TeX source row.
-       void setCursorFromRow(int row);
+       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 *);
@@ -154,11 +186,11 @@ public:
        void recenter();
        /// Ensure that the BufferView cursor is visible.
        /// This method will automatically scroll and update the BufferView
-       /// if needed.
+       /// (metrics+drawing) if needed.
        void showCursor();
        /// Ensure the passed cursor \p dit is visible.
        /// This method will automatically scroll and update the BufferView
-       /// if needed.
+       /// (metrics+drawing) if needed.
        /// \param recenter Whether the cursor should be centered on screen
        void showCursor(DocIterator const & dit, bool recenter,
                bool update);
@@ -228,8 +260,10 @@ 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);
        /// Check deleteEmptyParagraphMechanism and update metrics if needed.
        /// \retval true if an update was needed.
        bool checkDepm(Cursor & cur, Cursor & old);
@@ -252,6 +286,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);
@@ -269,12 +307,11 @@ 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;
-
+       /// 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();
@@ -331,6 +368,13 @@ private:
        /// \return true if no further update is needed.
        bool singleParUpdate();
 
+       // 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();
+
        /// The minimal size of the document that is visible. Used
        /// when it is allowed to scroll below the document.
        int minVisiblePart();