]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetCollapsable.h
Fix mis-nomer
[lyx.git] / src / insets / InsetCollapsable.h
index 654e28a7bf52865c6180aab3e915d5433d56c942..c7b6d65c3a4f193454ba8bc1dcd73d3a9d4ae19c 100644 (file)
 #ifndef INSETCOLLAPSABLE_H
 #define INSETCOLLAPSABLE_H
 
-#include "Inset.h"
 #include "InsetText.h"
 
 #include "Box.h"
-#include "TextClass.h"
+
+#include <map>
 
 namespace lyx {
 
@@ -33,28 +33,19 @@ namespace frontend { class Painter; }
 class InsetCollapsable : public InsetText {
 public:
        ///
-       InsetCollapsable(Buffer const &, InsetText::UsePlain = InsetText::PlainLayout);
+       InsetCollapsable(Buffer *, InsetText::UsePlain = InsetText::PlainLayout);
        ///
        InsetCollapsable(InsetCollapsable const & rhs);
        ///
+       virtual ~InsetCollapsable();
+       ///
        InsetCollapsable * asInsetCollapsable() { return this; }
        ///
        InsetCollapsable const * asInsetCollapsable() const { return this; }
        ///
        docstring toolTip(BufferView const & bv, int x, int y) const;
        ///
-       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 &);
-       /// (Re-)set the character style parameters from \p tc according
-       /// to name()
-       void setLayout(DocumentClass const * const tc);
-       ///
-       virtual bool usePlainLayout() { return true; }
+       docstring layoutName() const { return from_ascii("Collapsable"); }
        ///
        void read(Lexer &);
        ///
@@ -63,35 +54,43 @@ public:
        void metrics(MetricsInfo &, Dimension &) const;
        ///
        void draw(PainterInfo & pi, int x, int y) const;
+       ///
+       virtual void drawBackground(PainterInfo &, int, int) const {}
 
        /// 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;
        ///
        bool editable() const;
        ///
        bool hasSettings() const { return true; }
+       /// Returns true if coordinates are over the inset's button.
+       /// Always returns false when the inset does not have a
+       /// button.
+       bool clickable(BufferView const & bv, 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() {}
        ///
-       virtual docstring const buttonLabel(BufferView const &) const
-               { return labelstring_; }
+       virtual docstring const buttonLabel(BufferView const &) const;
        ///
-       bool isOpen(BufferView const & bv) const 
+       bool isOpen(BufferView const & bv) const
                { return geometry(bv) != ButtonOnly; }
        ///
+       enum CollapseStatus {
+               Collapsed,
+               Open
+       };
+       ///
+       virtual void setStatus(Cursor & cur, CollapseStatus st);
+       ///
        CollapseStatus status(BufferView const & bv) const;
-       /** Of the old CollapseStatus we only keep the values  
+       /** Of the old CollapseStatus we only keep the values
         *  Open and Collapsed.
         * We define a list of possible inset decoration
         * styles, and a list of possible (concrete, visual)
@@ -112,6 +111,10 @@ public:
 
        /// Default looks
        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,
@@ -125,84 +128,58 @@ public:
        /// (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(); }
        ///
-       bool allowMultiPar() const;
+       bool canPaintChange(BufferView const & bv) 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;
        ///
-       ColorCode backgroundColor() const { return layout_->bgcolor(); }
+       ColorCode backgroundColor(PainterInfo const &) const
+               { return getLayout().bgcolor(); }
        ///
-       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().
-       int xhtml(odocstream &, OutputParams const &) const;
-       ///
-       void validate(LaTeXFeatures &) const;
+       ColorCode labelColor() const { return getLayout().labelfont().color(); }
        ///
        InsetCode lyxCode() const { return COLLAPSABLE_CODE; }
 
-       /// Allow multiple blanks
-       virtual bool isFreeSpacing() const { return layout_->isFreeSpacing(); }
-       /// Don't eliminate empty paragraphs
-       virtual bool allowEmpty() const { return layout_->isKeepEmpty(); }
-       /// Force inset into LTR environment if surroundings are RTL?
-       virtual bool forceLTR() const { return layout_->isForceLtr(); }
        ///
        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;
+       std::string contextMenu(BufferView const & bv, int x, int y) const;
+       ///
+       std::string contextMenuName() const;
 protected:
        ///
        void doDispatch(Cursor & cur, FuncRequest & cmd);
        ///
-       void edit(Cursor & cur, bool front, 
+       void edit(Cursor & cur, bool front,
                EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
        ///
        Inset * editXY(Cursor & cur, int x, int y);
        ///
-       docstring floatName(std::string const & type, BufferParams const &) 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(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_;
+
+       // These variables depend of the view in which the inset is displayed
+       struct View
+       {
+               /// The dimension of the inset button
+               Box button_dim_;
+               /// a substatus of the Open status, determined automatically in metrics
+               bool openinlined_;
+               /// the inset will automatically open when the cursor is inside. This is
+               /// dependent on the bufferview, compare with MathMacro::editing_.
+               bool auto_open_;
+               /// changes color when mouse enters/leaves this inset
+               bool mouse_hover_;
+       };
+
        ///
-       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. 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 *, View> view_;
 };
 
 } // namespace lyx