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