4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Matthias Ettrich
8 * \author Lars Gullik Bjønnes
10 * Full author contact details are available in file CREDITS.
12 * Metrics for an on-screen text row.
19 #include "Dimension.h"
22 #include "support/docstring.h"
23 #include "support/types.h"
33 * An on-screen row of text. A paragraph is broken into a RowList for
34 * display. Each Row contains a tokenized description of the contents
39 // Possible types of row elements
41 // a string of character
44 * Something (completion, end-of-par marker)
45 * that occupies space one screen but does not
46 * correspond to any paragraph contents
51 // Some spacing described by its width, not a string
56 * One element of a Row. It has a set of attributes that can be used
57 * by other methods that need to parse the Row contents.
60 Element(Type const t, pos_type p, Font const & f, Change const & ch)
61 : type(t), pos(p), endpos(p + 1), inset(0),
62 extra(0), font(f), change(ch), final(false) {}
64 // Return total width of element, including separator overhead
65 double full_width() const { return dim.wid + extra * countSeparators(); };
66 // Return the number of separator in the element (only STRING type)
67 int countSeparators() const;
69 /** Return position in pixels (from the left) of position
70 * \param i in the row element.
72 double pos2x(pos_type const i) const;
73 /** Return character position that is the closest to
74 * pixel position \param x. The value \param x is
75 * adjusted to the actual pixel position.
77 pos_type x2pos(int &x) const;
78 /** Break the element if possible, so that its width is less
79 * than \param w. Returns true on success. When \param force
80 * is true, the string is cut at any place, other wise it
81 * respects the row breaking rules of characters.
83 bool breakAt(int w, bool force);
85 // Returns the position on left side of the element.
86 pos_type left_pos() const;
87 // Returns the position on right side of the element.
88 pos_type right_pos() const;
90 // The kind of row element
92 // position of the element in the paragraph
94 // first position after the element in the paragraph
96 // The dimension of the chunk (does not contains the
97 // separator correction)
100 // Non-zero only if element is an inset
103 // Only non-null for justified rows
106 // Non-empty if element is a string or is virtual
112 // is it possible to add contents to this element?
115 friend std::ostream & operator<<(std::ostream & os, Element const & row);
122 bool changed() const { return changed_; }
124 void setChanged(bool c) { changed_ = c; }
126 void setCrc(size_type crc) const;
127 /// Set the selection begin and end.
129 * This is const because we update the selection status only at draw()
132 void setSelection(pos_type sel_beg, pos_type sel_end) const;
134 bool selection() const;
135 /// Set the selection begin and end and whether the left and/or right
136 /// margins are selected.
137 void setSelectionAndMargins(DocIterator const & beg,
138 DocIterator const & end) const;
141 void pos(pos_type p) { pos_ = p; }
143 pos_type pos() const { return pos_; }
145 void endpos(pos_type p) { end_ = p; }
147 pos_type endpos() const { return end_; }
149 void right_boundary(bool b) { right_boundary_ = b; }
151 bool right_boundary() const { return right_boundary_; }
154 Dimension const & dimension() const { return dim_; }
156 Dimension & dimension() { return dim_; }
158 int height() const { return dim_.height(); }
159 /// The width of the row, including the left margin, but not the right one.
160 int width() const { return dim_.wid; }
162 int ascent() const { return dim_.asc; }
164 int descent() const { return dim_.des; }
166 // Return the number of separators in the row
167 int countSeparators() const;
168 // Set the extra spacing for every separator in STRING elements
169 void setSeparatorExtraWidth(double w);
172 void add(pos_type pos, Inset const * ins, Dimension const & dim,
173 Font const & f, Change const & ch);
175 void add(pos_type pos, char_type const c,
176 Font const & f, Change const & ch);
178 void addVirtual(pos_type pos, docstring const & s,
179 Font const & f, Change const & ch);
181 void addSpace(pos_type pos, int width, Font const & f, Change const & ch);
184 typedef std::vector<Element> Elements;
186 typedef Elements::iterator iterator;
188 typedef Elements::const_iterator const_iterator;
190 iterator begin() { return elements_.begin(); }
192 iterator end() { return elements_.end(); }
194 const_iterator begin() const { return elements_.begin(); }
196 const_iterator end() const { return elements_.end(); }
199 bool empty() const { return elements_.empty(); }
201 Element & front() { return elements_.front(); }
203 Element const & front() const { return elements_.front(); }
205 Element & back() { return elements_.back(); }
207 Element const & back() const { return elements_.back(); }
208 /// remove last element
210 /// remove all row elements
211 void clear() { elements_.clear(); }
213 * if row width is too large, remove all elements after last
214 * separator and update endpos if necessary. If all that
215 * remains is a large word, cut it to \param width.
216 * \param body_pos minimum amount of text to keep.
217 * \param width maximum width of the row
219 void shortenIfNeeded(pos_type const body_pos, int const width);
222 * If last element of the row is a string, compute its width
228 * Find sequences of right-to-left elements and reverse them.
229 * This should be called once the row is completely built.
231 void reverseRTL(bool rtl_par);
233 friend std::ostream & operator<<(std::ostream & os, Row const & row);
235 /// additional width for separators in justified rows (i.e. space)
237 /// width of hfills in the label
239 /// the left margin position of the row
241 /// the right margin of the row
244 mutable pos_type sel_beg;
246 mutable pos_type sel_end;
248 mutable bool begin_margin_sel;
250 mutable bool end_margin_sel;
253 /// Decides whether the margin is selected.
255 * \param margin_begin
259 bool isMarginSelected(bool left_margin, DocIterator const & beg,
260 DocIterator const & end) const;
263 * Returns true if a char or string with font \c f and change
264 * type \c ch can be added to the current last element of the
267 bool sameString(Font const & f, Change const & ch) const;
272 /// has the Row appearance changed since last drawing?
273 mutable bool changed_;
274 /// CRC of row contents.
275 mutable size_type crc_;
276 /// first pos covered by this row
278 /// one behind last pos covered by this row
280 // Is there is a boundary at the end of the row (display inset...)
281 bool right_boundary_;