]> git.lyx.org Git - lyx.git/blobdiff - src/TextMetrics.h
prepare Qt 5.6 builds
[lyx.git] / src / TextMetrics.h
index fccb2678b75d9da9b7aa285eec87f99a3e5c4d74..f0abcb520185a1ed4fd4daf721f0f1e16db008f8 100644 (file)
@@ -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
  *
@@ -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,12 +35,12 @@ class TextMetrics
 {
 public:
        /// Default constructor (only here for STL containers).
-       TextMetrics() : text_(0) {}
+       TextMetrics() : bv_(0), text_(0), main_text_(false), max_width_(0) {}
        /// The only useful constructor.
        TextMetrics(BufferView *, Text *);
-       
+
        ///
-       bool has(pit_type pit) const;
+       bool contains(pit_type pit) const;
        ///
        ParagraphMetrics const & parMetrics(pit_type) 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_; }
        ///
@@ -68,8 +67,7 @@ public:
        /// The difference is that this one is used for displaying, and thus we
        /// are allowed to make cosmetic improvements. For instance make footnotes
        /// smaller. (Asger)
-       Font getDisplayFont(pit_type pit,
-               pos_type pos) const;
+       Font displayFont(pit_type pit, pos_type pos) const;
 
        /// There are currently two font mechanisms in LyX:
        /// 1. The font attributes in a lyxtext, and
@@ -103,27 +101,27 @@ 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.
+       void setRowHeight(Row & row, pit_type const pit,
+                         bool topBottomSpace = true) const;
+
 private:
        ///
        ParagraphMetrics & parMetrics(pit_type, bool redo_paragraph);
@@ -136,39 +134,24 @@ private:
 
        /// sets row.end to the pos value *after* which a row should break.
        /// for example, the pos after which isNewLine(pos) == true
-       pit_type rowBreakPoint(
-               int width,
-               pit_type const pit,
-               pit_type first
-               ) const;
-
-       /// sets row.width to 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;
-
-       /// Calculate and set the height of the row (width member is set to 0)
-       Dimension rowHeight(
-               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,
-               DocIterator const & beg, DocIterator const & end, 
-               bool drawOnBegMargin, bool drawOnEndMargin) const;
+       void breakRow(Row & row, int right_margin, pit_type const pit) 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;
+
+       // 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;
+       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;
@@ -176,11 +159,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,27 +176,32 @@ 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
        void setCursorFromCoordinates(Cursor & cur, int x, int y);
 
-       ///
-       int cursorX(CursorSlice const & cursor,
-               bool boundary) const;
-       ///
-       int cursorY(CursorSlice const & cursor,
-               bool boundary) const;
+       /// Helper function: find row element that contains pos, and
+       /// compute x offset.
+       Row::const_iterator const
+       findRowElement(Row const & row, pos_type const pos,
+                   bool const boundary, double & x) const;
 
        ///
-       void cursorPrevious(Cursor & cur);
+       int cursorX(CursorSlice const & cursor, bool boundary) const;
        ///
-       void cursorNext(Cursor & cur);
+       int cursorY(CursorSlice const & cursor, bool boundary) const;
+
        ///
        bool cursorHome(Cursor & cur);
        ///
@@ -241,7 +229,12 @@ public:
        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;
+
 private:
+       friend class BufferView;
 
        /// The BufferView owner.
        BufferView * bv_;
@@ -264,7 +257,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_;