X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FRow.h;h=498fd07d7f8f8ce5c08335171605061ed6269701;hb=d8c018b8c691f6bc3ebbb5f78bffc0b3f87c228f;hp=0a45aa0f1b5bb18a395598dde741649d36363c68;hpb=8649ac7fe66ac0efca20918fff2fea051cc88512;p=lyx.git diff --git a/src/Row.h b/src/Row.h index 0a45aa0f1b..498fd07d7f 100644 --- a/src/Row.h +++ b/src/Row.h @@ -46,8 +46,6 @@ public: * correspond to any paragraph contents */ VIRTUAL, - // A stretchable space, basically - SEPARATOR, // An inset INSET, // Some spacing described by its width, not a string @@ -63,19 +61,49 @@ public: : type(t), pos(p), endpos(p + 1), inset(0), extra(0), font(f), change(ch), final(false) {} - // 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 the number of separator in the element (only STRING type) + int countSeparators() const; + + // Return total width of element, including separator overhead + // FIXME: Cache this value or the number of expanders? + double full_width() const { return dim.wid + extra * countExpanders(); } + // Return the number of expanding characters in the element (only STRING + // type). + int countExpanders() const; + // Return the amount of expansion: the number of expanding characters + // that get stretched during justification, times the em of the font + // (only STRING type). + int expansionAmount() const; + // set extra proportionally to the font em value. + void setExtra(double extra_per_em); + + /** 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 - * rounded to the actual pixel position. If \param - * short is true, the pixel value is rounded by - * default. + * adjusted to the actual pixel position. */ - pos_type x2pos(double &x, bool low = false) const; + 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; @@ -90,10 +118,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; @@ -127,6 +155,10 @@ public: void setSelectionAndMargins(DocIterator const & beg, DocIterator const & end) const; + /// + void pit(pit_type p) { pit_ = p; } + /// + pit_type pit() const { return pit_; } /// void pos(pos_type p) { pos_ = p; } /// @@ -139,6 +171,10 @@ public: void right_boundary(bool b) { right_boundary_ = b; } /// bool right_boundary() const { return right_boundary_; } + /// + void flushed(bool b) { flushed_ = b; } + /// + bool flushed() const { return flushed_; } /// Dimension const & dimension() const { return dim_; } @@ -146,13 +182,25 @@ public: 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; } + /// The offset of the left-most cursor position on the row + int left_x() const; + /// The offset of the right-most cursor position on the row + int right_x() const; + + // Return the number of separators in the row + int countSeparators() const; + // Set the extra spacing for every expanding character in STRING-type + // elements. \param w is the total amount of extra width for the row to be + // distributed among expanders. \return false if the justification fails. + bool setExtraWidth(int w); + /// void add(pos_type pos, Inset const * ins, Dimension const & dim, Font const & f, Change const & ch); @@ -163,9 +211,6 @@ public: void addVirtual(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 addSpace(pos_type pos, int width, Font const & f, Change const & ch); /// @@ -200,11 +245,13 @@ public: /** * if row width is too large, remove all elements after last * separator and update endpos if necessary. If all that - * rename is a large word, cut it to \param width. + * 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 + * \param width maximum width of the row. + * \param available width on next row. + * \return true if the row has been shortened. */ - void shorten_if_needed(pos_type const body_pos, int const width); + bool shortenIfNeeded(pos_type const body_pos, int const width, int const next_width); /** * If last element of the row is a string, compute its width @@ -217,15 +264,19 @@ public: * This should be called once the row is completely built. */ void reverseRTL(bool rtl_par); + /// + bool isRTL() const { return rtl_; } + /// Find row element that contains \c pos, and compute x offset. + const_iterator const findElement(pos_type pos, bool boundary, double & x) const; 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 (left margin) - double x; + /// the left margin position of the row + int left_margin; /// the right margin of the row int right_margin; /// @@ -261,14 +312,20 @@ private: mutable bool changed_; /// CRC of row contents. mutable size_type crc_; + /// Index of the paragraph that contains this row + pit_type pit_; /// first pos covered by this row 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...) + // Is there a boundary at the end of the row (display inset...) bool right_boundary_; + // Shall the row be flushed when it is supposed to be justified? + bool flushed_; /// Row dimension. Dimension dim_; + /// true when this row lives in a right-to-left paragraph + bool rtl_; };