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 "ParagraphMetrics.h"
20 #include "support/types.h"
31 /// A map from a Text to the map of paragraphs metrics
35 /// Default constructor (only here for STL containers).
36 TextMetrics() : text_(0) {}
37 /// The only useful constructor.
38 TextMetrics(BufferView *, Text *);
41 bool contains(pit_type pit) const;
43 ParagraphMetrics const & parMetrics(pit_type) const;
45 std::pair<pit_type, ParagraphMetrics const *> first() const;
47 std::pair<pit_type, ParagraphMetrics const *> last() const;
50 Dimension const & dimension() const { return dim_; }
52 Point const & origin() const { return origin_; }
55 /// compute text metrics.
56 bool metrics(MetricsInfo & mi, Dimension & dim, int min_width = 0);
59 void newParMetricsDown();
61 void newParMetricsUp();
63 /// Gets the fully instantiated font at a given position in a paragraph
64 /// Basically the same routine as Paragraph::getFont() in Paragraph.cpp.
65 /// The difference is that this one is used for displaying, and thus we
66 /// are allowed to make cosmetic improvements. For instance make footnotes
68 Font displayFont(pit_type pit, pos_type pos) const;
70 /// There are currently two font mechanisms in LyX:
71 /// 1. The font attributes in a lyxtext, and
72 /// 2. The inset-specific font properties, defined in an inset's
73 /// metrics() and draw() methods and handed down the inset chain through
74 /// the pi/mi parameters, and stored locally in a lyxtext in font_.
75 /// This is where the two are integrated in the final fully realized
77 void applyOuterFont(Font &) const;
79 /// is this position in the paragraph right-to-left?
80 bool isRTL(CursorSlice const & sl, bool boundary) const;
81 /// is between pos-1 and pos an RTL<->LTR boundary?
82 bool isRTLBoundary(pit_type pit,
84 /// would be a RTL<->LTR boundary between pos and the given font?
85 bool isRTLBoundary(pit_type pit,
86 pos_type pos, Font const & font) const;
89 /// Rebreaks the given paragraph.
90 /// \retval true if a full screen redraw is needed.
91 /// \retval false if a single paragraph redraw is enough.
92 bool redoParagraph(pit_type const pit);
93 /// Clear cache of paragraph metrics
94 void clear() { par_metrics_.clear(); }
97 int ascent() const { return dim_.asc; }
99 int descent() const { return dim_.des; }
100 /// current text width.
101 int width() const { return dim_.wid; }
102 /// current text heigth.
103 int height() const { return dim_.height(); }
106 int maxWidth() const { return max_width_; }
108 int singleWidth(pit_type const pit, pos_type pos) const;
111 int rightMargin(ParagraphMetrics const & pm) const;
112 int rightMargin(pit_type const pit) const;
114 /** this calculates the specified parameters. needed when setting
115 * the cursor and when creating a visible row */
116 void computeRowMetrics(pit_type pit, Row & row, int width) const;
119 void draw(PainterInfo & pi, int x, int y) const;
121 void drawParagraph(PainterInfo & pi, pit_type pit, int x, int y) const;
123 /// Returns the height of the row (width member is set to 0).
124 /// If \c topBottomSpace is true, extra space is added for the
125 /// top and bottom row.
128 pos_type const first,
130 bool topBottomSpace = true) const;
134 ParagraphMetrics & parMetrics(pit_type, bool redo_paragraph);
136 /// the minimum space a manual label needs on the screen in pixels
137 int labelFill(pit_type const pit, Row const & row) const;
140 int labelEnd(pit_type const pit) const;
142 /// sets row.end to the pos value *after* which a row should break.
143 /// for example, the pos after which isNewLine(pos) == true
144 pos_type rowBreakPoint(
150 /// returns the minimum space a row needs on the screen in pixel
154 pos_type const first,
158 /// draw selection for a single row
159 void drawRowSelection(PainterInfo & pi, int x, Row const & row,
160 Cursor const & cur, pit_type const pit) const;
164 /// returns the column near the specified x-coordinate of the row.
165 /// x is an absolute screen coord, it is set to the real beginning
167 pos_type getColumnNearX(pit_type pit, Row const & row, int & x,
168 bool & boundary) const;
170 /// returns pos in given par at given x coord.
171 pos_type x2pos(pit_type pit, int row, int x) const;
173 // FIXME: is there a need for this?
174 //int pos2x(pit_type pit, pos_type pos) const;
176 /// returns the row near the specified y-coordinate in a given paragraph
177 /// (relative to the screen). If assert_in_view is true, it is made sure
178 /// that the row is on screen completely; this might change the given pit.
179 Row const & getPitAndRowNearY(int & y, pit_type & pit,
180 bool assert_in_view, bool up);
182 /// returns the paragraph number closest to screen y-coordinate.
183 /// This method uses the BufferView CoordCache to locate the
184 /// paragraph. The y-coodinate is allowed to be off-screen and
185 /// the CoordCache will be automatically updated if needed. This is
186 /// the reason why we need a non const BufferView.
187 pit_type getPitNearY(int y);
189 /// sets cursor recursively descending into nested editable insets
191 \return the inset pointer if x,y is covering that inset
192 \param x,y are absolute screen coordinates.
193 \param assert_in_view if true the cursor will be set on a row
194 that is completely visible
195 \param up whether we are going up or down (only used when
196 assert_in_view is true
197 \retval inset is non-null if the cursor is positionned inside
199 /// FIXME: cleanup to use BufferView::getCoveringInset() and
200 /// setCursorFromCoordinates() instead of checkInsetHit().
201 Inset * editXY(Cursor & cur, int x, int y,
202 bool assert_in_view = false, bool up = true);
204 /// sets cursor only within this Text.
205 /// x,y are screen coordinates
206 void setCursorFromCoordinates(Cursor & cur, int x, int y);
209 int cursorX(CursorSlice const & cursor,
210 bool boundary) const;
212 int cursorY(CursorSlice const & cursor,
213 bool boundary) const;
216 bool cursorHome(Cursor & cur);
218 bool cursorEnd(Cursor & cur);
220 void deleteLineForward(Cursor & cur);
222 /// is this row the last in the text?
223 bool isLastRow(pit_type pit, Row const & row) const;
224 /// is this row the first in the text?
225 bool isFirstRow(pit_type pit, Row const & row) const;
227 /// Returns an inset if inset was hit, or 0 if not.
228 /// \warning This method is not recursive! It will return the
229 /// outermost inset within this Text.
230 /// \sa BufferView::getCoveringInset() to get the innermost inset.
231 Inset * checkInsetHit(int x, int y);
234 * Returns the left beginning of the text.
235 * This information cannot be taken from the layout object, because
236 * in LaTeX the beginning of the text fits in some cases
237 * (for example sections) exactly the label-width.
239 int leftMargin(int max_width, pit_type pit, pos_type pos) const;
240 int leftMargin(int max_width, pit_type pit) const;
242 /// calculates the position of a completion popup
243 void completionPosAndDim(Cursor const & cur, int & x, int & y,
244 Dimension & dim) const;
247 friend class BufferView;
249 /// The BufferView owner.
252 /// The text contents (the model).
253 /// \todo FIXME: this should be const.
257 /// A map from paragraph index number to paragraph metrics
258 typedef std::map<pit_type, ParagraphMetrics> ParMetricsCache;
260 mutable ParMetricsCache par_metrics_;
263 mutable Point origin_;
267 /// our 'outermost' font.
268 /// This is handed down from the surrounding
269 /// inset through the pi/mi parameter (pi.base.font)
270 /// It is used in applyOuterFont() and setCharFont() for reasons
271 /// that are not clear... to hand hand the outermost language and
272 /// also for char style apparently.
276 /// return the default height of a row in pixels, considering font zoom
277 int defaultRowHeight();
281 #endif // TEXT_METRICS_H