]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetCollapsable.h
Remove all BufferParam arguments in InsetXXX methods (since insets know about their...
[lyx.git] / src / insets / InsetCollapsable.h
index c5b9975f33fe561e19aeb9ec96e585644b9f8b5b..3cb7aaad937d9db9b8275d92810d45581e5cfffe 100644 (file)
@@ -5,8 +5,8 @@
  * Licence details can be found in the file COPYING.
  *
  * \author Alejandro Aguilar Sierra
- * \author Jürgen Vigna
- * \author Lars Gullik Bjønnes
+ * \author Jürgen Vigna
+ * \author Lars Gullik Bjønnes
  *
  * Full author contact details are available in file CREDITS.
  */
@@ -33,7 +33,7 @@ namespace frontend { class Painter; }
 class InsetCollapsable : public InsetText {
 public:
        ///
-       InsetCollapsable(Buffer const &, CollapseStatus status = Inset::Open);
+       InsetCollapsable(Buffer const &, InsetText::UsePlain = InsetText::PlainLayout);
        ///
        InsetCollapsable(InsetCollapsable const & rhs);
        ///
@@ -45,16 +45,14 @@ public:
        ///
        docstring name() const { return from_ascii("Collapsable"); }
        ///
-       InsetLayout const & getLayout(BufferParams const &) const { return *layout_; }
-       ///
        InsetLayout const & getLayout() const { return *layout_; } 
        ///
-       void setLayout(BufferParams const &);
+       void setLayout();
        /// (Re-)set the character style parameters from \p tc according
        /// to name()
        void setLayout(DocumentClass const * const tc);
        ///
-       virtual bool useEmptyLayout() { return true; }
+       virtual bool usePlainLayout() { return true; }
        ///
        void read(Lexer &);
        ///
@@ -66,14 +64,17 @@ public:
 
        /// 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;
-       ///
+               bool boundary, int & x, int & y) const;
+       /// Returns true if (mouse) action is over the inset's button.
+       /// Always returns false when the inset does not have a
+       /// button.
        bool hitButton(FuncRequest const &) const;
        ///
        docstring const getNewLabel(docstring const & l) const;
        ///
-       EDITABLE editable() const;
+       bool editable() const;
+       ///
+       bool hasSettings() const { return true; }
        /// can we go further down on mouse click?
        bool descendable() const;
        ///
@@ -81,9 +82,13 @@ public:
        ///
        virtual void setButtonLabel() {}
        ///
-       bool isOpen() const { return geometry() != ButtonOnly; }
+       virtual docstring const buttonLabel(BufferView const &) const
+               { return labelstring_; }
+       ///
+       bool isOpen(BufferView const & bv) const 
+               { return geometry(bv) != ButtonOnly; }
        ///
-       CollapseStatus status() const;
+       CollapseStatus status(BufferView const & bv) const;
        /** Of the old CollapseStatus we only keep the values  
         *  Open and Collapsed.
         * We define a list of possible inset decoration
@@ -100,7 +105,7 @@ public:
         *   Conglomerate | SubLabel            Corners
         *   ---------------------------------------------
         *   *) toggled by openinlined_
-        *   x) toggled by autoOpen_
+        *   x) toggled by auto_open_
         */
 
        /// Default looks
@@ -115,8 +120,10 @@ public:
                Corners
        };
        /// Returns the geometry based on CollapseStatus
-       /// (status_), autoOpen_ and openinlined_, and of
-       /// course decoration().
+       /// (status_), auto_open_[BufferView] and openinlined_,
+       /// and of course decoration().
+       Geometry geometry(BufferView const & bv) const;
+       /// Returns the geometry disregarding auto_open_
        Geometry geometry() const;
        /// Allow spellchecking, except for insets with latex_language
        bool allowSpellCheck() const { return !forceLTR(); }
@@ -129,25 +136,35 @@ public:
        ///
        bool setMouseHover(bool mouse_hover);
        ///
-       ColorCode backgroundColor() const { return layout_->bgcolor(); }
+       ColorCode backgroundColor() const { return getLayout().bgcolor(); }
+       ///
+       ColorCode labelColor() const { return getLayout().labelfont().color(); }
        ///
        int latex(odocstream &, OutputParams const &) const;
        ///
+       int docbook(odocstream &, OutputParams const &) const;
+       /// It will rarely be right to call this from subclasses, due
+       /// to the fact that it steps counters, etc. Instead, call
+       /// InsetText::xhtml().
+       docstring xhtml(odocstream &, OutputParams const &) const;
+       ///
        void validate(LaTeXFeatures &) const;
        ///
        InsetCode lyxCode() const { return COLLAPSABLE_CODE; }
 
        /// Allow multiple blanks
-       virtual bool isFreeSpacing() const { return layout_->isFreeSpacing(); }
+       virtual bool isFreeSpacing() const { return getLayout().isFreeSpacing(); }
        /// Don't eliminate empty paragraphs
-       virtual bool allowEmpty() const { return layout_->isKeepEmpty(); }
+       virtual bool allowEmpty() const { return getLayout().isKeepEmpty(); }
        /// Force inset into LTR environment if surroundings are RTL?
-       virtual bool forceLTR() const { return layout_->isForceLtr(); }
+       virtual bool forceLTR() const { return getLayout().isForceLtr(); }
        ///
-       virtual bool useEmptyLayout() const { return true; }
+       virtual bool usePlainLayout() const { return true; }
        /// Is this inset's layout defined in the document's textclass?
        /// May be wrong after textclass change or paste from another document
        bool undefined() const;
+       /// the string that is passed to the TOC
+       void tocString(odocstream &) const;
        ///
        virtual docstring contextMenu(BufferView const & bv, int x, int y) const;
 protected:
@@ -159,25 +176,31 @@ protected:
        ///
        Inset * editXY(Cursor & cur, int x, int y);
        ///
-       docstring floatName(std::string const & type, BufferParams const &) const;
+       docstring floatName(std::string const & type) const;
        ///
        virtual void resetParagraphsFont();
-
+       ///
+       mutable CollapseStatus status_;
 private:
        /// cache for the layout_. Make sure it is in sync with the document class!
        InsetLayout const * layout_;
        ///
-       Dimension dimensionCollapsed() const;
+       Dimension dimensionCollapsed(BufferView const & bv) const;
        ///
+       /// should paragraphs be forced to use the empty layout?
+       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 
+               { return getLayout().allowParagraphCustomization(); }
        docstring labelstring_;
        ///
        mutable Box button_dim;
-       ///
-       mutable CollapseStatus status_;
        /// a substatus of the Open status, determined automatically in metrics
        mutable bool openinlined_;
-       /// the inset will automatically open when the cursor is inside
-       mutable bool autoOpen_;
+       /// the inset will automatically open when the cursor is inside. This is
+       /// dependent on the bufferview, compare with MathMacro::editing_.
+       mutable std::map<BufferView const *, bool> auto_open_;
        /// changes color when mouse enters/leaves this inset
        bool mouse_hover_;
 };