]> git.lyx.org Git - lyx.git/blobdiff - src/Text.h
Remove obsolete (and false) comment.
[lyx.git] / src / Text.h
index 4c8ab94a6ec011a950d68f3bfc883c4fca4ac46f..99d83f4a29d25236ba69efcfb8a75faa64d28515 100644 (file)
@@ -24,6 +24,7 @@ class BufferParams;
 class BufferView;
 class CompletionList;
 class Cursor;
+class CursorData;
 class CursorSlice;
 class DocIterator;
 class ErrorList;
@@ -49,7 +50,7 @@ private:
 public:
        /// \return true if there's no content at all.
        /// \warning a non standard layout on an empty paragraph doesn't
-       // count as empty.
+       /// count as empty.
        bool empty() const;
        /// Access to owner InsetText.
        InsetText const & inset() const;
@@ -108,10 +109,12 @@ public:
 
        ///
        void toggleFree(Cursor & cur, Font const &, bool toggleall = false);
+       /// Stack to save recent text propterty applications
+       std::vector<docstring> getFreeFonts() const;
 
        /// ???
        /// FIXME: replace Cursor with DocIterator.
-       docstring getStringToIndex(Cursor const & cur);
+       docstring getStringForDialog(Cursor & cur);
 
        /// Convert the paragraphs to a string.
        /// \param AsStringParameter options. This can contain any combination of
@@ -123,14 +126,20 @@ public:
        ///
        docstring asString(pit_type beg, pit_type end,
                int options = AS_STR_NONE) const;
-       /// Appends a possibly abbreviated representation of our text
-       /// to \param os, where \param maxlen defines the maximum size
-       /// of \param os. If \param shorten is true, then we will shorten
-       /// \param os to maxlen chars and replace the final three by "...,
-       /// if \param os is longer than maxlen chars.
-       /// if \param maxlen is passed as 0, then it is ignored. (In fact,
-       /// it is reset to the maximum value for size_t.)
+
+       /// truncates str to maxlenwith an ellipsis and replaces the characters '\n'
+       /// and '\t' with spaces
+       static void shortenForOutliner(docstring & str, size_t const maxlen);
+
+       /// Appends a possibly abbreviated representation of our text to \param os,
+       /// where \param maxlen defines the maximum size of \param os. If \param
+       /// shorten is true, then os is shortened as above.
        void forOutliner(docstring & os, size_t maxlen, bool shorten = true) const;
+       /// Appends a possibly abbreviated representation of our text, from
+       /// start to end, to \param os, where \param maxlen defines the
+       /// maximum size of \param os. Omits the label of the first paragraph.
+       void forOutliner(docstring & os, size_t maxlen, pit_type start, pit_type end,
+                        bool shorten = true) const;
 
        /// insert a character at cursor position
        /// FIXME: replace Cursor with DocIterator.
@@ -151,8 +160,8 @@ public:
        /// read-write access to individual paragraph
        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 const & cur) const;
+       // When \param devel_mode is true, add more precise information
+       docstring currentState(CursorData const & cur, bool devel_mode) const;
 
        /** Find the word under \c from in the relative location
         *  defined by \c word_location.
@@ -166,7 +175,7 @@ public:
        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,
@@ -180,19 +189,12 @@ public:
        void rejectChanges();
 
        /// returns true if par was empty and was removed
-       bool setCursor(Cursor & cur, pit_type par, pos_type pos,
+       bool setCursor(Cursor & cur, pit_type pit, pos_type pos,
                       bool setfont = true, bool boundary = false);
        ///
-       void setCursor(CursorSlice &, pit_type par, pos_type pos);
-       ///
-       void setCursorIntern(Cursor & cur, pit_type par,
+       void setCursorIntern(Cursor & cur, pit_type pit,
                 pos_type pos, bool setfont = true, bool boundary = false);
 
-       ///
-       void recUndo(Cursor & cur, pit_type first, pit_type last) const;
-       ///
-       void recUndo(Cursor & cur, pit_type first) const;
-
        /// Move cursor one position backwards
        /**
         * Returns true if an update is needed after the move.
@@ -224,9 +226,10 @@ public:
        ///
        bool cursorVisRightOneWord(Cursor & cur);
        /// Delete from cursor up to the end of the current or next word.
-       void deleteWordForward(Cursor & cur);
+       /// Use force to skip the confirmDeletion check.
+       void deleteWordForward(Cursor & cur, bool force = false);
        /// Delete from cursor to start of current or prior word.
-       void deleteWordBackward(Cursor & cur);
+       void deleteWordBackward(Cursor & cur, bool force = false);
        ///
        bool cursorUpParagraph(Cursor & cur);
        ///
@@ -247,7 +250,7 @@ public:
        ///
        bool selectWordWhenUnderCursor(Cursor & cur, word_location);
        /// Change the case of the word at cursor position.
-       void changeCase(Cursor & cur, TextCase action);
+       void changeCase(Cursor & cur, TextCase action, bool partial);
        /// Transposes the character at the cursor with the one before it
        void charsTranspose(Cursor & cur);
 
@@ -257,7 +260,7 @@ public:
         settings are given to the new one.
         This function will handle a multi-paragraph selection.
         */
-       void setParagraphs(Cursor & cur, docstring arg, bool modify = false);
+       void setParagraphs(Cursor & cur, docstring const & arg, bool modify = false);
        /// Sets parameters for current or selected paragraphs
        void setParagraphs(Cursor & cur, ParagraphParameters const & p);
 
@@ -280,9 +283,9 @@ public:
        double spacing(Paragraph const & par) const;
        /// make a suggestion for a label
        /// FIXME: replace Cursor with DocIterator.
-       docstring getPossibleLabel(Cursor const & cur) const;
+       docstring getPossibleLabel(DocIterator const & cur) const;
        /// is this paragraph right-to-left?
-       bool isRTL(Paragraph const & par) const;
+       bool isRTL(pit_type pit) const;
 
        ///
        bool checkAndActivateInset(Cursor & cur, bool front);
@@ -298,13 +301,13 @@ public:
 
        /// 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 Cursor with DocIterator. This is not possible right
-       /// now because recordUndo() is called which needs a Cursor.
+       /// Handles undo.
        static bool deleteEmptyParagraphMechanism(Cursor & cur,
                Cursor & old, bool & need_anchor_change);
 
        /// delete double spaces, leading spaces, and empty paragraphs
        /// from \first to \last paragraph
+       /// Does NOT handle undo (responsibility of the caller)
        void deleteEmptyParagraphMechanism(pit_type first, pit_type last, bool trackChanges);
 
        /// To resolve macros properly the texts get their DocIterator.
@@ -325,29 +328,30 @@ public:
        docstring completionPrefix(Cursor const & cur) const;
        /// find a paragraph before \p par with the given \p depth, if such
        /// a paragraph cannot be found, \p par is returned
-       pit_type depthHook(pit_type par, depth_type depth) const;
+       pit_type depthHook(pit_type pit, depth_type depth) const;
        /// find a paragraph before \p par with depth less than the
        /// depth of \p par. If such paragraph cannot be found because
        /// \p par already has depth 0, lastpar + 1 is returned. If
        /// such paragraph cannot be found because there isn't a par
        /// with less depth before this one, \p par is returned.
-       pit_type outerHook(pit_type par) const;
+       pit_type outerHook(pit_type pit) const;
        /// Is it the first par with same depth and layout?
-       bool isFirstInSequence(pit_type par) const;
+       bool isFirstInSequence(pit_type pit) const;
+       /// Return the last paragraph with same depth and layout, or a strictly
+       /// greater depth
+       pit_type lastInSequence(pit_type pit) const;
        /// Is this paragraph in the table of contents?
-       int getTocLevel(pit_type par) const;
+       int getTocLevel(pit_type pit) const;
        /// Get the font of the "environment" of paragraph \p par_offset in \p pars.
        /// All font changes of the paragraph are relative to this font.
-       Font const outerFont(pit_type par_offset) const;
+       Font const outerFont(pit_type pit_offset) const;
+       /// Return the label type at the end of paragraph \c pit.
+       int getEndLabel(pit_type pit) const;
 
 private:
        /// The InsetText owner shall have access to everything.
        friend class InsetText;
 
-       // fix the cursor `cur' after a characters has been deleted at `where'
-       // position. Called by deleteEmptyParagraphMechanism
-       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(Cursor & cur);
@@ -378,8 +382,6 @@ private:
        InsetText * owner_;
        ///
        ParagraphList pars_;
-       ///
-       bool autoBreakRows_;
        /// position of the text in the buffer.
        DocIterator macrocontext_position_;
 };
@@ -388,7 +390,7 @@ private:
 ///
 void breakParagraphConservative(BufferParams const & bparams,
                                ParagraphList & paragraphs,
-                               pit_type par,
+                               pit_type pit,
                                pos_type pos);
 
 /**
@@ -396,7 +398,7 @@ void breakParagraphConservative(BufferParams const & bparams,
  * Be careful, this doesent make any check at all.
  */
 void mergeParagraph(BufferParams const & bparams,
-       ParagraphList & paragraphs, pit_type par);
+       ParagraphList & paragraphs, pit_type pit);
 
 /// accept the changes within the complete ParagraphList
 void acceptChanges(ParagraphList & pars, BufferParams const & bparams);