]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetCollapsable.h
Reduce caption hardcoding
[lyx.git] / src / insets / InsetCollapsable.h
index 75fc3d8e624aaac9969ed1f2a8910fe41cb5d0d0..1c990f93c88c4c2103ac5695f97a4a0a102d59fc 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.
  */
 #ifndef INSETCOLLAPSABLE_H
 #define INSETCOLLAPSABLE_H
 
-#include "Inset.h"
 #include "InsetText.h"
-#include "TextClass.h"
 
 #include "Box.h"
-#include "Font.h"
 
-#include <string>
+#include <map>
 
 namespace lyx {
 
-class Text;
-class Paragraph;
 class CursorSlice;
 class InsetLayout;
 
@@ -38,21 +33,23 @@ namespace frontend { class Painter; }
 class InsetCollapsable : public InsetText {
 public:
        ///
-       static int const TEXT_TO_TOP_OFFSET = 2;
+       InsetCollapsable(Buffer *, InsetText::UsePlain = InsetText::PlainLayout);
        ///
-       static int const TEXT_TO_BOTTOM_OFFSET = 2;
+       InsetCollapsable(InsetCollapsable const & rhs);
        ///
-       InsetCollapsable(BufferParams const &, CollapseStatus status = Inset::Open);
+       virtual ~InsetCollapsable();
        ///
-       InsetCollapsable(InsetCollapsable const & rhs);
+       InsetCollapsable * asInsetCollapsable() { return this; }
        ///
-       docstring name() const { return from_ascii("Collapsable"); }
+       InsetCollapsable const * asInsetCollapsable() const { return this; }
        ///
-       void setLayout(BufferParams const &);
+       docstring toolTip(BufferView const & bv, int x, int y) const;
        ///
-       void read(Buffer const &, Lexer &);
+       docstring layoutName() const { return from_ascii("Collapsable"); }
        ///
-       void write(Buffer const &, std::ostream &) const;
+       void read(Lexer &);
+       ///
+       void write(std::ostream &) const;
        ///
        void metrics(MetricsInfo &, Dimension &) const;
        ///
@@ -61,24 +58,38 @@ 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;
-       ///
+       /// 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; }
+       ///
+       bool clickable(int x, int y) const;
        /// can we go further down on mouse click?
-       bool descendable() const;
+       bool descendable(BufferView const & bv) const;
        ///
        void setLabel(docstring const & l);
        ///
        virtual void setButtonLabel() {}
        ///
-       void setLabelFont(Font const & f);
+       virtual docstring const buttonLabel(BufferView const &) const;
        ///
-       bool isOpen() const { return geometry() != ButtonOnly; }
+       bool isOpen(BufferView const & bv) const 
+               { return geometry(bv) != ButtonOnly; }
+       ///
+       enum CollapseStatus {
+               Collapsed,
+               Open
+       };
        ///
-       CollapseStatus status() const;
+       virtual void setStatus(Cursor & cur, CollapseStatus st);
+       ///
+       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
@@ -91,21 +102,19 @@ public:
         *   -------------+-------------------------------
         *   Classic      | *) TopButton, <--x) ButtonOnly
         *                | LeftButton
-        *   Minimalistic | ButtonOnly          NoButton
+        *   Minimalistic | NoButton            ButtonOnly
         *   Conglomerate | SubLabel            Corners
         *   ---------------------------------------------
         *   *) toggled by openinlined_
-        *   x) toggled by autoOpen_
+        *   x) toggled by auto_open_
         */
 
-       ///
-       enum Decoration {
-               Classic,
-               Minimalistic,
-               Conglomerate
-       };
        /// Default looks
-       virtual Decoration decoration() const;
+       virtual InsetLayout::InsetDecoration decoration() const;
+       /// Inset font
+       virtual FontInfo getFont() const { return getLayout().font(); }
+       /// Label font
+       virtual FontInfo getLabelfont() const { return getLayout().labelfont(); }
        ///
        enum Geometry {
                TopButton,
@@ -116,68 +125,57 @@ 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;
        ///
-       bool allowSpellCheck() const { return true; }
-       ///
-       bool allowMultiPar() const;
-       ///
        bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
        ///
-       void setStatus(Cursor & cur, CollapseStatus st);
-       ///
-       bool setMouseHover(bool mouse_hover);
+       bool setMouseHover(BufferView const * bv, bool mouse_hover) const;
        ///
-       virtual Color_color backgroundColor() const {return layout_.bgcolor; }
-
-       int latex(Buffer const &, odocstream &,
-                 OutputParams const &) const;
+       ColorCode backgroundColor(PainterInfo const &) const
+               { return getLayout().bgcolor(); }
        ///
-       void validate(LaTeXFeatures &) const;
+       ColorCode labelColor() const { return getLayout().labelfont().color(); }
        ///
-       virtual InsetCode lyxCode() const { return COLLAPSABLE_CODE; }
+       InsetCode lyxCode() const { return COLLAPSABLE_CODE; }
 
-protected:
-       ///
-       virtual void doDispatch(Cursor & cur, FuncRequest & cmd);
        ///
-       Dimension dimensionCollapsed() const;
+       virtual bool usePlainLayout() const { return true; }
        ///
-       Box const & buttonDim() const;
+       std::string contextMenu(BufferView const & bv, int x, int y) const;
        ///
-       void edit(Cursor & cur, bool left);
-       ///
-       Inset * editXY(Cursor & cur, int x, int y);
+       std::string contextMenuName() const;
        ///
-       docstring floatName(std::string const & type, BufferParams const &) const;
-
+       docstring floatName(std::string const & type) const;
 protected:
        ///
-       mutable Box button_dim;
-       ///
-       mutable int topx;
+       void doDispatch(Cursor & cur, FuncRequest & cmd);
        ///
-       mutable int topbaseline;
+       void edit(Cursor & cur, bool front, 
+               EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
        ///
-       mutable InsetLayout layout_;
+       Inset * editXY(Cursor & cur, int x, int y);
        ///
-       CollapseStatus internalStatus() const { return status_; }
+       mutable CollapseStatus status_;
 private:
        ///
-       mutable CollapseStatus status_;
+       Dimension dimensionCollapsed(BufferView const & bv) const;
+       ///
+       docstring labelstring_;
+       ///
+       mutable Box button_dim;
        /// 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_;
+       mutable std::map<BufferView const *, bool> mouse_hover_;
 };
 
-// A helper function that pushes the cursor out of the inset.
-void leaveInset(Cursor & cur, Inset const & in);
-
 } // namespace lyx
 
 #endif