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"); }
48 InsetLayout const & getLayout(BufferParams const &) const { return *layout_; }
50 InsetLayout const & getLayout() const { return *layout_; }
52 void setLayout(BufferParams const &);
53 /// (Re-)set the character style parameters from \p tc according
55 void setLayout(DocumentClass const * const tc);
57 virtual bool usePlainLayout() { return true; }
61 void write(std::ostream &) const;
63 void metrics(MetricsInfo &, Dimension &) const;
65 void draw(PainterInfo & pi, int x, int y) const;
67 /// return x,y of given position relative to the inset's baseline
68 void cursorPos(BufferView const & bv, CursorSlice const & sl,
69 bool boundary, int & x, int & y) const;
70 /// Returns true if (mouse) action is over the inset's button.
71 /// Always returns false when the inset does not have a
73 bool hitButton(FuncRequest const &) const;
75 docstring const getNewLabel(docstring const & l) const;
77 EDITABLE editable() const;
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;
128 /// Allow spellchecking, except for insets with latex_language
129 bool allowSpellCheck() const { return !forceLTR(); }
131 bool allowMultiPar() const;
133 bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
135 void setStatus(Cursor & cur, CollapseStatus st);
137 bool setMouseHover(bool mouse_hover);
139 ColorCode backgroundColor() const { return layout_->bgcolor(); }
141 int latex(odocstream &, OutputParams const &) const;
143 int docbook(odocstream &, OutputParams const &) const;
145 void validate(LaTeXFeatures &) const;
147 InsetCode lyxCode() const { return COLLAPSABLE_CODE; }
149 /// Allow multiple blanks
150 virtual bool isFreeSpacing() const { return layout_->isFreeSpacing(); }
151 /// Don't eliminate empty paragraphs
152 virtual bool allowEmpty() const { return layout_->isKeepEmpty(); }
153 /// Force inset into LTR environment if surroundings are RTL?
154 virtual bool forceLTR() const { return layout_->isForceLtr(); }
156 virtual bool usePlainLayout() const { return true; }
157 /// Is this inset's layout defined in the document's textclass?
158 /// May be wrong after textclass change or paste from another document
159 bool undefined() const;
160 /// the string that is passed to the TOC
161 void tocString(odocstream &) const;
163 virtual docstring contextMenu(BufferView const & bv, int x, int y) const;
166 void doDispatch(Cursor & cur, FuncRequest & cmd);
168 void edit(Cursor & cur, bool front,
169 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
171 Inset * editXY(Cursor & cur, int x, int y);
173 docstring floatName(std::string const & type, BufferParams const &) const;
175 virtual void resetParagraphsFont();
177 mutable CollapseStatus status_;
179 /// cache for the layout_. Make sure it is in sync with the document class!
180 InsetLayout const * layout_;
182 Dimension dimensionCollapsed(BufferView const & bv) const;
184 /// should paragraphs be forced to use the empty layout?
185 virtual bool forcePlainLayout(idx_type = 0) const
186 { return getLayout().forcePlainLayout(); }
187 /// should the user be allowed to customize alignment, etc.?
188 virtual bool allowParagraphCustomization(idx_type = 0) const
189 { return getLayout().allowParagraphCustomization(); }
190 docstring labelstring_;
192 mutable Box button_dim;
193 /// a substatus of the Open status, determined automatically in metrics
194 mutable bool openinlined_;
195 /// the inset will automatically open when the cursor is inside. This is
196 /// dependent on the bufferview, compare with MathMacro::editing_.
197 mutable std::map<BufferView const *, bool> auto_open_;
198 /// changes color when mouse enters/leaves this inset