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