// -*- 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 "LColor.h"
#include "insets/inset.h"
#include "RowList.h"
+#include "bufferview_funcs.h"
+#include "textcursor.h"
class Buffer;
class BufferParams;
/**
This class holds the mapping between buffer paragraphs and screen rows.
*/
-class LyXText {
-public:
- /// what repainting is needed
- enum refresh_status {
- /// no repaint is needed
- REFRESH_NONE = 0,
- /// the refresh_row needs repainting
- REFRESH_ROW = 1,
- /// everything from refresh_y downwards needs repainting
- REFRESH_AREA = 2
- };
-
- ///
- enum word_location {
- // the word around the cursor, only if the cursor is
- //not at a boundary
- WHOLE_WORD_STRICT,
- // the word around the cursor
- WHOLE_WORD,
- /// the word begining from the cursor position
- PARTIAL_WORD,
- /// the word around the cursor or before the cursor
- PREVIOUS_WORD,
- /// the next word (not yet used)
- NEXT_WORD
- };
+// The inheritance from TextCursor should go. It's just there to ease
+// transition...
+class LyXText : public TextCursor {
+public:
/// Constructor
LyXText(BufferView *);
/// sets inset as owner
LyXText(BufferView *, InsetText *);
- void init(BufferView *, bool reinit = false);
+ void init(BufferView *);
///
int height;
///
*/
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)
///
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);
///
void breakAgainOneRow(RowList::iterator rit);
/** 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 insertInset(Inset * inset);
- /// Completes the insertion with a full rebreak
+ /// Completes the insertion with a rebreak from 'need_break_row' on
+ void partialRebreak();
+ /// a full rebreak of the whole text
void fullRebreak();
+ /// rebuild RowList cache
+ void rebuild();
///
RowList::iterator need_break_row;
/// clear any pending paints
void clearPaint();
- /**
- * Mark position y as the starting point for a repaint
- */
- void postPaint(int start_y);
-
- /**
- * Mark the given row at position y as needing a repaint.
- */
- void postRowPaint(RowList::iterator rit, int start_y);
+ /// submit repaint request
+ void postPaint();
///
Inset::RESULT dispatch(FuncRequest const & cmd);
* Return the status. This represents what repaints are
* pending after some operation (e.g. inserting a char).
*/
- refresh_status refreshStatus() const;
+ bool needRefresh() const;
private:
- /**
- * The pixel y position from which to repaint the screen.
- * The position is absolute along the height of outermost
- * 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 REFRESH_ROW.
- * It doesn't make any difference for REFRESH_AREA.
- */
- RowList::iterator refresh_row;
-
- refresh_status refresh_status_;
+ // do we need a refresh?
+ bool need_refresh_;
+public:
/// only the top-level LyXText has this non-zero
BufferView * bv_owner;
+private:
+ /// returns a pointer to a specified row.
+ RowList::iterator
+ getRow(ParagraphList::iterator pit, lyx::pos_type pos) const;
public:
+ /// returns a pointer cursor row
+ RowList::iterator getRow(LyXCursor const & cursor) const;
+ /// convenience
+ RowList::iterator cursorRow() const;
+ /**
+ * Return the next row, when cursor is at the end of the
+ * previous row, for insets that take a full row.
+ *
+ * FIXME: explain why we need this ? especially for y...
+ */
+ RowList::iterator cursorIRow() const;
+
/** returns a pointer to the row near the specified y-coordinate
(relative to the whole text). y is set to the real beginning
of this row
x is set to the real beginning of this column
*/
lyx::pos_type getColumnNearX(RowList::iterator rit,
- int & x, bool & boundary) const;
+ int & x, bool & boundary) const;
/** returns a pointer to a specified row. y is set to the beginning
of the row
*/
RowList::iterator
- getRow(Paragraph * par, lyx::pos_type pos, int & y) const;
+ getRow(ParagraphList::iterator pit, lyx::pos_type pos, int & y) const;
- RowList & rows() {
- return rowlist_;
- }
- RowList const & rows() const {
+ RowList & rows() const {
return rowlist_;
}
- /** The cursor.
- Later this variable has to be removed. There should be now internal
- cursor in a text (and thus not in a buffer). By keeping this it is
- (I think) impossible to have several views with the same buffer, but
- the cursor placed at different places.
- [later]
- Since the LyXText now has been moved from Buffer to BufferView
- it should not be absolutely needed to move the cursor...
- */
- LyXCursor cursor; // actual cursor position
-
- /** The structure that keeps track of the selections set. */
- struct Selection {
- Selection()
- : set_(false), mark_(false)
- {}
- bool set() const {
- return set_;
- }
- void set(bool s) {
- set_ = s;
- }
- bool mark() const {
- return mark_;
- }
- void mark(bool m) {
- mark_ = m;
- }
- LyXCursor cursor; // temporary cursor to hold a cursor position
- // until setSelection is called!
- LyXCursor start; // start of a REAL selection
- LyXCursor end; // end of a REAL selection
- private:
- bool set_; // former selection
- bool mark_; // former mark_set
-
- };
- Selection selection;
- // this is used to handle XSelection events in the right manner
- Selection xsel_cache;
-
- /// needed for the toggling (cursor position on last selection made)
- LyXCursor last_sel_cursor;
- /// needed for toggling the selection in screen.C
- LyXCursor toggle_cursor;
- /// needed for toggling the selection in screen.C
- LyXCursor toggle_end_cursor;
/// need the selection cursor:
void setSelection();
///
void clearSelection();
- ///
- string const selectionAsString(Buffer const *, bool label) const;
/// select the word we need depending on word_location
- void getWord(LyXCursor & from, LyXCursor & to,
- word_location const);
+ void getWord(LyXCursor & from, LyXCursor & to, lyx::word_location const);
/// just selects the word the cursor is in
- void selectWord(word_location const);
+ void selectWord(lyx::word_location loc);
/// returns the inset at cursor (if it exists), 0 otherwise
Inset * getInset() const;
///
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();
///
void backspace();
///
- bool selectWordWhenUnderCursor(word_location);
+ bool selectWordWhenUnderCursor(lyx::word_location);
///
enum TextCase {
///
};
/// 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 const & 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:
///
- RowList rowlist_;
- ///
- void cursorLeftOneWord(LyXCursor &);
+ mutable RowList rowlist_;
///
float getCursorX(RowList::iterator rit, lyx::pos_type pos,
*/
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;
-
/// removes the row and reset the touched counters
void removeRow(RowList::iterator rit);
void removeParagraph(RowList::iterator rit);
/// insert the specified paragraph behind the specified row
- void insertParagraph(Paragraph * par, RowList::iterator rowit);
+ void insertParagraph(ParagraphList::iterator pit,
+ RowList::iterator rowit);
/** appends the implizit specified paragraph behind the specified row,
* start at the implizit given position */
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(RowList::iterator rit) 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(RowList::iterator rit, 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;
+
+private:
+ /** Cursor related data.
+ Later this variable has to be removed. There should be now internal
+ cursor in a text */
+ ///
+ ///TextCursor cursor_;
};
/// return the default height of a row in pixels, considering font zoom
projects / lyx.git / blobdiff