src/mathed/math_hullinset.h

   1 // -*- C++ -*-
   2 /**
   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.
   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 "math_gridinset.h"
  16
  17
  18 /// This provides an interface between "LyX insets" and "LyX math insets"
  19 class MathHullInset : public MathGridInset {
  20 public:
  21         ///
  22         MathHullInset();
  23         ///
  24         explicit MathHullInset(std::string const & type);
  25         ///
  26         std::auto_ptr<InsetBase> clone() const;
  27         ///
  28         mode_type currentMode() const;
  29         ///
  30         void metrics(MetricsInfo & mi, Dimension & dim) const;
  31         ///
  32         void draw(PainterInfo &, int x, int y) const;
  33         ///
  34         void metricsT(TextMetricsInfo const & mi, Dimension & dim) const;
  35         ///
  36         void drawT(TextPainter &, int x, int y) const;
  37         ///
  38         std::string label(row_type row) const;
  39         ///
  40         void label(row_type row, std::string const & label);
  41         ///
  42         void numbered(row_type row, bool num);
  43         ///
  44         bool numbered(row_type row) const;
  45         ///
  46         bool numberedType() const;
  47         ///
  48         bool ams() const;
  49         /// Appends \c list with all labels found within this inset.
  50         void getLabelList(Buffer const &,
  51                           std::vector<std::string> & list) const;
  52         ///
  53         void validate(LaTeXFeatures & features) const;
  54         /// identifies MatrixInsets
  55         MathHullInset const * asHullInset() const { return this; }
  56         /// identifies HullInset
  57         MathHullInset * asHullInset() { return this; }
  58
  59         /// add a row
  60         void addRow(row_type row);
  61         /// delete a row
  62         void delRow(row_type row);
  63         ///
  64         void swapRow(row_type row);
  65         /// add a column
  66         void addCol(col_type col);
  67         /// delete a column
  68         void delCol(col_type col);
  69
  70         /// get type
  71         std::string const & getType() const;
  72         /// change type
  73         void mutate(std::string const &);
  74
  75         ///
  76         int defaultColSpace(col_type col);
  77         ///
  78         char defaultColAlign(col_type col);
  79         ///
  80         bool idxFirst(LCursor &) const;
  81         ///
  82         bool idxLast(LCursor &) const;
  83
  84         ///
  85         std::string fileInsetLabel() const;
  86         ///
  87         void write(WriteStream & os) const;
  88         ///
  89         void mathmlize(MathMLStream &) const;
  90         ///
  91         void normalize(NormalStream &) const;
  92         ///
  93         void infoize(std::ostream & os) const;
  94
  95         ///
  96         void write(Buffer const &, std::ostream & os) const;
  97         ///
  98         void read(Buffer const &, LyXLex & lex);
  99         ///
 100         int latex(Buffer const &, std::ostream &,
 101                   OutputParams const &) const;
 102         ///
 103         int plaintext(Buffer const &, std::ostream &,
 104                   OutputParams const &) const;
 105         ///
 106         int linuxdoc(Buffer const &, std::ostream &,
 107                      OutputParams const &) const;
 108         ///
 109         int docbook(Buffer const &, std::ostream &,
 110                     OutputParams const &) const;
 111
 112         ///
 113         //bool insetAllowed(Code code) const;
 114         ///
 115         //void addPreview(lyx::graphics::PreviewLoader &) const;
 116
 117
 118 protected:
 119         ///
 120         void priv_dispatch(LCursor & cur, FuncRequest const & cmd);
 121         ///
 122         std::string eolString(row_type row, bool fragile) const;
 123
 124 private:
 125         ///
 126         void setType(std::string const & type);
 127         ///
 128         void validate1(LaTeXFeatures & features);
 129         ///
 130         void header_write(WriteStream &) const;
 131         ///
 132         void footer_write(WriteStream &) const;
 133         ///
 134         std::string nicelabel(row_type row) const;
 135         ///
 136         void doExtern(LCursor & cur, FuncRequest const & func);
 137         ///
 138         void glueall();
 139         ///
 140         char const * standardFont() const;
 141         /// consistency check
 142         void check() const;
 143         /// can this change its number of cols?
 144         bool colChangeOK() const;
 145
 146         /// "none", "simple", "display", "eqnarray",...
 147         std::string type_;
 148         ///
 149         std::vector<int> nonum_;
 150         ///
 151         std::vector<std::string> label_;
 152
 153 //
 154 // Incorporate me
 155 //
 156 public:
 157         /// lowest x coordinate
 158         int xlow() const;
 159         /// highest x coordinate
 160         int xhigh() const;
 161         /// lowest y coordinate
 162         int ylow() const;
 163         /// highest y coordinate
 164         int yhigh() const;
 165
 166
 167         /// what appears in the minibuffer when opening
 168         virtual std::string const editMessage() const;
 169         ///
 170         virtual void getCursorDim(int &, int &) const;
 171         ///
 172         virtual void insetUnlock(BufferView & bv);
 173
 174         /// To allow transparent use of math editing functions
 175         //virtual void status(FuncRequest const &);
 176
 177         ///
 178         virtual bool searchForward(BufferView *, std::string const &,
 179                                    bool = true, bool = false);
 180         ///
 181         virtual bool searchBackward(BufferView *, std::string const &,
 182                                     bool = true, bool = false);
 183         ///
 184         virtual bool isTextInset() const { return true; }
 185         ///
 186         virtual void mutateToText();
 187         ///
 188         virtual void revealCodes(LCursor & cur) const;
 189         ///
 190         virtual EDITABLE editable() const { return HIGHLY_EDITABLE; }
 191         ///
 192         bool display() const;
 193         ///
 194         Code lyxCode() const;
 195
 196 private:
 197         /// common base for handling accents
 198         void handleAccent(BufferView & bv, std::string const & arg,
 199                 std::string const & name);
 200
 201 protected:
 202
 203         /** Find the PreviewLoader, add a LaTeX snippet to it and
 204          *  start the loading process.
 205          *
 206          *  Most insets have no interest in this capability, so the method
 207          *  defaults to empty.
 208          */
 209         virtual void generatePreview(Buffer const &) const {}
 210
 211         ///
 212         void handleFont(LCursor &, std::string const & arg, std::string const & font);
 213         ///
 214         void handleFont2(LCursor &, std::string const & arg);
 215 };
 216
 217 // We don't really want to mess around with mathed stuff outside mathed.
 218 // So do it here.
 219 void mathDispatch(LCursor & cur, FuncRequest const & cmd);
 220 #endif