]> 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 be44d4f45ae506bd3aaee7597d486021546d4700..ae99490955f948a180dcbd24c6a74ed0dd98cade 100644 (file)
@@ -15,6 +15,8 @@
 #define TEXT_METRICS_H
 
 #include "Font.h"
+#include "InsetList.h"
+#include "LayoutEnums.h"
 #include "ParagraphMetrics.h"
 
 #include "support/types.h"
@@ -33,10 +35,10 @@ 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 *);
-       
+
        ///
        bool contains(pit_type pit) const;
        ///
@@ -46,9 +48,6 @@ public:
        ///
        std::pair<pit_type, ParagraphMetrics const *> last() const;
 
-       ///
-       int parPosition(pit_type pit) const;
-
        ///
        Dimension const & dimension() const { return dim_; }
        ///
@@ -63,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
@@ -95,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; }
@@ -102,73 +108,65 @@ public:
        int descent() const { return dim_.des; }
        /// current text width.
        int width() const { return dim_.wid; }
-       /// current text heigth.
+       /// current text height.
        int height() const { return dim_.height(); }
 
-       ///
-       int maxWidth() const { return max_width_; }
-       ///
-       int singleWidth(pit_type const pit,     pos_type pos) const;
-
        ///
        int rightMargin(ParagraphMetrics const & pm) const;
        int rightMargin(pit_type const pit) 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 draw(PainterInfo & pi, int x, int y) const;
-       
-       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.
-       Dimension rowHeight(
-               pit_type const pit,
-               pos_type const first,
-               pos_type const end,
-               bool topBottomSpace = true) const;
+       void drawParagraph(PainterInfo & pi, pit_type pit, int x, int y) 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
-       pos_type rowBreakPoint(
-               int width,
-               pit_type const pit,
-               pos_type first
-               ) const;
-
-       /// returns the minimum space a row needs on the screen in pixel
-       int rowWidth(
-               int right_margin,
-               pit_type const pit,
-               pos_type const first,
-               pos_type const end
-               ) const;
-
-       /// draw selection for a single row
-       void drawRowSelection(PainterInfo & pi, int x, Row const & row,
-               Cursor const & cur, 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 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(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);
+
 
 // Temporary public:
 public:
-       /// returns the column near the specified x-coordinate of the row.
+       /// 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.
-       pos_type getColumnNearX(pit_type pit, Row const & row, int & x,
-               bool & boundary) const;
+       /// 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.
        pos_type x2pos(pit_type pit, int row, int x) const;
@@ -179,7 +177,7 @@ public:
        /// 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,
+       Row const & getPitAndRowNearY(int y, pit_type & pit,
                bool assert_in_view, bool up);
 
        /// returns the paragraph number closest to screen y-coordinate.
@@ -195,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().
@@ -209,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);
@@ -223,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
@@ -233,17 +231,8 @@ 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, 
+       void completionPosAndDim(Cursor const & cur, int & x, int & y,
                Dimension & dim) const;
 
 private:
@@ -256,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;
        ///
@@ -270,7 +258,7 @@ public:
        /// our 'outermost' font.
        /// This is handed down from the surrounding
        /// inset through the pi/mi parameter (pi.base.font)
-       /// It is used in applyOuterFont() and setCharFont() for reasons 
+       /// It is used in applyOuterFont() and setCharFont() for reasons
        /// that are not clear... to hand hand the outermost language and
        /// also for char style apparently.
        Font font_;