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"
18 #include "DocIterator.h"
19 #include "OutputEnums.h"
21 #include <boost/scoped_ptr.hpp>
27 class ParConstIterator;
31 /// This provides an interface between "LyX insets" and "LyX math insets"
32 class InsetMathHull : public InsetMathGrid {
35 InsetMathHull(Buffer * buf);
37 InsetMathHull(Buffer * buf, HullType type);
39 virtual ~InsetMathHull();
41 void setBuffer(Buffer &);
43 void updateBuffer(ParIterator const &, UpdateType);
45 void addToToc(DocIterator const &);
47 InsetMathHull & operator=(InsetMathHull const &);
49 mode_type currentMode() const;
51 void metrics(MetricsInfo & mi, Dimension & dim) const;
53 void drawBackground(PainterInfo & pi, int x, int y) const;
55 void draw(PainterInfo &, int x, int y) const;
57 void metricsT(TextMetricsInfo const & mi, Dimension & dim) const;
59 void drawT(TextPainter &, int x, int y) const;
61 docstring label(row_type row) const;
63 void label(row_type row, docstring const & label);
65 std::vector<InsetLabel *> const & getLabels() { return label_; }
67 ColorCode backgroundColor(PainterInfo const &) const;
69 void numbered(row_type row, bool num);
71 bool numbered(row_type row) const;
73 bool numberedType() const;
77 void validate(LaTeXFeatures & features) const;
78 /// identifies HullInset
79 InsetMathHull const * asHullInset() const { return this; }
80 /// identifies HullInset
81 InsetMathHull * asHullInset() { return this; }
84 void addRow(row_type row);
86 void delRow(row_type row);
88 void swapRow(row_type row);
90 void addCol(col_type col);
92 void delCol(col_type col);
95 HullType getType() const;
97 void mutate(HullType newtype);
100 int defaultColSpace(col_type col);
102 char defaultColAlign(col_type col);
104 bool idxFirst(Cursor &) const;
106 bool idxLast(Cursor &) const;
109 void write(WriteStream & os) const;
111 void normalize(NormalStream &) const;
113 void infoize(odocstream & os) const;
116 void write(std::ostream & os) const;
118 void header_write(WriteStream &) const;
120 void footer_write(WriteStream &) const;
122 void read(Lexer & lex);
124 bool readQuiet(Lexer & lex);
126 int plaintext(odocstream &, OutputParams const &) const;
128 int docbook(odocstream &, OutputParams const &) const;
130 docstring xhtml(XHTMLStream &, OutputParams const &) const;
132 void mathmlize(MathStream &) const;
134 void htmlize(HtmlStream &) const;
136 void toString(odocstream &) const;
138 void forToc(docstring &, size_t) const;
140 /// get notification when the cursor leaves this inset
141 bool notifyCursorLeaves(Cursor const & old, Cursor & cur);
143 //bool insetAllowed(InsetCode code) const;
145 void addPreview(DocIterator const & inset_pos,
146 graphics::PreviewLoader &) const;
147 /// Recreates the preview if preview is enabled.
148 void reloadPreview(DocIterator const & pos) const;
150 void initUnicodeMath() const;
153 static int displayMargin() { return 12; }
155 /// Force inset into LTR environment if surroundings are RTL
156 virtual bool forceLTR() const { return true; }
158 void recordLocation(DocIterator const & di);
161 docstring contextMenuName() const;
163 InsetCode lyxCode() const { return MATH_HULL_CODE; }
166 InsetMathHull(InsetMathHull const &);
168 virtual void doDispatch(Cursor & cur, FuncRequest & cmd);
170 /// do we want to handle this event?
171 bool getStatus(Cursor & cur, FuncRequest const & cmd,
172 FuncStatus & status) const;
174 docstring eolString(row_type row, bool fragile, bool latex,
175 bool last_eoln) const;
178 virtual Inset * clone() const;
179 /// Prepare the preview if preview is enabled.
180 /// \param forexport: whether this is intended for export
181 /// If so, we ignore LyXRC and wait for the image to be generated.
182 void preparePreview(DocIterator const & pos,
183 bool forexport = false) const;
184 /// like reloadPreview, but forces load
185 /// used by image export
186 void loadPreview(DocIterator const & pos) const;
188 void setType(HullType type);
190 void validate1(LaTeXFeatures & features);
192 docstring nicelabel(row_type row) const;
194 void doExtern(Cursor & cur, FuncRequest & func);
196 void glueall(HullType type);
198 * split every row at the first relation operator.
199 * The number of columns must be 1. One column is added.
200 * The first relation operator and everything after it goes to the
205 * split every row at the first relation operator.
206 * The number of columns must be < 3. One or two columns are added.
207 * The first relation operator goes to the second column.
208 * Everything after it goes to the third column.
211 /// change number of columns, split or combine columns if necessary.
212 void changeCols(col_type);
214 docstring standardFont() const;
216 ColorCode standardColor() const;
217 /// consistency check
219 /// can this change its number of rows?
220 bool rowChangeOK() const;
221 /// can this change its number of cols?
222 bool colChangeOK() const;
224 /// "none", "simple", "display", "eqnarray",...
227 std::vector<bool> numbered_;
229 std::vector<docstring> numbers_;
231 std::vector<InsetLabel *> label_;
233 boost::scoped_ptr<RenderPreview> preview_;
235 mutable bool use_preview_;
243 virtual void mutateToText();
245 virtual void revealCodes(Cursor & cur) const;
247 bool editable() const { return true; }
249 void edit(Cursor & cur, bool front,
250 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
252 Inset * editXY(Cursor & cur, int x, int y);
254 DisplayType display() const;
258 void handleFont(Cursor & cur, docstring const & arg,
259 docstring const & font);
261 void handleFont2(Cursor & cur, docstring const & arg);
263 bool previewState(BufferView * bv) const;