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 // This is the rewrite of the tabular (table) support.
  12
  13 // It will probably be a lot of work.
  14
  15 // One first goal could be to make the inset read the old table format
  16 // and just output it again... no viewing at all.
  17
  18 // When making the internal structure of tabular support I really think
  19 // that STL containers should be used. This will separate the container from
  20 // the rest of the code, which is a good thing.
  21
  22 // Ideally the tabular support should do as the mathed and use
  23 // LaTeX in the .lyx file too.
  24
  25 // Things to think of when desingning the new tabular support:
  26 // - color support (colortbl, color)
  27 // - decimal alignment (dcloumn)
  28 // - custom lines (hhline)
  29 // - rotation
  30 // - multicolumn
  31 // - multirow
  32 // - column styles
  33
  34 // This is what I have written about tabular support in the LyX3-Tasks file:
  35 //
  36 //  o rewrite of table code. Should probably be written as some
  37 //          kind of an inset. At least get the code out of the kernel.
  38 //                - colortbl  -multirow
  39 //                - hhline    -multicolumn
  40 //                - dcolumn
  41 // o enhance longtable support
  42
  43 // Lgb
  44
  45 #ifndef INSETTABULAR_H
  46 #define INSETTABULAR_H
  47
  48 #include "inset.h"
  49 #include "tabular.h"
  50 #include "frontends/mouse_state.h"
  51
  52 class FuncStatus;
  53 class LyXLex;
  54 class Painter;
  55 class BufferView;
  56 class Buffer;
  57 class BufferParams;
  58 class Paragraph;
  59
  60 class InsetTabular : public UpdatableInset {
  61 public:
  62         ///
  63         InsetTabular(Buffer const &, int rows = 1, int columns = 1);
  64         ///
  65         InsetTabular(InsetTabular const &);
  66         ///
  67         ~InsetTabular();
  68         ///
  69         virtual std::auto_ptr<InsetBase> clone() const;
  70         ///
  71         void read(Buffer const &, LyXLex &);
  72         ///
  73         void write(Buffer const &, std::ostream &) const;
  74         ///
  75         void metrics(MetricsInfo &, Dimension &) const;
  76         ///
  77         void draw(PainterInfo & pi, int x, int y) const;
  78         ///
  79         std::string const editMessage() const;
  80         ///
  81         void updateLocal(BufferView *) const;
  82         ///
  83         bool insetAllowed(InsetOld::Code code) const;
  84         ///
  85         bool isTextInset() const { return true; }
  86         /** returns true if, when outputing LaTeX, font changes should
  87             be closed before generating this inset. This is needed for
  88             insets that may contain several paragraphs */
  89         bool noFontChange() const { return true; }
  90         ///
  91         bool display() const { return tabular.isLongTabular(); }
  92         ///
  93         int latex(Buffer const &, std::ostream &,
  94                   OutputParams const &) const;
  95         ///
  96         int plaintext(Buffer const &, std::ostream &,
  97                   OutputParams const &) const;
  98         ///
  99         int linuxdoc(Buffer const &, std::ostream &,
 100                      OutputParams const &) const;
 101         ///
 102         int docbook(Buffer const &, std::ostream &,
 103                     OutputParams const &) const;
 104         ///
 105         void validate(LaTeXFeatures & features) const;
 106         ///
 107         InsetOld::Code lyxCode() const { return InsetOld::TABULAR_CODE; }
 108         /// get the absolute screen x,y of the cursor
 109         void getCursorPos(int & x, int & y) const;
 110         ///
 111         bool tabularFeatures(BufferView * bv, std::string const & what);
 112         ///
 113         void tabularFeatures(BufferView * bv, LyXTabular::Feature feature,
 114                              std::string const & val = std::string());
 115         ///
 116         int getActCell() const { return actcell; }
 117         ///
 118         void openLayoutDialog(BufferView *) const;
 119         ///
 120         bool showInsetDialog(BufferView *) const;
 121         ///
 122         FuncStatus getStatus(std::string const & argument) const;
 123         /// Appends \c list with all labels found within this inset.
 124         void getLabelList(Buffer const &, std::vector<std::string> & list) const;
 125         ///
 126         int scroll(bool recursive = true) const;
 127         ///
 128         void scroll(BufferView * bv, float sx) const {
 129                 UpdatableInset::scroll(bv, sx);
 130         }
 131         ///
 132         void scroll(BufferView * bv, int offset) const {
 133                 UpdatableInset::scroll(bv, offset);
 134         }
 135         ///
 136         int numParagraphs() const;
 137         ///
 138         LyXText * getText(int) const;
 139
 140         ///
 141         void markErased();
 142
 143         // this should return true if we have a "normal" cell, otherwise true.
 144         // "normal" means without width set!
 145         bool forceDefaultParagraphs(InsetOld const * in) const;
 146
 147         ///
 148         void addPreview(lyx::graphics::PreviewLoader &) const;
 149
 150         /// are some cells selected ?
 151         bool hasSelection() const { return has_selection; }
 152         ///
 153         Buffer const & buffer() const;
 154
 155         /// set the owning buffer
 156         void buffer(Buffer * buf);
 157         /// lock cell with given index
 158         void edit(BufferView * bv, bool);
 159         ///
 160         void edit(BufferView * bv, int, int);
 161         /// can we go further down on mouse click?
 162         bool descendable() const { return true; }
 163
 164         //
 165         // Public structures and variables
 166         ///
 167         mutable LyXTabular tabular;
 168
 169 protected:
 170         ///
 171         virtual
 172         DispatchResult
 173         priv_dispatch(FuncRequest const &, idx_type &, pos_type &);
 174 private:
 175         ///
 176         void lfunMousePress(FuncRequest const &);
 177         ///
 178         void lfunMouseRelease(FuncRequest const &);
 179         ///
 180         void lfunMouseMotion(FuncRequest const &);
 181         ///
 182         void calculate_dimensions_of_cells(MetricsInfo & mi) const;
 183         ///
 184         void drawCellLines(Painter &, int x, int baseline,
 185                            int row, int cell) const;
 186         ///
 187         void drawCellSelection(Painter &, int x, int baseline,
 188                                int row, int column, int cell) const;
 189         ///
 190         void setPos(BufferView *, int x, int y) const;
 191         ///
 192         DispatchResult moveRight(BufferView *, bool lock);
 193         ///
 194         DispatchResult moveLeft(BufferView *, bool lock);
 195         ///
 196         DispatchResult moveUp(BufferView *, bool lock);
 197         ///
 198         DispatchResult moveDown(BufferView *, bool lock);
 199         ///
 200         bool moveNextCell(BufferView *, bool lock = false);
 201         ///
 202         bool movePrevCell(BufferView *, bool lock = false);
 203         ///
 204         int getCellXPos(int cell) const;
 205         ///
 206         void resetPos(BufferView *) const;
 207         ///
 208         void removeTabularRow();
 209         ///
 210         void clearSelection() const {
 211                 sel_cell_start = sel_cell_end = 0;
 212                 has_selection = false;
 213         }
 214         void setSelection(int start, int end) const {
 215                 sel_cell_start = start;
 216                 sel_cell_end = end;
 217                 has_selection = true;
 218         }
 219         ///
 220         bool activateCellInset(BufferView *, int x = 0, int y = 0,
 221                                bool behind = false);
 222         ///
 223         bool hasPasteBuffer() const;
 224         ///
 225         bool copySelection(BufferView *);
 226         ///
 227         bool pasteSelection(BufferView *);
 228         ///
 229         bool cutSelection(BufferParams const & bp);
 230         ///
 231         bool isRightToLeft(BufferView *);
 232         ///
 233         void getSelection(int & scol, int & ecol, int & srow, int & erow) const;
 234         ///
 235         bool insertAsciiString(BufferView *, std::string const & buf, bool usePaste);
 236
 237         //
 238         // Private structures and variables
 239         ///
 240         InsetText * the_locking_inset;
 241         ///
 242         Buffer const * buffer_;
 243         ///
 244         mutable int cursorx_;
 245         ///
 246         mutable int cursory_;
 247         /// true if a set of cells are selected
 248         mutable bool has_selection;
 249         /// the starting cell selection nr
 250         mutable int sel_cell_start;
 251         /// the ending cell selection nr
 252         mutable int sel_cell_end;
 253         ///
 254         mutable int actcell;
 255         ///
 256         mutable int actcol;
 257         ///
 258         mutable int actrow;
 259         ///
 260         mutable int first_visible_cell;
 261         ///
 262         mutable int in_reset_pos;
 263 };
 264
 265
 266 #include "mailinset.h"
 267
 268
 269 class InsetTabularMailer : public MailInset {
 270 public:
 271         ///
 272         InsetTabularMailer(InsetTabular const & inset);
 273         ///
 274         virtual InsetBase & inset() const { return inset_; }
 275         ///
 276         virtual std::string const & name() const { return name_; }
 277         ///
 278         virtual std::string const inset2string(Buffer const &) const;
 279         /// Returns the active cell if successful, else -1.
 280         static int string2params(std::string const &, InsetTabular &);
 281         ///
 282         static std::string const params2string(InsetTabular const &);
 283 private:
 284         ///
 285         static std::string const name_;
 286         ///
 287         InsetTabular & inset_;
 288 };
 289
 290 std::string const featureAsString(LyXTabular::Feature feature);
 291
 292 #endif