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 &);
  80         ///
  81         ~InsetTabular();
  82         ///
  83         Inset * clone() const;
  84         ///
  85         void read(Buffer const *, LyXLex &);
  86         ///
  87         void write(Buffer const *, std::ostream &) const;
  88         ///
  89         void metrics(MetricsInfo &, Dimension &) const;
  90         ///
  91         void draw(PainterInfo & pi, int x, int y) 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         LyXText * getLyXText(BufferView const *,
 158                              bool const recursive = false) const;
 159         ///
 160         void deleteLyXText(BufferView *, bool recursive = true) const;
 161         ///
 162         void resizeLyXText(BufferView *, bool force = false) const;
 163         ///
 164         void openLayoutDialog(BufferView *) const;
 165         ///
 166         bool showInsetDialog(BufferView *) const;
 167         ///
 168         FuncStatus getStatus(string const & argument) const;
 169         ///
 170         std::vector<string> const getLabelList() const;
 171         ///
 172         void nodraw(bool b) const {
 173                 UpdatableInset::nodraw(b);
 174         }
 175         bool nodraw() const;
 176         ///
 177         int scroll(bool recursive=true) const;
 178         ///
 179         void scroll(BufferView *bv, float sx) const {
 180                 UpdatableInset::scroll(bv, sx);
 181         }
 182         ///
 183         void scroll(BufferView *bv, int offset) const {
 184                 UpdatableInset::scroll(bv, offset);
 185         }
 186         ///
 187         Inset * getInsetFromID(int id) const;
 188         ///
 189         ParagraphList * getParagraphs(int) const;
 190         ///
 191         LyXCursor const & cursor(BufferView *) const;
 192         ///
 193         bool allowSpellcheck() const { return true; }
 194         ///
 195         WordLangTuple const
 196         selectNextWordToSpellcheck(BufferView *, float & value) const;
 197         ///
 198         void selectSelectedWord(BufferView *);
 199         ///
 200         void toggleSelection(BufferView *, bool kill_selection);
 201
 202         void markErased();
 203
 204         /// find next change
 205         bool nextChange(BufferView *, lyx::pos_type & length);
 206         ///
 207         bool searchForward(BufferView *, string const &,
 208                            bool = true, bool = false);
 209         bool searchBackward(BufferView *, string const &,
 210                             bool = true, bool = false);
 211
 212         // this should return true if we have a "normal" cell, otherwise true.
 213         // "normal" means without width set!
 214         bool forceDefaultParagraphs(Inset const * in) const;
 215
 216         ///
 217         void addPreview(grfx::PreviewLoader &) const;
 218
 219         //
 220         // Public structures and variables
 221         ///
 222         boost::scoped_ptr<LyXTabular> tabular;
 223
 224         /// are some cells selected ?
 225         bool hasSelection() const {
 226                 return has_selection;
 227         }
 228
 229         ///
 230         virtual BufferView * view() const;
 231
 232         /// set the owning buffer
 233         void buffer(Buffer * b);
 234
 235 private:
 236         ///
 237         void lfunMousePress(FuncRequest const &);
 238         ///
 239         // the bool return is used to see if we opened a dialog so that we can
 240         // check this from an outer inset and open the dialog of the outer inset
 241         // if that one has one!
 242         ///
 243         bool lfunMouseRelease(FuncRequest const &);
 244         ///
 245         void lfunMouseMotion(FuncRequest const &);
 246         ///
 247         bool calculate_dimensions_of_cells(BufferView *, bool = false) const;
 248         ///
 249         void drawCellLines(Painter &, int x, int baseline,
 250                            int row, int cell) const;
 251         ///
 252         void drawCellSelection(Painter &, int x, int baseline,
 253                                int row, int column, int cell) const;
 254         ///
 255         void fitInsetCursor(BufferView *) const;
 256         ///
 257         void setPos(BufferView *, int x, int y) const;
 258         ///
 259         RESULT moveRight(BufferView *, bool lock = true);
 260         ///
 261         RESULT moveLeft(BufferView *, bool lock = true);
 262         ///
 263         RESULT moveUp(BufferView *, bool lock = true);
 264         ///
 265         RESULT moveDown(BufferView *, bool lock = true);
 266         ///
 267         bool moveNextCell(BufferView *, bool lock = false);
 268         ///
 269         bool movePrevCell(BufferView *, bool lock = false);
 270         ///
 271         int getCellXPos(int cell) const;
 272         ///
 273         void resetPos(BufferView *) const;
 274         ///
 275         void removeTabularRow();
 276         ///
 277         void clearSelection() const {
 278                 sel_cell_start = sel_cell_end = 0;
 279                 has_selection = false;
 280         }
 281         void setSelection(int start, int end) const {
 282                 sel_cell_start = start;
 283                 sel_cell_end = end;
 284                 has_selection = true;
 285         }
 286         ///
 287         bool activateCellInset(BufferView *, int x = 0, int y = 0,
 288                                mouse_button::state button = mouse_button::none,
 289                                bool behind = false);
 290         ///
 291         bool activateCellInsetAbs(BufferView *, int x = 0, int y = 0,
 292                                   mouse_button::state button = mouse_button::none);
 293         ///
 294         bool insetHit(BufferView * bv, int x, int y) const;
 295         ///
 296         int getMaxWidthOfCell(BufferView * bv, int cell) const;
 297         ///
 298         bool hasPasteBuffer() const;
 299         ///
 300         bool copySelection(BufferView *);
 301         ///
 302         bool pasteSelection(BufferView *);
 303         ///
 304         bool cutSelection(BufferParams const & bp);
 305         ///
 306         bool isRightToLeft(BufferView *);
 307         ///
 308         void getSelection(int & scol, int & ecol,
 309                           int & srow, int & erow) const;
 310         ///
 311         WordLangTuple selectNextWordInt(BufferView *, float & value) const;
 312         ///
 313         bool insertAsciiString(BufferView *, string const & buf, bool usePaste);
 314
 315         //
 316         // Private structures and variables
 317         ///
 318         InsetText * the_locking_inset;
 319         ///
 320         InsetText * old_locking_inset;
 321         ///
 322         Buffer const * buffer_;
 323         ///
 324         mutable LyXCursor cursor_;
 325         ///
 326         mutable unsigned int inset_x;
 327         ///
 328         mutable unsigned int inset_y;
 329         /// true if a set of cells are selected
 330         mutable bool has_selection;
 331         /// the starting cell selection nr
 332         mutable int sel_cell_start;
 333         /// the ending cell selection nr
 334         mutable int sel_cell_end;
 335         ///
 336         mutable int actcell;
 337         ///
 338         mutable int oldcell;
 339         ///
 340         mutable int actcol;
 341         ///
 342         mutable int actrow;
 343         ///
 344         mutable int first_visible_cell;
 345         ///
 346         bool no_selection;
 347         ///
 348         mutable bool locked;
 349         ///
 350         mutable UpdateCodes need_update;
 351         ///
 352         bool in_update;
 353         ///
 354         mutable int in_reset_pos;
 355 };
 356
 357
 358 #include "mailinset.h"
 359
 360
 361 class InsetTabularMailer : public MailInset {
 362 public:
 363         ///
 364         InsetTabularMailer(InsetTabular & inset);
 365         ///
 366         virtual InsetBase & inset() const { return inset_; }
 367         ///
 368         virtual string const & name() const { return name_; }
 369         ///
 370         virtual string const inset2string() const;
 371         /// Returns the active cell if successful, else -1.
 372         static int string2params(string const &, InsetTabular &);
 373         ///
 374         static string const params2string(InsetTabular const &);
 375 private:
 376         ///
 377         static string const name_;
 378         ///
 379         InsetTabular & inset_;
 380 };
 381
 382 string const featureAsString(LyXTabular::Feature feature);
 383
 384 #endif