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 draw(PainterInfo &, int x, int y) const;
  50         ///
  51         void metricsT(TextMetricsInfo const & mi, Dimension & dim) const;
  52         ///
  53         void drawT(TextPainter &, int x, int y) const;
  54         ///
  55         docstring label(row_type row) const;
  56         ///
  57         void label(row_type row, docstring const & label);
  58         ///
  59         void numbered(row_type row, bool num);
  60         ///
  61         bool numbered(row_type row) const;
  62         ///
  63         bool numberedType() const;
  64         ///
  65         bool ams() const;
  66         ///
  67         void validate(LaTeXFeatures & features) const;
  68         /// identifies HullInset
  69         InsetMathHull const * asHullInset() const { return this; }
  70         /// identifies HullInset
  71         InsetMathHull * asHullInset() { return this; }
  72
  73         /// add a row
  74         void addRow(row_type row);
  75         /// delete a row
  76         void delRow(row_type row);
  77         /// swap two rows
  78         void swapRow(row_type row);
  79         /// add a column
  80         void addCol(col_type col);
  81         /// delete a column
  82         void delCol(col_type col);
  83
  84         /// get type
  85         HullType getType() const;
  86         /// change type
  87         void mutate(HullType newtype);
  88
  89         ///
  90         int defaultColSpace(col_type col);
  91         ///
  92         char defaultColAlign(col_type col);
  93         ///
  94         bool idxFirst(Cursor &) const;
  95         ///
  96         bool idxLast(Cursor &) const;
  97
  98         ///
  99         void write(WriteStream & os) const;
 100         ///
 101         void mathmlize(MathStream &) const;
 102         ///
 103         void normalize(NormalStream &) const;
 104         ///
 105         void infoize(odocstream & os) const;
 106
 107         ///
 108         void write(std::ostream & os) const;
 109         ///
 110         void read(Lexer & lex);
 111         ///
 112         int plaintext(odocstream &, OutputParams const &) const;
 113         ///
 114         int docbook(odocstream &, OutputParams const &) const;
 115         /// the string that is passed to the TOC
 116         void textString(odocstream &) const;
 117
 118         /// get notification when the cursor leaves this inset
 119         bool notifyCursorLeaves(Cursor const & old, Cursor & cur);
 120         ///
 121         //bool insetAllowed(InsetCode code) const;
 122         ///
 123         void addPreview(graphics::PreviewLoader &) const;
 124         ///
 125         void initUnicodeMath() const;
 126
 127         ///
 128         static int displayMargin() { return 12; }
 129
 130         /// Force inset into LTR environment if surroundings are RTL?
 131         virtual bool forceLTR() const { return true; }
 132
 133         ///
 134         virtual docstring contextMenu(BufferView const &, int, int) const;
 135
 136 protected:
 137         InsetMathHull(InsetMathHull const &);
 138
 139         virtual void doDispatch(Cursor & cur, FuncRequest & cmd);
 140
 141         /// do we want to handle this event?
 142         bool getStatus(Cursor & cur, FuncRequest const & cmd,
 143                 FuncStatus & status) const;
 144         ///
 145         docstring eolString(row_type row, bool emptyline, bool fragile) const;
 146
 147 private:
 148         virtual Inset * clone() const;
 149         ///
 150         void setType(HullType type);
 151         ///
 152         void validate1(LaTeXFeatures & features);
 153         ///
 154         void header_write(WriteStream &) const;
 155         ///
 156         void footer_write(WriteStream &) const;
 157         ///
 158         docstring nicelabel(row_type row) const;
 159         ///
 160         void doExtern(Cursor & cur, FuncRequest & func);
 161         ///
 162         void glueall();
 163         /*!
 164          * split every row at the first relation operator.
 165          * The number of columns must be 1. One column is added.
 166          * The first relation operator and everything after it goes to the
 167          * second column.
 168          */
 169         void splitTo2Cols();
 170         /*!
 171          * split every row at the first relation operator.
 172          * The number of columns must be < 3. One or two columns are added.
 173          * The first relation operator goes to the second column.
 174          * Everything after it goes to the third column.
 175          */
 176         void splitTo3Cols();
 177         /// change number of columns, split or combine columns if necessary.
 178         void changeCols(col_type);
 179         ///
 180         docstring standardFont() const;
 181         /// consistency check
 182         void check() const;
 183         /// can this change its number of rows?
 184         bool rowChangeOK() const;
 185         /// can this change its number of cols?
 186         bool colChangeOK() const;
 187
 188         /// "none", "simple", "display", "eqnarray",...
 189         HullType type_;
 190         ///
 191         std::vector<bool> nonum_;
 192         ///
 193         std::vector<InsetLabel *> label_;
 194         ///
 195         boost::scoped_ptr<RenderPreview> preview_;
 196         ///
 197         mutable bool use_preview_;
 198 //
 199 // Incorporate me
 200 //
 201 public:
 202         /// what appears in the minibuffer when opening
 203         docstring editMessage() const;
 204         ///
 205         virtual void mutateToText();
 206         ///
 207         virtual void revealCodes(Cursor & cur) const;
 208         ///
 209         EDITABLE editable() const { return HIGHLY_EDITABLE; }
 210         ///
 211         void edit(Cursor & cur, bool front,
 212                 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
 213         ///
 214         Inset * editXY(Cursor & cur, int x, int y);
 215         ///
 216         DisplayType display() const;
 217         ///
 218         InsetCode lyxCode() const;
 219
 220 protected:
 221         ///
 222         void handleFont(Cursor & cur, docstring const & arg,
 223                 docstring const & font);
 224         ///
 225         void handleFont2(Cursor & cur, docstring const & arg);
 226         ///
 227         bool previewState(BufferView * bv) const;
 228 };
 229
 230
 231
 232 } // namespace lyx
 233 #endif