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