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 "Paragraph.h"
  21
  22 namespace lyx {
  23
  24 /**
  25  * Each paragraph is broken up into a number of rows on the screen.
  26  * This is a list of such on-screen rows, ordered from the top row
  27  * downwards.
  28  */
  29 typedef std::vector<Row> RowList;
  30
  31 class MetricsInfo;
  32 class PainterInfo;
  33
  34 /// Helper class for Paragraph Metrics.
  35 class ParagraphMetrics  {
  36 public:
  37         /// Default constructor (only here for STL containers).
  38         ParagraphMetrics(): par_(0) {};
  39         /// The only useful constructor.
  40         ParagraphMetrics(Paragraph const & par);
  41
  42         /// Copy operator.
  43         /// Important note: We don't copy \c row_change_status_ and
  44         /// \c row_signature_ because those are updated externally with
  45         /// \c updateRowChangeStatus() in TextMetrics::redoParagraph().
  46         ParagraphMetrics & operator=(ParagraphMetrics const &);
  47
  48         ///
  49         Row & getRow(pos_type pos, bool boundary);
  50         ///
  51         Row const & getRow(pos_type pos, bool boundary) const;
  52         ///
  53         size_t pos2row(pos_type pos) const;
  54
  55         /// BufferView::redoParagraph updates this
  56         Dimension const & dim() const { return dim_; }
  57         Dimension & dim() { return dim_; }
  58         /// total height of paragraph
  59         unsigned int height() const { return dim_.height(); }
  60         /// total width of paragraph, may differ from workwidth
  61         unsigned int width() const { return dim_.width(); }
  62         /// ascend of paragraph above baseline
  63         unsigned int ascent() const { return dim_.ascent(); }
  64         /// descend of paragraph below baseline
  65         unsigned int descent() const { return dim_.descent(); }
  66         /// Text updates the rows using this access point
  67         RowList & rows() { return rows_; }
  68         /// The painter and others use this
  69         RowList const & rows() const { return rows_; }
  70         /// The painter and others use this
  71         std::vector<bool> const & rowChangeStatus() const
  72         { return row_change_status_; }
  73         ///
  74         void updateRowChangeStatus();
  75         ///
  76         int rightMargin(Buffer const & buffer) const;
  77
  78         /// dump some information to lyxerr
  79         void dump() const;
  80
  81 private:
  82         ///
  83         typedef std::vector<size_type> RowSignature;
  84         ///
  85         size_type calculateRowSignature(Row const &);
  86         ///
  87         mutable RowList rows_;
  88         ///
  89         RowSignature row_signature_;
  90         ///
  91         std::vector<bool> row_change_status_;
  92         /// cached dimensions of paragraph
  93         Dimension dim_;
  94         ///
  95         Paragraph const * par_;
  96 };
  97
  98 } // namespace lyx
  99
 100 #endif // PARAGRAPH_METRICS_H