src/TextMetrics.h

   1 // -*- C++ -*-
   2 /**
   3  * \file TextMetrics.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Lars Gullik Bjønnes
   8  * \author John Levon
   9  * \author Abdelrazak Younes
  10  *
  11  * Full author contact details are available in file CREDITS.
  12  */
  13
  14 #ifndef TEXT_METRICS_H
  15 #define TEXT_METRICS_H
  16
  17 #include "ParagraphMetrics.h"
  18
  19 #include "support/types.h"
  20
  21 #include <map>
  22
  23
  24 namespace lyx {
  25
  26 class BufferView;
  27 class Text;
  28 class MetricsInfo;
  29
  30 /// A map from a Text to the map of paragraphs metrics
  31 class TextMetrics
  32 {
  33 public:
  34         /// Default constructor (only here for STL containers).
  35         TextMetrics(): text_(0) {}
  36         /// The only useful constructor.
  37         TextMetrics(BufferView *, Text *);
  38         ///
  39         ParagraphMetrics const & parMetrics(pit_type) const;
  40         ///
  41         Dimension const & dimension() const;
  42         Dimension const & dimension();
  43
  44         /// compute text metrics.
  45         bool metrics(MetricsInfo & mi, Dimension & dim);
  46
  47         /// Rebreaks the given paragraph.
  48         /// \retval true if a full screen redraw is needed.
  49         /// \retval false if a single paragraph redraw is enough.
  50         bool redoParagraph(pit_type const pit);
  51
  52         ///
  53         int ascent() const { return dim_.asc; }
  54         ///
  55         int descent() const { return dim_.des; }
  56         /// current text width.
  57         int width() const { return dim_.wid; }
  58         /// current text heigth.
  59         int height() const { return dim_.height(); }
  60
  61         ///
  62         int maxWidth() const { return max_width_; }
  63
  64         ///
  65         int rightMargin(ParagraphMetrics const & pm) const;
  66         int rightMargin(pit_type const pit) const;
  67
  68         /** this calculates the specified parameters. needed when setting
  69          * the cursor and when creating a visible row */
  70         RowMetrics computeRowMetrics(pit_type pit, Row const & row) const;
  71
  72
  73 private:
  74         ///
  75         ParagraphMetrics & parMetrics(pit_type, bool redo_paragraph);
  76
  77         /// the minimum space a manual label needs on the screen in pixels
  78         int labelFill(Paragraph const & par, Row const & row) const;
  79
  80         /// FIXME??
  81         int labelEnd(pit_type const pit) const;
  82
  83         /// sets row.end to the pos value *after* which a row should break.
  84         /// for example, the pos after which isNewLine(pos) == true
  85         void rowBreakPoint(int width, pit_type const pit, Row & row) const;
  86
  87         /// sets row.width to the minimum space a row needs on the screen in pixel
  88         void setRowWidth(int right_margin, pit_type const pit, Row & row) const;
  89
  90         /// Calculate and set the height of the row
  91         void setHeightOfRow(pit_type, Row & row);
  92
  93 // Temporary public:
  94 public:
  95         /// returns the column near the specified x-coordinate of the row.
  96         /// x is an absolute screen coord, it is set to the real beginning
  97         /// of this column.
  98         pos_type getColumnNearX(pit_type pit, Row const & row, int & x,
  99                 bool & boundary) const;
 100
 101         /// returns pos in given par at given x coord.
 102         pos_type x2pos(pit_type pit, int row, int x) const;
 103
 104         // FIXME: is there a need for this?
 105         //int pos2x(pit_type pit, pos_type pos) const;
 106
 107 private:
 108
 109         /// The BufferView owner.
 110         BufferView * bv_;
 111
 112         /// The text contents (the model).
 113         /// \todo FIXME: this should be const.
 114         Text * text_;
 115
 116         bool main_text_;
 117         /// A map from paragraph index number to paragraph metrics
 118         typedef std::map<pit_type, ParagraphMetrics> ParMetricsCache;
 119         ///
 120         mutable ParMetricsCache par_metrics_;
 121         Dimension dim_;
 122         int max_width_;
 123
 124         /// FIXME: transfer this code in CoordCache here.
 125         /*
 126         /// A map from paragraph index number to screen point
 127         typedef std::map<pit_type, Point> InnerParPosCache;
 128         /// A map from a Text to the map of paragraphs to screen points
 129         typedef std::map<Text const *, InnerParPosCache> ParPosCache;
 130         /// Paragraph grouped by owning text
 131         ParPosCache pars_;
 132         */
 133 };
 134
 135 /// return the default height of a row in pixels, considering font zoom
 136 int defaultRowHeight();
 137
 138 } // namespace lyx
 139
 140 #endif // TEXT_METRICS_H