]> git.lyx.org Git - lyx.git/blobdiff - src/TextMetrics.h
Provide proper fallback if a bibliography processor is not found
[lyx.git] / src / TextMetrics.h
index 92b1962545e40c4ea5301f81956adb2d567dac21..ae99490955f948a180dcbd24c6a74ed0dd98cade 100644 (file)
@@ -16,6 +16,7 @@
 
 #include "Font.h"
 #include "InsetList.h"
+#include "LayoutEnums.h"
 #include "ParagraphMetrics.h"
 
 #include "support/types.h"
@@ -34,7 +35,7 @@ class TextMetrics
 {
 public:
        /// Default constructor (only here for STL containers).
-       TextMetrics() : text_(0) {}
+       TextMetrics() : bv_(0), text_(0), max_width_(0) {}
        /// The only useful constructor.
        TextMetrics(BufferView *, Text *);
 
@@ -61,6 +62,11 @@ public:
        ///
        void newParMetricsUp();
 
+       /// The "nodraw" drawing stage for one single paragraph: set the
+       /// positions of the insets contained this paragraph in metrics
+       /// cache. Related to BufferView::updatePosCache.
+       void updatePosCache(pit_type pit) const;
+
        /// Gets the fully instantiated font at a given position in a paragraph
        /// Basically the same routine as Paragraph::getFont() in Paragraph.cpp.
        /// The difference is that this one is used for displaying, and thus we
@@ -93,6 +99,8 @@ public:
        bool redoParagraph(pit_type const pit);
        /// Clear cache of paragraph metrics
        void clear() { par_metrics_.clear(); }
+       /// Is cache of paragraph metrics empty ?
+       bool empty() const { return par_metrics_.empty(); }
 
        ///
        int ascent() const { return dim_.asc; }
@@ -103,9 +111,6 @@ public:
        /// current text height.
        int height() const { return dim_.height(); }
 
-       ///
-       int maxWidth() const { return max_width_; }
-
        ///
        int rightMargin(ParagraphMetrics const & pm) const;
        int rightMargin(pit_type const pit) const;
@@ -115,31 +120,42 @@ public:
 
        void drawParagraph(PainterInfo & pi, pit_type pit, int x, int y) const;
 
-       /// Returns the height of the row (width member is set to 0).
-       /// If \c topBottomSpace is true, extra space is added for the
-       /// top and bottom row.
-       void setRowHeight(Row & row, pit_type const pit,
-                         bool topBottomSpace = true) const;
-
 private:
        ///
        ParagraphMetrics & parMetrics(pit_type, bool redo_paragraph);
 
+       /**
+        * Returns the left beginning of the text.
+        * This information cannot be taken from the layout object, because
+        * in LaTeX the beginning of the text fits in some cases
+        * (for example sections) exactly the label-width.
+        */
+       int leftMargin(pit_type pit, pos_type pos) const;
+       int leftMargin(pit_type pit) const;
+
        /// the minimum space a manual label needs on the screen in pixels
-       int labelFill(pit_type const pit, Row const & row) const;
+       int labelFill(Row const & row) const;
 
        /// FIXME??
        int labelEnd(pit_type const pit) const;
 
        /// sets row.end to the pos value *after* which a row should break.
        /// for example, the pos after which isNewLine(pos) == true
-       void breakRow(Row & row, int right_margin, pit_type const pit) const;
+       /// \return true when another row is required (after a newline)
+       bool breakRow(Row & row, int right_margin) const;
 
-       // Expand the alignment of paragraph \param par at position \param pos
-       int getAlign(Paragraph const & par, pos_type pos) const;
+       // Expand the alignment of row \param row in paragraph \param par
+       LyXAlignment getAlign(Paragraph const & par, Row const & row) const;
        /** this calculates the specified parameters. needed when setting
         * the cursor and when creating a visible row */
-       void computeRowMetrics(pit_type pit, Row & row, int width) const;
+       void computeRowMetrics(Row & row, int width) const;
+
+       /// Set the height of the row (without space above/below paragraph)
+       void setRowHeight(Row & row) const;
+       // Compute the space on top of a paragraph
+       int parTopSpacing(pit_type pit) const;
+       // Compute the space below a a paragraph
+       int parBottomSpacing(pit_type pit) const;
 
        // Helper function for the other checkInsetHit method.
        InsetList::InsetTable * checkInsetHit(pit_type pit, int x, int y);
@@ -149,7 +165,7 @@ private:
 public:
        /// returns the position near the specified x-coordinate of the row.
        /// x is an absolute screen coord, it is set to the real beginning
-       /// of this column.
+       /// of this column. This takes in account horizontal cursor row scrolling.
        pos_type getPosNearX(Row const & row, int & x, bool & boundary) const;
 
        /// returns pos in given par at given x coord.
@@ -177,9 +193,11 @@ public:
        \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
+       \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
+       \retval inset is null if the cursor is positioned over normal
+              text in the current Text object. Otherwise it is the inset
+              that the cursor points to, like for Inset::editXY.
        */
        /// FIXME: cleanup to use BufferView::getCoveringInset() and
        /// setCursorFromCoordinates() instead of checkInsetHit().
@@ -191,11 +209,9 @@ public:
        void setCursorFromCoordinates(Cursor & cur, int x, int y);
 
        ///
-       int cursorX(CursorSlice const & cursor,
-               bool boundary) const;
+       int cursorX(CursorSlice const & cursor, bool boundary) const;
        ///
-       int cursorY(CursorSlice const & cursor,
-               bool boundary) const;
+       int cursorY(CursorSlice const & cursor, bool boundary) const;
 
        ///
        bool cursorHome(Cursor & cur);
@@ -205,9 +221,9 @@ public:
        void deleteLineForward(Cursor & cur);
 
        /// is this row the last in the text?
-       bool isLastRow(pit_type pit, Row const & row) const;
+       bool isLastRow(Row const & row) const;
        /// is this row the first in the text?
-       bool isFirstRow(pit_type pit, Row const & row) const;
+       bool isFirstRow(Row const & row) const;
 
        /// Returns an inset if inset was hit, or 0 if not.
        /// \warning This method is not recursive! It will return the
@@ -215,15 +231,6 @@ public:
        /// \sa BufferView::getCoveringInset() to get the innermost inset.
        Inset * checkInsetHit(int x, int y);
 
-       /**
-        * Returns the left beginning of the text.
-        * This information cannot be taken from the layout object, because
-        * in LaTeX the beginning of the text fits in some cases
-        * (for example sections) exactly the label-width.
-        */
-       int leftMargin(int max_width, pit_type pit, pos_type pos) const;
-       int leftMargin(int max_width, pit_type pit) const;
-
        /// calculates the position of a completion popup
        void completionPosAndDim(Cursor const & cur, int & x, int & y,
                Dimension & dim) const;
@@ -238,7 +245,6 @@ private:
        /// \todo FIXME: this should be const.
        Text * text_;
 
-       bool main_text_;
        /// A map from paragraph index number to paragraph metrics
        typedef std::map<pit_type, ParagraphMetrics> ParMetricsCache;
        ///