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 BufferView;
  36 class Paragraph;
  37
  38 /// Helper class for paragraph metrics.
  39 class ParagraphMetrics {
  40 public:
  41         /// Default constructor (only here for STL containers).
  42         ParagraphMetrics() : position_(0), par_(0) {}
  43         /// The only useful constructor.
  44         explicit ParagraphMetrics(Paragraph const & par);
  45
  46         /// Copy operator.
  47         ParagraphMetrics & operator=(ParagraphMetrics const &);
  48
  49         void reset(Paragraph const & par);
  50
  51         ///
  52         Row const & getRow(pos_type pos, bool boundary) const;
  53         ///
  54         size_t pos2row(pos_type pos) const;
  55
  56         /// TextMetrics::redoParagraph updates this
  57         Dimension const & dim() const { return dim_; }
  58         Dimension & dim() { return dim_; }
  59         /// total height of paragraph
  60         int height() const { return dim_.height(); }
  61         /// total width of paragraph, may differ from workwidth
  62         int width() const { return dim_.width(); }
  63         /// ascend of paragraph above baseline
  64         int ascent() const { return dim_.ascent(); }
  65         /// descend of paragraph below baseline
  66         int descent() const { return dim_.descent(); }
  67         /// Text updates the rows using this access point
  68         RowList & rows() { return rows_; }
  69         /// The painter and others use this
  70         RowList const & rows() const { return rows_; }
  71         ///
  72         int rightMargin(BufferView const & bv) const;
  73
  74         /// dump some information to lyxerr
  75         void dump() const;
  76
  77         ///
  78         bool hfillExpansion(Row const & row, pos_type pos) const;
  79
  80         ///
  81         int position() const { return position_; }
  82         void setPosition(int position);
  83
  84 private:
  85         ///
  86         int position_;
  87         ///
  88         mutable RowList rows_;
  89         /// cached dimensions of paragraph
  90         Dimension dim_;
  91         ///
  92         Paragraph const * par_;
  93 };
  94
  95 } // namespace lyx
  96
  97 #endif // PARAGRAPH_METRICS_H