src/ParagraphMetrics.h

   1 // -*- C++ -*-
   2 /**
   3  * \file ParagraphMetrics.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Asger Alstrup
   8  * \author Lars Gullik Bjønnes
   9  * \author John Levon
  10  * \author André Pönitz
  11  * \author Jürgen Vigna
  12  * \author Abdelrazak Younes
  13  *
  14  * Full author contact details are available in file CREDITS.
  15  */
  16
  17 #ifndef PARAGRAPH_METRICS_H
  18 #define PARAGRAPH_METRICS_H
  19
  20 #include "Dimension.h"
  21 #include "Row.h"
  22
  23 #include <map>
  24 #include <vector>
  25
  26 namespace lyx {
  27
  28 /**
  29  * Each paragraph is broken up into a number of rows on the screen.
  30  * This is a list of such on-screen rows, ordered from the top row
  31  * downwards.
  32  */
  33 typedef std::vector<Row> RowList;
  34
  35 class Buffer;
  36 class BufferView;
  37 class BufferParams;
  38 class Font;
  39 class Inset;
  40 class Paragraph;
  41 class MetricsInfo;
  42 class PainterInfo;
  43
  44 /// Helper class for paragraph metrics.
  45 class ParagraphMetrics {
  46 public:
  47         /// Default constructor (only here for STL containers).
  48         ParagraphMetrics() : position_(0), par_(0) {}
  49         /// The only useful constructor.
  50         explicit ParagraphMetrics(Paragraph const & par);
  51
  52         /// Copy operator.
  53         ParagraphMetrics & operator=(ParagraphMetrics const &);
  54
  55         void reset(Paragraph const & par);
  56
  57         ///
  58         Row & getRow(pos_type pos, bool boundary);
  59         ///
  60         Row const & getRow(pos_type pos, bool boundary) const;
  61         ///
  62         size_t pos2row(pos_type pos) const;
  63
  64         /// TextMetrics::redoParagraph updates this
  65         Dimension const & dim() const { return dim_; }
  66         Dimension & dim() { return dim_; }
  67         /// total height of paragraph
  68         int height() const { return dim_.height(); }
  69         /// total width of paragraph, may differ from workwidth
  70         int width() const { return dim_.width(); }
  71         /// ascend of paragraph above baseline
  72         int ascent() const { return dim_.ascent(); }
  73         /// descend of paragraph below baseline
  74         int descent() const { return dim_.descent(); }
  75         /// Text updates the rows using this access point
  76         RowList & rows() { return rows_; }
  77         /// The painter and others use this
  78         RowList const & rows() const { return rows_; }
  79         ///
  80         int rightMargin(BufferView const & bv) const;
  81
  82         /// dump some information to lyxerr
  83         void dump() const;
  84
  85         ///
  86         bool hfillExpansion(Row const & row, pos_type pos) const;
  87
  88         ///
  89         int position() const { return position_; }
  90         void setPosition(int position);
  91
  92 private:
  93         ///
  94         int position_;
  95         ///
  96         mutable RowList rows_;
  97         /// cached dimensions of paragraph
  98         Dimension dim_;
  99         ///
 100         Paragraph const * par_;
 101 };
 102
 103 } // namespace lyx
 104
 105 #endif // PARAGRAPH_METRICS_H