X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FRow.h;h=a51e3ceb912cefef657b80c71a83ddd3238d929f;hb=44cdffa39e9160bde46d824f1915f9ef3084b53e;hp=03aeb746369265df318a9faff0dfc44c47d75405;hpb=35d47698c658bef33cf949db3c08cc88be64c14d;p=lyx.git diff --git a/src/Row.h b/src/Row.h index 03aeb74636..a51e3ceb91 100644 --- a/src/Row.h +++ b/src/Row.h @@ -30,36 +30,69 @@ class DocIterator; class Inset; /** - * An on-screen row of text. A paragraph is broken into a - * RowList for display. Each Row contains position pointers - * into the first and last character positions of that row. + * An on-screen row of text. A paragraph is broken into a RowList for + * display. Each Row contains a tokenized description of the contents + * of the line. */ class Row { public: + // Possible types of row elements + enum Type { + // a string of character + STRING, + /** + * Something (completion, end-of-par marker) + * that occupies space one screen but does not + * correspond to any paragraph contents + */ + VIRTUAL, + // An inset + INSET, + // Some spacing described by its width, not a string + SPACE + }; + /** * One element of a Row. It has a set of attributes that can be used * by other methods that need to parse the Row contents. */ struct Element { - enum Type { - STRING, - COMPLETION, - SEPARATOR, - INSET, - SPACE - }; - Element(Type const t, pos_type p, Font const & f, Change const & ch) : type(t), pos(p), endpos(p + 1), inset(0), extra(0), font(f), change(ch), final(false) {} - // - bool isSeparator() const { return type == SEPARATOR; } - // returns total width of element, including separator overhead - double width() const { return dim.wid + extra; }; - // returns position in pixels (from the left) of position - // \param i in the row element + // Return total width of element, including separator overhead + double full_width() const { return dim.wid + extra * countSeparators(); } + // Return the number of separator in the element (only STRING type) + int countSeparators() const; + + /** Return position in pixels (from the left) of position + * \param i in the row element. + */ double pos2x(pos_type const i) const; + /** Return character position that is the closest to + * pixel position \param x. The value \param x is + * adjusted to the actual pixel position. + */ + pos_type x2pos(int &x) const; + /** Break the element if possible, so that its width is less + * than \param w. Returns true on success. When \param force + * is true, the string is cut at any place, other wise it + * respects the row breaking rules of characters. + */ + bool breakAt(int w, bool force); + + // Returns the position on left side of the element. + pos_type left_pos() const; + // Returns the position on right side of the element. + pos_type right_pos() const; + + // + bool isRTL() const { return font.isVisibleRightToLeft(); } + // This is true for virtual elements. + // Note that we do not use the type here. The two definitions + // should be equivalent + bool isVirtual() const { return pos == endpos; } // The kind of row element Type type; @@ -74,10 +107,10 @@ public: // Non-zero only if element is an inset Inset const * inset; - // Only non-null for separator elements + // Only non-null for justified rows double extra; - // Non-empty if element is a string or separator + // Non-empty if element is a string or is virtual docstring str; // Font font; @@ -112,26 +145,36 @@ public: DocIterator const & end) const; /// - void pos(pos_type p); + void pos(pos_type p) { pos_ = p; } /// pos_type pos() const { return pos_; } /// - void endpos(pos_type p); + void endpos(pos_type p) { end_ = p; } /// pos_type endpos() const { return end_; } + /// + void right_boundary(bool b) { right_boundary_ = b; } + /// + bool right_boundary() const { return right_boundary_; } + /// Dimension const & dimension() const { return dim_; } /// Dimension & dimension() { return dim_; } /// int height() const { return dim_.height(); } - /// + /// The width of the row, including the left margin, but not the right one. int width() const { return dim_.wid; } /// int ascent() const { return dim_.asc; } /// int descent() const { return dim_.des; } + // Return the number of separators in the row + int countSeparators() const; + // Set the extra spacing for every separator in STRING elements + void setSeparatorExtraWidth(double w); + /// void add(pos_type pos, Inset const * ins, Dimension const & dim, Font const & f, Change const & ch); @@ -139,11 +182,8 @@ public: void add(pos_type pos, char_type const c, Font const & f, Change const & ch); /// - void addCompletion(pos_type pos, docstring const & s, - Font const & f, Change const & ch); - /// - void addSeparator(pos_type pos, char_type const c, - Font const & f, Change const & ch); + void addVirtual(pos_type pos, docstring const & s, + Font const & f, Change const & ch); /// void addSpace(pos_type pos, int width, Font const & f, Change const & ch); @@ -165,6 +205,10 @@ public: /// bool empty() const { return elements_.empty(); } /// + Element & front() { return elements_.front(); } + /// + Element const & front() const { return elements_.front(); } + /// Element & back() { return elements_.back(); } /// Element const & back() const { return elements_.back(); } @@ -173,11 +217,13 @@ public: /// remove all row elements void clear() { elements_.clear(); } /** - * remove all elements after last separator and update endpos - * if necessary. - * \param keep is the minimum amount of text to keep. + * if row width is too large, remove all elements after last + * separator and update endpos if necessary. If all that + * remains is a large word, cut it to \param width. + * \param body_pos minimum amount of text to keep. + * \param width maximum width of the row */ - void separate_back(pos_type keep); + void shortenIfNeeded(pos_type const body_pos, int const width); /** * If last element of the row is a string, compute its width @@ -186,19 +232,21 @@ public: void finalizeLast(); /** - * Find sequences of RtL elements and reverse them. + * Find sequences of right-to-left elements and reverse them. * This should be called once the row is completely built. */ - void reverseRtL(); + void reverseRTL(bool rtl_par); friend std::ostream & operator<<(std::ostream & os, Row const & row); - /// width of a separator (i.e. space) + /// additional width for separators in justified rows (i.e. space) double separator; /// width of hfills in the label double label_hfill; - /// the x position of the row - double x; + /// the left margin position of the row + int left_margin; + /// the right margin of the row + int right_margin; /// mutable pos_type sel_beg; /// @@ -236,6 +284,8 @@ private: pos_type pos_; /// one behind last pos covered by this row pos_type end_; + // Is there is a boundary at the end of the row (display inset...) + bool right_boundary_; /// Row dimension. Dimension dim_; };