]> git.lyx.org Git - lyx.git/blobdiff - src/Text.h
Fix bug #5131: Remember last file active.
[lyx.git] / src / Text.h
index b5db10f07e5ac04e0915d81cce14b03c721898c4..df19ca7ae2dc71c20621bb692c9a4f4a9d274ae8 100644 (file)
@@ -5,7 +5,7 @@
  * Licence details can be found in the file COPYING.
  *
  * \author unknown
- * \author Lars Gullik Bjønnes
+ * \author Lars Gullik Bjønnes
  * \author John Levon
  *
  * Full author contact details are available in file CREDITS.
 #ifndef TEXT_H
 #define TEXT_H
 
-#include "Bidi.h"
-#include "DispatchResult.h"
-#include "Font.h"
-#include "Layout.h"
-#include "lyxlayout_ptr_fwd.h"
+#include "DocIterator.h"
 #include "ParagraphList.h"
 
-#include <iosfwd>
-
-
 namespace lyx {
 
 class Buffer;
 class BufferParams;
 class BufferView;
+class CompletionList;
 class CursorSlice;
 class DocIterator;
 class ErrorList;
+class Font;
+class FontInfo;
 class FuncRequest;
 class FuncStatus;
 class Inset;
-class Color_color;
 class Cursor;
+class Lexer;
 class PainterInfo;
 class Spacing;
 
@@ -53,21 +49,16 @@ public:
        bool empty() const;
 
        ///
-       Font getFont(Buffer const & buffer, Paragraph const & par,
-               pos_type pos) const;
-       ///
-       void applyOuterFont(Buffer const & buffer, Font &) const;
-       ///
-       Font getLayoutFont(Buffer const & buffer, pit_type pit) const;
+       FontInfo layoutFont(Buffer const & buffer, pit_type pit) const;
        ///
-       Font getLabelFont(Buffer const & buffer,
+       FontInfo labelFont(Buffer const & buffer,
                Paragraph const & par) const;
        /** Set font of character at position \p pos in paragraph \p pit.
         *  Must not be called if \p pos denotes an inset with text contents,
         *  and the inset is not allowed inside a font change (see below).
         */
        void setCharFont(Buffer const & buffer, pit_type pit, pos_type pos,
-               Font const & font);
+               Font const & font, Font const & display_font);
 
        /** Needed to propagate font changes to all text cells of insets
         *  that are not allowed inside a font change (bug 1973).
@@ -76,11 +67,11 @@ public:
         *  FIXME: This should be removed, see documentation of noFontChange
         *  in insetbase.h
         */
-       void setInsetFont(Buffer const & buffer, pit_type pit, pos_type pos,
+       void setInsetFont(BufferView const & bv, pit_type pit, pos_type pos,
                Font const & font, bool toggleall = false);
 
        /// what you expect when pressing \<enter\> at cursor position
-       void breakParagraph(Cursor & cur, bool keep_layout = false);
+       void breakParagraph(Cursor & cur, bool inverse_logic = false);
 
        /// set layout over selection
        void setLayout(Buffer const & buffer, pit_type start, pit_type end,
@@ -106,7 +97,7 @@ public:
        /// FIXME: replace Cursor with DocIterator.
        void setFont(Cursor & cur, Font const &, bool toggleall = false);
        /// Set font from \p begin to \p end and rebreak.
-       void setFont(Buffer const & buffer, CursorSlice const & begin,
+       void setFont(BufferView const & bv, CursorSlice const & begin,
                CursorSlice const & end, Font const &,
                bool toggleall = false);
 
@@ -117,6 +108,17 @@ public:
        /// FIXME: replace Cursor with DocIterator.
        docstring getStringToIndex(Cursor const & cur);
 
+       /// Convert the paragraphs to a string.
+       /// \param AsStringParameter options. This can contain any combination of
+       /// asStringParameter values. Valid examples:
+       ///             asString(AS_STR_LABEL)
+       ///             asString(AS_STR_LABEL | AS_STR_INSETS)
+       ///             asString(AS_STR_INSETS)
+       docstring asString(int options = AS_STR_NONE) const;
+       ///
+       docstring asString(pit_type beg, pit_type end,
+               int options = AS_STR_NONE) const;
+
        /// insert a character at cursor position
        /// FIXME: replace Cursor with DocIterator.
        void insertChar(Cursor & cur, char_type c);
@@ -137,17 +139,21 @@ public:
        Paragraph & getPar(pit_type pit) { return pars_[pit]; }
        // Returns the current font and depth as a message.
        /// FIXME: replace Cursor with DocIterator.
-       docstring currentState(Cursor & cur);
+       docstring currentState(Cursor const & cur) const;
 
        /** Find the word under \c from in the relative location
         *  defined by \c word_location.
         *  @param from return here the start of the word
         *  @param to return here the end of the word
         */
-       void getWord(CursorSlice & from, CursorSlice & to, word_location const);
+       void getWord(CursorSlice & from, CursorSlice & to, word_location const) const;
        /// just selects the word the cursor is in
        void selectWord(Cursor & cur, word_location loc);
-
+       /// select all text
+       void selectAll(Cursor & cur);
+       /// convenience function get the previous word or an empty string
+       docstring previousWord(CursorSlice const & sl) const;
+       
        /// what type of change operation to make
        enum ChangeOp {
                ACCEPT,
@@ -168,28 +174,42 @@ public:
        ///
        void setCursorIntern(Cursor & cur, pit_type par,
                 pos_type pos, bool setfont = true, bool boundary = false);
-       ///
-       void setCurrentFont(Cursor & cur);
 
        ///
        void recUndo(Cursor & cur, pit_type first, pit_type last) const;
        ///
        void recUndo(Cursor & cur, pit_type first) const;
 
-       /// Move cursor one position left
+       /// Move cursor one position backwards
        /**
         * Returns true if an update is needed after the move.
         */
-       bool cursorLeft(Cursor & cur);
-       /// Move cursor one position right
+       bool cursorBackward(Cursor & cur);
+       /// Move cursor visually one position to the left
        /**
+        * \param skip_inset if true, don't enter insets
         * Returns true if an update is needed after the move.
         */
-       bool cursorRight(Cursor & cur);
+       bool cursorVisLeft(Cursor & cur, bool skip_inset = false);
+       /// Move cursor one position forward
+       /**
+        * Returns true if an update is needed after the move.
+        */
+       bool cursorForward(Cursor & cur);
+       /// Move cursor visually one position to the right
+       /**
+        * \param skip_inset if true, don't enter insets
+        * Returns true if an update is needed after the move.
+        */
+       bool cursorVisRight(Cursor & cur, bool skip_inset = false);
+       ///
+       bool cursorBackwardOneWord(Cursor & cur);
        ///
-       bool cursorLeftOneWord(Cursor & cur);
+       bool cursorForwardOneWord(Cursor & cur);
        ///
-       bool cursorRightOneWord(Cursor & cur);
+       bool cursorVisLeftOneWord(Cursor & cur);
+       ///
+       bool cursorVisRightOneWord(Cursor & cur);
        /// Delete from cursor up to the end of the current or next word.
        void deleteWordForward(Cursor & cur);
        /// Delete from cursor to start of current or prior word.
@@ -213,15 +233,6 @@ public:
        bool dissolveInset(Cursor & cur);
        ///
        bool selectWordWhenUnderCursor(Cursor & cur, word_location);
-       ///
-       enum TextCase {
-               ///
-               text_lowercase = 0,
-               ///
-               text_capitalization = 1,
-               ///
-               text_uppercase = 2
-       };
        /// Change the case of the word at cursor position.
        void changeCase(Cursor & cur, TextCase action);
        /// Transposes the character at the cursor with the one before it
@@ -246,9 +257,6 @@ public:
        /// FIXME: replace Cursor with DocIterator.
        void insertStringAsParagraphs(Cursor & cur, docstring const & str);
 
-       /// return the color of the canvas
-       Color_color backgroundColor() const;
-
        /// access to our paragraphs
        ParagraphList const & paragraphs() const { return pars_; }
        ParagraphList & paragraphs() { return pars_; }
@@ -259,25 +267,21 @@ public:
        double spacing(Buffer const & buffer, Paragraph const & par) const;
        /// make a suggestion for a label
        /// FIXME: replace Cursor with DocIterator.
-       docstring getPossibleLabel(Cursor & cur) const;
+       docstring getPossibleLabel(Cursor const & cur) const;
        /// is this paragraph right-to-left?
        bool isRTL(Buffer const &, Paragraph const & par) const;
-       /// is this position in the paragraph right-to-left?
-       bool isRTL(Buffer const & buffer, CursorSlice const & sl, bool boundary) const;
-       /// is between pos-1 and pos an RTL<->LTR boundary?
-       bool isRTLBoundary(Buffer const & buffer, Paragraph const & par,
-         pos_type pos) const;
-       /// would be a RTL<->LTR boundary between pos and the given font?
-       bool isRTLBoundary(Buffer const & buffer, Paragraph const & par,
-         pos_type pos, Font const & font) const;
 
        ///
        bool checkAndActivateInset(Cursor & cur, bool front);
+       ///
+       bool checkAndActivateInsetVisual(Cursor & cur, bool movingForward, bool movingLeft);
 
        ///
        void write(Buffer const & buf, std::ostream & os) const;
-       /// returns whether we've seen our usual 'end' marker
-       bool read(Buffer const & buf, Lexer & lex, ErrorList & errorList);
+       /// returns true if \end_document has not been read
+       /// insetPtr is the containing Inset
+       bool read(Buffer const & buf, Lexer & lex, ErrorList & errorList, 
+                 InsetText * insetPtr);
 
        /// delete double spaces, leading spaces, and empty paragraphs around old cursor.
        /// \retval true if a change has happened and we need a redraw.
@@ -290,20 +294,26 @@ public:
        /// from \first to \last paragraph
        void deleteEmptyParagraphMechanism(pit_type first, pit_type last, bool trackChanges);
 
-public:
-       /// the current font settings
-       Font current_font;
-       /// the current font
-       Font real_current_font;
+       /// To resolve macros properly the texts get their DocIterator.
+       /// Every macro definition is stored with its DocIterator
+       /// as well. Only those macros with a smaller iterator become 
+       /// visible in a paragraph.
+       DocIterator macrocontextPosition() const;
        ///
-       int background_color_;
+       void setMacrocontextPosition(DocIterator const & pos);
 
        ///
-       ParagraphList pars_;
+       bool completionSupported(Cursor const & cur) const;
+       ///
+       CompletionList const * createCompletionList(Cursor const & cur) const;
+       ///
+       bool insertCompletion(Cursor & cur, docstring const & s, bool /*finished*/);
+       ///
+       docstring completionPrefix(Cursor const & cur) const;
 
-       /// our 'outermost' font. This is handed down from the surrounding
-       // inset through the pi/mi parameter (pi.base.font)
-       Font font_;
+public:
+       ///
+       ParagraphList pars_;
 
        ///
        bool autoBreakRows_;
@@ -321,8 +331,10 @@ private:
        bool backspacePos0(Cursor & cur);
        /// handle the case where bibitems were deleted
        bool handleBibitems(Cursor & cur);
+       /// are we in a list item (description etc.)?
+       bool inDescriptionItem(Cursor & cur) const;
        ///
-       void charInserted();
+       void charInserted(Cursor & cur);
        /// set 'number' font property
        void number(Cursor & cur);
 
@@ -331,8 +343,11 @@ private:
        /// \param asParagraphs whether to paste as paragraphs or as lines
        void pasteString(Cursor & cur, docstring const & str,
                        bool asParagraphs);
+
+       /// position of the text in the buffer.
+       DocIterator macrocontext_position_;
 };
 
 } // namespace lyx
 
-#endif // LYXTEXT_H
+#endif // TEXT_H