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