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 #ifdef __GNUG__
  49 #pragma interface
  50 #endif
  51
  52 #include "inset.h"
  53 #include "tabular.h"
  54 #include "LString.h"
  55 #include "lyxcursor.h"
  56 #include "FuncStatus.h"
  57
  58 #include <boost/scoped_ptr.hpp>
  59
  60 #include <boost/signals/signal0.hpp>
  61
  62 class LyXLex;
  63 class Painter;
  64 class BufferView;
  65 class Buffer;
  66 class Paragraph;
  67
  68 class InsetTabular : public UpdatableInset {
  69 public:
  70         ///
  71         enum UpdateCodes {
  72                 NONE = 0,
  73                 CURSOR = 1,
  74                 CELL = 2,
  75                 SELECTION = 3,
  76                 FULL = 4,
  77                 INIT = 5
  78         };
  79         ///
  80         InsetTabular(Buffer const &, int rows = 1, int columns = 1);
  81         ///
  82         InsetTabular(InsetTabular const &, Buffer const &, bool same_id = false);
  83         ///
  84         ~InsetTabular();
  85         ///
  86         Inset * clone(Buffer const &, bool same_id = false) const;
  87         ///
  88         void read(Buffer const *, LyXLex &);
  89         ///
  90         void write(Buffer const *, std::ostream &) const;
  91         ///
  92         int ascent(BufferView *, LyXFont const &) const;
  93         ///
  94         int descent(BufferView *, LyXFont const &) const;
  95         ///
  96         int width(BufferView *, LyXFont const & f) const;
  97         ///
  98         void draw(BufferView *, const LyXFont &, int , float &, bool) const;
  99         ///
 100         void update(BufferView *, LyXFont const &, bool = false);
 101         ///
 102         string const editMessage() const;
 103         ///
 104         void edit(BufferView *, int x, int y, mouse_button::state);
 105         ///
 106         void edit(BufferView * bv, bool front = true);
 107         ///
 108         bool doClearArea() const;
 109         ///
 110         void insetUnlock(BufferView *);
 111         ///
 112         void updateLocal(BufferView *, UpdateCodes, bool mark_dirty) const;
 113         ///
 114         bool lockInsetInInset(BufferView *, UpdatableInset *);
 115         ///
 116         bool unlockInsetInInset(BufferView *, UpdatableInset *,
 117                                 bool lr = false);
 118         ///
 119         bool updateInsetInInset(BufferView *, Inset *);
 120         ///
 121         int insetInInsetY() const;
 122         ///
 123         UpdatableInset * getLockingInset() const;
 124         ///
 125         UpdatableInset * getFirstLockingInsetOfType(Inset::Code);
 126         ///
 127         bool insertInset(BufferView *, Inset *);
 128         ///
 129         bool insetAllowed(Inset::Code code) const;
 130         ///
 131         bool isTextInset() const { return true; }
 132         /** returns true if, when outputing LaTeX, font changes should
 133             be closed before generating this inset. This is needed for
 134             insets that may contain several paragraphs */
 135         bool noFontChange() const { return true; }
 136         ///
 137         bool display() const { return tabular->IsLongTabular(); }
 138         ///
 139         RESULT localDispatch(FuncRequest const &);
 140         ///
 141         int latex(Buffer const *, std::ostream &, bool, bool) const;
 142         ///
 143         int ascii(Buffer const *, std::ostream &, int linelen) const;
 144         ///
 145         int linuxdoc(Buffer const *, std::ostream &) const;
 146         ///
 147         int docbook(Buffer const *, std::ostream &, bool mixcont) const;
 148         ///
 149         void validate(LaTeXFeatures & features) const;
 150         ///
 151         Inset::Code lyxCode() const { return Inset::TABULAR_CODE; }
 152         ///
 153         void getCursorPos(BufferView *, int & x, int & y) const;
 154         ///
 155         void toggleInsetCursor(BufferView *);
 156         ///
 157         bool tabularFeatures(BufferView * bv, string const & what);
 158         ///
 159         void tabularFeatures(BufferView * bv, LyXTabular::Feature feature,
 160                              string const & val = string());
 161         ///
 162         int getActCell() const { return actcell; }
 163         ///
 164         void setFont(BufferView *, LyXFont const &, bool toggleall = false,
 165                      bool selectall = false);
 166         ///
 167         int getMaxWidth(BufferView *, UpdatableInset const *) const;
 168         ///
 169         Buffer * bufferOwner() const { return const_cast<Buffer *>(buffer); }
 170         ///
 171         LyXText * getLyXText(BufferView const *,
 172                              bool const recursive = false) const;
 173         ///
 174         void deleteLyXText(BufferView *, bool recursive = true) const;
 175         ///
 176         void resizeLyXText(BufferView *, bool force = false) const;
 177         ///
 178         void openLayoutDialog(BufferView *) const;
 179         ///
 180         bool showInsetDialog(BufferView *) const;
 181         ///
 182         FuncStatus getStatus(string const & argument) const;
 183         ///
 184         std::vector<string> const getLabelList() const;
 185         ///
 186         void nodraw(bool b) const {
 187                 UpdatableInset::nodraw(b);
 188         }
 189         bool nodraw() const;
 190         ///
 191         int scroll(bool recursive=true) const;
 192         ///
 193         void scroll(BufferView *bv, float sx) const {
 194                 UpdatableInset::scroll(bv, sx);
 195         }
 196         ///
 197         void scroll(BufferView *bv, int offset) const {
 198                 UpdatableInset::scroll(bv, offset);
 199         }
 200         ///
 201         Paragraph * getParFromID(int id) const;
 202         ///
 203         Inset * getInsetFromID(int id) const;
 204         ///
 205         Paragraph * firstParagraph() const;
 206         ///
 207         Paragraph * getFirstParagraph(int) const;
 208         ///
 209         LyXCursor const & cursor(BufferView *) const;
 210         ///
 211         bool allowSpellcheck() { return true; }
 212         ///
 213         WordLangTuple const
 214         selectNextWordToSpellcheck(BufferView *, float & value) const;
 215         ///
 216         void selectSelectedWord(BufferView *);
 217         ///
 218         void toggleSelection(BufferView *, bool kill_selection);
 219         ///
 220         bool searchForward(BufferView *, string const &,
 221                            bool = true, bool = false);
 222         bool searchBackward(BufferView *, string const &,
 223                             bool = true, bool = false);
 224
 225         // this should return true if we have a "normal" cell, otherwise true.
 226         // "normal" means without width set!
 227         bool forceDefaultParagraphs(Inset const * in) const;
 228
 229         ///
 230         void addPreview(grfx::PreviewLoader &) const;
 231
 232         //
 233         // Public structures and variables
 234         ///
 235         boost::scoped_ptr<LyXTabular> tabular;
 236         ///
 237         boost::signal0<void> hideDialog;
 238
 239         /// are some cells selected ?
 240         bool hasSelection() const {
 241                 return has_selection;
 242         }
 243 private:
 244         ///
 245         void lfunMousePress(FuncRequest const &);
 246         ///
 247         // the bool return is used to see if we opened a dialog so that we can
 248         // check this from an outer inset and open the dialog of the outer inset
 249         // if that one has one!
 250         ///
 251         bool lfunMouseRelease(FuncRequest const &);
 252         ///
 253         void lfunMouseMotion(FuncRequest const &);
 254         ///
 255         bool calculate_dimensions_of_cells(BufferView *, LyXFont const &,
 256                                            bool = false) const;
 257         ///
 258         void drawCellLines(Painter &, int x, int baseline,
 259                            int row, int cell) const;
 260         ///
 261         void drawCellSelection(Painter &, int x, int baseline,
 262                                int row, int column, int cell) const;
 263         ///
 264         void showInsetCursor(BufferView *, bool show=true);
 265         ///
 266         void hideInsetCursor(BufferView *);
 267         ///
 268         void fitInsetCursor(BufferView *) const;
 269         ///
 270         void setPos(BufferView *, int x, int y) const;
 271         ///
 272         RESULT moveRight(BufferView *, bool lock = true);
 273         ///
 274         RESULT moveLeft(BufferView *, bool lock = true);
 275         ///
 276         RESULT moveUp(BufferView *, bool lock = true);
 277         ///
 278         RESULT moveDown(BufferView *, bool lock = true);
 279         ///
 280         bool moveNextCell(BufferView *, bool lock = false);
 281         ///
 282         bool movePrevCell(BufferView *, bool lock = false);
 283         ///
 284         bool deletable() const;
 285         ///
 286         int getCellXPos(int cell) const;
 287         ///
 288         void resetPos(BufferView *) const;
 289         ///
 290         void removeTabularRow();
 291         ///
 292         void clearSelection() const {
 293                 sel_cell_start = sel_cell_end = 0;
 294                 has_selection = false;
 295         }
 296         void setSelection(int start, int end) const {
 297                 sel_cell_start = start;
 298                 sel_cell_end = end;
 299                 has_selection = true;
 300         }
 301         ///
 302         bool activateCellInset(BufferView *, int x = 0, int y = 0,
 303                                mouse_button::state button = mouse_button::none,
 304                                bool behind = false);
 305         ///
 306         bool activateCellInsetAbs(BufferView *, int x = 0, int y = 0,
 307                                   mouse_button::state button = mouse_button::none);
 308         ///
 309         bool insetHit(BufferView * bv, int x, int y) const;
 310         ///
 311         int getMaxWidthOfCell(BufferView * bv, int cell) const;
 312         ///
 313         bool hasPasteBuffer() const;
 314         ///
 315         bool copySelection(BufferView *);
 316         ///
 317         bool pasteSelection(BufferView *);
 318         ///
 319         bool cutSelection();
 320         ///
 321         bool isRightToLeft(BufferView *);
 322         ///
 323         void getSelection(int & scol, int & ecol,
 324                           int & srow, int & erow) const;
 325         ///
 326         WordLangTuple selectNextWordInt(BufferView *, float & value) const;
 327         ///
 328         bool insertAsciiString(BufferView *, string const & buf, bool usePaste);
 329
 330         //
 331         // Private structures and variables
 332         ///
 333         InsetText * the_locking_inset;
 334         ///
 335         InsetText * old_locking_inset;
 336         ///
 337         Buffer const * buffer;
 338         ///
 339         mutable LyXCursor cursor_;
 340         ///
 341         mutable unsigned int inset_x;
 342         ///
 343         mutable unsigned int inset_y;
 344         /// true if a set of cells are selected
 345         mutable bool has_selection;
 346         /// the starting cell selection nr
 347         mutable int sel_cell_start;
 348         /// the ending cell selection nr
 349         mutable int sel_cell_end;
 350         ///
 351         mutable int actcell;
 352         ///
 353         mutable int oldcell;
 354         ///
 355         mutable int actcol;
 356         ///
 357         mutable int actrow;
 358         ///
 359         mutable int first_visible_cell;
 360         ///
 361         bool no_selection;
 362         ///
 363         mutable bool locked;
 364         ///
 365         mutable UpdateCodes need_update;
 366         ///
 367         bool in_update;
 368         ///
 369         mutable int in_reset_pos;
 370 };
 371 #endif