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 "support/unique_ptr.h"
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 explicit InsetMathHull(Buffer * buf);
46 InsetMathHull(Buffer * buf, HullType type);
48 virtual ~InsetMathHull();
50 void setBuffer(Buffer &);
52 void updateBuffer(ParIterator const &, UpdateType, bool const deleted = false);
54 void addToToc(DocIterator const & di, bool output_active,
55 UpdateType utype, TocBackend & backend) 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 bool outerDisplay() const;
91 OutputParams::CtObject CtObject(OutputParams const &) const;
93 void validate(LaTeXFeatures & features) const;
94 /// identifies HullInset
95 InsetMathHull const * asHullInset() const { return this; }
96 /// identifies HullInset
97 InsetMathHull * asHullInset() { return this; }
100 void addRow(row_type row);
102 void delRow(row_type row);
104 void swapRow(row_type row);
106 void addCol(col_type col);
108 void delCol(col_type col);
111 HullType getType() const;
112 /// is mutation implemented for this type?
113 static bool isMutable(HullType type);
115 void mutate(HullType newtype);
118 int defaultColSpace(col_type col);
120 int displayColSpace(col_type col) const;
122 char defaultColAlign(col_type col);
124 char displayColAlign(idx_type idx) 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;
176 /// Force inset into LTR environment if surroundings are RTL
177 virtual bool forceLTR(OutputParams const &) const { return true; }
179 void recordLocation(DocIterator const & di);
182 std::string contextMenuName() const;
184 InsetCode lyxCode() const { return MATH_HULL_CODE; }
186 bool canPaintChange(BufferView const &) const;
188 bool confirmDeletion() const { return nargs() != 1 || !cell(0).empty(); }
191 InsetMathHull(InsetMathHull const &);
193 virtual void doDispatch(Cursor & cur, FuncRequest & cmd);
195 /// do we want to handle this event?
196 bool getStatus(Cursor & cur, FuncRequest const & cmd,
197 FuncStatus & status) const;
198 /// override to set to 0 for inline equation
199 int leftMargin() const;
200 /// override to set to 0 for inline equation
201 int rightMargin() const;
202 /// override to set to 0 for inline equation
205 docstring eolString(row_type row, bool fragile, bool latex,
206 bool last_eoln) const;
209 virtual Inset * clone() const;
210 /// Prepare the preview if preview is enabled.
211 /// \param forexport: whether this is intended for export
212 /// If so, we ignore LyXRC and wait for the image to be generated.
213 void preparePreview(DocIterator const & pos,
214 bool forexport = false) const;
215 /// like reloadPreview, but forces load
216 /// used by image export
217 void loadPreview(DocIterator const & pos) const;
219 void setType(HullType type);
221 void validate1(LaTeXFeatures & features);
223 docstring nicelabel(row_type row) const;
225 void doExtern(Cursor & cur, FuncRequest & func);
227 void glueall(HullType type);
229 * split every row at the first relation operator.
230 * The number of columns must be 1. One column is added.
231 * The first relation operator and everything after it goes to the
236 * split every row at the first relation operator.
237 * The number of columns must be < 3. One or two columns are added.
238 * The first relation operator goes to the second column.
239 * Everything after it goes to the third column.
242 /// change number of columns, split or combine columns if necessary.
243 void changeCols(col_type);
245 std::string standardFont() const;
247 ColorCode standardColor() const;
248 /// consistency check
250 /// does it understand tabular-feature commands?
251 bool allowsTabularFeatures() const;
252 /// can this change its number of rows?
253 bool rowChangeOK() const;
254 /// can this change its number of cols?
255 bool colChangeOK() const;
256 /// are any of the equations numbered?
257 bool haveNumbers() const;
258 /// draw four angular markers
259 virtual void drawMarkers(PainterInfo & pi, int x, int y) const;
261 /// "none", "simple", "display", "eqnarray",...
264 std::vector<Numbered> numbered_;
266 std::vector<docstring> numbers_;
268 std::vector<InsetLabel *> label_;
270 unique_ptr<RenderPreview> preview_;
274 typedef std::map<docstring, int> CounterMap;
275 /// used to store current values of important counters
276 CounterMap counter_map;
282 virtual void mutateToText();
284 bool editable() const { return true; }
286 void edit(Cursor & cur, bool front,
287 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
289 Inset * editXY(Cursor & cur, int x, int y);
291 DisplayType display() const;
293 int indent(BufferView const &) const;
297 void handleFont(Cursor & cur, docstring const & arg,
298 docstring const & font);
300 void handleFont2(Cursor & cur, docstring const & arg);
302 bool previewState(BufferView const * const bv) const;