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 #include <boost/scoped_ptr.hpp>
  17
  18 class RenderPreview;
  19
  20
  21 /// This provides an interface between "LyX insets" and "LyX math insets"
  22 class InsetMathHull : public InsetMathGrid {
  23 public:
  24         ///
  25         InsetMathHull();
  26         ///
  27         explicit InsetMathHull(HullType type);
  28         ///
  29         ~InsetMathHull();
  30         ///
  31         InsetMathHull & operator=(InsetMathHull const &);
  32         ///
  33         mode_type currentMode() const;
  34         ///
  35         void metrics(MetricsInfo & mi, Dimension & dim) const;
  36         ///
  37         void draw(PainterInfo &, int x, int y) const;
  38         ///
  39         void metricsT(TextMetricsInfo const & mi, Dimension & dim) const;
  40         ///
  41         void drawT(TextPainter &, int x, int y) const;
  42         ///
  43         std::string label(row_type row) const;
  44         ///
  45         void label(row_type row, std::string const & label);
  46         ///
  47         void numbered(row_type row, bool num);
  48         ///
  49         bool numbered(row_type row) const;
  50         ///
  51         bool numberedType() const;
  52         ///
  53         bool ams() const;
  54         /// Appends \c list with all labels found within this inset.
  55         void getLabelList(Buffer const &,
  56                           std::vector<std::string> & list) const;
  57         ///
  58         void validate(LaTeXFeatures & features) const;
  59         /// identifies HullInset
  60         InsetMathHull const * asHullInset() const { return this; }
  61         /// identifies HullInset
  62         InsetMathHull * asHullInset() { return this; }
  63
  64         /// add a row
  65         void addRow(row_type row);
  66         /// delete a row
  67         void delRow(row_type row);
  68         /// swap two rows
  69         void swapRow(row_type row);
  70         /// add a column
  71         void addCol(col_type col);
  72         /// delete a column
  73         void delCol(col_type col);
  74
  75         /// get type
  76         HullType getType() const;
  77         /// change type
  78         void mutate(HullType newtype);
  79
  80         ///
  81         int defaultColSpace(col_type col);
  82         ///
  83         char defaultColAlign(col_type col);
  84         ///
  85         bool idxFirst(LCursor &) const;
  86         ///
  87         bool idxLast(LCursor &) const;
  88
  89         ///
  90         void write(WriteStream & os) const;
  91         ///
  92         void mathmlize(MathMLStream &) const;
  93         ///
  94         void normalize(NormalStream &) const;
  95         ///
  96         void infoize(std::ostream & os) const;
  97
  98         ///
  99         void write(Buffer const &, std::ostream & os) const;
 100         ///
 101         void read(Buffer const &, LyXLex & lex);
 102         ///
 103         int plaintext(Buffer const &, std::ostream &,
 104                   OutputParams const &) const;
 105         ///
 106         int docbook(Buffer const &, std::ostream &,
 107                     OutputParams const &) const;
 108         /// the string that is passed to the TOC
 109         virtual int textString(Buffer const &, std::ostream & os,
 110                 OutputParams const &) const;
 111
 112         /// get notification when the cursor leaves this inset
 113         bool notifyCursorLeaves(LCursor & cur);
 114         ///
 115         //bool insetAllowed(Code code) const;
 116         ///
 117         void addPreview(lyx::graphics::PreviewLoader &) const;
 118
 119         ///
 120         static int displayMargin() { return 12; }
 121
 122 protected:
 123         InsetMathHull(InsetMathHull const &);
 124
 125         virtual void doDispatch(LCursor & cur, FuncRequest & cmd);
 126
 127         /// do we want to handle this event?
 128         bool getStatus(LCursor & cur, FuncRequest const & cmd,
 129                 FuncStatus & status) const;
 130         ///
 131         std::string eolString(row_type row, bool emptyline, bool fragile) const;
 132
 133 private:
 134         virtual std::auto_ptr<InsetBase> doClone() const;
 135         ///
 136         void setType(HullType type);
 137         ///
 138         void validate1(LaTeXFeatures & features);
 139         ///
 140         void header_write(WriteStream &) const;
 141         ///
 142         void footer_write(WriteStream &) const;
 143         ///
 144         std::string nicelabel(row_type row) const;
 145         ///
 146         void doExtern(LCursor & cur, FuncRequest & func);
 147         ///
 148         void glueall();
 149         /*!
 150          * split every row at the first relation operator.
 151          * The number of columns must be 1. One column is added.
 152          * The first relation operator and everything after it goes to the
 153          * second column.
 154          */
 155         void splitTo2Cols();
 156         /*!
 157          * split every row at the first relation operator.
 158          * The number of columns must be < 3. One or two columns are added.
 159          * The first relation operator goes to the second column.
 160          * Everything after it goes to the third column.
 161          */
 162         void splitTo3Cols();
 163         /// change number of columns, split or combine columns if necessary.
 164         void changeCols(col_type);
 165         ///
 166         char const * standardFont() const;
 167         /// consistency check
 168         void check() const;
 169         /// can this change its number of rows?
 170         bool rowChangeOK() const;
 171         /// can this change its number of cols?
 172         bool colChangeOK() const;
 173
 174         /// "none", "simple", "display", "eqnarray",...
 175         HullType type_;
 176         ///
 177         std::vector<int> nonum_;
 178         ///
 179         std::vector<std::string> label_;
 180         ///
 181         boost::scoped_ptr<RenderPreview> preview_;
 182         ///
 183         mutable bool use_preview_;
 184 //
 185 // Incorporate me
 186 //
 187 public:
 188         /// what appears in the minibuffer when opening
 189         virtual lyx::docstring const editMessage() const;
 190         ///
 191         virtual void mutateToText();
 192         ///
 193         virtual void revealCodes(LCursor & cur) const;
 194         ///
 195         EDITABLE editable() const { return HIGHLY_EDITABLE; }
 196         ///
 197         void edit(LCursor & cur, bool left);
 198         ///
 199         InsetBase * editXY(LCursor & cur, int x, int y);
 200         ///
 201         bool display() const;
 202         ///
 203         Code lyxCode() const;
 204
 205 protected:
 206         ///
 207         void handleFont(LCursor & cur, std::string const & arg,
 208                 std::string const & font);
 209         ///
 210         void handleFont2(LCursor & cur, std::string const & arg);
 211         ///
 212         bool previewState(BufferView * bv) const;
 213 };
 214
 215 #endif