]> 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 d7310607341b089241356ab47659a65f40e982c3..4a4f2fec1975ec54032431f4d9d3c762db02ff0d 100644 (file)
@@ -8,7 +8,7 @@
  * \author Jürgen Vigna
  * \author Lars Gullik Bjønnes
  *
- * Full author contact details are available in file CREDITS
+ * Full author contact details are available in file CREDITS.
  */
 
 #ifndef INSETCOLLAPSABLE_H
 
 #include "inset.h"
 #include "insettext.h"
+
+#include "box.h"
 #include "lyxfont.h"
-#include "LColor.h"
 
-#include <boost/weak_ptr.hpp>
+#include <string>
+
+namespace lyx {
 
-class Painter;
 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 = false);
-       ///
-       InsetCollapsable(InsetCollapsable const & in, bool same_id = false);
-       ///
-       void read(Buffer const *, LyXLex &);
-       ///
-       void write(Buffer const *, std::ostream &) const;
-       ///
-       int ascent(BufferView *, LyXFont const &) const;
-       ///
-       int descent(BufferView *, LyXFont const &) const;
-       ///
-       int width(BufferView *, LyXFont const &) const;
-       ///
-       void draw(BufferView *, const LyXFont &, int , float &) const;
-       /// draw, either inlined (no button) or collapsed/open
-       void draw(BufferView * bv, LyXFont const & f,
-                 int baseline, float & x, bool inlined) const;
-       ///
-       void update(BufferView *, bool =false);
-       ///
-       EDITABLE editable() const;
-       ///
-       bool insertInset(BufferView *, Inset * inset);
-       ///
-       virtual bool insetAllowed(Inset::Code code) const {
-               return inset.insetAllowed(code);
-       }
        ///
-       bool isTextInset() const { return true; }
+       InsetCollapsable(BufferParams const &, CollapseStatus status = Open);
        ///
-       void insetUnlock(BufferView *);
+       InsetCollapsable(InsetCollapsable const & rhs);
        ///
-       bool needFullRow() const { return isOpen(); }
+       void read(Buffer const &, LyXLex &);
        ///
-       bool lockInsetInInset(BufferView *, UpdatableInset *);
+       void write(Buffer const &, std::ostream &) const;
        ///
-       bool unlockInsetInInset(BufferView *, UpdatableInset *,
-                               bool lr = false);
-       ///
-       bool updateInsetInInset(BufferView *, Inset *);
-       ///
-       int insetInInsetY() const;
-       ///
-       RESULT localDispatch(FuncRequest const &);
-       ///
-       int latex(Buffer const *, std::ostream &,
-                 bool fragile, bool free_spc) const;
-       ///
-       int ascii(Buffer const *, std::ostream &, int) const;
-       ///
-       int linuxdoc(Buffer const *, std::ostream &) const;
-       ///
-       int docbook(Buffer const *, std::ostream &, bool mixcont) const;
-       ///
-       void validate(LaTeXFeatures & features) const;
-       /// FIXME, document
-       void getCursorPos(BufferView *, int & x, int & y) const;
-       /// Get the absolute document x,y of the cursor
-       virtual void getCursor(BufferView &, int &, int &) const;
-       ///
-       void fitInsetCursor(BufferView * bv) const {
-               inset.fitInsetCursor(bv);
-       }
-       UpdatableInset * getLockingInset() const;
-       ///
-       UpdatableInset * getFirstLockingInsetOfType(Inset::Code);
-       ///
-       void setFont(BufferView *, LyXFont const &, bool toggleall = false,
-                bool selectall = false);
-       ///
-       void setLabel(string const & l) const;
-       ///
-       void setLabelFont(LyXFont & f) { labelfont = f; }
-#if 0
-       ///
-       void setAutoCollapse(bool f) { autocollapse = f; }
-#endif
+       bool metrics(MetricsInfo &, Dimension &) const;
        ///
-       LyXText * getLyXText(BufferView const *, bool const recursive) const;
+       void draw(PainterInfo & pi, int x, int y) const;
        ///
-       void deleteLyXText(BufferView *, bool recursive=true) 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;
        ///
-       void resizeLyXText(BufferView *, bool force = false) const;
+       bool hitButton(FuncRequest const &) const;
        ///
-       std::vector<string> const getLabelList() const;
+       docstring const getNewLabel(docstring const & l) const;
        ///
-       bool nodraw() const;
-       ///
-       int scroll(bool recursive=true) const;
-       ///
-       void scroll(BufferView *bv, float sx) const {
-               UpdatableInset::scroll(bv, sx);
-       }
-       ///
-       void scroll(BufferView *bv, int offset) const {
-               UpdatableInset::scroll(bv, offset);
-       }
-       ///
-       Inset * getInsetFromID(int id) const;
-       ///
-       ParagraphList * getParagraphs(int) const;
+       EDITABLE editable() const;
+       /// can we go further down on mouse click?
+       bool descendable() const;
        ///
-       LyXCursor const & cursor(BufferView *) const;
+       void setLabel(docstring const & l);
        ///
-       bool isOpen() const { return !collapsed_; }
+       virtual void setButtonLabel() {}
        ///
-       void open(BufferView *);
+       void setLabelFont(LyXFont & f);
        ///
-       void close(BufferView *) const;
+       bool isOpen() const { return status_ == Open || status_ == Inlined; }
        ///
-       bool allowSpellcheck() const { return inset.allowSpellcheck(); }
+       bool inlined() const { return status_ == Inlined; }
        ///
-       WordLangTuple const
-       selectNextWordToSpellcheck(BufferView *, float &) const;
+       CollapseStatus status() const;
        ///
-       void selectSelectedWord(BufferView * bv) {
-               inset.selectSelectedWord(bv);
-       }
+       bool allowSpellCheck() const { return true; }
        ///
-       void toggleSelection(BufferView * bv, bool kill_selection) {
-               inset.toggleSelection(bv, kill_selection);
-       }
-       void markErased();
-       bool nextChange(BufferView * bv, lyx::pos_type & length);
-
+       bool getStatus(LCursor &, FuncRequest const &, FuncStatus &) const;
        ///
-       bool searchForward(BufferView * bv, string const & str,
-                          bool = true, bool = false);
-       bool searchBackward(BufferView * bv, string const & str,
-                           bool = true, bool = false);
-
+       void setStatus(LCursor & cur, CollapseStatus st);
        ///
-       void addPreview(grfx::PreviewLoader &) const;
+       bool setMouseHover(bool mouse_hover);
 
 protected:
        ///
-       virtual void cache(BufferView *) const;
+       virtual void doDispatch(LCursor & cur, FuncRequest & cmd);
        ///
-       virtual BufferView * view() const;
-
+       Dimension dimensionCollapsed() const;
        ///
-       int ascent_collapsed() const;
+       Box const & buttonDim() const;
        ///
-       int descent_collapsed() const;
+       void edit(LCursor & cur, bool left);
        ///
-       int width_collapsed() const;
+       InsetBase * editXY(LCursor & cur, int x, int y);
        ///
-       void draw_collapsed(Painter & pain, int , float &) const;
+       void setInlined() { status_ = Inlined; }
+       /// Is the width forced to some value?
+       virtual bool hasFixedWidth() const { return false; }
        ///
-       int getMaxTextWidth(Painter & pain, UpdatableInset const *) const;
+       docstring floatName(std::string const & type, BufferParams const &);
 
-       ///
-       mutable bool collapsed_;
-       ///
-       LColor::color framecolor;
-       ///
-       LyXFont labelfont;
-public:
-       ///
-       mutable InsetText inset;
 protected:
        ///
-       mutable int button_length;
-       ///
-       mutable int button_top_y;
+       LyXFont labelfont_;
        ///
-       mutable int button_bottom_y;
+       mutable Box button_dim;
        ///
        mutable int topx;
-       mutable int topbaseline;
-
-private:
-       ///
-       void lfunMousePress(FuncRequest const &);
-       ///
-       bool lfunMouseRelease(FuncRequest const &);
-       ///
-       void lfunMouseMotion(FuncRequest const &);
-
        ///
-       mutable string label;
-#if 0
-       ///
-       bool autocollapse;
-#endif
-       ///
-       mutable int oldWidth;
+       mutable int topbaseline;
        ///
-       bool in_update;
+       mutable docstring label;
+private:
        ///
-       mutable bool first_after_edit;
+       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 boost::weak_ptr<BufferView> view_;
+       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