]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetText.h
Fix trailing whitespace in cpp files.
[lyx.git] / src / insets / InsetText.h
index 8c1f6842e7d377f3e000483bffe430cedb4b539e..eea88cdd690786ac9fddfaaa127872159b4c9180 100644 (file)
@@ -17,8 +17,6 @@
 #include "ColorCode.h"
 #include "Text.h"
 
-#include "insets/InsetLayout.h"
-
 namespace lyx {
 
 class CompletionList;
@@ -27,6 +25,7 @@ class Dimension;
 class ParagraphList;
 class InsetCaption;
 class InsetTabular;
+class TocBuilder;
 
 /**
  A text inset is like a TeX box to write full text
@@ -49,7 +48,7 @@ public:
        void setBuffer(Buffer &);
 
        ///
-       Dimension const dimension(BufferView const &) const;
+       Dimension const dimensionHelper(BufferView const &) const;
 
        /// empty inset to empty par
        void clear();
@@ -61,10 +60,14 @@ public:
        void metrics(MetricsInfo & mi, Dimension & dim) const;
        ///
        void draw(PainterInfo & pi, int x, int y) const;
+       /// Drawing background is handled in draw
+       virtual void drawBackground(PainterInfo &, int, int) const {}
        ///
        bool editable() const { return true; }
        ///
        bool canTrackChanges() const { return true; }
+       /// Rely on RowPainter to draw the cue of inline insets.
+       bool canPaintChange(BufferView const &) const { return allowMultiPar(); }
        ///
        InsetText * asInsetText() { return this; }
        ///
@@ -73,9 +76,10 @@ public:
        Text & text() { return text_; }
        Text const & text() const { return text_; }
        ///
-       int latex(odocstream &, OutputParams const &) const;
+       void latex(otexstream &, OutputParams const &) const;
        ///
-       int plaintext(odocstream &, OutputParams const &) const;
+       int plaintext(odocstringstream & ods, OutputParams const & op,
+                     size_t max_length = INT_MAX) const;
        ///
        int docbook(odocstream &, OutputParams const &) const;
        ///
@@ -89,11 +93,14 @@ public:
                WriteEverything = 7
        };
        ///
-       docstring insetAsXHTML(XHTMLStream &, OutputParams const &, 
+       docstring insetAsXHTML(XHTMLStream &, OutputParams const &,
                               XHTMLOptions) const;
        ///
        void validate(LaTeXFeatures & features) const;
 
+       /// return the argument(s) only
+       void getArgs(otexstream & os, OutputParams const &, bool const post = false) const;
+
        /// return x,y of given position relative to the inset's baseline
        void cursorPos(BufferView const & bv, CursorSlice const & sl,
                bool boundary, int & x, int & y) const;
@@ -102,18 +109,12 @@ public:
        ///
        void setText(docstring const &, Font const &, bool trackChanges);
        ///
-       void setAutoBreakRows(bool);
-       ///
-       bool getAutoBreakRows() const { return text_.autoBreakRows_; }
-       ///
        void setDrawFrame(bool);
        ///
        ColorCode frameColor() const;
        ///
        void setFrameColor(ColorCode);
        ///
-       bool showInsetDialog(BufferView *) const;
-       ///
        Text * getText(int i) const {
                return (i == 0) ? const_cast<Text*>(&text_) : 0;
        }
@@ -148,27 +149,35 @@ public:
        ///
        ParagraphList const & paragraphs() const;
        ///
-       bool insetAllowed(InsetCode) const { return !getLayout().isPassThru(); }
-       /// Allow spellchecking, except for insets with latex_language
-       bool allowSpellCheck() const { return !getLayout().isPassThru(); }
+       bool insetAllowed(InsetCode) const;
+       ///
+       bool allowSpellCheck() const { return getLayout().spellcheck() && !getLayout().isPassThru(); }
        ///
        virtual bool isMacroScope() const { return false; }
        ///
        virtual bool allowMultiPar() const { return getLayout().isMultiPar(); }
        ///
        /// should paragraphs be forced to use the empty layout?
-       virtual bool forcePlainLayout(idx_type = 0) const 
+       virtual bool forcePlainLayout(idx_type = 0) const
                { return getLayout().forcePlainLayout(); }
        /// should the user be allowed to customize alignment, etc.?
-       virtual bool allowParagraphCustomization(idx_type = 0) const 
+       virtual bool allowParagraphCustomization(idx_type = 0) const
                { return getLayout().allowParagraphCustomization(); }
+       /// should paragraphs be forced to use a local font language switch?
+       virtual bool forceLocalFontSwitch() const
+               { return getLayout().forcelocalfontswitch(); }
 
        /// Update the counters of this inset and of its contents
-       virtual void updateLabels(ParIterator const &, UpdateType);
-       /// the string that is passed to the TOC
-       void tocString(odocstream &) const;
+       virtual void updateBuffer(ParIterator const &, UpdateType);
+       ///
+       void setMacrocontextPositionRecursive(DocIterator const & pos);
+       ///
+       void toString(odocstream &) const;
        ///
-       void addToToc(DocIterator const &);
+       void forOutliner(docstring &, size_t const, bool const) const;
+       ///
+       void addToToc(DocIterator const & di, bool output_active,
+                                 UpdateType utype, TocBackend & backend) const;
        ///
        Inset * clone() const { return new InsetText(*this); }
        ///
@@ -192,27 +201,48 @@ public:
        bool insertCompletion(Cursor & cur, docstring const & s, bool finished);
        ///
        void completionPosAndDim(Cursor const &, int & x, int & y, Dimension & dim) const;
+       /// returns the text to be used as tooltip
+       /// \param prefix: a string that will preced the tooltip,
+       /// e.g., "Index: ".
+       /// \param len: length of the resulting string
+       /// NOTE This routine is kind of slow. It's fine to use it within the
+       /// GUI, but definitely do not try to use it in updateBuffer or anything
+       /// of that sort. (Note: unnecessary internal copies have been removed
+       /// since the previous note. The efficiency would have to be assessed
+       /// again by profiling.)
+       docstring toolTipText(docstring prefix = empty_docstring(),
+                             size_t len = 400) const;
 
        ///
-       virtual docstring contextMenu(BufferView const & bv, int x, int y) const;
+       std::string contextMenu(BufferView const &, int, int) const;
        ///
-       void doDispatch(Cursor & cur, FuncRequest & cmd);
-protected:
+       std::string contextMenuName() const;
        ///
-       InsetCaption const * getCaptionInset() const;
+       void doDispatch(Cursor & cur, FuncRequest & cmd);
+
        ///
-       docstring getCaptionText(OutputParams const &) const;
+       bool confirmDeletion() const { return !text().empty(); }
+
+protected:
        ///
-       docstring getCaptionHTML(OutputParams const &) const;
+       void iterateForToc(DocIterator const & cdit, bool output_active,
+                                          UpdateType utype, TocBackend & backend) const;
 private:
+       /// Open the toc item for paragraph pit. Returns the paragraph index where
+       /// it should end.
+       pit_type openAddToTocForParagraph(pit_type pit,
+                                         DocIterator const & dit,
+                                         bool output_active,
+                                         TocBackend & backend) const;
+       /// Close a toc item opened in start and closed in end
+       void closeAddToTocForParagraph(pit_type start, pit_type end,
+                                      TocBackend & backend) const;
        ///
        bool drawFrame_;
        ///
        ColorCode frame_color_;
        ///
-       mutable pit_type old_pit;
-       ///
-       mutable Text text_;
+       Text text_;
 };