3 * \file math_hullinset.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 "math_gridinset.h"
16 #include <boost/scoped_ptr.hpp>
21 /// This provides an interface between "LyX insets" and "LyX math insets"
22 class MathHullInset : public MathGridInset {
27 explicit MathHullInset(std::string const & type);
31 MathHullInset & operator=(MathHullInset const &);
33 mode_type currentMode() const;
35 void metrics(MetricsInfo & mi, Dimension & dim) const;
37 void draw(PainterInfo &, int x, int y) const;
39 void metricsT(TextMetricsInfo const & mi, Dimension & dim) const;
41 void drawT(TextPainter &, int x, int y) const;
43 std::string label(row_type row) const;
45 void label(row_type row, std::string const & label);
47 void numbered(row_type row, bool num);
49 bool numbered(row_type row) const;
51 bool numberedType() const;
54 /// Appends \c list with all labels found within this inset.
55 void getLabelList(Buffer const &,
56 std::vector<std::string> & list) const;
58 void validate(LaTeXFeatures & features) const;
59 /// identifies HullInset
60 MathHullInset const * asHullInset() const { return this; }
61 /// identifies HullInset
62 MathHullInset * asHullInset() { return this; }
65 void addRow(row_type row);
67 void delRow(row_type row);
69 void swapRow(row_type row);
71 void addCol(col_type col);
73 void delCol(col_type col);
76 std::string const & getType() const;
78 void mutate(std::string const &);
81 int defaultColSpace(col_type col);
83 char defaultColAlign(col_type col);
85 bool idxFirst(LCursor &) const;
87 bool idxLast(LCursor &) const;
90 void write(WriteStream & os) const;
92 void mathmlize(MathMLStream &) const;
94 void normalize(NormalStream &) const;
96 void infoize(std::ostream & os) const;
99 void write(Buffer const &, std::ostream & os) const;
101 void read(Buffer const &, LyXLex & lex);
103 int plaintext(Buffer const &, std::ostream &,
104 OutputParams const &) const;
106 int linuxdoc(Buffer const &, std::ostream &,
107 OutputParams const &) const;
109 int docbook(Buffer const &, std::ostream &,
110 OutputParams const &) const;
111 /// the string that is passed to the TOC
112 virtual int textString(Buffer const &, std::ostream & os,
113 OutputParams const &) const;
115 /// get notification when the cursor leaves this inset
116 void notifyCursorLeaves(LCursor & cur);
118 //bool insetAllowed(Code code) const;
120 void addPreview(lyx::graphics::PreviewLoader &) const;
124 MathHullInset(MathHullInset const &);
126 virtual void doDispatch(LCursor & cur, FuncRequest & cmd);
128 /// do we want to handle this event?
129 bool getStatus(LCursor & cur, FuncRequest const & cmd,
130 FuncStatus & status) const;
132 std::string eolString(row_type row, bool emptyline, bool fragile) const;
135 virtual std::auto_ptr<InsetBase> doClone() const;
137 void setType(std::string const & type);
139 void validate1(LaTeXFeatures & features);
141 void header_write(WriteStream &) const;
143 void footer_write(WriteStream &) const;
145 std::string nicelabel(row_type row) const;
147 void doExtern(LCursor & cur, FuncRequest & func);
151 * split every row at the first relation operator.
152 * The number of columns must be 1. One column is added.
153 * The first relation operator and everything after it goes to the
158 * split every row at the first relation operator.
159 * The number of columns must be < 3. One or two columns are added.
160 * The first relation operator goes to the second column.
161 * Everything after it goes to the third column.
164 /// change number of columns, split or combine columns if necessary.
165 void changeCols(col_type);
167 char const * standardFont() const;
168 /// consistency check
170 /// can this change its number of rows?
171 bool rowChangeOK() const;
172 /// can this change its number of cols?
173 bool colChangeOK() const;
175 /// "none", "simple", "display", "eqnarray",...
178 std::vector<int> nonum_;
180 std::vector<std::string> label_;
182 boost::scoped_ptr<RenderPreview> preview_;
184 mutable bool use_preview_;
189 /// what appears in the minibuffer when opening
190 virtual std::string const editMessage() const;
192 virtual bool canTrackChanges() const { return true; }
194 virtual void mutateToText();
196 virtual void revealCodes(LCursor & cur) const;
198 EDITABLE editable() const { return HIGHLY_EDITABLE; }
200 void edit(LCursor & cur, bool left);
202 InsetBase * editXY(LCursor & cur, int x, int y);
204 bool display() const;
206 Code lyxCode() const;
210 void handleFont(LCursor & cur, std::string const & arg,
211 std::string const & font);
213 void handleFont2(LCursor & cur, std::string const & arg);
215 bool previewState(BufferView * bv) const;