// -*- C++ -*-
-/* This file is part of
- * ======================================================
- *
- * LyX, The Document Processor
+/**
+ * \file lyxtext.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
*
- * Copyright 1995 Matthias Ettrich
- * Copyright 1995-2001 The LyX Team.
+ * \author unknown
+ * \author Lars Gullik Bjønnes
+ * \author John Levon
*
- * ====================================================== */
+ * Full author contact details are available in file CREDITS
+ */
#ifndef LYXTEXT_H
#define LYXTEXT_H
#include "layout.h"
#include "LColor.h"
#include "insets/inset.h"
+#include "RowList.h"
+#include "bufferview_funcs.h"
class Buffer;
class BufferParams;
class LyXText {
public:
/// what repainting is needed
- enum text_status {
+ enum refresh_status {
/// no repaint is needed
- UNCHANGED = 0,
- /**
- * A paint has caused a change in some rows
- * and rebreaking is needed.
- */
- CHANGED_IN_DRAW = 1,
+ REFRESH_NONE = 0,
/// the refresh_row needs repainting
- NEED_VERY_LITTLE_REFRESH = 2,
+ REFRESH_ROW = 1,
/// everything from refresh_y downwards needs repainting
- NEED_MORE_REFRESH = 3
+ REFRESH_AREA = 2
};
///
/// sets inset as owner
LyXText(BufferView *, InsetText *);
- /// Destructor
- ~LyXText();
-
void init(BufferView *, bool reinit = false);
///
int height;
/** the 'anchor' row: the position of this row remains constant
* with respect to the top of the screen
*/
- Row * anchor_row_;
+ RowList::iterator anchor_row_;
/** the pixel offset with respect to this row of top_y
*/
int anchor_row_offset_;
public:
+ /// update all cached row positions
+ void updateRowPositions();
/// get the y coord. of the top of the screen (relative to doc start)
int top_y() const;
/// set the y coord. of the top of the screen (relative to doc start)
void top_y(int newy);
/// set the anchoring row. top_y will be computed relative to this
- void anchor_row(Row * row);
+ void anchor_row(RowList::iterator rit);
///
InsetText * inset_owner;
///
///
int getRealCursorX() const;
///
- LyXFont const getFont(Buffer const *, Paragraph * par,
+ LyXFont const getFont(Buffer const *, ParagraphList::iterator pit,
lyx::pos_type pos) const;
///
- LyXFont const getLayoutFont(Buffer const *, Paragraph * par) const;
+ LyXFont const getLayoutFont(Buffer const *,
+ ParagraphList::iterator pit) const;
///
- LyXFont const getLabelFont(Buffer const *, Paragraph * par) const;
+ LyXFont const getLabelFont(Buffer const *,
+ ParagraphList::iterator pit) const;
///
- void setCharFont(Buffer const *, Paragraph * par,
+ void setCharFont(Buffer const *, ParagraphList::iterator pit,
lyx::pos_type pos, LyXFont const & font);
- void setCharFont(Paragraph * par,
- lyx::pos_type pos, LyXFont const & font, bool toggleall);
+ void setCharFont(ParagraphList::iterator pit,
+ lyx::pos_type pos,
+ LyXFont const & font, bool toggleall);
- /// return true if the row changed
- void markChangeInDraw(Row * row, Row * next);
///
- void breakAgainOneRow(Row * row);
+ void breakAgainOneRow(RowList::iterator rit);
/// what you expect when pressing <enter> at cursor position
void breakParagraph(ParagraphList & paragraphs, char keep_layout = 0);
/** set layout over selection and make a total rebreak of
those paragraphs
*/
- Paragraph * setLayout(LyXCursor & actual_cursor,
- LyXCursor & selection_start,
- LyXCursor & selection_end,
- string const & layout);
+ ParagraphList::iterator
+ setLayout(LyXCursor & actual_cursor,
+ LyXCursor & selection_start,
+ LyXCursor & selection_end,
+ string const & layout);
///
void setLayout(string const & layout);
- /** increment depth over selection and make a total rebreak of those
- paragraphs
- */
- void incDepth();
-
- /** decrement depth over selection and make a total rebreak of those
- paragraphs */
- void decDepth();
+ /**
+ * Increase or decrease the nesting depth of the selected paragraph(s)
+ * if test_only, don't change any depths. Returns whether something
+ * (would have) changed
+ */
+ bool changeDepth(bv_funcs::DEPTH_CHANGE type, bool test_only);
/// get the depth at current cursor position
int getDepth() const;
This function is needed after SetLayout and SetFont etc.
*/
void redoParagraphs(LyXCursor const & cursor,
- Paragraph const * end_par);
+ ParagraphList::iterator endpit);
///
void redoParagraph();
void fullRebreak();
///
- Row * need_break_row;
+ RowList::iterator need_break_row;
/// clear any pending paints
void clearPaint();
- /// post notice that we changed during a draw
- void postChangedInDraw();
-
/**
* Mark position y as the starting point for a repaint
*/
/**
* Mark the given row at position y as needing a repaint.
*/
- void postRowPaint(Row * row, int start_y);
+ void postRowPaint(RowList::iterator rit, int start_y);
///
Inset::RESULT dispatch(FuncRequest const & cmd);
* Return the status. This represents what repaints are
* pending after some operation (e.g. inserting a char).
*/
- text_status status() const;
+ refresh_status refreshStatus() const;
private:
/**
* The pixel y position from which to repaint the screen.
* The position is absolute along the height of outermost
- * lyxtext (I think). NEED_MORE_REFRESH and NEED_LITTLE_REFRESH
+ * lyxtext (I think). REFRESH_AREA and REFRESH_ROW
* repaints both use this as a starting point (if it's within
* the viewable portion of the lyxtext).
*/
int refresh_y;
/**
* The row from which to repaint the screen, used by screen.c.
- * This must be set if the pending update is NEED_LITTLE_REFRESH.
- * It doesn't make any difference for NEED_MORE_REFRESH.
+ * This must be set if the pending update is REFRESH_ROW.
+ * It doesn't make any difference for REFRESH_AREA.
*/
- Row * refresh_row;
+ RowList::iterator refresh_row;
- /// refresh status
- text_status status_;
+ refresh_status refresh_status_;
/// only the top-level LyXText has this non-zero
BufferView * bv_owner;
(relative to the whole text). y is set to the real beginning
of this row
*/
- Row * getRowNearY(int & y) const;
+ RowList::iterator getRowNearY(int & y) const;
/** returns the column near the specified x-coordinate of the row
x is set to the real beginning of this column
*/
- lyx::pos_type getColumnNearX(Row * row,
- int & x, bool & boundary) const;
+ lyx::pos_type getColumnNearX(RowList::iterator rit,
+ int & x, bool & boundary) const;
/** returns a pointer to a specified row. y is set to the beginning
of the row
*/
- Row * getRow(Paragraph * par, lyx::pos_type pos, int & y) const;
- /** returns the firstrow, this could be done with the above too but
- IMO it's stupid to have to allocate a dummy y all the time I need
- the first row
- */
- Row * firstRow() const { return firstrow; }
+ RowList::iterator
+ getRow(ParagraphList::iterator pit, lyx::pos_type pos, int & y) const;
+
+ RowList & rows() const {
+ return rowlist_;
+ }
/** The cursor.
Later this variable has to be removed. There should be now internal
///
void selectSelectedWord();
/// returns true if par was empty and was removed
- bool setCursor(Paragraph * par,
+ bool setCursor(ParagraphList::iterator pit,
lyx::pos_type pos,
bool setfont = true,
bool boundary = false);
///
- void setCursor(LyXCursor &, Paragraph * par,
+ void setCursor(LyXCursor &, ParagraphList::iterator pit,
lyx::pos_type pos,
bool boundary = false);
///
- void setCursorIntern(Paragraph * par,
+ void setCursorIntern(ParagraphList::iterator pit,
lyx::pos_type pos,
bool setfont = true,
bool boundary = false);
void setCurrentFont();
///
- bool isBoundary(Buffer const *, Paragraph * par,
+ bool isBoundary(Buffer const *, Paragraph const & par,
lyx::pos_type pos) const;
///
- bool isBoundary(Buffer const *, Paragraph * par,
+ bool isBoundary(Buffer const *, Paragraph const & par,
lyx::pos_type pos,
LyXFont const & font) const;
///
void cursorNext();
///
- void cursorTab();
- ///
void cursorTop();
///
void cursorBottom();
};
/// Change the case of the word at cursor position.
void changeCase(TextCase action);
- ///
- void transposeChars();
///
void toggleInset();
///
void copySelection();
///
- void pasteSelection();
- ///
- void copyEnvironmentType();
- ///
- void pasteEnvironmentType();
+ void pasteSelection(size_t sel_index = 0);
/** the DTP switches for paragraphs. LyX will store the top settings
always in the first physical paragraph, the bottom settings in the
/// returns false if inset wasn't found
bool updateInset(Inset *);
///
- void checkParagraph(Paragraph * par, lyx::pos_type pos);
+ void checkParagraph(ParagraphList::iterator pit, lyx::pos_type pos);
///
int workWidth() const;
- ///
- int workWidth(Inset * inset) const;
+ /// returns width of row containing inset
+ int workWidth(Inset const * inset) const;
///
- void computeBidiTables(Buffer const *, Row * row) const;
+ void computeBidiTables(Buffer const *, RowList::iterator row) const;
/// Maps positions in the visual string to positions in logical string.
lyx::pos_type log2vis(lyx::pos_type pos) const;
/// Maps positions in the logical string to positions in visual string.
bool bidi_InRange(lyx::pos_type pos) const;
private:
///
- Row * firstrow;
- ///
- Row * lastrow;
-
+ mutable RowList rowlist_;
///
void cursorLeftOneWord(LyXCursor &);
///
- float getCursorX(Row *, lyx::pos_type pos,
+ float getCursorX(RowList::iterator rit, lyx::pos_type pos,
lyx::pos_type last, bool boundary) const;
/// used in setlayout
void makeFontEntriesLayoutSpecific(Buffer const &, Paragraph & par);
*/
void redoDrawingOfParagraph(LyXCursor const & cursor);
- /** Copybuffer for copy environment type.
- Asger has learned that this should be a buffer-property instead
- Lgb has learned that 'char' is a lousy type for non-characters
- */
- string copylayouttype;
-
- /** inserts a new row behind the specified row, increments
- the touched counters */
- void insertRow(Row * row, Paragraph * par, lyx::pos_type pos);
/// removes the row and reset the touched counters
- void removeRow(Row * row);
+ void removeRow(RowList::iterator rit);
/// remove all following rows of the paragraph of the specified row.
- void removeParagraph(Row * row);
+ void removeParagraph(RowList::iterator rit);
/// insert the specified paragraph behind the specified row
- void insertParagraph(Paragraph * par, Row * row);
+ void insertParagraph(ParagraphList::iterator pit,
+ RowList::iterator rowit);
/** appends the implizit specified paragraph behind the specified row,
* start at the implizit given position */
- void appendParagraph(Row * row);
+ void appendParagraph(RowList::iterator rowit);
///
- void breakAgain(Row * row);
+ void breakAgain(RowList::iterator rit);
/// Calculate and set the height of the row
- void setHeightOfRow(Row * row_ptr);
+ void setHeightOfRow(RowList::iterator rit);
// fix the cursor `cur' after a characters has been deleted at `where'
// position. Called by deleteEmptyParagraphMechanism
Inset * checkInsetHit(int & x, int & y);
///
- int singleWidth(Paragraph * par,
+ int singleWidth(ParagraphList::iterator pit,
lyx::pos_type pos) const;
///
- int singleWidth(Paragraph * par,
+ int singleWidth(ParagraphList::iterator pit,
lyx::pos_type pos, char c) const;
/// return the color of the canvas
///
mutable bool bidi_same_direction;
- unsigned char transformChar(unsigned char c, Paragraph * par,
+ unsigned char transformChar(unsigned char c, Paragraph const & par,
lyx::pos_type pos) const;
/**
* in LaTeX the beginning of the text fits in some cases
* (for example sections) exactly the label-width.
*/
- int leftMargin(Row const * row) const;
+ int leftMargin(Row const & row) const;
///
int rightMargin(Buffer const &, Row const & row) const;
/** this calculates the specified parameters. needed when setting
* the cursor and when creating a visible row */
- void prepareToPrint(Row * row, float & x,
+ void prepareToPrint(RowList::iterator row, float & x,
float & fill_separator,
float & fill_hfill,
float & fill_label_hfill,
private:
///
- void setCounter(Buffer const *, Paragraph * par);
+ void setCounter(Buffer const *, ParagraphList::iterator pit);
///
void deleteWordForward();
///
lyx::pos_type rowBreakPoint(Row const & row) const;
/// returns the minimum space a row needs on the screen in pixel
- int fill(Row & row, int workwidth) const;
+ int fill(RowList::iterator row, int workwidth) const;
/**
* returns the minimum space a manual label needs on the
//
// special owner functions
///
- Paragraph * ownerParagraph() const;
- //
- void ownerParagraph(Paragraph *) const;
- // set it searching first for the right owner using the paragraph id
- void ownerParagraph(int id, Paragraph *) const;
+ ParagraphList & ownerParagraphs() const;
/// return true if this is owned by an inset.
bool isInInset() const;