3 * \file InsetMathHull.h
4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
9 * Full author contact details are available in file CREDITS.
12 #ifndef MATH_HULLINSET_H
13 #define MATH_HULLINSET_H
15 #include "InsetMathGrid.h"
17 #include <boost/scoped_ptr.hpp>
23 class ParConstIterator;
27 /// This provides an interface between "LyX insets" and "LyX math insets"
28 class InsetMathHull : public InsetMathGrid {
33 explicit InsetMathHull(HullType type);
37 void setBuffer(Buffer &);
39 void updateLabels(ParIterator const &);
41 void addToToc(ParConstIterator const &) const;
43 InsetMathHull & operator=(InsetMathHull const &);
45 mode_type currentMode() const;
47 void metrics(MetricsInfo & mi, Dimension & dim) const;
49 void draw(PainterInfo &, int x, int y) const;
51 void metricsT(TextMetricsInfo const & mi, Dimension & dim) const;
53 void drawT(TextPainter &, int x, int y) const;
55 docstring label(row_type row) const;
57 void label(row_type row, docstring const & label);
59 void numbered(row_type row, bool num);
61 bool numbered(row_type row) const;
63 bool numberedType() const;
67 void validate(LaTeXFeatures & features) const;
68 /// identifies HullInset
69 InsetMathHull const * asHullInset() const { return this; }
70 /// identifies HullInset
71 InsetMathHull * asHullInset() { return this; }
74 void addRow(row_type row);
76 void delRow(row_type row);
78 void swapRow(row_type row);
80 void addCol(col_type col);
82 void delCol(col_type col);
85 HullType getType() const;
87 void mutate(HullType newtype);
90 int defaultColSpace(col_type col);
92 char defaultColAlign(col_type col);
94 bool idxFirst(Cursor &) const;
96 bool idxLast(Cursor &) const;
99 void write(WriteStream & os) const;
101 void mathmlize(MathStream &) const;
103 void normalize(NormalStream &) const;
105 void infoize(odocstream & os) const;
108 void write(std::ostream & os) const;
110 void read(Lexer & lex);
112 int plaintext(odocstream &, OutputParams const &) const;
114 int docbook(odocstream &, OutputParams const &) const;
115 /// the string that is passed to the TOC
116 void textString(odocstream &) const;
118 /// get notification when the cursor leaves this inset
119 bool notifyCursorLeaves(Cursor const & old, Cursor & cur);
121 //bool insetAllowed(InsetCode code) const;
123 void addPreview(graphics::PreviewLoader &) const;
126 static int displayMargin() { return 12; }
128 /// Force inset into LTR environment if surroundings are RTL?
129 virtual bool forceLTR() const { return true; }
132 virtual docstring contextMenu(BufferView const &, int, int) const;
135 InsetMathHull(InsetMathHull const &);
137 virtual void doDispatch(Cursor & cur, FuncRequest & cmd);
139 /// do we want to handle this event?
140 bool getStatus(Cursor & cur, FuncRequest const & cmd,
141 FuncStatus & status) const;
143 docstring eolString(row_type row, bool emptyline, bool fragile) const;
146 virtual Inset * clone() const;
148 void setType(HullType type);
150 void validate1(LaTeXFeatures & features);
152 void header_write(WriteStream &) const;
154 void footer_write(WriteStream &) const;
156 docstring nicelabel(row_type row) const;
158 void doExtern(Cursor & cur, FuncRequest & func);
162 * split every row at the first relation operator.
163 * The number of columns must be 1. One column is added.
164 * The first relation operator and everything after it goes to the
169 * split every row at the first relation operator.
170 * The number of columns must be < 3. One or two columns are added.
171 * The first relation operator goes to the second column.
172 * Everything after it goes to the third column.
175 /// change number of columns, split or combine columns if necessary.
176 void changeCols(col_type);
178 docstring standardFont() const;
179 /// consistency check
181 /// can this change its number of rows?
182 bool rowChangeOK() const;
183 /// can this change its number of cols?
184 bool colChangeOK() const;
186 /// "none", "simple", "display", "eqnarray",...
189 std::vector<bool> nonum_;
191 std::vector<InsetLabel *> label_;
193 boost::scoped_ptr<RenderPreview> preview_;
195 mutable bool use_preview_;
200 /// what appears in the minibuffer when opening
201 docstring editMessage() const;
203 virtual void mutateToText();
205 virtual void revealCodes(Cursor & cur) const;
207 EDITABLE editable() const { return HIGHLY_EDITABLE; }
209 void edit(Cursor & cur, bool front,
210 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
212 Inset * editXY(Cursor & cur, int x, int y);
214 DisplayType display() const;
216 InsetCode lyxCode() const;
220 void handleFont(Cursor & cur, docstring const & arg,
221 docstring const & font);
223 void handleFont2(Cursor & cur, docstring const & arg);
225 bool previewState(BufferView * bv) const;