empty file format change due to r29840.

[lyx.git] / src / Text.h

diff --git a/src/Text.h b/src/Text.h
index 34977dab015b563e6ce725cfad17c8e7d172a57b..df19ca7ae2dc71c20621bb692c9a4f4a9d274ae8 100644 (file)
--- a/src/Text.h
+++ b/src/Text.h
@@ -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.
@@ -108,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);
@@ -128,7 +139,7 @@ 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.
@@ -138,6 +149,8 @@ public:
        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;
        
@@ -254,7 +267,7 @@ 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;
 
@@ -265,7 +278,7 @@ public:
 
        ///
        void write(Buffer const & buf, std::ostream & os) const;
-       /// returns whether we've seen our usual 'end' marker
+       /// 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);
@@ -318,6 +331,8 @@ 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(Cursor & cur);
        /// set 'number' font property