]> git.lyx.org Git - lyx.git/blobdiff - src/insets/insetcollapsable.h
Enable the external inset to handle unknown templates gracefully.
[lyx.git] / src / insets / insetcollapsable.h
index 38cefa54e5bf3efff98ff671ad0d0f4c08c82ca3..f6b8c70cd3a5f8642dbf1c823936e64c9bc1e8f7 100644 (file)
@@ -1,68 +1,57 @@
 // -*- C++ -*-
-/* This file is part of
- * ======================================================
- * 
- *           LyX, The Document Processor
+/**
+ * \file insetcollapsable.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
  *
- *           Copyright 2000-2001 The LyX Team.
+ * \author Alejandro Aguilar Sierra
+ * \author Jürgen Vigna
+ * \author Lars Gullik Bjønnes
  *
- *======================================================
+ * Full author contact details are available in file CREDITS
  */
 
-
 #ifndef INSETCOLLAPSABLE_H
 #define INSETCOLLAPSABLE_H
 
-#ifdef __GNUG__
-#pragma interface
-#endif
-
 #include "inset.h"
 #include "insettext.h"
 #include "lyxfont.h"
+#include "funcrequest.h" // for adjustCommand
 #include "LColor.h"
 
+#include <boost/weak_ptr.hpp>
+
 class Painter;
 class LyXText;
 class Paragraph;
 class LyXCursor;
 
 /** A collapsable text inset
-  
+
 */
 class InsetCollapsable : public UpdatableInset {
 public:
-       ///
-       enum UpdateCodes {
-               NONE = 0,
-               FULL
-       };
        ///
        static int const TEXT_TO_TOP_OFFSET = 2;
        ///
        static int const TEXT_TO_BOTTOM_OFFSET = 2;
        /// inset is initially collapsed if bool = true
-       InsetCollapsable(bool = false);
+       InsetCollapsable(BufferParams const &, bool collapsed = false);
        ///
-       InsetCollapsable(InsetCollapsable const & in, bool same_id = false);
+       InsetCollapsable(InsetCollapsable const & in);
        ///
        void read(Buffer const *, LyXLex &);
        ///
        void write(Buffer const *, std::ostream &) const;
        ///
-       int ascent(BufferView *, LyXFont const &) const;
-       ///
-       int descent(BufferView *, LyXFont const &) const;
-       ///
-       int width(BufferView *, LyXFont const &) const;
-       ///
-       void draw(BufferView *, const LyXFont &, int , float &, bool) const;
-       ///
-       void update(BufferView *, LyXFont const &, bool =false); 
+       void metrics(MetricsInfo &, Dimension &) const;
        ///
-       void edit(BufferView *, int, int, unsigned int);
+       void draw(PainterInfo & pi, int x, int y) const;
+       /// draw, either inlined (no button) or collapsed/open
+       void draw(PainterInfo & pi, int x, int y, bool inlined) const;
        ///
-       void edit(BufferView *, bool front = true);
+       void update(BufferView *, bool = false);
        ///
        EDITABLE editable() const;
        ///
@@ -74,8 +63,6 @@ public:
        ///
        bool isTextInset() const { return true; }
        ///
-       bool doClearArea() const;
-       ///
        void insetUnlock(BufferView *);
        ///
        bool needFullRow() const { return isOpen(); }
@@ -87,37 +74,24 @@ public:
        ///
        bool updateInsetInInset(BufferView *, Inset *);
        ///
-       unsigned int insetInInsetY();
-       ///
-       void insetButtonRelease(BufferView *, int, int, int);
-       ///
-       void insetButtonPress(BufferView *, int, int, int);
-       ///
-       void insetMotionNotify(BufferView *, int, int, int);
-       ///
-       void insetKeyPress(XKeyEvent *);
+       int insetInInsetY() const;
        ///
-       UpdatableInset::RESULT localDispatch(BufferView *, kb_action,
-                                            string const &);
+       RESULT localDispatch(FuncRequest const &);
        ///
        int latex(Buffer const *, std::ostream &,
-                 bool fragile, bool free_spc) const;
+                 LatexRunParams const &) const;
        ///
-       int ascii(Buffer const *, std::ostream &, int) const { return 0; }
+       int ascii(Buffer const *, std::ostream &, int) const;
        ///
-       int linuxdoc(Buffer const *, std::ostream &) const { return 0; }
+       int linuxdoc(Buffer const *, std::ostream &) const;
        ///
-       int docbook(Buffer const *, std::ostream &) const { return 0; }
+       int docbook(Buffer const *, std::ostream &, bool mixcont) const;
        ///
        void validate(LaTeXFeatures & features) const;
-       ///
+       /// FIXME, document
        void getCursorPos(BufferView *, int & x, int & y) const;
-       ///
-       void toggleInsetCursor(BufferView *);
-       ///
-       void showInsetCursor(BufferView *, bool show = true);
-       ///
-       void hideInsetCursor(BufferView *);
+       /// Get the absolute document x,y of the cursor
+       virtual void getCursor(BufferView &, int &, int &) const;
        ///
        void fitInsetCursor(BufferView * bv) const {
                inset.fitInsetCursor(bv);
@@ -127,7 +101,7 @@ public:
        UpdatableInset * getFirstLockingInsetOfType(Inset::Code);
        ///
        void setFont(BufferView *, LyXFont const &, bool toggleall = false,
-                 bool selectall = false);
+                bool selectall = false);
        ///
        void setLabel(string const & l) const;
        ///
@@ -136,8 +110,6 @@ public:
        ///
        void setAutoCollapse(bool f) { autocollapse = f; }
 #endif
-       ///
-       int getMaxWidth(BufferView *, UpdatableInset const *) const;
        ///
        LyXText * getLyXText(BufferView const *, bool const recursive) const;
        ///
@@ -159,13 +131,9 @@ public:
                UpdatableInset::scroll(bv, offset);
        }
        ///
-       Paragraph * getParFromID(int id) const;
-       ///
        Inset * getInsetFromID(int id) const;
        ///
-       Paragraph * firstParagraph() const;
-       ///
-       Paragraph * getFirstParagraph(int) const;
+       ParagraphList * getParagraphs(int) const;
        ///
        LyXCursor const & cursor(BufferView *) const;
        ///
@@ -175,35 +143,47 @@ public:
        ///
        void close(BufferView *) const;
        ///
-       string const selectNextWordToSpellcheck(BufferView *, float &) const;
-
+       bool allowSpellcheck() const { return inset.allowSpellcheck(); }
+       ///
+       WordLangTuple const
+       selectNextWordToSpellcheck(BufferView *, float &) const;
+       ///
        void selectSelectedWord(BufferView * bv) {
                inset.selectSelectedWord(bv);
        }
+       ///
        void toggleSelection(BufferView * bv, bool kill_selection) {
                inset.toggleSelection(bv, kill_selection);
        }
+
+       void markErased();
+
+       bool nextChange(BufferView * bv, lyx::pos_type & length);
+
        ///
        bool searchForward(BufferView * bv, string const & str,
-                          bool const & cs = true, bool const & mw = false);
+                          bool = true, bool = false);
        bool searchBackward(BufferView * bv, string const & str,
-                           bool const & cs = true, bool const & mw = false);
-       /// check if the font of the char we want inserting is correct
-       /// and modify it if it is not.
-       virtual bool checkInsertChar(LyXFont &) { return false; }
+                           bool = true, bool = false);
+
+       ///
+       void addPreview(grfx::PreviewLoader &) const;
 
 protected:
        ///
-       int ascent_collapsed() const;
+       virtual void cache(BufferView *) const;
        ///
-       int descent_collapsed() const;
+       virtual BufferView * view() const;
+
        ///
-       int width_collapsed() const;
+       void dimension_collapsed(Dimension &) const;
        ///
-       void draw_collapsed(Painter & pain, int , float &) const;
+       int height_collapsed() const;
+       ///
+       void draw_collapsed(PainterInfo & pi, int x, int y) const;
        ///
        int getMaxTextWidth(Painter & pain, UpdatableInset const *) const;
-       
+
        ///
        mutable bool collapsed_;
        ///
@@ -223,9 +203,13 @@ protected:
        ///
        mutable int topx;
        mutable int topbaseline;
-       mutable UpdateCodes need_update;
 
 private:
+       ///
+       void lfunMouseRelease(FuncRequest const &);
+       ///
+       FuncRequest adjustCommand(FuncRequest const &);
+
        ///
        mutable string label;
 #if 0
@@ -238,6 +222,8 @@ private:
        bool in_update;
        ///
        mutable bool first_after_edit;
+       ///
+       mutable boost::weak_ptr<BufferView> view_;
 };
 
 #endif