* 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
*
#define TEXT_METRICS_H
#include "Font.h"
+#include "InsetList.h"
+#include "LayoutEnums.h"
#include "ParagraphMetrics.h"
#include "support/types.h"
+#include <map>
+
namespace lyx {
class BufferView;
class Cursor;
class CursorSlice;
-class DocIterator;
class MetricsInfo;
class Text;
/// A map from a Text to the map of paragraphs metrics
class TextMetrics
{
+ /// noncopyable
+ TextMetrics(TextMetrics const &);
+ void operator=(TextMetrics const &);
public:
/// Default constructor (only here for STL containers).
- TextMetrics() : text_(0) {}
+ TextMetrics() : bv_(0), text_(0), max_width_(0), tight_(false) {}
/// The only useful constructor.
TextMetrics(BufferView *, Text *);
-
- ///
- bool has(pit_type pit) const;
+
///
- ParagraphMetrics const & parMetrics(pit_type) const;
+ bool contains(pit_type pit) const;
///
std::pair<pit_type, ParagraphMetrics const *> first() const;
///
std::pair<pit_type, ParagraphMetrics const *> last() const;
-
+ /// is this row the last in the text?
+ bool isLastRow(Row const & row) const;
+ /// is this row the first in the text?
+ bool isFirstRow(Row const & row) const;
///
- int parPosition(pit_type pit) const;
+ void setRowChanged(pit_type pit, pos_type pos);
///
- Dimension const & dimension() const { return dim_; }
+ Dimension const & dim() const { return dim_; }
///
Point const & origin() const { return origin_; }
-
- /// compute text metrics.
- bool metrics(MetricsInfo & mi, Dimension & dim, int min_width = 0);
+ ///
+ ParagraphMetrics const & parMetrics(pit_type) const;
+ ///
+ ParagraphMetrics & parMetrics(pit_type);
///
void newParMetricsDown();
///
void newParMetricsUp();
- /// Gets the fully instantiated font at a given position in a paragraph
+ /// compute text metrics.
+ bool metrics(MetricsInfo const & mi, Dimension & dim, int min_width = 0);
+
+ /// The "nodraw" drawing stage for one single paragraph: set the
+ /// positions of the insets contained in 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;
+
+ /// Gets the fully instantiated label font of a paragraph.
+ /// Basically the same routine as displayFont, but specialized for
+ /// a layout font.
+ Font labelDisplayFont(pit_type pit) const;
+
/// There are currently two font mechanisms in LyX:
/// 1. The font attributes in a lyxtext, and
/// is this position in the paragraph right-to-left?
bool isRTL(CursorSlice const & sl, bool boundary) const;
/// is between pos-1 and pos an RTL<->LTR boundary?
- bool isRTLBoundary(pit_type pit,
- pos_type pos) const;
+ bool isRTLBoundary(pit_type pit, pos_type pos) const;
/// would be a RTL<->LTR boundary between pos and the given font?
- bool isRTLBoundary(pit_type pit,
- pos_type pos, Font const & font) const;
+ bool isRTLBoundary(pit_type pit, pos_type pos, Font const & font) const;
/// Rebreaks the given paragraph.
/// \retval true if a full screen redraw is needed.
/// \retval false if a single paragraph redraw is enough.
- bool redoParagraph(pit_type const pit);
+ bool redoParagraph(pit_type const pit, bool align_rows = true);
/// 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; }
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;
+ /**
+ * Returns the left beginning of a row starting at \c pos.
+ * 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;
+ /// Return the left beginning of a row which is not the first one.
+ /// This is the left margin when there is no indentation.
+ int leftMargin(pit_type pit) 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);
- /// draw textselection.
- /// FIXME: simplify to just to single row painting.
- void drawSelection(PainterInfo & pi,
- DocIterator const & beg, ///< selection begin.
- DocIterator const & end, ///< selection end.
- int x) const;
-
/// the minimum space a manual label needs on the screen in pixels
- int labelFill(pit_type const pit, 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;
+ int labelFill(Row const & row) const;
+
+ // Turn paragraph oh index \c pit into a single row
+ Row tokenizeParagraph(pit_type pit) const;
+
+ // Break the row produced by tokenizeParagraph() into a list of rows.
+ RowList breakParagraph(Row const & row) const;
+
+ // Expands the alignment of row \param row in paragraph \param par
+ LyXAlignment getAlign(Paragraph const & par, Row const & row) const;
+ /// Aligns properly the row contents (computes spaces and fills)
+ void setRowAlignment(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::Element * 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;
// 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
/**
\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 & sl, bool boundary) const;
///
- int cursorY(CursorSlice const & cursor,
- bool boundary) const;
+ int cursorY(CursorSlice const & sl, bool boundary) const;
- ///
- void cursorPrevious(Cursor & cur);
- ///
- void cursorNext(Cursor & cur);
///
bool cursorHome(Cursor & cur);
///
///
void deleteLineForward(Cursor & cur);
- /// is this row the last in the text?
- bool isLastRow(pit_type pit, Row const & row) const;
- /// is this row the first in the text?
- bool isFirstRow(pit_type pit, 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
/// outermost inset within this Text.
/// \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:
/// \todo FIXME: this should be const.
Text * text_;
- bool main_text_;
/// A map from paragraph index number to paragraph metrics
typedef std::map<pit_type, ParagraphMetrics> ParMetricsCache;
///
mutable ParMetricsCache par_metrics_;
Dimension dim_;
int max_width_;
+ /// if true, do not expand insets to max width artificially
+ bool tight_;
mutable Point origin_;
// temporary 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_;
projects / lyx.git / blobdiff