]> git.lyx.org Git - lyx.git/blobdiff - src/TextMetrics.h
getting rid of more superfluous lyx::support:: statements.
[lyx.git] / src / TextMetrics.h
index 3d2cae5e401b53e62f18310a07caf6bf8b9e780e..fccb2678b75d9da9b7aa285eec87f99a3e5c4d74 100644 (file)
 #ifndef TEXT_METRICS_H
 #define TEXT_METRICS_H
 
+#include "Font.h"
 #include "ParagraphMetrics.h"
 
 #include "support/types.h"
 
-#include <map>
-
-
 namespace lyx {
 
 class BufferView;
-class Text;
+class Cursor;
+class CursorSlice;
+class DocIterator;
 class MetricsInfo;
+class Text;
 
 /// A map from a Text to the map of paragraphs metrics
 class TextMetrics
 {
 public:
        /// Default constructor (only here for STL containers).
-       TextMetrics(): text_(0) {}
+       TextMetrics() : text_(0) {}
        /// The only useful constructor.
        TextMetrics(BufferView *, Text *);
+       
+       ///
+       bool has(pit_type pit) const;
        ///
        ParagraphMetrics const & parMetrics(pit_type) const;
        ///
-       Dimension const & dimension() const;
-       Dimension const & dimension();
+       std::pair<pit_type, ParagraphMetrics const *> first() const;
+       ///
+       std::pair<pit_type, ParagraphMetrics const *> last() const;
+
+       ///
+       int parPosition(pit_type pit) const;
+
+       ///
+       Dimension const & dimension() const { return dim_; }
+       ///
+       Point const & origin() const { return origin_; }
+
 
        /// compute text metrics.
-       bool metrics(MetricsInfo & mi, Dimension & dim);
+       bool metrics(MetricsInfo & mi, Dimension & dim, int min_width = 0);
+
+       ///
+       void newParMetricsDown();
+       ///
+       void newParMetricsUp();
+
+       /// 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
+       /// are allowed to make cosmetic improvements. For instance make footnotes
+       /// smaller. (Asger)
+       Font getDisplayFont(pit_type pit,
+               pos_type pos) const;
+
+       /// There are currently two font mechanisms in LyX:
+       /// 1. The font attributes in a lyxtext, and
+       /// 2. The inset-specific font properties, defined in an inset's
+       /// metrics() and draw() methods and handed down the inset chain through
+       /// the pi/mi parameters, and stored locally in a lyxtext in font_.
+       /// This is where the two are integrated in the final fully realized
+       /// font.
+       void applyOuterFont(Font &) const;
+
+       /// 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;
+       /// would be a RTL<->LTR boundary between pos and the given font?
+       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);
+       /// Clear cache of paragraph metrics
+       void clear() { par_metrics_.clear(); }
 
        ///
        int ascent() const { return dim_.asc; }
@@ -60,6 +108,8 @@ public:
 
        ///
        int maxWidth() const { return max_width_; }
+       ///
+       int singleWidth(pit_type const pit,     pos_type pos) const;
 
        ///
        int rightMargin(ParagraphMetrics const & pm) const;
@@ -67,28 +117,50 @@ public:
 
        /** this calculates the specified parameters. needed when setting
         * the cursor and when creating a visible row */
-       RowMetrics computeRowMetrics(pit_type pit, Row const & row) const;
+       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;
 
 private:
        ///
        ParagraphMetrics & parMetrics(pit_type, bool redo_paragraph);
 
        /// the minimum space a manual label needs on the screen in pixels
-       int labelFill(Paragraph const & par, Row const & row) const;
+       int labelFill(pit_type const pit, 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 rowBreakPoint(int width, pit_type const pit, Row & row) const;
+       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
-       void setRowWidth(int right_margin, pit_type const pit, Row & row) const;
-
-       /// Calculate and set the height of the row
-       void setHeightOfRow(pit_type, Row & row);
+       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;
 
 // Temporary public:
 public:
@@ -104,6 +176,71 @@ 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 paragraph number closest to screen y-coordinate.
+       /// This method uses the BufferView CoordCache to locate the
+       /// paragraph. The y-coodinate is allowed to be off-screen and
+       /// the CoordCache will be automatically updated if needed. This is
+       /// the reason why we need a non const BufferView.
+       pit_type getPitNearY(int y);
+
+       /// sets cursor recursively descending into nested editable insets
+       /**
+       \return the inset pointer if x,y is covering that inset
+       \param x,y are absolute screen coordinates.
+       \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);
+
+       /// 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;
+
+       ///
+       void cursorPrevious(Cursor & cur);
+       ///
+       void cursorNext(Cursor & cur);
+       ///
+       bool cursorHome(Cursor & cur);
+       ///
+       bool cursorEnd(Cursor & cur);
+       ///
+       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;
+
 private:
 
        /// The BufferView owner.
@@ -120,16 +257,17 @@ private:
        mutable ParMetricsCache par_metrics_;
        Dimension dim_;
        int max_width_;
+       mutable Point origin_;
 
-       /// FIXME: transfer this code in CoordCache here.
-       /*
-       /// A map from paragraph index number to screen point
-       typedef std::map<pit_type, Point> InnerParPosCache;
-       /// A map from a Text to the map of paragraphs to screen points
-       typedef std::map<Text const *, InnerParPosCache> ParPosCache;
-       /// Paragraph grouped by owning text
-       ParPosCache pars_;
-       */
+// temporary public:
+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 
+       /// that are not clear... to hand hand the outermost language and
+       /// also for char style apparently.
+       Font font_;
 };
 
 /// return the default height of a row in pixels, considering font zoom