* \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 "funcrequest.h" // for adjustCommand
-#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 collapsed = false);
- ///
- InsetCollapsable(InsetCollapsable const & in);
- ///
- void read(Buffer const *, LyXLex &);
- ///
- void write(Buffer const *, std::ostream &) const;
- ///
- void 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 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; }
- ///
- void insetUnlock(BufferView *);
///
- bool needFullRow() const { return isOpen(); }
+ InsetCollapsable(BufferParams const &, CollapseStatus status = Open);
///
- bool lockInsetInInset(BufferView *, UpdatableInset *);
+ InsetCollapsable(InsetCollapsable const & rhs);
///
- bool unlockInsetInInset(BufferView *, UpdatableInset *,
- bool lr = false);
- ///
- bool updateInsetInInset(BufferView *, Inset *);
- ///
- int insetInInsetY() const;
- ///
- RESULT localDispatch(FuncRequest const &);
- ///
- int latex(Buffer const *, std::ostream &,
- LatexRunParams const &) 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
+ void read(Buffer const &, LyXLex &);
///
- LyXText * getLyXText(BufferView const *, bool const recursive) const;
+ void write(Buffer const &, std::ostream &) const;
///
- void deleteLyXText(BufferView *, bool recursive=true) const;
+ bool metrics(MetricsInfo &, Dimension &) const;
///
- void resizeLyXText(BufferView *, bool force = false) const;
- ///
- void getLabelList(std::vector<string> &) const;
- ///
- bool nodraw() const;
+ void draw(PainterInfo & pi, int x, int y) const;
///
- int scroll(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 scroll(BufferView *bv, float sx) const {
- UpdatableInset::scroll(bv, sx);
- }
+ bool hitButton(FuncRequest const &) const;
///
- void scroll(BufferView *bv, int offset) const {
- UpdatableInset::scroll(bv, offset);
- }
+ docstring const getNewLabel(docstring const & l) const;
///
- Inset * getInsetFromID(int id) const;
+ EDITABLE editable() const;
+ /// can we go further down on mouse click?
+ bool descendable() const;
///
- ParagraphList * getParagraphs(int) const;
+ void setLabel(docstring const & l);
///
- LyXCursor const & cursor(BufferView *) const;
+ virtual void setButtonLabel() {}
///
- bool isOpen() const { return !collapsed_; }
+ void setLabelFont(LyXFont & f);
///
- void open(BufferView *);
+ bool isOpen() const { return status_ == Open || status_ == Inlined; }
///
- void close(BufferView *) const;
+ bool inlined() const { return status_ == Inlined; }
///
- bool allowSpellcheck() const { return inset.allowSpellcheck(); }
+ CollapseStatus status() const;
///
- WordLangTuple const
- selectNextWordToSpellcheck(BufferView *, float &) const;
+ bool allowSpellCheck() const { return true; }
///
- void selectSelectedWord(BufferView * bv) {
- inset.selectSelectedWord(bv);
- }
+ bool getStatus(LCursor &, FuncRequest const &, FuncStatus &) const;
///
- void toggleSelection(BufferView * bv, bool kill_selection) {
- inset.toggleSelection(bv, kill_selection);
- }
-
- void markErased();
-
- bool nextChange(BufferView * bv, lyx::pos_type & length);
-
+ void setStatus(LCursor & cur, CollapseStatus st);
///
- bool searchForward(BufferView * bv, string const & str,
- bool = true, bool = false);
- bool searchBackward(BufferView * bv, string const & str,
- bool = true, bool = false);
-
- ///
- void addPreview(grfx::PreviewLoader &) const;
+ bool setMouseHover(bool mouse_hover);
protected:
///
- virtual void cache(BufferView *) const;
- ///
- virtual BufferView * view() const;
-
+ virtual void doDispatch(LCursor & cur, FuncRequest & cmd);
///
- void dimension_collapsed(Dimension &) const;
+ Dimension dimensionCollapsed() const;
///
- int height_collapsed() const;
+ Box const & buttonDim() const;
///
- void draw_collapsed(PainterInfo & pi, int x, int y) const;
+ void edit(LCursor & cur, bool left);
///
- int getMaxTextWidth(Painter & pain, UpdatableInset const *) const;
-
+ InsetBase * editXY(LCursor & cur, int x, int y);
///
- mutable bool collapsed_;
- ///
- LColor::color framecolor;
- ///
- LyXFont labelfont;
-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:
///
- 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 lfunMouseRelease(FuncRequest const &);
- ///
- FuncRequest adjustCommand(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