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 & di, bool output_active) 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);
105 char displayColAlign(col_type col, row_type row) const;
107 bool idxFirst(Cursor &) const;
109 bool idxLast(Cursor &) const;
112 void write(WriteStream & os) const;
114 void normalize(NormalStream &) const;
116 void infoize(odocstream & os) const;
119 void write(std::ostream & os) const;
121 void header_write(WriteStream &) const;
123 void footer_write(WriteStream &) const;
125 void read(Lexer & lex);
127 bool readQuiet(Lexer & lex);
129 int plaintext(odocstringstream &, OutputParams const &,
130 size_t max_length = INT_MAX) const;
132 int docbook(odocstream &, OutputParams const &) const;
134 docstring xhtml(XHTMLStream &, OutputParams const &) const;
136 void mathmlize(MathStream &) const;
138 void htmlize(HtmlStream &) const;
140 void mathAsLatex(WriteStream &) const;
142 void toString(odocstream &) const;
144 void forToc(docstring &, size_t) const;
146 /// get notification when the cursor leaves this inset
147 bool notifyCursorLeaves(Cursor const & old, Cursor & cur);
149 //bool insetAllowed(InsetCode code) const;
151 void addPreview(DocIterator const & inset_pos,
152 graphics::PreviewLoader &) const;
153 /// Recreates the preview if preview is enabled.
154 void reloadPreview(DocIterator const & pos) const;
156 void initUnicodeMath() const;
159 static int displayMargin() { return 12; }
161 /// Force inset into LTR environment if surroundings are RTL
162 virtual bool forceLTR() const { return true; }
164 void recordLocation(DocIterator const & di);
167 std::string contextMenuName() const;
169 InsetCode lyxCode() const { return MATH_HULL_CODE; }
172 InsetMathHull(InsetMathHull const &);
174 virtual void doDispatch(Cursor & cur, FuncRequest & cmd);
176 /// do we want to handle this event?
177 bool getStatus(Cursor & cur, FuncRequest const & cmd,
178 FuncStatus & status) const;
180 docstring eolString(row_type row, bool fragile, bool latex,
181 bool last_eoln) const;
184 virtual Inset * clone() const;
185 /// Prepare the preview if preview is enabled.
186 /// \param forexport: whether this is intended for export
187 /// If so, we ignore LyXRC and wait for the image to be generated.
188 void preparePreview(DocIterator const & pos,
189 bool forexport = false) const;
190 /// like reloadPreview, but forces load
191 /// used by image export
192 void loadPreview(DocIterator const & pos) const;
194 void setType(HullType type);
196 void validate1(LaTeXFeatures & features);
198 docstring nicelabel(row_type row) const;
200 void doExtern(Cursor & cur, FuncRequest & func);
202 void glueall(HullType type);
204 * split every row at the first relation operator.
205 * The number of columns must be 1. One column is added.
206 * The first relation operator and everything after it goes to the
211 * split every row at the first relation operator.
212 * The number of columns must be < 3. One or two columns are added.
213 * The first relation operator goes to the second column.
214 * Everything after it goes to the third column.
217 /// change number of columns, split or combine columns if necessary.
218 void changeCols(col_type);
220 docstring standardFont() const;
222 ColorCode standardColor() const;
223 /// consistency check
225 /// can this change its number of rows?
226 bool rowChangeOK() const;
227 /// can this change its number of cols?
228 bool colChangeOK() const;
229 /// are any of the equations numbered?
230 bool haveNumbers() const;
232 /// "none", "simple", "display", "eqnarray",...
235 std::vector<bool> numbered_;
237 std::vector<docstring> numbers_;
239 std::vector<InsetLabel *> label_;
241 boost::scoped_ptr<RenderPreview> preview_;
243 mutable bool use_preview_;
247 typedef std::map<docstring, int> CounterMap;
248 /// used to store current values of important counters
249 CounterMap counter_map;
255 virtual void mutateToText();
257 virtual void revealCodes(Cursor & cur) const;
259 bool editable() const { return true; }
261 void edit(Cursor & cur, bool front,
262 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
264 Inset * editXY(Cursor & cur, int x, int y);
266 DisplayType display() const;
270 void handleFont(Cursor & cur, docstring const & arg,
271 docstring const & font);
273 void handleFont2(Cursor & cur, docstring const & arg);
275 bool previewState(BufferView * bv) const;