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 {
35 /// By default, InsetCollapsable uses the plain layout. If you
36 /// want to override this in a subclass, you'll need to call
37 /// Paragraph::setDefaultLayout() in its constructor. See
38 /// InsetBranch for an example.
39 InsetCollapsable(Buffer const &);
41 InsetCollapsable(InsetCollapsable const & rhs);
43 InsetCollapsable * asInsetCollapsable() { return this; }
45 InsetCollapsable const * asInsetCollapsable() const { return this; }
47 docstring toolTip(BufferView const & bv, int x, int y) const;
49 docstring name() const { return from_ascii("Collapsable"); }
51 InsetLayout const & getLayout(BufferParams const &) const { return *layout_; }
53 InsetLayout const & getLayout() const { return *layout_; }
55 void setLayout(BufferParams const &);
56 /// (Re-)set the character style parameters from \p tc according
58 void setLayout(DocumentClass const * const tc);
60 virtual bool usePlainLayout() { return true; }
64 void write(std::ostream &) const;
66 void metrics(MetricsInfo &, Dimension &) const;
68 void draw(PainterInfo & pi, int x, int y) const;
70 /// return x,y of given position relative to the inset's baseline
71 void cursorPos(BufferView const & bv, CursorSlice const & sl,
72 bool boundary, int & x, int & y) const;
73 /// Returns true if (mouse) action is over the inset's button.
74 /// Always returns false when the inset does not have a
76 bool hitButton(FuncRequest const &) const;
78 docstring const getNewLabel(docstring const & l) const;
80 EDITABLE editable(BufferView const & bv) const;
81 /// can we go further down on mouse click?
82 bool descendable(BufferView const & bv) const;
84 void setLabel(docstring const & l);
86 virtual void setButtonLabel() {}
88 virtual docstring const buttonLabel(BufferView const &) const
89 { return labelstring_; }
91 bool isOpen(BufferView const & bv) const
92 { return geometry(bv) != ButtonOnly; }
94 CollapseStatus status(BufferView const & bv) const;
95 /** Of the old CollapseStatus we only keep the values
97 * We define a list of possible inset decoration
98 * styles, and a list of possible (concrete, visual)
99 * inset geometries. Relationships between them
100 * (geometries in body of table):
103 * Decoration: \ Open Collapsed
104 * -------------+-------------------------------
105 * Classic | *) TopButton, <--x) ButtonOnly
107 * Minimalistic | NoButton ButtonOnly
108 * Conglomerate | SubLabel Corners
109 * ---------------------------------------------
110 * *) toggled by openinlined_
111 * x) toggled by autoOpen_
115 virtual InsetLayout::InsetDecoration decoration() const;
125 /// Returns the geometry based on CollapseStatus
126 /// (status_), autoOpen_ and openinlined_, and of
127 /// course decoration().
128 Geometry geometry(BufferView const & bv) const;
129 /// Allow spellchecking, except for insets with latex_language
130 bool allowSpellCheck() const { return !forceLTR(); }
132 bool allowMultiPar() const;
134 bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
136 void setStatus(Cursor & cur, CollapseStatus st);
138 bool setMouseHover(bool mouse_hover);
140 ColorCode backgroundColor() const { return layout_->bgcolor(); }
142 int latex(odocstream &, OutputParams const &) const;
144 int docbook(odocstream &, OutputParams const &) const;
146 void validate(LaTeXFeatures &) const;
148 InsetCode lyxCode() const { return COLLAPSABLE_CODE; }
150 /// Allow multiple blanks
151 virtual bool isFreeSpacing() const { return layout_->isFreeSpacing(); }
152 /// Don't eliminate empty paragraphs
153 virtual bool allowEmpty() const { return layout_->isKeepEmpty(); }
154 /// Force inset into LTR environment if surroundings are RTL?
155 virtual bool forceLTR() const { return layout_->isForceLtr(); }
157 virtual bool usePlainLayout() const { return true; }
158 /// Is this inset's layout defined in the document's textclass?
159 /// May be wrong after textclass change or paste from another document
160 bool undefined() const;
161 /// the string that is passed to the TOC
162 void tocString(odocstream &) const;
164 virtual docstring contextMenu(BufferView const & bv, int x, int y) const;
167 void doDispatch(Cursor & cur, FuncRequest & cmd);
169 void edit(Cursor & cur, bool front,
170 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
172 Inset * editXY(Cursor & cur, int x, int y);
174 docstring floatName(std::string const & type, BufferParams const &) const;
176 virtual void resetParagraphsFont();
178 mutable CollapseStatus status_;
180 /// cache for the layout_. Make sure it is in sync with the document class!
181 InsetLayout const * layout_;
183 Dimension dimensionCollapsed(BufferView const & bv) const;
185 /// should paragraphs be forced to use the empty layout?
186 virtual bool forcePlainLayout(idx_type = 0) const
187 { return getLayout().forcePlainLayout(); }
188 /// should the user be allowed to customize alignment, etc.?
189 virtual bool allowParagraphCustomization(idx_type = 0) const
190 { return getLayout().allowParagraphCustomization(); }
191 docstring labelstring_;
193 mutable Box button_dim;
194 /// a substatus of the Open status, determined automatically in metrics
195 mutable bool openinlined_;
196 /// the inset will automatically open when the cursor is inside. This is
197 /// dependent on the bufferview, compare with MathMacro::editing_.
198 mutable std::map<BufferView const *, bool> auto_open_;
199 /// changes color when mouse enters/leaves this inset