X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FTextMetrics.h;h=ae99490955f948a180dcbd24c6a74ed0dd98cade;hb=c7d29be153debac82e3d2e8865fcc849f0a5f40d;hp=34eda6b2de971a1e01ddf60ebb75cabfab734896;hpb=c7c1db84bdb454d590af4489504a6af6ed26729e;p=lyx.git diff --git a/src/TextMetrics.h b/src/TextMetrics.h index 34eda6b2de..ae99490955 100644 --- a/src/TextMetrics.h +++ b/src/TextMetrics.h @@ -4,7 +4,7 @@ * This file is part of LyX, the document processor. * Licence details can be found in the file COPYING. * - * \author Lars Gullik Bjønnes + * \author Lars Gullik Bjønnes * \author John Levon * \author Abdelrazak Younes * @@ -15,6 +15,8 @@ #define TEXT_METRICS_H #include "Font.h" +#include "InsetList.h" +#include "LayoutEnums.h" #include "ParagraphMetrics.h" #include "support/types.h" @@ -33,12 +35,12 @@ class TextMetrics { public: /// Default constructor (only here for STL containers). - TextMetrics() : text_(0) {} + TextMetrics() : bv_(0), text_(0), max_width_(0) {} /// The only useful constructor. TextMetrics(BufferView *, Text *); - + /// - bool has(pit_type pit) const; + bool contains(pit_type pit) const; /// ParagraphMetrics const & parMetrics(pit_type) const; /// @@ -46,9 +48,6 @@ public: /// std::pair last() const; - /// - int parPosition(pit_type pit) const; - /// Dimension const & dimension() const { return dim_; } /// @@ -63,13 +62,17 @@ public: /// void newParMetricsUp(); + /// The "nodraw" drawing stage for one single paragraph: set the + /// positions of the insets contained this paragraph in metrics + /// cache. Related to BufferView::updatePosCache. + void updatePosCache(pit_type pit) const; + /// Gets the fully instantiated font at a given position in a paragraph /// Basically the same routine as Paragraph::getFont() in Paragraph.cpp. /// The difference is that this one is used for displaying, and thus we /// are allowed to make cosmetic improvements. For instance make footnotes /// smaller. (Asger) - Font getDisplayFont(pit_type pit, - pos_type pos) const; + Font displayFont(pit_type pit, pos_type pos) const; /// There are currently two font mechanisms in LyX: /// 1. The font attributes in a lyxtext, and @@ -96,6 +99,8 @@ public: bool redoParagraph(pit_type const pit); /// Clear cache of paragraph metrics void clear() { par_metrics_.clear(); } + /// Is cache of paragraph metrics empty ? + bool empty() const { return par_metrics_.empty(); } /// int ascent() const { return dim_.asc; } @@ -103,72 +108,65 @@ public: int descent() const { return dim_.des; } /// current text width. int width() const { return dim_.wid; } - /// current text heigth. + /// current text height. int height() const { return dim_.height(); } - /// - int maxWidth() const { return max_width_; } - /// - int singleWidth(pit_type const pit, pos_type pos) const; - /// int rightMargin(ParagraphMetrics const & pm) const; int rightMargin(pit_type const pit) const; - /** this calculates the specified parameters. needed when setting - * the cursor and when creating a visible row */ - void computeRowMetrics(pit_type pit, Row & row, int width) const; - /// void draw(PainterInfo & pi, int x, int y) const; - + void drawParagraph(PainterInfo & pi, pit_type pit, int x, int y) const; private: /// ParagraphMetrics & parMetrics(pit_type, bool redo_paragraph); + /** + * Returns the left beginning of the text. + * This information cannot be taken from the layout object, because + * in LaTeX the beginning of the text fits in some cases + * (for example sections) exactly the label-width. + */ + int leftMargin(pit_type pit, pos_type pos) const; + int leftMargin(pit_type pit) const; + /// the minimum space a manual label needs on the screen in pixels - int labelFill(pit_type const pit, Row const & row) const; + int labelFill(Row const & row) const; /// FIXME?? int labelEnd(pit_type const pit) const; /// sets row.end to the pos value *after* which a row should break. /// for example, the pos after which isNewLine(pos) == true - pit_type rowBreakPoint( - int width, - pit_type const pit, - pit_type first - ) const; - - /// sets row.width to the minimum space a row needs on the screen in pixel - int rowWidth( - int right_margin, - pit_type const pit, - pos_type const first, - pos_type const end - ) const; - - /// Calculate and set the height of the row (width member is set to 0) - Dimension rowHeight( - pit_type const pit, - pos_type const first, - pos_type const end - ) const; - - /// draw selection for a single row - void drawRowSelection(PainterInfo & pi, int x, Row const & row, - DocIterator const & beg, DocIterator const & end, - bool drawOnBegMargin, bool drawOnEndMargin) const; + /// \return true when another row is required (after a newline) + bool breakRow(Row & row, int right_margin) const; + + // Expand the alignment of row \param row in paragraph \param par + LyXAlignment getAlign(Paragraph const & par, Row const & row) const; + /** this calculates the specified parameters. needed when setting + * the cursor and when creating a visible row */ + void computeRowMetrics(Row & row, int width) const; + + /// Set the height of the row (without space above/below paragraph) + void setRowHeight(Row & row) const; + // Compute the space on top of a paragraph + int parTopSpacing(pit_type pit) const; + // Compute the space below a a paragraph + int parBottomSpacing(pit_type pit) const; + + // Helper function for the other checkInsetHit method. + InsetList::InsetTable * checkInsetHit(pit_type pit, int x, int y); + // Temporary public: public: - /// returns the column near the specified x-coordinate of the row. + /// returns the position near the specified x-coordinate of the row. /// x is an absolute screen coord, it is set to the real beginning - /// of this column. - pos_type getColumnNearX(pit_type pit, Row const & row, int & x, - bool & boundary) const; + /// of this column. This takes in account horizontal cursor row scrolling. + pos_type getPosNearX(Row const & row, int & x, bool & boundary) const; /// returns pos in given par at given x coord. pos_type x2pos(pit_type pit, int row, int x) const; @@ -176,11 +174,11 @@ public: // FIXME: is there a need for this? //int pos2x(pit_type pit, pos_type pos) const; - /** returns row near the specified - * y-coordinate in given paragraph (relative to the screen). - */ - Row const & getRowNearY(int y, - pit_type pit) const; + /// returns the row near the specified y-coordinate in a given paragraph + /// (relative to the screen). If assert_in_view is true, it is made sure + /// that the row is on screen completely; this might change the given pit. + Row const & getPitAndRowNearY(int & y, pit_type & pit, + bool assert_in_view, bool up); /// returns the paragraph number closest to screen y-coordinate. /// This method uses the BufferView CoordCache to locate the @@ -193,27 +191,28 @@ public: /** \return the inset pointer if x,y is covering that inset \param x,y are absolute screen coordinates. - \retval inset is non-null if the cursor is positionned inside + \param assert_in_view if true the cursor will be set on a row + that is completely visible + \param up whether we are going up or down (only used when + assert_in_view is true + \retval inset is null if the cursor is positioned over normal + text in the current Text object. Otherwise it is the inset + that the cursor points to, like for Inset::editXY. */ /// FIXME: cleanup to use BufferView::getCoveringInset() and /// setCursorFromCoordinates() instead of checkInsetHit(). - Inset * editXY(Cursor & cur, int x, int y); + Inset * editXY(Cursor & cur, int x, int y, + bool assert_in_view = false, bool up = true); /// sets cursor only within this Text. /// x,y are screen coordinates void setCursorFromCoordinates(Cursor & cur, int x, int y); /// - int cursorX(CursorSlice const & cursor, - bool boundary) const; + int cursorX(CursorSlice const & cursor, bool boundary) const; /// - int cursorY(CursorSlice const & cursor, - bool boundary) const; + int cursorY(CursorSlice const & cursor, bool boundary) const; - /// - void cursorPrevious(Cursor & cur); - /// - void cursorNext(Cursor & cur); /// bool cursorHome(Cursor & cur); /// @@ -222,9 +221,9 @@ public: void deleteLineForward(Cursor & cur); /// is this row the last in the text? - bool isLastRow(pit_type pit, Row const & row) const; + bool isLastRow(Row const & row) const; /// is this row the first in the text? - bool isFirstRow(pit_type pit, Row const & row) const; + bool isFirstRow(Row const & row) const; /// Returns an inset if inset was hit, or 0 if not. /// \warning This method is not recursive! It will return the @@ -232,14 +231,9 @@ public: /// \sa BufferView::getCoveringInset() to get the innermost inset. Inset * checkInsetHit(int x, int y); - /** - * Returns the left beginning of the text. - * This information cannot be taken from the layout object, because - * in LaTeX the beginning of the text fits in some cases - * (for example sections) exactly the label-width. - */ - int leftMargin(int max_width, pit_type pit, pos_type pos) const; - int leftMargin(int max_width, pit_type pit) const; + /// calculates the position of a completion popup + void completionPosAndDim(Cursor const & cur, int & x, int & y, + Dimension & dim) const; private: friend class BufferView; @@ -251,7 +245,6 @@ private: /// \todo FIXME: this should be const. Text * text_; - bool main_text_; /// A map from paragraph index number to paragraph metrics typedef std::map ParMetricsCache; /// @@ -265,7 +258,7 @@ public: /// our 'outermost' font. /// This is handed down from the surrounding /// inset through the pi/mi parameter (pi.base.font) - /// It is used in applyOuterFont() and setCharFont() for reasons + /// It is used in applyOuterFont() and setCharFont() for reasons /// that are not clear... to hand hand the outermost language and /// also for char style apparently. Font font_;