3 * \file ParagraphMetrics.h
4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Asger Alstrup
8 * \author Lars Gullik Bjønnes
10 * \author André Pönitz
11 * \author Jürgen Vigna
12 * \author Abdelrazak Younes
14 * Full author contact details are available in file CREDITS.
17 #ifndef PARAGRAPH_METRICS_H
18 #define PARAGRAPH_METRICS_H
20 #include "Dimension.h"
28 /// Helper class for paragraph metrics.
29 class ParagraphMetrics {
31 /// Default constructor (only here for STL containers).
33 /// The only useful constructor.
34 explicit ParagraphMetrics(Paragraph const & par);
37 ParagraphMetrics & operator=(ParagraphMetrics const &);
39 void reset(Paragraph const & par);
42 Row const & getRow(pos_type pos, bool boundary) const;
44 size_t pos2row(pos_type pos) const;
46 /// TextMetrics::redoParagraph updates this
47 Dimension const & dim() const { return dim_; }
48 Dimension & dim() { return dim_; }
49 /// total height of paragraph
50 int height() const { return dim_.height(); }
51 /// total width of paragraph, may differ from workwidth
52 int width() const { return dim_.width(); }
53 /// ascend of paragraph above baseline
54 int ascent() const { return dim_.ascent(); }
55 /// descend of paragraph below baseline
56 int descent() const { return dim_.descent(); }
57 /// Text updates the rows using this access point
58 RowList & rows() { return rows_; }
59 /// The painter and others use this
60 RowList const & rows() const { return rows_; }
62 int rightMargin(BufferView const & bv) const;
64 Paragraph const & par() const { return *par_; }
66 /// dump some information to lyxerr
70 bool hfillExpansion(Row const & row, pos_type pos) const;
73 int position() const { return position_; }
74 void setPosition(int position);
76 int id() const { return id_; }
84 mutable RowList rows_;
85 /// cached dimensions of paragraph
88 Paragraph const * par_ = nullptr;
93 #endif // PARAGRAPH_METRICS_H