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 "ParagraphMetrics.h"
21 #include "support/types.h"
32 /// A map from a Text to the map of paragraphs metrics
36 /// Default constructor (only here for STL containers).
37 TextMetrics() : text_(0) {}
38 /// The only useful constructor.
39 TextMetrics(BufferView *, Text *);
42 bool contains(pit_type pit) const;
44 ParagraphMetrics const & parMetrics(pit_type) const;
46 std::pair<pit_type, ParagraphMetrics const *> first() const;
48 std::pair<pit_type, ParagraphMetrics const *> last() const;
51 Dimension const & dimension() const { return dim_; }
53 Point const & origin() const { return origin_; }
56 /// compute text metrics.
57 bool metrics(MetricsInfo & mi, Dimension & dim, int min_width = 0);
60 void newParMetricsDown();
62 void newParMetricsUp();
64 /// Gets the fully instantiated font at a given position in a paragraph
65 /// Basically the same routine as Paragraph::getFont() in Paragraph.cpp.
66 /// The difference is that this one is used for displaying, and thus we
67 /// are allowed to make cosmetic improvements. For instance make footnotes
69 Font displayFont(pit_type pit, pos_type pos) const;
71 /// There are currently two font mechanisms in LyX:
72 /// 1. The font attributes in a lyxtext, and
73 /// 2. The inset-specific font properties, defined in an inset's
74 /// metrics() and draw() methods and handed down the inset chain through
75 /// the pi/mi parameters, and stored locally in a lyxtext in font_.
76 /// This is where the two are integrated in the final fully realized
78 void applyOuterFont(Font &) const;
80 /// is this position in the paragraph right-to-left?
81 bool isRTL(CursorSlice const & sl, bool boundary) const;
82 /// is between pos-1 and pos an RTL<->LTR boundary?
83 bool isRTLBoundary(pit_type pit,
85 /// would be a RTL<->LTR boundary between pos and the given font?
86 bool isRTLBoundary(pit_type pit,
87 pos_type pos, Font const & font) const;
90 /// Rebreaks the given paragraph.
91 /// \retval true if a full screen redraw is needed.
92 /// \retval false if a single paragraph redraw is enough.
93 bool redoParagraph(pit_type const pit);
94 /// Clear cache of paragraph metrics
95 void clear() { par_metrics_.clear(); }
98 int ascent() const { return dim_.asc; }
100 int descent() const { return dim_.des; }
101 /// current text width.
102 int width() const { return dim_.wid; }
103 /// current text height.
104 int height() const { return dim_.height(); }
107 int maxWidth() const { return max_width_; }
109 int singleWidth(pit_type const pit, pos_type pos) const;
112 int rightMargin(ParagraphMetrics const & pm) const;
113 int rightMargin(pit_type const pit) const;
115 /** this calculates the specified parameters. needed when setting
116 * the cursor and when creating a visible row */
117 void computeRowMetrics(pit_type pit, Row & row, int width) const;
120 void draw(PainterInfo & pi, int x, int y) const;
122 void drawParagraph(PainterInfo & pi, pit_type pit, int x, int y) const;
124 /// Returns the height of the row (width member is set to 0).
125 /// If \c topBottomSpace is true, extra space is added for the
126 /// top and bottom row.
129 pos_type const first,
131 bool topBottomSpace = true) const;
135 ParagraphMetrics & parMetrics(pit_type, bool redo_paragraph);
137 /// the minimum space a manual label needs on the screen in pixels
138 int labelFill(pit_type const pit, Row const & row) const;
141 int labelEnd(pit_type const pit) const;
143 /// sets row.end to the pos value *after* which a row should break.
144 /// for example, the pos after which isNewLine(pos) == true
145 pos_type rowBreakPoint(
151 /// returns the minimum space a row needs on the screen in pixel
155 pos_type const first,
159 // Helper function for the other checkInsetHit method.
160 InsetList::InsetTable * checkInsetHit(pit_type pit, int x, int y);
165 /// returns the column near the specified x-coordinate of the row.
166 /// x is an absolute screen coord, it is set to the real beginning
168 pos_type getColumnNearX(pit_type pit, Row const & row, int & x,
169 bool & boundary) const;
171 /// returns pos in given par at given x coord.
172 pos_type x2pos(pit_type pit, int row, int x) const;
174 // FIXME: is there a need for this?
175 //int pos2x(pit_type pit, pos_type pos) const;
177 /// returns the row near the specified y-coordinate in a given paragraph
178 /// (relative to the screen). If assert_in_view is true, it is made sure
179 /// that the row is on screen completely; this might change the given pit.
180 Row const & getPitAndRowNearY(int & y, pit_type & pit,
181 bool assert_in_view, bool up);
183 /// returns the paragraph number closest to screen y-coordinate.
184 /// This method uses the BufferView CoordCache to locate the
185 /// paragraph. The y-coodinate is allowed to be off-screen and
186 /// the CoordCache will be automatically updated if needed. This is
187 /// the reason why we need a non const BufferView.
188 pit_type getPitNearY(int y);
190 /// sets cursor recursively descending into nested editable insets
192 \return the inset pointer if x,y is covering that inset
193 \param x,y are absolute screen coordinates.
194 \param assert_in_view if true the cursor will be set on a row
195 that is completely visible
196 \param up whether we are going up or down (only used when
197 assert_in_view is true
198 \retval inset is non-null if the cursor is positionned inside
200 /// FIXME: cleanup to use BufferView::getCoveringInset() and
201 /// setCursorFromCoordinates() instead of checkInsetHit().
202 Inset * editXY(Cursor & cur, int x, int y,
203 bool assert_in_view = false, bool up = true);
205 /// sets cursor only within this Text.
206 /// x,y are screen coordinates
207 void setCursorFromCoordinates(Cursor & cur, int x, int y);
210 int cursorX(CursorSlice const & cursor,
211 bool boundary) const;
213 int cursorY(CursorSlice const & cursor,
214 bool boundary) const;
217 bool cursorHome(Cursor & cur);
219 bool cursorEnd(Cursor & cur);
221 void deleteLineForward(Cursor & cur);
223 /// is this row the last in the text?
224 bool isLastRow(pit_type pit, Row const & row) const;
225 /// is this row the first in the text?
226 bool isFirstRow(pit_type pit, Row const & row) const;
228 /// Returns an inset if inset was hit, or 0 if not.
229 /// \warning This method is not recursive! It will return the
230 /// outermost inset within this Text.
231 /// \sa BufferView::getCoveringInset() to get the innermost inset.
232 Inset * checkInsetHit(int x, int y);
235 * Returns the left beginning of the text.
236 * This information cannot be taken from the layout object, because
237 * in LaTeX the beginning of the text fits in some cases
238 * (for example sections) exactly the label-width.
240 int leftMargin(int max_width, pit_type pit, pos_type pos) const;
241 int leftMargin(int max_width, pit_type pit) const;
243 /// calculates the position of a completion popup
244 void completionPosAndDim(Cursor const & cur, int & x, int & y,
245 Dimension & dim) const;
248 friend class BufferView;
250 /// The BufferView owner.
253 /// The text contents (the model).
254 /// \todo FIXME: this should be const.
258 /// A map from paragraph index number to paragraph metrics
259 typedef std::map<pit_type, ParagraphMetrics> ParMetricsCache;
261 mutable ParMetricsCache par_metrics_;
264 mutable Point origin_;
268 /// our 'outermost' font.
269 /// This is handed down from the surrounding
270 /// inset through the pi/mi parameter (pi.base.font)
271 /// It is used in applyOuterFont() and setCharFont() for reasons
272 /// that are not clear... to hand hand the outermost language and
273 /// also for char style apparently.
277 /// return the default height of a row in pixels, considering font zoom
278 int defaultRowHeight();
282 #endif // TEXT_METRICS_H