New DocBook support

[lyx.git] / src / insets / InsetText.h

diff --git a/src/insets/InsetText.h b/src/insets/InsetText.h
index 64b62357ff26f3d6ec27888912d7b4b9b13c549f..d86bfb75d339456def755b311329633fed9f575a 100644 (file)
--- a/src/insets/InsetText.h
+++ b/src/insets/InsetText.h
@@ -25,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
@@ -47,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();
@@ -59,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; }
        ///
@@ -76,9 +81,7 @@ public:
        int plaintext(odocstringstream & ods, OutputParams const & op,
                      size_t max_length = INT_MAX) const;
        ///
-       int docbook(odocstream &, OutputParams const &) const;
-       ///
-       docstring xhtml(XHTMLStream &, OutputParams const &) const;
+       docstring xhtml(XMLStream &, OutputParams const &) const;
        ///
        enum XHTMLOptions {
                JustText = 0,
@@ -88,11 +91,15 @@ public:
                WriteEverything = 7
        };
        ///
-       docstring insetAsXHTML(XHTMLStream &, OutputParams const &, 
+       docstring insetAsXHTML(XMLStream &, OutputParams const &,
                               XHTMLOptions) const;
        ///
+       void docbook(XMLStream &, OutputParams const &, XHTMLOptions opts) const;
+       ///
+       void docbook(XMLStream &, OutputParams const &) const;
+       ///
        void validate(LaTeXFeatures & features) const;
-       
+
        /// return the argument(s) only
        void getArgs(otexstream & os, OutputParams const &, bool const post = false) const;
 
@@ -119,6 +126,10 @@ public:
        ///
        void fixParagraphsFont();
 
+       /// does the inset contain changes ?
+       bool isChanged() const { return is_changed_; }
+       /// this is const because value is mutable
+       void isChanged(bool ic) const { is_changed_ = ic; }
        /// set the change for the entire inset
        void setChange(Change const & change);
        /// accept the changes within the inset
@@ -152,6 +163,8 @@ public:
        ///
        virtual bool allowMultiPar() const { return getLayout().isMultiPar(); }
        ///
+       bool isInTitle() const { return intitle_context_; }
+       ///
        /// should paragraphs be forced to use the empty layout?
        virtual bool forcePlainLayout(idx_type = 0) const
                { return getLayout().forcePlainLayout(); }
@@ -163,15 +176,16 @@ public:
                { return getLayout().forcelocalfontswitch(); }
 
        /// Update the counters of this inset and of its contents
-       virtual void updateBuffer(ParIterator const &, UpdateType);
-       /// 
+       virtual void updateBuffer(ParIterator const &, UpdateType, bool const deleted = false);
+       ///
        void setMacrocontextPositionRecursive(DocIterator const & pos);
        ///
        void toString(odocstream &) const;
        ///
-       void forOutliner(docstring &, size_t) const;
+       void forOutliner(docstring &, size_t const, bool const) const;
        ///
-       void addToToc(DocIterator const & di, bool output_active) const;
+       void addToToc(DocIterator const & di, bool output_active,
+                                 UpdateType utype, TocBackend & backend) const;
        ///
        Inset * clone() const { return new InsetText(*this); }
        ///
@@ -196,12 +210,16 @@ public:
        ///
        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,
+       /// \param prefix: a string that will precede the tooltip,
        /// e.g., "Index: ".
-       /// \param numlines: the number of lines in the tooltip
-       /// \param len: length of those lines
+       /// \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 numlines = 5, size_t len = 80) const;
+                             size_t len = 400) const;
 
        ///
        std::string contextMenu(BufferView const &, int, int) const;
@@ -209,22 +227,40 @@ public:
        std::string contextMenuName() const;
        ///
        void doDispatch(Cursor & cur, FuncRequest & cmd);
-protected:
+
        ///
-       InsetCaption const * getCaptionInset() const;
+       bool confirmDeletion() const { return !text().empty(); }
+
        ///
-       docstring getCaptionText(OutputParams const &) const;
+       bool needsCProtection(bool const maintext = false,
+                             bool const fragile = false) const;
        ///
-       docstring getCaptionHTML(OutputParams const &) const;
+       bool hasCProtectContent(bool fragile = false) const;
+
+protected:
        ///
-       void iterateForToc(DocIterator const & cdit, bool output_active) 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_;
+       /// true if the inset contains change
+       mutable bool is_changed_;
+       ///
+       bool intitle_context_;
        ///
        ColorCode frame_color_;
        ///
-       mutable Text text_;
+       Text text_;
 };