X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Flyxtext.h;h=897808cca860789ac90c57995140309b4efb7b67;hb=e7f4618bcce770369cf46335c2c7f0164b4b8857;hp=75cb8021144e4c227a23e6b7848d12e05d2257f1;hpb=d06475855c85e16fec9b708779509cab1dd3a470;p=lyx.git diff --git a/src/lyxtext.h b/src/lyxtext.h index 75cb802114..897808cca8 100644 --- a/src/lyxtext.h +++ b/src/lyxtext.h @@ -14,10 +14,8 @@ #ifndef LYXTEXT_H #define LYXTEXT_H -#include "bufferview_funcs.h" #include "Bidi.h" #include "dispatchresult.h" -#include "dimension.h" #include "lyxfont.h" #include "layout.h" #include "lyxlayout_ptr_fwd.h" @@ -32,16 +30,14 @@ class Buffer; class BufferParams; class BufferView; class CursorSlice; -class Dimension; +class DocIterator; class ErrorList; -class InsetBase; -class InsetBase_code; class FuncRequest; class FuncStatus; +class InsetBase; class LColor_color; class LCursor; class LyXTextClass; -class MetricsInfo; class PainterInfo; class Row; class RowMetrics; @@ -52,9 +48,7 @@ class Spacing; class LyXText { public: /// constructor - explicit LyXText(BufferView * bv = 0); - /// - void init(BufferView *); + explicit LyXText(); /// LyXFont getFont(Buffer const & buffer, Paragraph const & par, @@ -79,7 +73,8 @@ public: /// set layout over selection void setLayout(Buffer const & buffer, pit_type start, pit_type end, std::string const & layout); - /// + /// Set given layout to current cursor position. + /// FIXME: replace LCursor with DocIterator. void setLayout(LCursor & cur, std::string const & layout); /// what type of depth change to make @@ -88,40 +83,38 @@ public: DEC_DEPTH }; /// Increase or decrease the nesting depth of the selected paragraph(s) + /// FIXME: replace LCursor with DocIterator. void changeDepth(LCursor & cur, DEPTH_CHANGE type); /// Returns whether something would be changed by changeDepth + /// FIXME: replace LCursor with DocIterator. bool changeDepthAllowed(LCursor & cur, DEPTH_CHANGE type) const; /// Set font over selection paragraphs and rebreak. + /// FIXME: replace LCursor with DocIterator. void setFont(LCursor & cur, LyXFont const &, bool toggleall = false); - /// rebreaks the given par - bool redoParagraph(BufferView &, pit_type pit); - - /// returns pos in given par at given x coord - pos_type x2pos(BufferView const &, pit_type pit, int row, int x) const; - int pos2x(pit_type pit, pos_type pos) const; - /// void toggleFree(LCursor & cur, LyXFont const &, bool toggleall = false); - /// + /// ??? + /// FIXME: replace LCursor with DocIterator. docstring getStringToIndex(LCursor const & cur); /// insert a character at cursor position + /// FIXME: replace LCursor with DocIterator. void insertChar(LCursor & cur, char_type c); /// insert an inset at cursor position + /// FIXME: replace LCursor with DocIterator. void insertInset(LCursor & cur, InsetBase * inset); - /// compute text metrics - void metrics(MetricsInfo & mi, Dimension & dim); /// draw text (only used for insets) void draw(PainterInfo & pi, int x, int y) const; /// draw textselection void drawSelection(PainterInfo & pi, int x, int y) const; /// try to handle that request + /// FIXME: replace LCursor with DocIterator. void dispatch(LCursor & cur, FuncRequest & cmd); /// do we want to handle this event? bool getStatus(LCursor & cur, FuncRequest const & cmd, @@ -132,20 +125,24 @@ public: /// read-write access to individual paragraph Paragraph & getPar(pit_type pit) { return pars_[pit]; } // Returns the current font and depth as a message. - std::string currentState(LCursor & cur); + /// FIXME: replace LCursor with DocIterator. + docstring currentState(LCursor & cur); /** returns row near the specified * y-coordinate in given paragraph (relative to the screen). */ + /// FIXME: move to TextMetrics. Row const & getRowNearY(BufferView const & bv, int y, pit_type pit) const; - pit_type getPitNearY(BufferView const & bv, int y) const; - /** returns the column near the specified x-coordinate of the row - x is set to the real beginning of this column - */ - pos_type getColumnNearX(BufferView const & bv, pit_type pit, - Row const & row, int & x, bool & boundary) const; + /// returns the paragraph number closest to screen y-coordinate. + /// This method uses the BufferView CoordCache to locate the + /// paragraph. The y-coodinate is allowed to be off-screen and + /// the CoordCache will be automatically updated if needed. This is + /// the reason why we need a non const BufferView and why this + /// method is non-const. + /// FIXME: move to TextMetrics. + pit_type getPitNearY(BufferView & bv, int y); /** Find the word under \c from in the relative location * defined by \c word_location. @@ -156,10 +153,17 @@ public: /// just selects the word the cursor is in void selectWord(LCursor & cur, word_location loc); - /// accept selected change - void acceptChange(LCursor & cur); - /// reject selected change - void rejectChange(LCursor & cur); + /// what type of change operation to make + enum ChangeOp { + ACCEPT, + REJECT + }; + /// accept or reject the selected change + void acceptOrRejectChanges(LCursor & cur, ChangeOp op); + /// accept the changes within the complete LyXText + void acceptChanges(BufferParams const & bparams); + /// reject the changes within the complete LyXText + void rejectChanges(BufferParams const & bparams); /// returns true if par was empty and was removed bool setCursor(LCursor & cur, pit_type par, pos_type pos, @@ -176,19 +180,31 @@ public: void recUndo(LCursor & cur, pit_type first, pit_type last) const; /// void recUndo(LCursor & cur, pit_type first) const; - /// returns true if par was empty and was removed - bool setCursorFromCoordinates(LCursor & cur, int x, int y); - /// + + /// sets cursor only within this LyXText. + /// x,y are screen coordinates + void setCursorFromCoordinates(LCursor & cur, int x, int y); + + /// sets cursor recursively descending into nested editable insets + /** + \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 + */ + /// FIXME: move to TextMetrics. InsetBase * editXY(LCursor & cur, int x, int y); + /// Move cursor one line up. /** * Returns true if an update is needed after the move. */ + /// FIXME: move to TextMetrics. bool cursorUp(LCursor & cur); /// Move cursor one line down. /** * Returns true if an update is needed after the move. */ + /// FIXME: move to TextMetrics. bool cursorDown(LCursor & cur); /// Move cursor one position left /** @@ -209,27 +225,27 @@ public: /// bool cursorDownParagraph(LCursor & cur); /// + /// FIXME: move to TextMetrics. bool cursorHome(LCursor & cur); /// + /// FIXME: move to TextMetrics. bool cursorEnd(LCursor & cur); /// - bool cursorPrevious(LCursor & cur); + void cursorPrevious(LCursor & cur); /// - bool cursorNext(LCursor & cur); + void cursorNext(LCursor & cur); /// bool cursorTop(LCursor & cur); /// bool cursorBottom(LCursor & cur); /// Erase character at cursor. Honour change tracking + /// FIXME: replace LCursor with DocIterator. bool erase(LCursor & cur); - /** At cursor position 0, merge paragraph with the one before it. - * Ignore CT (this is used in \c acceptChange, \c rejectChange for - * physical deletion of paragraph break) - */ - bool backspacePos0(LCursor & cur); /// Delete character before cursor. Honour CT + /// FIXME: replace LCursor with DocIterator. bool backspace(LCursor & cur); // Dissolve the inset under cursor + /// FIXME: replace LCursor with DocIterator. bool dissolveInset(LCursor & cur); /// bool selectWordWhenUnderCursor(LCursor & cur, word_location); @@ -244,6 +260,8 @@ public: }; /// Change the case of the word at cursor position. void changeCase(LCursor & cur, TextCase action); + /// Transposes the character at the cursor with the one before it + void charsTranspose(LCursor & cur); /** the DTP switches for paragraphs. LyX will store the top settings always in the first physical paragraph, the bottom settings in the @@ -253,29 +271,27 @@ public: void setParagraph(LCursor & cur, Spacing const & spacing, LyXAlignment align, - std::string const & labelwidthstring, + docstring const & labelwidthstring, bool noindent); /* these things are for search and replace */ /// needed to insert the selection + /// FIXME: replace LCursor with DocIterator. void insertStringAsLines(LCursor & cur, docstring const & str); /// needed to insert the selection + /// FIXME: replace LCursor with DocIterator. void insertStringAsParagraphs(LCursor & cur, docstring const & str); - /// current text width - int width() const; - - /// current text heigth - int height() const; - /// Returns an inset if inset was hit, or 0 if not. - InsetBase * checkInsetHit(BufferView const &, int x, int y) const; + InsetBase * checkInsetHit(BufferView &, int x, int y); /// + /// FIXME: move to TextMetrics. int singleWidth(Buffer const &, Paragraph const & par, pos_type pos) const; /// + /// FIXME: move to TextMetrics. int singleWidth(Paragraph const & par, pos_type pos, char_type c, LyXFont const & Font) const; @@ -288,15 +304,9 @@ public: * in LaTeX the beginning of the text fits in some cases * (for example sections) exactly the label-width. */ - int leftMargin(Buffer const &, pit_type pit, pos_type pos) const; - int leftMargin(Buffer const &, pit_type pit) const; - /// - int rightMargin(Buffer const &, Paragraph const & par) const; - - /** this calculates the specified parameters. needed when setting - * the cursor and when creating a visible row */ - RowMetrics computeRowMetrics(Buffer const &, pit_type pit, - Row const & row) const; + /// FIXME: move to TextMetrics. + int leftMargin(Buffer const &, int max_width, pit_type pit, pos_type pos) const; + int leftMargin(Buffer const &, int max_width, pit_type pit) const; /// access to our paragraphs ParagraphList const & paragraphs() const { return pars_; } @@ -304,18 +314,18 @@ public: /// return true if this is the main text bool isMainText(Buffer const &) const; - /// return first row of text - Row const & firstRow() const; - /// is this row the last in the text? + /// FIXME: move to TextMetrics. bool isLastRow(pit_type pit, Row const & row) const; /// is this row the first in the text? + /// FIXME: move to TextMetrics. bool isFirstRow(pit_type pit, Row const & row) const; /// double spacing(Buffer const & buffer, Paragraph const & par) const; /// make a suggestion for a label - std::string getPossibleLabel(LCursor & cur) const; + /// FIXME: replace LCursor with DocIterator. + docstring getPossibleLabel(LCursor & cur) const; /// is this paragraph right-to-left? bool isRTL(Buffer const &, Paragraph const & par) const; /// @@ -327,23 +337,26 @@ public: bool read(Buffer const & buf, LyXLex & lex, ErrorList & errorList); /// - int ascent() const; - /// - int descent() const; - /// - int cursorX(Buffer const &, CursorSlice const & cursor, + /// FIXME: move to TextMetrics. + int cursorX(BufferView const &, CursorSlice const & cursor, bool boundary) const; /// - int cursorY(CursorSlice const & cursor, bool boundary) const; + /// FIXME: move to TextMetrics. + int cursorY(BufferView const & bv, CursorSlice const & cursor, + bool boundary) const; + + /// delete double spaces, leading spaces, and empty paragraphs around old cursor. + /// \retval true if a change has happened and we need a redraw. + /// FIXME: replace LCursor with DocIterator. This is not possible right + /// now because recordUndo() is called which needs a LCursor. + static bool deleteEmptyParagraphMechanism(LCursor & cur, + LCursor & old, bool & need_anchor_change); - /// delete double space or empty paragraphs around old cursor - bool deleteEmptyParagraphMechanism(LCursor & cur, LCursor & old); + /// delete double spaces, leading spaces, and empty paragraphs + /// from \first to \last paragraph + void deleteEmptyParagraphMechanism(pit_type first, pit_type last, bool trackChanges); public: - /// - Dimension dim_; - /// - int maxwidth_; /// the current font settings LyXFont current_font; /// the current font @@ -367,12 +380,13 @@ private: /// change on pit pit_type undoSpan(pit_type pit); - /// Calculate and set the height of the row - void setHeightOfRow(BufferView const &, pit_type, Row & row); - // fix the cursor `cur' after a characters has been deleted at `where' // position. Called by deleteEmptyParagraphMechanism - void fixCursorAfterDelete(CursorSlice & cur, CursorSlice const & where); + static void fixCursorAfterDelete(CursorSlice & cur, CursorSlice const & where); + + // At cursor position 0, try to merge the paragraph with the one before it. + // Ignore change tracking, i.e., physically remove the end-of-par character + bool backspacePos0(LCursor & cur); /// void deleteWordForward(LCursor & cur); @@ -380,26 +394,17 @@ private: void deleteWordBackward(LCursor & cur); /// void deleteLineForward(LCursor & cur); - - /// sets row.end to the pos value *after* which a row should break. - /// for example, the pos after which isNewLine(pos) == true - void rowBreakPoint(Buffer const &, pit_type pit, Row & row) const; - /// sets row.width to the minimum space a row needs on the screen in pixel - void setRowWidth(Buffer const &, pit_type pit, Row & row) const; - /// the minimum space a manual label needs on the screen in pixels - int labelFill(Buffer const &, Paragraph const & par, Row const & row) const; - /// FIXME - int labelEnd(Buffer const &, pit_type pit) const; - /// void charInserted(); /// set 'number' font property void number(LCursor & cur); -}; - -/// return the default height of a row in pixels, considering font zoom -int defaultRowHeight(); + /// paste plain text at current cursor. + /// \param str string to paste + /// \param asParagraphs whether to paste as paragraphs or as lines + void pasteString(LCursor & cur, docstring const & str, + bool asParagraphs); +}; } // namespace lyx