]> git.lyx.org Git - lyx.git/blobdiff - src/TextMetrics.h
Update it.po
[lyx.git] / src / TextMetrics.h
index f100cb862dc92c1bb38083dec4a77b2aff8c4827..cf53faa13282407acd05c6f8278ea3bfed52958d 100644 (file)
 
 #include "support/types.h"
 
+#include <map>
+
 namespace lyx {
 
 class BufferView;
 class Cursor;
 class CursorSlice;
-class DocIterator;
 class MetricsInfo;
 class Text;
 
 /// A map from a Text to the map of paragraphs metrics
 class TextMetrics
 {
+       /// noncopyable
+       TextMetrics(TextMetrics const &);
+       void operator=(TextMetrics const &);
 public:
        /// Default constructor (only here for STL containers).
-       TextMetrics() : bv_(0), text_(0), main_text_(false), max_width_(0) {}
+       TextMetrics() : bv_(0), text_(0), max_width_(0), tight_(false) {}
        /// The only useful constructor.
        TextMetrics(BufferView *, Text *);
 
        ///
        bool contains(pit_type pit) const;
        ///
-       ParagraphMetrics const & parMetrics(pit_type) const;
-       ///
        std::pair<pit_type, ParagraphMetrics const *> first() const;
        ///
        std::pair<pit_type, ParagraphMetrics const *> last() const;
+       /// is this row the last in the text?
+       bool isLastRow(Row const & row) const;
+       /// is this row the first in the text?
+       bool isFirstRow(Row const & row) const;
+       ///
+       void setRowChanged(pit_type pit, pos_type pos);
 
        ///
-       Dimension const & dimension() const { return dim_; }
+       Dimension const & dim() const { return dim_; }
        ///
        Point const & origin() const { return origin_; }
 
-
-       /// compute text metrics.
-       bool metrics(MetricsInfo & mi, Dimension & dim, int min_width = 0);
+       ///
+       ParagraphMetrics const & parMetrics(pit_type) const;
+       ///
+       ParagraphMetrics & parMetrics(pit_type);
 
        ///
        void newParMetricsDown();
        ///
        void newParMetricsUp();
 
+       /// compute text metrics.
+       bool metrics(MetricsInfo const & mi, Dimension & dim, int min_width = 0);
+
+       /// The "nodraw" drawing stage for one single paragraph: set the
+       /// positions of the insets contained in 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
@@ -81,19 +98,19 @@ public:
        /// is this position in the paragraph right-to-left?
        bool isRTL(CursorSlice const & sl, bool boundary) const;
        /// is between pos-1 and pos an RTL<->LTR boundary?
-       bool isRTLBoundary(pit_type pit,
-         pos_type pos) const;
+       bool isRTLBoundary(pit_type pit, pos_type pos) const;
        /// would be a RTL<->LTR boundary between pos and the given font?
-       bool isRTLBoundary(pit_type pit,
-         pos_type pos, Font const & font) const;
+       bool isRTLBoundary(pit_type pit, pos_type pos, Font const & font) const;
 
 
        /// Rebreaks the given paragraph.
        /// \retval true if a full screen redraw is needed.
        /// \retval false if a single paragraph redraw is enough.
-       bool redoParagraph(pit_type const pit);
+       bool redoParagraph(pit_type const pit, bool align_rows = true);
        /// 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; }
@@ -104,8 +121,16 @@ public:
        /// current text height.
        int height() const { return dim_.height(); }
 
-       ///
-       int maxWidth() const { return max_width_; }
+       /**
+        * Returns the left beginning of a row starting at \c pos.
+        * 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;
+       /// Return the left beginning of a row which is not the first one.
+       /// This is the left margin when there is no indentation.
+       int leftMargin(pit_type pit) const;
 
        ///
        int rightMargin(ParagraphMetrics const & pm) const;
@@ -116,41 +141,40 @@ 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);
 
        /// 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;
+
+       // Turn paragraph oh index \c pit into a single row
+       Row tokenizeParagraph(pit_type pit) const;
 
-       /// FIXME??
-       int labelEnd(pit_type const pit) const;
+       // Break the row produced by tokenizeParagraph() into a list of rows.
+       RowList breakParagraph(Row const & row) 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;
+       // Expands the alignment of row \param row in paragraph \param par
+       LyXAlignment getAlign(Paragraph const & par, Row const & row) const;
+       /// Aligns properly the row contents (computes spaces and fills)
+       void setRowAlignment(Row & row, int width) const;
 
-       // Expand the alignment of paragraph \param par at position \param pos
-       LyXAlignment getAlign(Paragraph const & par, pos_type pos) 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;
+       /// 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);
+       InsetList::Element * checkInsetHit(pit_type pit, int x, int y);
 
 
 // Temporary public:
 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.
@@ -180,7 +204,9 @@ public:
            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
+       \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,16 +217,10 @@ public:
        /// x,y are screen coordinates
        void setCursorFromCoordinates(Cursor & cur, int x, int y);
 
-       /// 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;
-
        ///
-       int cursorX(CursorSlice const & cursor, bool boundary) const;
+       int cursorX(CursorSlice const & sl, bool boundary) const;
        ///
-       int cursorY(CursorSlice const & cursor, bool boundary) const;
+       int cursorY(CursorSlice const & sl, bool boundary) const;
 
        ///
        bool cursorHome(Cursor & cur);
@@ -209,32 +229,17 @@ public:
        ///
        void deleteLineForward(Cursor & cur);
 
-       /// is this row the last in the text?
-       bool isLastRow(pit_type pit, Row const & row) const;
-       /// is this row the first in the text?
-       bool isFirstRow(pit_type pit, 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
        /// outermost inset within this Text.
        /// \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;
 
 private:
-       friend class BufferView;
 
        /// The BufferView owner.
        BufferView * bv_;
@@ -243,13 +248,14 @@ 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;
        ///
        mutable ParMetricsCache par_metrics_;
        Dimension dim_;
        int max_width_;
+       /// if true, do not expand insets to max width artificially
+       bool tight_;
        mutable Point origin_;
 
 // temporary public: