3 * \file InsetCollapsable.h
4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Alejandro Aguilar Sierra
9 * \author Lars Gullik Bjønnes
11 * Full author contact details are available in file CREDITS.
14 #ifndef INSETCOLLAPSABLE_H
15 #define INSETCOLLAPSABLE_H
18 #include "InsetText.h"
21 #include "TextClass.h"
28 namespace frontend { class Painter; }
30 /** A collapsable text inset
33 class InsetCollapsable : public InsetText {
36 InsetCollapsable(Buffer *, InsetText::UsePlain = InsetText::PlainLayout);
38 InsetCollapsable(InsetCollapsable const & rhs);
40 virtual ~InsetCollapsable();
42 InsetCollapsable * asInsetCollapsable() { return this; }
44 InsetCollapsable const * asInsetCollapsable() const { return this; }
46 docstring toolTip(BufferView const & bv, int x, int y) const;
48 docstring name() const { return from_ascii("Collapsable"); }
52 void write(std::ostream &) const;
54 void metrics(MetricsInfo &, Dimension &) const;
56 void draw(PainterInfo & pi, int x, int y) const;
58 /// return x,y of given position relative to the inset's baseline
59 void cursorPos(BufferView const & bv, CursorSlice const & sl,
60 bool boundary, int & x, int & y) const;
61 /// Returns true if (mouse) action is over the inset's button.
62 /// Always returns false when the inset does not have a
64 bool hitButton(FuncRequest const &) const;
66 docstring const getNewLabel(docstring const & l) const;
68 bool editable() const;
70 bool hasSettings() const { return true; }
71 /// can we go further down on mouse click?
72 bool descendable(BufferView const & bv) const;
74 void setLabel(docstring const & l);
76 virtual void setButtonLabel() {}
78 virtual docstring const buttonLabel(BufferView const &) const;
80 bool isOpen(BufferView const & bv) const
81 { return geometry(bv) != ButtonOnly; }
88 virtual void setStatus(Cursor & cur, CollapseStatus st);
90 CollapseStatus status(BufferView const & bv) const;
91 /** Of the old CollapseStatus we only keep the values
93 * We define a list of possible inset decoration
94 * styles, and a list of possible (concrete, visual)
95 * inset geometries. Relationships between them
96 * (geometries in body of table):
99 * Decoration: \ Open Collapsed
100 * -------------+-------------------------------
101 * Classic | *) TopButton, <--x) ButtonOnly
103 * Minimalistic | NoButton ButtonOnly
104 * Conglomerate | SubLabel Corners
105 * ---------------------------------------------
106 * *) toggled by openinlined_
107 * x) toggled by auto_open_
111 virtual InsetLayout::InsetDecoration decoration() const;
121 /// Returns the geometry based on CollapseStatus
122 /// (status_), auto_open_[BufferView] and openinlined_,
123 /// and of course decoration().
124 Geometry geometry(BufferView const & bv) const;
125 /// Returns the geometry disregarding auto_open_
126 Geometry geometry() const;
128 bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
130 bool setMouseHover(BufferView const * bv, bool mouse_hover);
132 ColorCode backgroundColor(PainterInfo const &) const
133 { return getLayout().bgcolor(); }
135 ColorCode labelColor() const { return getLayout().labelfont().color(); }
137 InsetCode lyxCode() const { return COLLAPSABLE_CODE; }
140 virtual bool usePlainLayout() const { return true; }
142 virtual docstring contextMenu(BufferView const & bv, int x, int y) const;
144 docstring floatName(std::string const & type) const;
147 void doDispatch(Cursor & cur, FuncRequest & cmd);
149 void edit(Cursor & cur, bool front,
150 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
152 Inset * editXY(Cursor & cur, int x, int y);
154 mutable CollapseStatus status_;
157 Dimension dimensionCollapsed(BufferView const & bv) const;
159 docstring labelstring_;
161 mutable Box button_dim;
162 /// a substatus of the Open status, determined automatically in metrics
163 mutable bool openinlined_;
164 /// the inset will automatically open when the cursor is inside. This is
165 /// dependent on the bufferview, compare with MathMacro::editing_.
166 mutable std::map<BufferView const *, bool> auto_open_;
167 /// changes color when mouse enters/leaves this inset
168 mutable std::map<BufferView const *, bool> mouse_hover_;