]> git.lyx.org Git - lyx.git/blobdiff - src/insets/insetbase.h
* src/LyXAction.C: mark goto-clear-bookmark as working without buffer
[lyx.git] / src / insets / insetbase.h
index 8e1af0aee74e15bd810d3ba2795c16ffb578dbca..540f117e3ad10ec6c2f173ec5c9a03d514953c4a 100644 (file)
@@ -114,6 +114,10 @@ public:
        virtual bool editing(BufferView * bv) const;
        ///
        virtual bool showInsetDialog(BufferView *) const { return false; }
+
+       /// draw inset decoration if necessary.
+       /// This can use \c drawMarkers() for example.
+       virtual void drawDecoration(PainterInfo &, int, int) const {}
        /// draw four angular markers
        void drawMarkers(PainterInfo & pi, int x, int y) const;
        /// draw two angular markers
@@ -202,8 +206,7 @@ public:
        virtual int docbook(Buffer const &, odocstream & os,
                OutputParams const &) const;
        /// the string that is passed to the TOC
-       virtual int textString(Buffer const &, odocstream &,
-               OutputParams const &) const { return 0; };
+       virtual void textString(Buffer const &, odocstream &) const {}
 
        /** This enum indicates by which means the inset can be modified:
        - NOT_EDITABLE: the inset's content cannot be modified at all
@@ -343,7 +346,7 @@ public:
        /// returns true if the inset can hold an inset of given type
        virtual bool insetAllowed(Code) const { return false; }
        /// if this inset has paragraphs should they be output all as default
-       /// paragraphs with "Standard" layout?
+       /// paragraphs with the default layout of the text class?
        virtual bool forceDefaultParagraphs(idx_type) const { return false; }
 
        ///
@@ -369,7 +372,12 @@ public:
        virtual void write(Buffer const &, std::ostream &) const {}
        /// read inset in .lyx format
        virtual void read(Buffer const &, LyXLex &) {}
-       /// returns the number of rows (\n's) of generated tex code.
+       /** Export the inset to LaTeX.
+        *  Don't use a temporary stringstream if the final output is
+        *  supposed to go to a file.
+        *  \sa Buffer::writeLaTeXSource for the reason.
+        *  \return the number of rows (\n's) of generated LaTeX code.
+        */
        virtual int latex(Buffer const &, odocstream &,
                          OutputParams const &) const { return 0; }
        /// returns true to override begin and end inset in file
@@ -387,7 +395,7 @@ public:
         *  defaults to empty.
         */
        virtual void addPreview(graphics::PreviewLoader &) const {}
-       /// Add an antry to the TocList
+       /// Add an entry to the TocList
        virtual void addToToc(TocList &, Buffer const &) const {}
 
 public: