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 insertInset(BufferView *, InsetOld *);
  84         ///
  85         bool insetAllowed(InsetOld::Code code) const;
  86         ///
  87         bool isTextInset() const { return true; }
  88         /** returns true if, when outputing LaTeX, font changes should
  89             be closed before generating this inset. This is needed for
  90             insets that may contain several paragraphs */
  91         bool noFontChange() const { return true; }
  92         ///
  93         bool display() const { return tabular.isLongTabular(); }
  94         ///
  95         int latex(Buffer const &, std::ostream &,
  96                   OutputParams const &) const;
  97         ///
  98         int plaintext(Buffer const &, std::ostream &,
  99                   OutputParams const &) const;
 100         ///
 101         int linuxdoc(Buffer const &, std::ostream &,
 102                      OutputParams const &) const;
 103         ///
 104         int docbook(Buffer const &, std::ostream &,
 105                     OutputParams const &) const;
 106         ///
 107         void validate(LaTeXFeatures & features) const;
 108         ///
 109         InsetOld::Code lyxCode() const { return InsetOld::TABULAR_CODE; }
 110         /// get the absolute screen x,y of the cursor
 111         void getCursorPos(int & x, int & y) const;
 112         ///
 113         bool tabularFeatures(BufferView * bv, std::string const & what);
 114         ///
 115         void tabularFeatures(BufferView * bv, LyXTabular::Feature feature,
 116                              std::string const & val = std::string());
 117         ///
 118         int getActCell() const { return actcell; }
 119         ///
 120         void openLayoutDialog(BufferView *) const;
 121         ///
 122         bool showInsetDialog(BufferView *) const;
 123         ///
 124         FuncStatus getStatus(std::string const & argument) const;
 125         /// Appends \c list with all labels found within this inset.
 126         void getLabelList(Buffer const &, std::vector<std::string> & list) const;
 127         ///
 128         int scroll(bool recursive=true) const;
 129         ///
 130         void scroll(BufferView *bv, float sx) const {
 131                 UpdatableInset::scroll(bv, sx);
 132         }
 133         ///
 134         void scroll(BufferView *bv, int offset) const {
 135                 UpdatableInset::scroll(bv, offset);
 136         }
 137         ///
 138         ParagraphList * getParagraphs(int) const;
 139         ///
 140         int numParagraphs() const;
 141         ///
 142         LyXText * getText(int) const;
 143
 144         ///
 145         void markErased();
 146
 147         // this should return true if we have a "normal" cell, otherwise true.
 148         // "normal" means without width set!
 149         bool forceDefaultParagraphs(InsetOld const * in) const;
 150
 151         ///
 152         void addPreview(lyx::graphics::PreviewLoader &) const;
 153
 154         //
 155         // Public structures and variables
 156         ///
 157         mutable LyXTabular tabular;
 158
 159         /// are some cells selected ?
 160         bool hasSelection() const { return has_selection; }
 161
 162         ///
 163         Buffer const & buffer() const;
 164
 165         /// set the owning buffer
 166         void buffer(Buffer * buf);
 167         /// lock cell with given index
 168         void edit(BufferView * bv, bool);
 169         ///
 170         void edit(BufferView * bv, int, int);
 171         /// can we go further down on mouse click?
 172         bool descendable() const { return true; }
 173 protected:
 174         ///
 175         virtual
 176         DispatchResult
 177         priv_dispatch(FuncRequest const &, idx_type &, pos_type &);
 178 private:
 179         ///
 180         void lfunMousePress(FuncRequest const &);
 181         ///
 182         void lfunMouseRelease(FuncRequest const &);
 183         ///
 184         void lfunMouseMotion(FuncRequest const &);
 185         ///
 186         void calculate_dimensions_of_cells(MetricsInfo & mi) const;
 187         ///
 188         void drawCellLines(Painter &, int x, int baseline,
 189                            int row, int cell) const;
 190         ///
 191         void drawCellSelection(Painter &, int x, int baseline,
 192                                int row, int column, int cell) const;
 193         ///
 194         void setPos(BufferView *, int x, int y) const;
 195         ///
 196         DispatchResult moveRight(BufferView *, bool lock);
 197         ///
 198         DispatchResult moveLeft(BufferView *, bool lock);
 199         ///
 200         DispatchResult moveUp(BufferView *, bool lock);
 201         ///
 202         DispatchResult moveDown(BufferView *, bool lock);
 203         ///
 204         bool moveNextCell(BufferView *, bool lock = false);
 205         ///
 206         bool movePrevCell(BufferView *, bool lock = false);
 207         ///
 208         int getCellXPos(int cell) const;
 209         ///
 210         void resetPos(BufferView *) const;
 211         ///
 212         void removeTabularRow();
 213         ///
 214         void clearSelection() const {
 215                 sel_cell_start = sel_cell_end = 0;
 216                 has_selection = false;
 217         }
 218         void setSelection(int start, int end) const {
 219                 sel_cell_start = start;
 220                 sel_cell_end = end;
 221                 has_selection = true;
 222         }
 223         ///
 224         bool activateCellInset(BufferView *, int x = 0, int y = 0,
 225                                bool behind = false);
 226         ///
 227         bool hasPasteBuffer() const;
 228         ///
 229         bool copySelection(BufferView *);
 230         ///
 231         bool pasteSelection(BufferView *);
 232         ///
 233         bool cutSelection(BufferParams const & bp);
 234         ///
 235         bool isRightToLeft(BufferView *);
 236         ///
 237         void getSelection(int & scol, int & ecol, int & srow, int & erow) const;
 238         ///
 239         bool insertAsciiString(BufferView *, std::string const & buf, bool usePaste);
 240
 241         //
 242         // Private structures and variables
 243         ///
 244         InsetText * the_locking_inset;
 245         ///
 246         Buffer const * buffer_;
 247         ///
 248         mutable int cursorx_;
 249         ///
 250         mutable int cursory_;
 251         /// true if a set of cells are selected
 252         mutable bool has_selection;
 253         /// the starting cell selection nr
 254         mutable int sel_cell_start;
 255         /// the ending cell selection nr
 256         mutable int sel_cell_end;
 257         ///
 258         mutable int actcell;
 259         ///
 260         mutable int actcol;
 261         ///
 262         mutable int actrow;
 263         ///
 264         mutable int first_visible_cell;
 265         ///
 266         mutable int in_reset_pos;
 267 };
 268
 269
 270 #include "mailinset.h"
 271
 272
 273 class InsetTabularMailer : public MailInset {
 274 public:
 275         ///
 276         InsetTabularMailer(InsetTabular const & inset);
 277         ///
 278         virtual InsetBase & inset() const { return inset_; }
 279         ///
 280         virtual std::string const & name() const { return name_; }
 281         ///
 282         virtual std::string const inset2string(Buffer const &) const;
 283         /// Returns the active cell if successful, else -1.
 284         static int string2params(std::string const &, InsetTabular &);
 285         ///
 286         static std::string const params2string(InsetTabular const &);
 287 private:
 288         ///
 289         static std::string const name_;
 290         ///
 291         InsetTabular & inset_;
 292 };
 293
 294 std::string const featureAsString(LyXTabular::Feature feature);
 295
 296 #endif