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 "DocIterator.h"
18 #include "OutputEnums.h"
20 #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 {
34 /// How a line is numbered
36 /// not numbered, LaTeX code \\nonumber if line differs from inset
38 /// numbered, LaTeX code \\number if line differs from inset
40 /// not numbered, LaTeX code \\notag if line differs from inset
44 InsetMathHull(Buffer * buf);
46 InsetMathHull(Buffer * buf, HullType type);
48 virtual ~InsetMathHull();
50 void setBuffer(Buffer &);
52 void updateBuffer(ParIterator const &, UpdateType);
54 void addToToc(DocIterator const & di, bool output_active,
55 UpdateType utype) const;
57 InsetMathHull & operator=(InsetMathHull const &);
59 mode_type currentMode() const;
61 void metrics(MetricsInfo & mi, Dimension & dim) const;
63 void drawBackground(PainterInfo & pi, int x, int y) const;
65 void draw(PainterInfo &, int x, int y) const;
67 void metricsT(TextMetricsInfo const & mi, Dimension & dim) const;
69 void drawT(TextPainter &, int x, int y) const;
71 docstring label(row_type row) const;
73 void label(row_type row, docstring const & label);
75 std::vector<InsetLabel *> const & getLabels() { return label_; }
77 ColorCode backgroundColor(PainterInfo const &) const;
79 void numbered(row_type row, bool num) { numbered(row, num ? NUMBER : NONUMBER); }
81 void numbered(row_type row, Numbered num);
83 bool numbered(row_type row) const;
85 bool numberedType() const;
89 void validate(LaTeXFeatures & features) const;
90 /// identifies HullInset
91 InsetMathHull const * asHullInset() const { return this; }
92 /// identifies HullInset
93 InsetMathHull * asHullInset() { return this; }
96 void addRow(row_type row);
98 void delRow(row_type row);
100 void swapRow(row_type row);
102 void addCol(col_type col);
104 void delCol(col_type col);
107 HullType getType() const;
108 /// is mutation implemented for this type?
109 static bool isMutable(HullType type);
111 void mutate(HullType newtype);
114 int defaultColSpace(col_type col);
116 int displayColSpace(col_type col) const;
118 char defaultColAlign(col_type col);
120 char displayColAlign(idx_type idx) const;
122 bool idxFirst(Cursor &) const;
124 bool idxLast(Cursor &) const;
127 void write(WriteStream & os) const;
129 void normalize(NormalStream &) const;
131 void infoize(odocstream & os) const;
134 void write(std::ostream & os) const;
136 void header_write(WriteStream &) const;
138 void footer_write(WriteStream &) const;
140 void read(Lexer & lex);
142 bool readQuiet(Lexer & lex);
144 int plaintext(odocstringstream &, OutputParams const &,
145 size_t max_length = INT_MAX) const;
147 int docbook(odocstream &, OutputParams const &) const;
149 docstring xhtml(XHTMLStream &, OutputParams const &) const;
151 void mathmlize(MathStream &) const;
153 void htmlize(HtmlStream &) const;
155 void mathAsLatex(WriteStream &) const;
157 void toString(odocstream &) const;
159 void forOutliner(docstring &, size_t const, bool const) const;
161 /// get notification when the cursor leaves this inset
162 bool notifyCursorLeaves(Cursor const & old, Cursor & cur);
164 //bool insetAllowed(InsetCode code) const;
166 void addPreview(DocIterator const & inset_pos,
167 graphics::PreviewLoader &) const;
168 /// Recreates the preview if preview is enabled.
169 void reloadPreview(DocIterator const & pos) const;
171 void usedMacros(MathData const & md, DocIterator const & pos,
172 MacroNameSet & macros, MacroNameSet & defs) const;
174 void initUnicodeMath() const;
177 static int displayMargin() { return 12; }
179 /// Force inset into LTR environment if surroundings are RTL
180 virtual bool forceLTR() const { return true; }
182 void recordLocation(DocIterator const & di);
185 std::string contextMenuName() const;
187 InsetCode lyxCode() const { return MATH_HULL_CODE; }
190 InsetMathHull(InsetMathHull const &);
192 virtual void doDispatch(Cursor & cur, FuncRequest & cmd);
194 /// do we want to handle this event?
195 bool getStatus(Cursor & cur, FuncRequest const & cmd,
196 FuncStatus & status) const;
198 docstring eolString(row_type row, bool fragile, bool latex,
199 bool last_eoln) const;
202 virtual Inset * clone() const;
203 /// Prepare the preview if preview is enabled.
204 /// \param forexport: whether this is intended for export
205 /// If so, we ignore LyXRC and wait for the image to be generated.
206 void preparePreview(DocIterator const & pos,
207 bool forexport = false) const;
208 /// like reloadPreview, but forces load
209 /// used by image export
210 void loadPreview(DocIterator const & pos) const;
212 void setType(HullType type);
214 void validate1(LaTeXFeatures & features);
216 docstring nicelabel(row_type row) const;
218 void doExtern(Cursor & cur, FuncRequest & func);
220 void glueall(HullType type);
222 * split every row at the first relation operator.
223 * The number of columns must be 1. One column is added.
224 * The first relation operator and everything after it goes to the
229 * split every row at the first relation operator.
230 * The number of columns must be < 3. One or two columns are added.
231 * The first relation operator goes to the second column.
232 * Everything after it goes to the third column.
235 /// change number of columns, split or combine columns if necessary.
236 void changeCols(col_type);
238 docstring standardFont() const;
240 ColorCode standardColor() const;
241 /// consistency check
243 /// does it understand tabular-feature commands?
244 bool allowsTabularFeatures() const;
245 /// can this change its number of rows?
246 bool rowChangeOK() const;
247 /// can this change its number of cols?
248 bool colChangeOK() const;
249 /// are any of the equations numbered?
250 bool haveNumbers() const;
252 /// "none", "simple", "display", "eqnarray",...
255 std::vector<Numbered> numbered_;
257 std::vector<docstring> numbers_;
259 std::vector<InsetLabel *> label_;
261 boost::scoped_ptr<RenderPreview> preview_;
265 typedef std::map<docstring, int> CounterMap;
266 /// used to store current values of important counters
267 CounterMap counter_map;
273 virtual void mutateToText();
275 virtual void revealCodes(Cursor & cur) const;
277 bool editable() const { return true; }
279 void edit(Cursor & cur, bool front,
280 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
282 Inset * editXY(Cursor & cur, int x, int y);
284 DisplayType display() const;
288 void handleFont(Cursor & cur, docstring const & arg,
289 docstring const & font);
291 void handleFont2(Cursor & cur, docstring const & arg);
293 bool previewState(BufferView const * const bv) const;
295 bool previewTooSmall(Dimension const & dim) const;