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 "Color.h"
  18 #include "DocIterator.h"
  19 #include "OutputEnums.h"
  20
  21 #include <boost/scoped_ptr.hpp>
  22
  23
  24 namespace lyx {
  25
  26 class InsetLabel;
  27 class ParConstIterator;
  28 class RenderPreview;
  29
  30
  31 /// This provides an interface between "LyX insets" and "LyX math insets"
  32 class InsetMathHull : public InsetMathGrid {
  33 public:
  34         ///
  35         InsetMathHull(Buffer * buf);
  36         ///
  37         InsetMathHull(Buffer * buf, HullType type);
  38         ///
  39         virtual ~InsetMathHull();
  40         ///
  41         void setBuffer(Buffer &);
  42         ///
  43         void updateBuffer(ParIterator const &, UpdateType);
  44         ///
  45         void addToToc(DocIterator const &);
  46         ///
  47         InsetMathHull & operator=(InsetMathHull const &);
  48         ///
  49         mode_type currentMode() const;
  50         ///
  51         void metrics(MetricsInfo & mi, Dimension & dim) const;
  52         ///
  53         void drawBackground(PainterInfo & pi, int x, int y) const;
  54         ///
  55         void draw(PainterInfo &, int x, int y) const;
  56         ///
  57         void metricsT(TextMetricsInfo const & mi, Dimension & dim) const;
  58         ///
  59         void drawT(TextPainter &, int x, int y) const;
  60         ///
  61         docstring label(row_type row) const;
  62         ///
  63         void label(row_type row, docstring const & label);
  64         ///
  65         std::vector<InsetLabel *> const & getLabels() { return label_; }
  66         ///
  67         ColorCode backgroundColor(PainterInfo const &) const;
  68         ///
  69         void numbered(row_type row, bool num);
  70         ///
  71         bool numbered(row_type row) const;
  72         ///
  73         bool numberedType() const;
  74         ///
  75         bool ams() const;
  76         ///
  77         void validate(LaTeXFeatures & features) const;
  78         /// identifies HullInset
  79         InsetMathHull const * asHullInset() const { return this; }
  80         /// identifies HullInset
  81         InsetMathHull * asHullInset() { return this; }
  82
  83         /// add a row
  84         void addRow(row_type row);
  85         /// delete a row
  86         void delRow(row_type row);
  87         /// swap two rows
  88         void swapRow(row_type row);
  89         /// add a column
  90         void addCol(col_type col);
  91         /// delete a column
  92         void delCol(col_type col);
  93
  94         /// get type
  95         HullType getType() const;
  96         /// change type
  97         void mutate(HullType newtype);
  98
  99         ///
 100         int defaultColSpace(col_type col);
 101         ///
 102         char defaultColAlign(col_type col);
 103         ///
 104         bool idxFirst(Cursor &) const;
 105         ///
 106         bool idxLast(Cursor &) const;
 107
 108         ///
 109         void write(WriteStream & os) const;
 110         ///
 111         void mathmlize(MathStream &) const;
 112         ///
 113         void normalize(NormalStream &) const;
 114         ///
 115         void infoize(odocstream & os) const;
 116
 117         ///
 118         void write(std::ostream & os) const;
 119         ///
 120         void header_write(WriteStream &) const;
 121         ///
 122         void footer_write(WriteStream &) const;
 123         ///
 124         void read(Lexer & lex);
 125         ///
 126         bool readQuiet(Lexer & lex);
 127         ///
 128         int plaintext(odocstream &, OutputParams const &) const;
 129         ///
 130         int docbook(odocstream &, OutputParams const &) const;
 131         ///
 132         docstring xhtml(XHTMLStream &, OutputParams const &) const;
 133         /// the string that is passed to the TOC
 134         void tocString(odocstream &) const;
 135
 136         /// get notification when the cursor leaves this inset
 137         bool notifyCursorLeaves(Cursor const & old, Cursor & cur);
 138         ///
 139         //bool insetAllowed(InsetCode code) const;
 140         ///
 141         void addPreview(DocIterator const & inset_pos,
 142                 graphics::PreviewLoader &) const;
 143         /// Recreates the preview if preview is enabled.
 144         void reloadPreview(DocIterator const & pos) const;
 145         ///
 146         void initUnicodeMath() const;
 147
 148         ///
 149         static int displayMargin() { return 12; }
 150
 151         /// Force inset into LTR environment if surroundings are RTL
 152         virtual bool forceLTR() const { return true; }
 153         ///
 154         void recordLocation(DocIterator const & di);
 155
 156         ///
 157         virtual docstring contextMenu(BufferView const &, int, int) const;
 158         ///
 159         InsetCode lyxCode() const { return MATH_HULL_CODE; }
 160
 161 protected:
 162         InsetMathHull(InsetMathHull const &);
 163
 164         virtual void doDispatch(Cursor & cur, FuncRequest & cmd);
 165
 166         /// do we want to handle this event?
 167         bool getStatus(Cursor & cur, FuncRequest const & cmd,
 168                 FuncStatus & status) const;
 169         ///
 170         docstring eolString(row_type row, bool fragile, bool latex,
 171                         bool last_eoln) const;
 172
 173 private:
 174         virtual Inset * clone() const;
 175         /// Prepare the preview if preview is enabled.
 176         /// \param forexport: whether this is intended for export
 177         /// If so, we ignore LyXRC and wait for the image to be generated.
 178         void preparePreview(DocIterator const & pos,
 179                             bool forexport = false) const;
 180         /// like reloadPreview, but forces load
 181         /// used by image export
 182         void loadPreview(DocIterator const & pos) const;
 183         ///
 184         void setType(HullType type);
 185         ///
 186         void validate1(LaTeXFeatures & features);
 187         ///
 188         docstring nicelabel(row_type row) const;
 189         ///
 190         void doExtern(Cursor & cur, FuncRequest & func);
 191         ///
 192         void glueall(HullType type);
 193         /*!
 194          * split every row at the first relation operator.
 195          * The number of columns must be 1. One column is added.
 196          * The first relation operator and everything after it goes to the
 197          * second column.
 198          */
 199         void splitTo2Cols();
 200         /*!
 201          * split every row at the first relation operator.
 202          * The number of columns must be < 3. One or two columns are added.
 203          * The first relation operator goes to the second column.
 204          * Everything after it goes to the third column.
 205          */
 206         void splitTo3Cols();
 207         /// change number of columns, split or combine columns if necessary.
 208         void changeCols(col_type);
 209         ///
 210         docstring standardFont() const;
 211         ///
 212         ColorCode standardColor() const;
 213         /// consistency check
 214         void check() const;
 215         /// can this change its number of rows?
 216         bool rowChangeOK() const;
 217         /// can this change its number of cols?
 218         bool colChangeOK() const;
 219
 220         /// "none", "simple", "display", "eqnarray",...
 221         HullType type_;
 222         ///
 223         std::vector<bool> numbered_;
 224         ///
 225         std::vector<InsetLabel *> label_;
 226         ///
 227         boost::scoped_ptr<RenderPreview> preview_;
 228         ///
 229         mutable bool use_preview_;
 230         ///
 231         DocIterator docit_;
 232 //
 233 // Incorporate me
 234 //
 235 public:
 236         ///
 237         virtual void mutateToText();
 238         ///
 239         virtual void revealCodes(Cursor & cur) const;
 240         ///
 241         bool editable() const { return true; }
 242         ///
 243         void edit(Cursor & cur, bool front,
 244                 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
 245         ///
 246         Inset * editXY(Cursor & cur, int x, int y);
 247         ///
 248         DisplayType display() const;
 249
 250 protected:
 251         ///
 252         void handleFont(Cursor & cur, docstring const & arg,
 253                 docstring const & font);
 254         ///
 255         void handleFont2(Cursor & cur, docstring const & arg);
 256         ///
 257         bool previewState(BufferView * bv) const;
 258 };
 259
 260
 261
 262 } // namespace lyx
 263 #endif