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 std::pair<pit_type, ParagraphMetrics const *> first() const;
47 std::pair<pit_type, ParagraphMetrics const *> last() const;
48 /// is this row the last in the text?
49 bool isLastRow(Row const & row) const;
50 /// is this row the first in the text?
51 bool isFirstRow(Row const & row) const;
53 void setRowChanged(pit_type pit, pos_type pos);
56 Dimension const & dim() const { return dim_; }
58 Point const & origin() const { return origin_; }
62 ParagraphMetrics const & parMetrics(pit_type) const;
64 void newParMetricsDown();
66 void newParMetricsUp();
68 /// compute text metrics.
69 bool metrics(MetricsInfo & mi, Dimension & dim, int min_width = 0,
70 bool const expand_on_multipars = true);
72 /// The "nodraw" drawing stage for one single paragraph: set the
73 /// positions of the insets contained this paragraph in metrics
74 /// cache. Related to BufferView::updatePosCache.
75 void updatePosCache(pit_type pit) const;
77 /// Gets the fully instantiated font at a given position in a paragraph
78 /// Basically the same routine as Paragraph::getFont() in Paragraph.cpp.
79 /// The difference is that this one is used for displaying, and thus we
80 /// are allowed to make cosmetic improvements. For instance make footnotes
82 Font displayFont(pit_type pit, pos_type pos) const;
84 /// There are currently two font mechanisms in LyX:
85 /// 1. The font attributes in a lyxtext, and
86 /// 2. The inset-specific font properties, defined in an inset's
87 /// metrics() and draw() methods and handed down the inset chain through
88 /// the pi/mi parameters, and stored locally in a lyxtext in font_.
89 /// This is where the two are integrated in the final fully realized
91 void applyOuterFont(Font &) const;
93 /// is this position in the paragraph right-to-left?
94 bool isRTL(CursorSlice const & sl, bool boundary) const;
95 /// is between pos-1 and pos an RTL<->LTR boundary?
96 bool isRTLBoundary(pit_type pit,
98 /// would be a RTL<->LTR boundary between pos and the given font?
99 bool isRTLBoundary(pit_type pit,
100 pos_type pos, Font const & font) const;
103 /// Rebreaks the given paragraph.
104 /// \retval true if a full screen redraw is needed.
105 /// \retval false if a single paragraph redraw is enough.
106 bool redoParagraph(pit_type const pit, bool align_rows = true);
107 /// Clear cache of paragraph metrics
108 void clear() { par_metrics_.clear(); }
109 /// Is cache of paragraph metrics empty ?
110 bool empty() const { return par_metrics_.empty(); }
113 int ascent() const { return dim_.asc; }
115 int descent() const { return dim_.des; }
116 /// current text width.
117 int width() const { return dim_.wid; }
118 /// current text height.
119 int height() const { return dim_.height(); }
122 int rightMargin(ParagraphMetrics const & pm) const;
123 int rightMargin(pit_type const pit) const;
126 void draw(PainterInfo & pi, int x, int y) const;
128 void drawParagraph(PainterInfo & pi, pit_type pit, int x, int y) const;
132 ParagraphMetrics & parMetrics(pit_type, bool redo_paragraph);
135 * Returns the left beginning of the text.
136 * This information cannot be taken from the layout object, because
137 * in LaTeX the beginning of the text fits in some cases
138 * (for example sections) exactly the label-width.
140 int leftMargin(pit_type pit, pos_type pos) const;
141 int leftMargin(pit_type pit) const;
143 /// the minimum space a manual label needs on the screen in pixels
144 int labelFill(Row const & row) const;
147 int labelEnd(pit_type const pit) const;
149 /// sets row.end to the pos value *after* which a row should break.
150 /// for example, the pos after which isNewLine(pos) == true
151 /// \return true when another row is required (after a newline)
152 bool breakRow(Row & row, int right_margin) const;
154 // Expands the alignment of row \param row in paragraph \param par
155 LyXAlignment getAlign(Paragraph const & par, Row const & row) const;
156 /// Aligns properly the row contents (computes spaces and fills)
157 void setRowAlignment(Row & row, int width) const;
159 /// Set the height of the row (without space above/below paragraph)
160 void setRowHeight(Row & row) const;
161 // Compute the space on top of a paragraph
162 int parTopSpacing(pit_type pit) const;
163 // Compute the space below a a paragraph
164 int parBottomSpacing(pit_type pit) const;
166 // Helper function for the other checkInsetHit method.
167 InsetList::Element * checkInsetHit(pit_type pit, int x, int y);
172 /// returns the position near the specified x-coordinate of the row.
173 /// x is an absolute screen coord, it is set to the real beginning
174 /// of this column. This takes in account horizontal cursor row scrolling.
175 pos_type getPosNearX(Row const & row, int & x, bool & boundary) const;
177 /// returns pos in given par at given x coord.
178 pos_type x2pos(pit_type pit, int row, int x) const;
180 // FIXME: is there a need for this?
181 //int pos2x(pit_type pit, pos_type pos) const;
183 /// returns the row near the specified y-coordinate in a given paragraph
184 /// (relative to the screen). If assert_in_view is true, it is made sure
185 /// that the row is on screen completely; this might change the given pit.
186 Row const & getPitAndRowNearY(int & y, pit_type & pit,
187 bool assert_in_view, bool up);
189 /// returns the paragraph number closest to screen y-coordinate.
190 /// This method uses the BufferView CoordCache to locate the
191 /// paragraph. The y-coodinate is allowed to be off-screen and
192 /// the CoordCache will be automatically updated if needed. This is
193 /// the reason why we need a non const BufferView.
194 pit_type getPitNearY(int y);
196 /// sets cursor recursively descending into nested editable insets
198 \return the inset pointer if x,y is covering that inset
199 \param x,y are absolute screen coordinates.
200 \param assert_in_view if true the cursor will be set on a row
201 that is completely visible
202 \param up whether we are going up or down (only used when
203 assert_in_view is true
204 \retval inset is null if the cursor is positioned over normal
205 text in the current Text object. Otherwise it is the inset
206 that the cursor points to, like for Inset::editXY.
208 /// FIXME: cleanup to use BufferView::getCoveringInset() and
209 /// setCursorFromCoordinates() instead of checkInsetHit().
210 Inset * editXY(Cursor & cur, int x, int y,
211 bool assert_in_view = false, bool up = true);
213 /// sets cursor only within this Text.
214 /// x,y are screen coordinates
215 void setCursorFromCoordinates(Cursor & cur, int x, int y);
218 int cursorX(CursorSlice const & cursor, bool boundary) const;
220 int cursorY(CursorSlice const & cursor, bool boundary) const;
223 bool cursorHome(Cursor & cur);
225 bool cursorEnd(Cursor & cur);
227 void deleteLineForward(Cursor & cur);
229 /// Returns an inset if inset was hit, or 0 if not.
230 /// \warning This method is not recursive! It will return the
231 /// outermost inset within this Text.
232 /// \sa BufferView::getCoveringInset() to get the innermost inset.
233 Inset * checkInsetHit(int x, int y);
235 /// calculates the position of a completion popup
236 void completionPosAndDim(Cursor const & cur, int & x, int & y,
237 Dimension & dim) const;
240 friend class BufferView;
242 /// The BufferView owner.
245 /// The text contents (the model).
246 /// \todo FIXME: this should be const.
249 /// A map from paragraph index number to paragraph metrics
250 typedef std::map<pit_type, ParagraphMetrics> ParMetricsCache;
252 mutable ParMetricsCache par_metrics_;
255 mutable Point origin_;
259 /// our 'outermost' font.
260 /// This is handed down from the surrounding
261 /// inset through the pi/mi parameter (pi.base.font)
262 /// It is used in applyOuterFont() and setCharFont() for reasons
263 /// that are not clear... to hand hand the outermost language and
264 /// also for char style apparently.
268 /// return the default height of a row in pixels, considering font zoom
269 int defaultRowHeight();
273 #endif // TEXT_METRICS_H