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