]> git.lyx.org Git - lyx.git/blobdiff - src/insets/insetcollapsable.h
* src/LyXAction.C: mark goto-clear-bookmark as working without buffer
[lyx.git] / src / insets / insetcollapsable.h
index c4866a1dcc6ab450b4b5e7c179a7913871f93470..4a4f2fec1975ec54032431f4d9d3c762db02ff0d 100644 (file)
 #include "box.h"
 #include "lyxfont.h"
 
-class Painter;
+#include <string>
+
+namespace lyx {
+
 class LyXText;
 class Paragraph;
 class CursorSlice;
 
+namespace frontend { class Painter; }
+
 /** A collapsable text inset
 
 */
-class InsetCollapsable : public UpdatableInset {
+class InsetCollapsable : public InsetText {
 public:
        ///
        static int const TEXT_TO_TOP_OFFSET = 2;
        ///
        static int const TEXT_TO_BOTTOM_OFFSET = 2;
        ///
-       enum CollapseStatus {
-               Open,
-               Collapsed,
-               Inlined
-       };
-       ///
        InsetCollapsable(BufferParams const &, CollapseStatus status = Open);
        ///
-       InsetCollapsable(InsetCollapsable const & in);
+       InsetCollapsable(InsetCollapsable const & rhs);
        ///
        void read(Buffer const &, LyXLex &);
        ///
        void write(Buffer const &, std::ostream &) const;
        ///
-       void metrics(MetricsInfo &, Dimension &) const;
+       bool metrics(MetricsInfo &, Dimension &) const;
        ///
        void draw(PainterInfo & pi, int x, int y) const;
        ///
        void drawSelection(PainterInfo & pi, int x, int y) 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;
        ///
-       bool hitButton(FuncRequest &) const;
+       bool hitButton(FuncRequest const &) const;
        ///
-       std::string const getNewLabel(std::string const & l) const;
+       docstring const getNewLabel(docstring const & l) const;
        ///
        EDITABLE editable() const;
        /// can we go further down on mouse click?
        bool descendable() const;
        ///
-       bool insetAllowed(InsetOld::Code code) const;
-       ///
-       bool isTextInset() const { return true; }
-       ///
-       int latex(Buffer const &, std::ostream &,
-                 OutputParams const &) const;
-       ///
-       int plaintext(Buffer const &, std::ostream &,
-                 OutputParams const &) const;
-       ///
-       int linuxdoc(Buffer const &, std::ostream &,
-                    OutputParams const &) const;
-       ///
-       int docbook(Buffer const &, std::ostream &,
-                   OutputParams const & runparams) const;
-       ///
-       void validate(LaTeXFeatures & features) const;
-       /// get the screen x,y of the cursor
-       void getCursorPos(CursorSlice const & cur, int & x, int & y) const;
-       ///
-       void setLabel(std::string const & l);
+       void setLabel(docstring const & l);
        ///
        virtual void setButtonLabel() {}
-       ///
-       void setLabelFont(LyXFont & f);
-       /// Appends \c list with all labels found within this inset.
-       void getLabelList(Buffer const &, std::vector<std::string> & list) const;
-       ///
-       int scroll(bool recursive = true) const;
-       ///
-       void scroll(BufferView & bv, float sx) const;
-       ///
-       void scroll(BufferView & bv, int offset) const;
-       ///
-       size_t nargs() const;
        ///
-       LyXText * getText(int) const;
+       void setLabelFont(LyXFont & f);
        ///
        bool isOpen() const { return status_ == Open || status_ == Inlined; }
        ///
        bool inlined() const { return status_ == Inlined; }
        ///
-       CollapseStatus status() const { return status_; }
-       ///
-       void open();
-       ///
-       void close();
-       ///
-       void markErased();
+       CollapseStatus status() const;
        ///
-       void addPreview(lyx::graphics::PreviewLoader &) const;
+       bool allowSpellCheck() const { return true; }
        ///
-       void setBackgroundColor(LColor_color);
+       bool getStatus(LCursor &, FuncRequest const &, FuncStatus &) const;
        ///
-       void setStatus(CollapseStatus st);
+       void setStatus(LCursor & cur, CollapseStatus st);
        ///
-       bool allowSpellCheck() const { return true; }
+       bool setMouseHover(bool mouse_hover);
 
 protected:
        ///
-       void priv_dispatch(LCursor & cur, FuncRequest & cmd);
-       ///
-       void dimension_collapsed(Dimension &) const;
-       ///
-       void draw_collapsed(PainterInfo & pi, int x, int y) const;
+       virtual void doDispatch(LCursor & cur, FuncRequest & cmd);
        ///
-       int getMaxTextWidth(Painter & pain, UpdatableInset const *) const;
+       Dimension dimensionCollapsed() const;
        ///
        Box const & buttonDim() const;
        ///
        void edit(LCursor & cur, bool left);
        ///
        InsetBase * editXY(LCursor & cur, int x, int y);
-
-private:
        ///
-       void lfunMouseRelease(LCursor & cur, FuncRequest & cmd);
-
-public:
+       void setInlined() { status_ = Inlined; }
+       /// Is the width forced to some value?
+       virtual bool hasFixedWidth() const { return false; }
        ///
-       mutable InsetText inset;
+       docstring floatName(std::string const & type, BufferParams const &);
+
 protected:
        ///
        LyXFont labelfont_;
@@ -154,12 +113,23 @@ protected:
        ///
        mutable int topbaseline;
        ///
-       mutable std::string label;
+       mutable docstring label;
 private:
        ///
        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_;
+       ///
+       mutable Dimension textdim_;
+       /// changes color when mouse enters/leaves this inset
+       bool mouse_hover_;
 };
 
+// A helper function that pushes the cursor out of the inset.
+void leaveInset(LCursor & cur, InsetBase const & in);
+
+} // namespace lyx
+
 #endif