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 const &, InsetText::UsePlain = InsetText::PlainLayout);
38 InsetCollapsable(InsetCollapsable const & rhs);
40 InsetCollapsable * asInsetCollapsable() { return this; }
42 InsetCollapsable const * asInsetCollapsable() const { return this; }
44 docstring toolTip(BufferView const & bv, int x, int y) const;
46 docstring name() const { return from_ascii("Collapsable"); }
49 InsetLayout const & getLayout() const { return *layout_; }
53 /// (Re-)set the character style parameters from \p tc according
55 void setLayout(DocumentClass const * const tc);
59 void write(std::ostream &) const;
61 void metrics(MetricsInfo &, Dimension &) const;
63 void draw(PainterInfo & pi, int x, int y) const;
65 /// return x,y of given position relative to the inset's baseline
66 void cursorPos(BufferView const & bv, CursorSlice const & sl,
67 bool boundary, int & x, int & y) const;
68 /// Returns true if (mouse) action is over the inset's button.
69 /// Always returns false when the inset does not have a
71 bool hitButton(FuncRequest const &) const;
73 docstring const getNewLabel(docstring const & l) const;
75 bool editable() const;
77 bool hasSettings() const { return true; }
78 /// can we go further down on mouse click?
79 bool descendable() const;
81 void setLabel(docstring const & l);
83 virtual void setButtonLabel() {}
85 virtual docstring const buttonLabel(BufferView const &) const
86 { return labelstring_; }
88 bool isOpen(BufferView const & bv) const
89 { return geometry(bv) != ButtonOnly; }
91 CollapseStatus status(BufferView const & bv) const;
92 /** Of the old CollapseStatus we only keep the values
94 * We define a list of possible inset decoration
95 * styles, and a list of possible (concrete, visual)
96 * inset geometries. Relationships between them
97 * (geometries in body of table):
100 * Decoration: \ Open Collapsed
101 * -------------+-------------------------------
102 * Classic | *) TopButton, <--x) ButtonOnly
104 * Minimalistic | NoButton ButtonOnly
105 * Conglomerate | SubLabel Corners
106 * ---------------------------------------------
107 * *) toggled by openinlined_
108 * x) toggled by auto_open_
112 virtual InsetLayout::InsetDecoration decoration() const;
122 /// Returns the geometry based on CollapseStatus
123 /// (status_), auto_open_[BufferView] and openinlined_,
124 /// and of course decoration().
125 Geometry geometry(BufferView const & bv) const;
126 /// Returns the geometry disregarding auto_open_
127 Geometry geometry() const;
129 bool allowMultiPar() const;
131 bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
133 void setStatus(Cursor & cur, CollapseStatus st);
135 bool setMouseHover(bool mouse_hover);
137 ColorCode backgroundColor() const { return getLayout().bgcolor(); }
139 ColorCode labelColor() const { return getLayout().labelfont().color(); }
141 int latex(odocstream &, OutputParams const &) const;
143 int docbook(odocstream &, OutputParams const &) const;
144 /// It will rarely be right to call this from subclasses, due
145 /// to the fact that it steps counters, etc. Instead, call
146 /// InsetText::xhtml().
147 docstring xhtml(odocstream &, OutputParams const &) const;
149 void validate(LaTeXFeatures &) const;
151 InsetCode lyxCode() const { return COLLAPSABLE_CODE; }
154 virtual bool usePlainLayout() const { return true; }
155 /// Is this inset's layout defined in the document's textclass?
156 /// May be wrong after textclass change or paste from another document
157 bool undefined() const;
158 /// the string that is passed to the TOC
159 void tocString(odocstream &) const;
161 virtual docstring contextMenu(BufferView const & bv, int x, int y) const;
164 void doDispatch(Cursor & cur, FuncRequest & cmd);
166 void edit(Cursor & cur, bool front,
167 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
169 Inset * editXY(Cursor & cur, int x, int y);
171 docstring floatName(std::string const & type) const;
173 virtual void resetParagraphsFont();
175 mutable CollapseStatus status_;
177 /// cache for the layout_. Make sure it is in sync with the document class!
178 InsetLayout const * layout_;
180 Dimension dimensionCollapsed(BufferView const & bv) const;
182 /// should paragraphs be forced to use the empty layout?
183 virtual bool forcePlainLayout(idx_type = 0) const
184 { return getLayout().forcePlainLayout(); }
185 /// should the user be allowed to customize alignment, etc.?
186 virtual bool allowParagraphCustomization(idx_type = 0) const
187 { return getLayout().allowParagraphCustomization(); }
188 docstring labelstring_;
190 mutable Box button_dim;
191 /// a substatus of the Open status, determined automatically in metrics
192 mutable bool openinlined_;
193 /// the inset will automatically open when the cursor is inside. This is
194 /// dependent on the bufferview, compare with MathMacro::editing_.
195 mutable std::map<BufferView const *, bool> auto_open_;
196 /// changes color when mouse enters/leaves this inset