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"
28 /** A collapsable text inset
31 class InsetCollapsable : public UpdatableInset {
34 static int const TEXT_TO_TOP_OFFSET = 2;
36 static int const TEXT_TO_BOTTOM_OFFSET = 2;
37 /// inset is initially collapsed if bool = true
38 InsetCollapsable(BufferParams const &, bool collapsed = false);
40 InsetCollapsable(InsetCollapsable const & in);
42 void read(Buffer const &, LyXLex &);
44 void write(Buffer const &, std::ostream &) const;
46 void metrics(MetricsInfo &, Dimension &) const;
48 void draw(PainterInfo & pi, int x, int y) const;
49 /// draw, either inlined (no button) or collapsed/open
50 void draw(PainterInfo & pi, int x, int y, bool inlined) const;
52 bool hitButton(FuncRequest const &) const;
54 EDITABLE editable() const;
55 /// can we go further down on mouse click?
56 bool descendable() const { return isOpen(); }
58 bool insertInset(BufferView *, InsetOld * inset);
60 bool insetAllowed(InsetOld::Code code) const;
62 bool isTextInset() const { return true; }
64 int latex(Buffer const &, std::ostream &,
65 OutputParams const &) const;
67 int plaintext(Buffer const &, std::ostream &,
68 OutputParams const &) const;
70 int linuxdoc(Buffer const &, std::ostream &,
71 OutputParams const &) const;
73 int docbook(Buffer const &, std::ostream &,
74 OutputParams const & runparams) const;
76 void validate(LaTeXFeatures & features) const;
77 /// get the screen x,y of the cursor
78 void getCursorPos(int & x, int & y) const;
80 void setLabel(std::string const & l) const;
82 void setLabelFont(LyXFont & f);
85 void setAutoCollapse(bool f);
87 /// Appends \c list with all labels found within this inset.
88 void getLabelList(Buffer const &, std::vector<std::string> & list) const;
90 int scroll(bool recursive=true) const;
92 void scroll(BufferView *bv, float sx) const;
94 void scroll(BufferView *bv, int offset) const;
96 ParagraphList * getParagraphs(int) const;
98 int numParagraphs() const;
100 LyXText * getText(int) const;
102 bool display() const { return isOpen(); }
112 void addPreview(lyx::graphics::PreviewLoader &) const;
118 priv_dispatch(FuncRequest const &, idx_type &, pos_type &);
120 void dimension_collapsed(Dimension &) const;
122 int height_collapsed() const;
124 void draw_collapsed(PainterInfo & pi, int x, int y) const;
126 int getMaxTextWidth(Painter & pain, UpdatableInset const *) const;
127 /// Should be non-const...
128 void setCollapsed(bool) const;
130 Box const & buttonDim() const;
132 void edit(BufferView *, bool);
134 void edit(BufferView *, int, int);
138 DispatchResult lfunMouseRelease(FuncRequest const &);
140 FuncRequest adjustCommand(FuncRequest const &);
144 mutable InsetText inset;
147 mutable bool collapsed_;
151 mutable Box button_dim;
155 mutable int topbaseline;
157 mutable std::string label;