4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Lars Gullik Bjønnes
9 * \author Abdelrazak Younes
11 * Full author contact details are available in file CREDITS.
14 #ifndef TEXT_METRICS_H
15 #define TEXT_METRICS_H
18 #include "InsetList.h"
19 #include "LayoutEnums.h"
20 #include "ParagraphMetrics.h"
22 #include "support/types.h"
33 /// A map from a Text to the map of paragraphs metrics
37 /// Default constructor (only here for STL containers).
38 TextMetrics() : bv_(0), text_(0), max_width_(0) {}
39 /// The only useful constructor.
40 TextMetrics(BufferView *, Text *);
43 bool contains(pit_type pit) const;
45 ParagraphMetrics const & parMetrics(pit_type) const;
47 std::pair<pit_type, ParagraphMetrics const *> first() const;
49 std::pair<pit_type, ParagraphMetrics const *> last() const;
52 Dimension const & dimension() const { return dim_; }
54 Point const & origin() const { return origin_; }
57 /// compute text metrics.
58 bool metrics(MetricsInfo & mi, Dimension & dim, int min_width = 0);
61 void newParMetricsDown();
63 void newParMetricsUp();
65 /// Gets the fully instantiated font at a given position in a paragraph
66 /// Basically the same routine as Paragraph::getFont() in Paragraph.cpp.
67 /// The difference is that this one is used for displaying, and thus we
68 /// are allowed to make cosmetic improvements. For instance make footnotes
70 Font displayFont(pit_type pit, pos_type pos) const;
72 /// There are currently two font mechanisms in LyX:
73 /// 1. The font attributes in a lyxtext, and
74 /// 2. The inset-specific font properties, defined in an inset's
75 /// metrics() and draw() methods and handed down the inset chain through
76 /// the pi/mi parameters, and stored locally in a lyxtext in font_.
77 /// This is where the two are integrated in the final fully realized
79 void applyOuterFont(Font &) const;
81 /// is this position in the paragraph right-to-left?
82 bool isRTL(CursorSlice const & sl, bool boundary) const;
83 /// is between pos-1 and pos an RTL<->LTR boundary?
84 bool isRTLBoundary(pit_type pit,
86 /// would be a RTL<->LTR boundary between pos and the given font?
87 bool isRTLBoundary(pit_type pit,
88 pos_type pos, Font const & font) const;
91 /// Rebreaks the given paragraph.
92 /// \retval true if a full screen redraw is needed.
93 /// \retval false if a single paragraph redraw is enough.
94 bool redoParagraph(pit_type const pit);
95 /// Clear cache of paragraph metrics
96 void clear() { par_metrics_.clear(); }
99 int ascent() const { return dim_.asc; }
101 int descent() const { return dim_.des; }
102 /// current text width.
103 int width() const { return dim_.wid; }
104 /// current text height.
105 int height() const { return dim_.height(); }
108 int rightMargin(ParagraphMetrics const & pm) const;
109 int rightMargin(pit_type const pit) const;
112 void draw(PainterInfo & pi, int x, int y) const;
114 void drawParagraph(PainterInfo & pi, pit_type pit, int x, int y) const;
118 ParagraphMetrics & parMetrics(pit_type, bool redo_paragraph);
120 /// the minimum space a manual label needs on the screen in pixels
121 int labelFill(Row const & row) const;
124 int labelEnd(pit_type const pit) const;
126 /// sets row.end to the pos value *after* which a row should break.
127 /// for example, the pos after which isNewLine(pos) == true
128 /// \return true when another row is required (after a newline)
129 bool breakRow(Row & row, int right_margin) const;
131 // Expand the alignment of row \param row in paragraph \param par
132 LyXAlignment getAlign(Paragraph const & par, Row const & row) const;
133 /** this calculates the specified parameters. needed when setting
134 * the cursor and when creating a visible row */
135 void computeRowMetrics(Row & row, int width) const;
137 /// Set the height of the row (without space above/below paragraph)
138 void setRowHeight(Row & row) const;
139 // Compute the space on top of a paragraph
140 int parTopSpacing(pit_type pit) const;
141 // Compute the space below a a paragraph
142 int parBottomSpacing(pit_type pit) const;
144 // Helper function for the other checkInsetHit method.
145 InsetList::InsetTable * checkInsetHit(pit_type pit, int x, int y);
150 /// returns the position near the specified x-coordinate of the row.
151 /// x is an absolute screen coord, it is set to the real beginning
152 /// of this column. This takes in account horizontal cursor row scrolling.
153 pos_type getPosNearX(Row const & row, int & x, bool & boundary) const;
155 /// returns pos in given par at given x coord.
156 pos_type x2pos(pit_type pit, int row, int x) const;
158 // FIXME: is there a need for this?
159 //int pos2x(pit_type pit, pos_type pos) const;
161 /// returns the row near the specified y-coordinate in a given paragraph
162 /// (relative to the screen). If assert_in_view is true, it is made sure
163 /// that the row is on screen completely; this might change the given pit.
164 Row const & getPitAndRowNearY(int & y, pit_type & pit,
165 bool assert_in_view, bool up);
167 /// returns the paragraph number closest to screen y-coordinate.
168 /// This method uses the BufferView CoordCache to locate the
169 /// paragraph. The y-coodinate is allowed to be off-screen and
170 /// the CoordCache will be automatically updated if needed. This is
171 /// the reason why we need a non const BufferView.
172 pit_type getPitNearY(int y);
174 /// sets cursor recursively descending into nested editable insets
176 \return the inset pointer if x,y is covering that inset
177 \param x,y are absolute screen coordinates.
178 \param assert_in_view if true the cursor will be set on a row
179 that is completely visible
180 \param up whether we are going up or down (only used when
181 assert_in_view is true
182 \retval inset is non-null if the cursor is positionned inside
184 /// FIXME: cleanup to use BufferView::getCoveringInset() and
185 /// setCursorFromCoordinates() instead of checkInsetHit().
186 Inset * editXY(Cursor & cur, int x, int y,
187 bool assert_in_view = false, bool up = true);
189 /// sets cursor only within this Text.
190 /// x,y are screen coordinates
191 void setCursorFromCoordinates(Cursor & cur, int x, int y);
193 /// Helper function: find row element that contains pos, and
194 /// compute x offset.
195 Row::const_iterator const
196 findRowElement(Row const & row, pos_type const pos,
197 bool const boundary, double & x) const;
200 int cursorX(CursorSlice const & cursor, bool boundary) const;
202 int cursorY(CursorSlice const & cursor, bool boundary) const;
205 bool cursorHome(Cursor & cur);
207 bool cursorEnd(Cursor & cur);
209 void deleteLineForward(Cursor & cur);
211 /// is this row the last in the text?
212 bool isLastRow(Row const & row) const;
213 /// is this row the first in the text?
214 bool isFirstRow(Row const & row) const;
216 /// Returns an inset if inset was hit, or 0 if not.
217 /// \warning This method is not recursive! It will return the
218 /// outermost inset within this Text.
219 /// \sa BufferView::getCoveringInset() to get the innermost inset.
220 Inset * checkInsetHit(int x, int y);
223 * Returns the left beginning of the text.
224 * This information cannot be taken from the layout object, because
225 * in LaTeX the beginning of the text fits in some cases
226 * (for example sections) exactly the label-width.
228 int leftMargin(int max_width, pit_type pit, pos_type pos) const;
229 int leftMargin(int max_width, pit_type pit) const;
231 /// calculates the position of a completion popup
232 void completionPosAndDim(Cursor const & cur, int & x, int & y,
233 Dimension & dim) const;
236 friend class BufferView;
238 /// The BufferView owner.
241 /// The text contents (the model).
242 /// \todo FIXME: this should be const.
245 /// A map from paragraph index number to paragraph metrics
246 typedef std::map<pit_type, ParagraphMetrics> ParMetricsCache;
248 mutable ParMetricsCache par_metrics_;
251 mutable Point origin_;
255 /// our 'outermost' font.
256 /// This is handed down from the surrounding
257 /// inset through the pi/mi parameter (pi.base.font)
258 /// It is used in applyOuterFont() and setCharFont() for reasons
259 /// that are not clear... to hand hand the outermost language and
260 /// also for char style apparently.
264 /// return the default height of a row in pixels, considering font zoom
265 int defaultRowHeight();
269 #endif // TEXT_METRICS_H