Updates from Bennett and myself.

[lyx.git] / src / lyxtext.h

diff --git a/src/lyxtext.h b/src/lyxtext.h
index 3fba32736201ac8fc22ab2a8fcfdfa85faff1537..db041303289d0e98bb0c1933de48240f60e1c309 100644 (file)
--- a/src/lyxtext.h
+++ b/src/lyxtext.h
@@ -96,7 +96,9 @@ public:
        /// Set font over selection paragraphs and rebreak.
        void setFont(LCursor & cur, LyXFont const &, bool toggleall = false);
 
-       /// rebreaks the given par
+       /// Rebreaks the given paragraph.
+       /// \retval true if a full screen redraw is needed.
+       /// \retval false if a single paragraph redraw is enough.
        bool redoParagraph(BufferView &, pit_type pit);
 
        /// returns pos in given par at given x coord
@@ -107,7 +109,7 @@ public:
        void toggleFree(LCursor & cur, LyXFont const &, bool toggleall = false);
 
        ///
-       std::string getStringToIndex(LCursor const & cur);
+       docstring getStringToIndex(LCursor const & cur);
 
        /// insert a character at cursor position
        void insertChar(LCursor & cur, char_type c);
@@ -178,8 +180,15 @@ public:
        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 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
+       */
        InsetBase * editXY(LCursor & cur, int x, int y);
+       
        /// Move cursor one line up.
        /**
         * Returns true if an update is needed after the move.
@@ -213,20 +222,15 @@ public:
        ///
        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
        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
        bool backspace(LCursor & cur);
        // Dissolve the inset under cursor
@@ -244,6 +248,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,7 +259,7 @@ 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 */
@@ -276,8 +282,8 @@ public:
        int singleWidth(Buffer const &, Paragraph const & par,
                pos_type pos) const;
        ///
-       int singleWidth(Buffer const &, Paragraph const & par,
-               pos_type pos, char_type c, LyXFont const & Font) const;
+       int singleWidth(Paragraph const & par, pos_type pos, char_type c,
+               LyXFont const & Font) const;
 
        /// return the color of the canvas
        LColor_color backgroundColor() const;
@@ -315,7 +321,7 @@ public:
        ///
        double spacing(Buffer const & buffer, Paragraph const & par) const;
        /// make a suggestion for a label
-       std::string getPossibleLabel(LCursor & cur) const;
+       docstring getPossibleLabel(LCursor & cur) const;
        /// is this paragraph right-to-left?
        bool isRTL(Buffer const &, Paragraph const & par) const;
        ///
@@ -374,6 +380,10 @@ private:
        // position. Called by deleteEmptyParagraphMechanism
        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);
        ///
@@ -383,7 +393,8 @@ private:
 
        /// 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;
+       void rowBreakPoint(Buffer const &, int right_margin, 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