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 Painter;
  41 class BufferView;
  42 class Buffer;
  43 class BufferParams;
  44 class Paragraph;
  45 class CursorSlice;
  46
  47
  48 class InsetTabular : public UpdatableInset {
  49 public:
  50         ///
  51         InsetTabular(Buffer const &, row_type rows = 1,
  52                      col_type columns = 1);
  53         ///
  54         ~InsetTabular();
  55         ///
  56         void read(Buffer const &, LyXLex &);
  57         ///
  58         void write(Buffer const &, std::ostream &) const;
  59         ///
  60         void metrics(MetricsInfo &, Dimension &) const;
  61         ///
  62         void draw(PainterInfo & pi, int x, int y) const;
  63         ///
  64         void drawSelection(PainterInfo & pi, int x, int y) const;
  65         ///
  66         std::string const editMessage() const;
  67         ///
  68         bool insetAllowed(InsetBase::Code) const { return true; }
  69         ///
  70         bool isTextInset() const { return true; }
  71         /** returns true if, when outputing LaTeX, font changes should
  72             be closed before generating this inset. This is needed for
  73             insets that may contain several paragraphs */
  74         bool noFontChange() const { return true; }
  75         ///
  76         bool display() const { return tabular.isLongTabular(); }
  77         ///
  78         int latex(Buffer const &, std::ostream &,
  79                   OutputParams const &) const;
  80         ///
  81         int plaintext(Buffer const &, std::ostream &,
  82                   OutputParams const &) const;
  83         ///
  84         int linuxdoc(Buffer const &, std::ostream &,
  85                      OutputParams const &) const;
  86         ///
  87         int docbook(Buffer const &, std::ostream &,
  88                     OutputParams const &) const;
  89         ///
  90         void validate(LaTeXFeatures & features) const;
  91         ///
  92         Code lyxCode() const { return InsetBase::TABULAR_CODE; }
  93         /// get offset of this cursor slice relative to our upper left corner
  94         void cursorPos(CursorSlice const & sl, bool boundary, int & x, int & y) const;
  95         ///
  96         bool tabularFeatures(LCursor & cur, std::string const & what);
  97         ///
  98         void tabularFeatures(LCursor & cur, LyXTabular::Feature feature,
  99                              std::string const & val = std::string());
 100         ///
 101         void openLayoutDialog(BufferView *) const;
 102         ///
 103         bool showInsetDialog(BufferView *) const;
 104         /// Appends \c list with all labels found within this inset.
 105         void getLabelList(Buffer const &, std::vector<std::string> & list) const;
 106         /// number of cells
 107         size_t nargs() const;
 108         ///
 109         boost::shared_ptr<InsetText const> cell(idx_type) const;
 110         ///
 111         boost::shared_ptr<InsetText> cell(idx_type);
 112         ///
 113         LyXText * getText(int) const;
 114
 115         ///
 116         void markErased();
 117
 118         // this should return true if we have a "normal" cell, otherwise true.
 119         // "normal" means without width set!
 120         bool forceDefaultParagraphs(InsetBase const * in) const;
 121
 122         ///
 123         void addPreview(lyx::graphics::PreviewLoader &) const;
 124
 125         ///
 126         Buffer const & buffer() const;
 127
 128         /// set the owning buffer
 129         void buffer(Buffer const * buf);
 130         /// lock cell with given index
 131         void edit(LCursor & cur, bool left);
 132         ///
 133         InsetBase * editXY(LCursor & cur, int x, int y);
 134         /// can we go further down on mouse click?
 135         bool descendable() const { return true; }
 136
 137         //
 138         // Public structures and variables
 139         ///
 140         mutable LyXTabular tabular;
 141
 142 protected:
 143         InsetTabular(InsetTabular const &);
 144
 145         virtual void doDispatch(LCursor & cur, FuncRequest & cmd);
 146
 147         ///
 148         bool getStatus(LCursor & cur, FuncRequest const & cmd, FuncStatus &) const;
 149 private:
 150         virtual std::auto_ptr<InsetBase> doClone() const;
 151
 152         ///
 153         void drawCellLines(Painter &, int x, int y, row_type row,
 154                            idx_type cell) const;
 155         ///
 156         void setCursorFromCoordinates(LCursor & cur, int x, int y) const;
 157
 158         ///
 159         void moveNextCell(LCursor & cur);
 160         ///
 161         void movePrevCell(LCursor & cur);
 162         ///
 163         int getCellXPos(idx_type cell) const;
 164         ///
 165         void resetPos(LCursor & cur) const;
 166         ///
 167         void removeTabularRow();
 168         ///
 169         bool hasPasteBuffer() const;
 170         ///
 171         bool copySelection(LCursor & cur);
 172         ///
 173         bool pasteSelection(LCursor & cur);
 174         ///
 175         void cutSelection(LCursor & cur);
 176         ///
 177         bool isRightToLeft(LCursor & cur) const;
 178         ///
 179         void getSelection(LCursor & cur, row_type & rs, row_type & re,
 180                           col_type & cs, col_type & ce) const;
 181         ///
 182         bool insertAsciiString(BufferView &, std::string const & buf, bool usePaste);
 183         /// are we operating on several cells?
 184         bool tablemode(LCursor & cur) const;
 185
 186         /// return the "Manhattan distance" to nearest corner
 187         int dist(idx_type cell, int x, int y) const;
 188         /// return the cell nearest to x, y
 189         idx_type getNearestCell(int x, int y) const;
 190
 191         ///
 192         Buffer const * buffer_;
 193         ///
 194         mutable int cursorx_;
 195         ///
 196         mutable idx_type first_visible_cell;
 197 };
 198
 199
 200 #include "mailinset.h"
 201
 202
 203 class InsetTabularMailer : public MailInset {
 204 public:
 205         ///
 206         InsetTabularMailer(InsetTabular const & inset);
 207         ///
 208         virtual InsetBase & inset() const { return inset_; }
 209         ///
 210         virtual std::string const & name() const { return name_; }
 211         ///
 212         virtual std::string const inset2string(Buffer const &) const;
 213         ///
 214         static void string2params(std::string const &, InsetTabular &);
 215         ///
 216         static std::string const params2string(InsetTabular const &);
 217 private:
 218         ///
 219         static std::string const name_;
 220         ///
 221         InsetTabular & inset_;
 222 };
 223
 224 std::string const featureAsString(LyXTabular::Feature feature);
 225
 226 #endif