]> 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 c0eed4a19538f2f1bdb681659e88b9a51b8b3e7f..4a4f2fec1975ec54032431f4d9d3c762db02ff0d 100644 (file)
 #include "box.h"
 #include "lyxfont.h"
 
-class Painter;
+#include <string>
+
+namespace lyx {
+
 class LyXText;
 class Paragraph;
-class LyXCursor;
+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;
-       /// inset is initially collapsed if bool = true
-       InsetCollapsable(BufferParams const &, bool collapsed = false);
        ///
-       InsetCollapsable(InsetCollapsable const & in);
+       InsetCollapsable(BufferParams const &, CollapseStatus status = Open);
+       ///
+       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;
-       /// draw, either inlined (no button) or collapsed/open
-       void draw(PainterInfo & pi, int x, int y, bool inlined) 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 &) 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 { return isOpen(); }
-       ///
-       bool insertInset(BufferView *, InsetOld * inset);
-       ///
-       bool insetAllowed(InsetOld::Code code) const;
-       ///
-       bool isTextInset() const { return true; }
-       ///
-       int latex(Buffer const &, std::ostream &,
-                 OutputParams const &) const;
+       bool descendable() const;
        ///
-       int plaintext(Buffer const &, std::ostream &,
-                 OutputParams const &) const;
+       void setLabel(docstring const & l);
        ///
-       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(int & x, int & y) const;
-       ///
-       void setLabel(std::string const & l) const;
+       virtual void setButtonLabel() {}
        ///
        void setLabelFont(LyXFont & f);
-#if 0
-       ///
-       void setAutoCollapse(bool f);
-#endif
-       /// 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;
-       ///
-       ParagraphList * getParagraphs(int) const;
        ///
-       int numParagraphs() const;
+       bool isOpen() const { return status_ == Open || status_ == Inlined; }
        ///
-       LyXText * getText(int) const;
+       bool inlined() const { return status_ == Inlined; }
        ///
-       bool display() const { return isOpen(); }
+       CollapseStatus status() const;
        ///
-       bool isOpen() const;
+       bool allowSpellCheck() const { return true; }
        ///
-       void open();
+       bool getStatus(LCursor &, FuncRequest const &, FuncStatus &) const;
        ///
-       void close() const;
+       void setStatus(LCursor & cur, CollapseStatus st);
        ///
-       void markErased();
-       ///
-       void addPreview(lyx::graphics::PreviewLoader &) const;
-       ///
-       void setBackgroundColor(LColor_color);
+       bool setMouseHover(bool mouse_hover);
 
 protected:
        ///
-       virtual
-       DispatchResult
-       priv_dispatch(FuncRequest const &, idx_type &, pos_type &);
-       ///
-       void dimension_collapsed(Dimension &) const;
-       ///
-       int height_collapsed() 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;
-       /// Should be non-const...
-       void setCollapsed(bool) const;
+       Dimension dimensionCollapsed() const;
        ///
        Box const & buttonDim() const;
        ///
-       void edit(BufferView *, bool);
+       void edit(LCursor & cur, bool left);
        ///
-       void edit(BufferView *, int, int);
-
-private:
+       InsetBase * editXY(LCursor & cur, int x, int y);
        ///
-       DispatchResult lfunMouseRelease(FuncRequest const &);
+       void setInlined() { status_ = Inlined; }
+       /// Is the width forced to some value?
+       virtual bool hasFixedWidth() const { return false; }
        ///
-       FuncRequest adjustCommand(FuncRequest const &);
+       docstring floatName(std::string const & type, BufferParams const &);
 
-public:
-       ///
-       mutable InsetText inset;
-private:
-       ///
-       mutable bool collapsed_;
+protected:
        ///
        LyXFont labelfont_;
        ///
@@ -158,11 +113,23 @@ private:
        ///
        mutable int topbaseline;
        ///
-       mutable std::string label;
-#if 0
+       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_;
        ///
-       bool autocollapse;
-#endif
+       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