src/mathed/InsetMathHull.h

   1 // -*- C++ -*-
   2 /**
   3  * \file InsetMathHull.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author André Pönitz
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef MATH_HULLINSET_H
  13 #define MATH_HULLINSET_H
  14
  15 #include "InsetMathGrid.h"
  16
  17 #include <boost/scoped_ptr.hpp>
  18
  19
  20 namespace lyx {
  21
  22 class InsetLabel;
  23 class ParConstIterator;
  24 class RenderPreview;
  25
  26
  27 /// This provides an interface between "LyX insets" and "LyX math insets"
  28 class InsetMathHull : public InsetMathGrid {
  29 public:
  30         ///
  31         InsetMathHull();
  32         ///
  33         explicit InsetMathHull(HullType type);
  34         ///
  35         ~InsetMathHull();
  36         ///
  37         void setBuffer(Buffer &);
  38         ///
  39         void updateLabels(ParIterator const &);
  40         ///
  41         void addToToc(DocIterator const &);
  42         ///
  43         InsetMathHull & operator=(InsetMathHull const &);
  44         ///
  45         mode_type currentMode() const;
  46         ///
  47         void metrics(MetricsInfo & mi, Dimension & dim) const;
  48         ///
  49         void drawBackground(PainterInfo & pi, int x, int y) const;
  50         ///
  51         void draw(PainterInfo &, int x, int y) const;
  52         ///
  53         void metricsT(TextMetricsInfo const & mi, Dimension & dim) const;
  54         ///
  55         void drawT(TextPainter &, int x, int y) const;
  56         ///
  57         docstring label(row_type row) const;
  58         ///
  59         void label(row_type row, docstring const & label);
  60         ///
  61         ColorCode backgroundColor() const { return Color_mathbg; }
  62         ///
  63         void numbered(row_type row, bool num);
  64         ///
  65         bool numbered(row_type row) const;
  66         ///
  67         bool numberedType() const;
  68         ///
  69         bool ams() const;
  70         ///
  71         void validate(LaTeXFeatures & features) const;
  72         /// identifies HullInset
  73         InsetMathHull const * asHullInset() const { return this; }
  74         /// identifies HullInset
  75         InsetMathHull * asHullInset() { return this; }
  76
  77         /// add a row
  78         void addRow(row_type row);
  79         /// delete a row
  80         void delRow(row_type row);
  81         /// swap two rows
  82         void swapRow(row_type row);
  83         /// add a column
  84         void addCol(col_type col);
  85         /// delete a column
  86         void delCol(col_type col);
  87
  88         /// get type
  89         HullType getType() const;
  90         /// change type
  91         void mutate(HullType newtype);
  92
  93         ///
  94         int defaultColSpace(col_type col);
  95         ///
  96         char defaultColAlign(col_type col);
  97         ///
  98         bool idxFirst(Cursor &) const;
  99         ///
 100         bool idxLast(Cursor &) const;
 101
 102         ///
 103         void write(WriteStream & os) const;
 104         ///
 105         void mathmlize(MathStream &) const;
 106         ///
 107         void normalize(NormalStream &) const;
 108         ///
 109         void infoize(odocstream & os) const;
 110
 111         ///
 112         void write(std::ostream & os) const;
 113         ///
 114         void header_write(WriteStream &) const;
 115         ///
 116         void footer_write(WriteStream &) const;
 117         ///
 118         void read(Lexer & lex);
 119         ///
 120         bool readQuiet(Lexer & lex);
 121         ///
 122         int plaintext(odocstream &, OutputParams const &) const;
 123         ///
 124         int docbook(odocstream &, OutputParams const &) const;
 125         /// the string that is passed to the TOC
 126         void textString(odocstream &) const;
 127
 128         /// get notification when the cursor leaves this inset
 129         bool notifyCursorLeaves(Cursor const & old, Cursor & cur);
 130         ///
 131         //bool insetAllowed(InsetCode code) const;
 132         ///
 133         void addPreview(graphics::PreviewLoader &) const;
 134         ///
 135         void initUnicodeMath() const;
 136
 137         ///
 138         static int displayMargin() { return 12; }
 139
 140         /// Force inset into LTR environment if surroundings are RTL?
 141         virtual bool forceLTR() const { return true; }
 142
 143         ///
 144         virtual docstring contextMenu(BufferView const &, int, int) const;
 145
 146 protected:
 147         InsetMathHull(InsetMathHull const &);
 148
 149         virtual void doDispatch(Cursor & cur, FuncRequest & cmd);
 150
 151         /// do we want to handle this event?
 152         bool getStatus(Cursor & cur, FuncRequest const & cmd,
 153                 FuncStatus & status) const;
 154         ///
 155         docstring eolString(row_type row, bool emptyline, bool fragile) const;
 156
 157 private:
 158         virtual Inset * clone() const;
 159         ///
 160         void setType(HullType type);
 161         ///
 162         void validate1(LaTeXFeatures & features);
 163         ///
 164         docstring nicelabel(row_type row) const;
 165         ///
 166         void doExtern(Cursor & cur, FuncRequest & func);
 167         ///
 168         void glueall();
 169         /*!
 170          * split every row at the first relation operator.
 171          * The number of columns must be 1. One column is added.
 172          * The first relation operator and everything after it goes to the
 173          * second column.
 174          */
 175         void splitTo2Cols();
 176         /*!
 177          * split every row at the first relation operator.
 178          * The number of columns must be < 3. One or two columns are added.
 179          * The first relation operator goes to the second column.
 180          * Everything after it goes to the third column.
 181          */
 182         void splitTo3Cols();
 183         /// change number of columns, split or combine columns if necessary.
 184         void changeCols(col_type);
 185         ///
 186         docstring standardFont() const;
 187         /// consistency check
 188         void check() const;
 189         /// can this change its number of rows?
 190         bool rowChangeOK() const;
 191         /// can this change its number of cols?
 192         bool colChangeOK() const;
 193
 194         /// "none", "simple", "display", "eqnarray",...
 195         HullType type_;
 196         ///
 197         std::vector<bool> nonum_;
 198         ///
 199         std::vector<InsetLabel *> label_;
 200         ///
 201         boost::scoped_ptr<RenderPreview> preview_;
 202         ///
 203         mutable bool use_preview_;
 204 //
 205 // Incorporate me
 206 //
 207 public:
 208         /// what appears in the minibuffer when opening
 209         docstring editMessage() const;
 210         ///
 211         virtual void mutateToText();
 212         ///
 213         virtual void revealCodes(Cursor & cur) const;
 214         ///
 215         EDITABLE editable() const { return HIGHLY_EDITABLE; }
 216         ///
 217         void edit(Cursor & cur, bool front,
 218                 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
 219         ///
 220         Inset * editXY(Cursor & cur, int x, int y);
 221         ///
 222         DisplayType display() const;
 223         ///
 224         InsetCode lyxCode() const;
 225
 226 protected:
 227         ///
 228         void handleFont(Cursor & cur, docstring const & arg,
 229                 docstring const & font);
 230         ///
 231         void handleFont2(Cursor & cur, docstring const & arg);
 232         ///
 233         bool previewState(BufferView * bv) const;
 234 };
 235
 236
 237
 238 } // namespace lyx
 239 #endif