src/insets/insettabular.h

   1 // -*- C++ -*-
   2 /**
   3  * \file insettabular.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Jürgen Vigna
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12
  13 // This is Juergen's rewrite of the tabular (table) support.
  14
  15 // Things to think of when designing the new tabular support:
  16 // - color support (colortbl, color)
  17 // - decimal alignment (dcloumn)
  18 // - custom lines (hhline)
  19 // - rotation
  20 // - multicolumn
  21 // - multirow
  22 // - column styles
  23
  24 // This is what I have written about tabular support in the LyX3-Tasks file:
  25 //
  26 //  o rewrite of table code. Should probably be written as some
  27 //    kind of an inset. [Done]
  28 // o enhance longtable support
  29
  30 // Lgb
  31
  32 #ifndef INSETTABULAR_H
  33 #define INSETTABULAR_H
  34
  35 #include "inset.h"
  36 #include "tabular.h"
  37
  38 class FuncStatus;
  39 class LyXLex;
  40 class BufferView;
  41 class Buffer;
  42 class BufferParams;
  43 class Paragraph;
  44 class CursorSlice;
  45
  46 namespace lyx {
  47 namespace frontend {
  48 class Painter;
  49 }
  50 }
  51
  52
  53 class InsetTabular : public InsetOld {
  54 public:
  55         ///
  56         InsetTabular(Buffer const &, row_type rows = 1,
  57                      col_type columns = 1);
  58         ///
  59         ~InsetTabular();
  60         ///
  61         void read(Buffer const &, LyXLex &);
  62         ///
  63         void write(Buffer const &, std::ostream &) const;
  64         ///
  65         void metrics(MetricsInfo &, Dimension &) const;
  66         ///
  67         void draw(PainterInfo & pi, int x, int y) const;
  68         ///
  69         void drawSelection(PainterInfo & pi, int x, int y) const;
  70         ///
  71         std::string const editMessage() const;
  72         ///
  73         EDITABLE editable() const { return HIGHLY_EDITABLE; }
  74         ///
  75         bool insetAllowed(InsetBase::Code) const { return true; }
  76         ///
  77         bool allowSpellCheck() const { return true; }
  78         ///
  79         bool canTrackChanges() const { return true; }
  80         /** returns true if, when outputing LaTeX, font changes should
  81             be closed before generating this inset. This is needed for
  82             insets that may contain several paragraphs */
  83         bool noFontChange() const { return true; }
  84         ///
  85         bool display() const { return tabular.isLongTabular(); }
  86         ///
  87         int latex(Buffer const &, std::ostream &,
  88                   OutputParams const &) const;
  89         ///
  90         int plaintext(Buffer const &, std::ostream &,
  91                   OutputParams const &) const;
  92         ///
  93         int docbook(Buffer const &, std::ostream &,
  94                     OutputParams const &) const;
  95         ///
  96         void validate(LaTeXFeatures & features) const;
  97         ///
  98         Code lyxCode() const { return InsetBase::TABULAR_CODE; }
  99         /// get offset of this cursor slice relative to our upper left corner
 100         void cursorPos(CursorSlice const & sl, bool boundary, int & x, int & y) const;
 101         ///
 102         bool tabularFeatures(LCursor & cur, std::string const & what);
 103         ///
 104         void tabularFeatures(LCursor & cur, LyXTabular::Feature feature,
 105                              std::string const & val = std::string());
 106         ///
 107         void openLayoutDialog(BufferView *) const;
 108         ///
 109         bool showInsetDialog(BufferView *) const;
 110         /// number of cells
 111         size_t nargs() const { return tabular.getNumberOfCells(); }
 112         ///
 113         boost::shared_ptr<InsetText const> cell(idx_type) const;
 114         ///
 115         boost::shared_ptr<InsetText> cell(idx_type);
 116         ///
 117         LyXText * getText(int) const;
 118
 119         ///
 120         void markErased(bool);
 121
 122         // this should return true if we have a "normal" cell, otherwise false.
 123         // "normal" means without width set!
 124         /// should all paragraphs be output with "Standard" layout?
 125         bool forceDefaultParagraphs(idx_type cell = 0) const;
 126
 127         ///
 128         void addPreview(lyx::graphics::PreviewLoader &) const;
 129
 130         ///
 131         Buffer const & buffer() const;
 132
 133         /// set the owning buffer
 134         void buffer(Buffer const * buf);
 135         /// lock cell with given index
 136         void edit(LCursor & cur, bool left);
 137         ///
 138         InsetBase * editXY(LCursor & cur, int x, int y);
 139         /// can we go further down on mouse click?
 140         bool descendable() const { return true; }
 141
 142         //
 143         // Public structures and variables
 144         ///
 145         mutable LyXTabular tabular;
 146
 147 protected:
 148         ///
 149         InsetTabular(InsetTabular const &);
 150         ///
 151         virtual void doDispatch(LCursor & cur, FuncRequest & cmd);
 152         ///
 153         bool getStatus(LCursor & cur, FuncRequest const & cmd, FuncStatus &) const;
 154         ///
 155         int scroll() const { return scx_; }
 156
 157 private:
 158         virtual std::auto_ptr<InsetBase> doClone() const;
 159
 160         ///
 161         void drawCellLines(lyx::frontend::Painter &, int x, int y, row_type row,
 162                            idx_type cell, bool erased) const;
 163         ///
 164         void setCursorFromCoordinates(LCursor & cur, int x, int y) const;
 165
 166         ///
 167         void moveNextCell(LCursor & cur);
 168         ///
 169         void movePrevCell(LCursor & cur);
 170         ///
 171         int getCellXPos(idx_type cell) const;
 172         ///
 173         void resetPos(LCursor & cur) const;
 174         ///
 175         void removeTabularRow();
 176         ///
 177         bool hasPasteBuffer() const;
 178         ///
 179         bool copySelection(LCursor & cur);
 180         ///
 181         bool pasteSelection(LCursor & cur);
 182         ///
 183         void cutSelection(LCursor & cur);
 184         ///
 185         bool isRightToLeft(LCursor & cur) const;
 186         ///
 187         void getSelection(LCursor & cur, row_type & rs, row_type & re,
 188                           col_type & cs, col_type & ce) const;
 189         ///
 190         bool insertAsciiString(BufferView &, std::string const & buf, bool usePaste);
 191         /// are we operating on several cells?
 192         bool tablemode(LCursor & cur) const;
 193
 194         /// return the "Manhattan distance" to nearest corner
 195         int dist(idx_type cell, int x, int y) const;
 196         /// return the cell nearest to x, y
 197         idx_type getNearestCell(int x, int y) const;
 198
 199         ///
 200         Buffer const * buffer_;
 201         ///
 202         mutable idx_type first_visible_cell;
 203         ///
 204         mutable int scx_;
 205 };
 206
 207
 208 #include "mailinset.h"
 209
 210
 211 class InsetTabularMailer : public MailInset {
 212 public:
 213         ///
 214         InsetTabularMailer(InsetTabular const & inset);
 215         ///
 216         virtual InsetBase & inset() const { return inset_; }
 217         ///
 218         virtual std::string const & name() const { return name_; }
 219         ///
 220         virtual std::string const inset2string(Buffer const &) const;
 221         ///
 222         static void string2params(std::string const &, InsetTabular &);
 223         ///
 224         static std::string const params2string(InsetTabular const &);
 225 private:
 226         ///
 227         static std::string const name_;
 228         ///
 229         InsetTabular & inset_;
 230 };
 231
 232 std::string const featureAsString(LyXTabular::Feature feature);
 233
 234 #endif