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 Lars Gullik Bjønnes
   8  * \author Matthias Ettrich
   9  * \author André Pönitz
  10  * \author Jürgen Vigna
  11  *
  12  * Full author contact details are available in file CREDITS.
  13  */
  14
  15
  16 // This is Juergen's rewrite of the tabular (table) support.
  17
  18 // Things to think of when designing the new tabular support:
  19 // - color support (colortbl, color)
  20 // - decimal alignment (dcloumn)
  21 // - custom lines (hhline)
  22 // - rotation
  23 // - multicolumn
  24 // - multirow
  25 // - column styles
  26
  27 // This is what I have written about tabular support in the LyX3-Tasks file:
  28 //
  29 //  o rewrite of table code. Should probably be written as some
  30 //    kind of an inset. [Done]
  31 // o enhance longtable support
  32
  33 // Lgb
  34
  35 #ifndef INSET_TABULAR_H
  36 #define INSET_TABULAR_H
  37
  38 #include "Inset.h"
  39 #include "InsetText.h"
  40 #include "Layout.h"
  41 #include "Length.h"
  42
  43 #include <boost/shared_ptr.hpp>
  44
  45 #include <iosfwd>
  46 #include <vector>
  47
  48 namespace lyx {
  49
  50 class Buffer;
  51 class BufferParams;
  52 class BufferView;
  53 class CompletionList;
  54 class CursorSlice;
  55 class InsetTableCell;
  56 class FuncStatus;
  57 class Lexer;
  58 class Paragraph;
  59
  60 namespace frontend { class Painter; }
  61
  62
  63 class InsetTabular;
  64 class Cursor;
  65 class OutputParams;
  66
  67 //
  68 // A helper struct for tables
  69 //
  70 class Tabular {
  71 public:
  72         ///
  73         enum Feature {
  74                 ///
  75                 APPEND_ROW = 0,
  76                 ///
  77                 APPEND_COLUMN,
  78                 ///
  79                 DELETE_ROW,
  80                 ///
  81                 DELETE_COLUMN,
  82                 ///
  83                 COPY_ROW,
  84                 ///
  85                 COPY_COLUMN,
  86                 ///
  87                 TOGGLE_LINE_TOP,
  88                 ///
  89                 TOGGLE_LINE_BOTTOM,
  90                 ///
  91                 TOGGLE_LINE_LEFT,
  92                 ///
  93                 TOGGLE_LINE_RIGHT,
  94                 ///
  95                 ALIGN_LEFT,
  96                 ///
  97                 ALIGN_RIGHT,
  98                 ///
  99                 ALIGN_CENTER,
 100                 ///
 101                 ALIGN_BLOCK,
 102                 ///
 103                 VALIGN_TOP,
 104                 ///
 105                 VALIGN_BOTTOM,
 106                 ///
 107                 VALIGN_MIDDLE,
 108                 ///
 109                 M_ALIGN_LEFT,
 110                 ///
 111                 M_ALIGN_RIGHT,
 112                 ///
 113                 M_ALIGN_CENTER,
 114                 ///
 115                 M_VALIGN_TOP,
 116                 ///
 117                 M_VALIGN_BOTTOM,
 118                 ///
 119                 M_VALIGN_MIDDLE,
 120                 ///
 121                 MULTICOLUMN,
 122                 ///
 123                 SET_ALL_LINES,
 124                 ///
 125                 UNSET_ALL_LINES,
 126                 ///
 127                 SET_LONGTABULAR,
 128                 ///
 129                 UNSET_LONGTABULAR,
 130                 ///
 131                 SET_PWIDTH,
 132                 ///
 133                 SET_MPWIDTH,
 134                 ///
 135                 SET_ROTATE_TABULAR,
 136                 ///
 137                 UNSET_ROTATE_TABULAR,
 138                 ///
 139                 TOGGLE_ROTATE_TABULAR,
 140                 ///
 141                 SET_ROTATE_CELL,
 142                 ///
 143                 UNSET_ROTATE_CELL,
 144                 ///
 145                 TOGGLE_ROTATE_CELL,
 146                 ///
 147                 SET_USEBOX,
 148                 ///
 149                 SET_LTHEAD,
 150                 UNSET_LTHEAD,
 151                 ///
 152                 SET_LTFIRSTHEAD,
 153                 UNSET_LTFIRSTHEAD,
 154                 ///
 155                 SET_LTFOOT,
 156                 UNSET_LTFOOT,
 157                 ///
 158                 SET_LTLASTFOOT,
 159                 UNSET_LTLASTFOOT,
 160                 ///
 161                 SET_LTNEWPAGE,
 162                 ///
 163                 SET_SPECIAL_COLUMN,
 164                 ///
 165                 SET_SPECIAL_MULTI,
 166                 ///
 167                 SET_BOOKTABS,
 168                 ///
 169                 UNSET_BOOKTABS,
 170                 ///
 171                 SET_TOP_SPACE,
 172                 ///
 173                 SET_BOTTOM_SPACE,
 174                 ///
 175                 SET_INTERLINE_SPACE,
 176                 ///
 177                 SET_BORDER_LINES,
 178                 ///
 179                 LAST_ACTION
 180         };
 181         ///
 182         enum {
 183                 ///
 184                 CELL_NORMAL = 0,
 185                 ///
 186                 CELL_BEGIN_OF_MULTICOLUMN,
 187                 ///
 188                 CELL_PART_OF_MULTICOLUMN
 189         };
 190
 191         ///
 192         enum VAlignment {
 193                 ///
 194                 LYX_VALIGN_TOP = 0,
 195                 ///
 196                 LYX_VALIGN_BOTTOM = 1,
 197                 ///
 198                 LYX_VALIGN_MIDDLE = 2
 199         };
 200
 201         enum BoxType {
 202                 ///
 203                 BOX_NONE = 0,
 204                 ///
 205                 BOX_PARBOX = 1,
 206                 ///
 207                 BOX_MINIPAGE = 2
 208         };
 209
 210         class ltType {
 211         public:
 212                 // constructor
 213                 ltType();
 214                 // we have this header type (is set in the getLT... functions)
 215                 bool set;
 216                 // double borders on top
 217                 bool topDL;
 218                 // double borders on bottom
 219                 bool bottomDL;
 220                 // used for FirstHeader & LastFooter and if this is true
 221                 // all the rows marked as FirstHeader or LastFooter are
 222                 // ignored in the output and it is set to be empty!
 223                 bool empty;
 224         };
 225
 226         /// type for row numbers
 227         typedef size_t row_type;
 228         /// type for column numbers
 229         typedef size_t col_type;
 230         /// type for cell indices
 231         typedef size_t idx_type;
 232         /// index indicating an invalid position
 233         static const idx_type npos = static_cast<idx_type>(-1);
 234
 235         /// constructor
 236         Tabular(Buffer const &, col_type columns_arg, row_type rows_arg);
 237
 238         /// Returns true if there is a topline, returns false if not
 239         bool topLine(idx_type cell) const;
 240         /// Returns true if there is a topline, returns false if not
 241         bool bottomLine(idx_type cell) const;
 242         /// Returns true if there is a topline, returns false if not
 243         bool leftLine(idx_type cell) const;
 244         /// Returns true if there is a topline, returns false if not
 245         bool rightLine(idx_type cell) const;
 246
 247         ///
 248         bool topAlreadyDrawn(idx_type cell) const;
 249         ///
 250         bool leftAlreadyDrawn(idx_type cell) const;
 251         ///
 252         bool isLastRow(idx_type cell) const;
 253
 254         /// return space occupied by the second horizontal line and
 255         /// interline space above row \p row in pixels
 256         int getAdditionalHeight(row_type row) const;
 257         ///
 258         int getAdditionalWidth(idx_type cell) const;
 259
 260         /* returns the maximum over all rows */
 261         ///
 262         int columnWidth(idx_type cell) const;
 263         ///
 264         int width() const;
 265         ///
 266         int height() const;
 267         ///
 268         int rowAscent(row_type row) const;
 269         ///
 270         int rowDescent(row_type row) const;
 271         ///
 272         void setRowAscent(row_type row, int height);
 273         ///
 274         void setRowDescent(row_type row, int height);
 275         ///
 276         void setCellWidth(idx_type cell, int new_width);
 277         ///
 278         void setAllLines(idx_type cell, bool line);
 279         ///
 280         void setTopLine(idx_type cell, bool line);
 281         ///
 282         void setBottomLine(idx_type cell, bool line);
 283         ///
 284         void setLeftLine(idx_type cell, bool line);
 285         ///
 286         void setRightLine(idx_type cell, bool line);
 287         ///
 288         bool rowTopLine(row_type row) const;
 289         ///
 290         bool rowBottomLine(row_type row) const;
 291         ///
 292         bool columnLeftLine(col_type column) const;
 293         ///
 294         bool columnRightLine(col_type column) const;
 295
 296         void setAlignment(idx_type cell, LyXAlignment align,
 297                           bool onlycolumn = false);
 298         ///
 299         void setVAlignment(idx_type cell, VAlignment align,
 300                            bool onlycolumn = false);
 301         ///
 302         void setColumnPWidth(Cursor &, idx_type, Length const &);
 303         ///
 304         bool setMColumnPWidth(Cursor &, idx_type, Length const &);
 305         ///
 306         void setAlignSpecial(idx_type cell, docstring const & special,
 307                              Feature what);
 308         ///
 309         LyXAlignment getAlignment(idx_type cell,
 310                                   bool onlycolumn = false) const;
 311         ///
 312         VAlignment getVAlignment(idx_type cell,
 313                                  bool onlycolumn = false) const;
 314         ///
 315         Length const getPWidth(idx_type cell) const;
 316         ///
 317         Length const getColumnPWidth(idx_type cell) const;
 318         ///
 319         Length const getMColumnPWidth(idx_type cell) const;
 320         ///
 321         docstring const getAlignSpecial(idx_type cell, int what) const;
 322         ///
 323         int cellWidth(idx_type cell) const;
 324         ///
 325         int getBeginningOfTextInCell(idx_type cell) const;
 326         ///
 327         void appendRow(idx_type cell);
 328         ///
 329         void deleteRow(row_type row);
 330         ///
 331         void copyRow(row_type);
 332         ///
 333         void appendColumn(idx_type cell);
 334         ///
 335         void deleteColumn(col_type column);
 336         ///
 337         void copyColumn(col_type);
 338         ///
 339         bool isFirstCellInRow(idx_type cell) const;
 340         ///
 341         idx_type getFirstCellInRow(row_type row) const;
 342         ///
 343         bool isLastCellInRow(idx_type cell) const;
 344         ///
 345         idx_type getLastCellInRow(row_type row) const;
 346         ///
 347         idx_type numberOfCellsInRow(idx_type cell) const;
 348         ///
 349         void write(std::ostream &) const;
 350         ///
 351         void read(Lexer &);
 352         ///
 353         int latex(odocstream &, OutputParams const &) const;
 354         //
 355         int docbook(odocstream & os, OutputParams const &) const;
 356         ///
 357         void plaintext(odocstream &,
 358                        OutputParams const & runparams, int const depth,
 359                        bool onlydata, char_type delim) const;
 360         ///
 361         bool isMultiColumn(idx_type cell) const;
 362         ///
 363         bool isMultiColumnReal(idx_type cell) const;
 364         ///
 365         void setMultiColumn(idx_type cell, idx_type number);
 366         ///
 367         idx_type unsetMultiColumn(idx_type cell); // returns number of new cells
 368         ///
 369         bool isPartOfMultiColumn(row_type row, col_type column) const;
 370         ///
 371         row_type cellRow(idx_type cell) const;
 372         ///
 373         col_type cellColumn(idx_type cell) const;
 374         ///
 375         col_type cellRightColumn(idx_type cell) const;
 376         ///
 377         void setRotateCell(idx_type cell, bool);
 378         ///
 379         bool getRotateCell(idx_type cell) const;
 380         ///
 381         bool needRotating() const;
 382         ///
 383         bool isLastCell(idx_type cell) const;
 384         ///
 385         idx_type cellAbove(idx_type cell) const;
 386         ///
 387         idx_type cellBelow(idx_type cell) const;
 388         ///
 389         idx_type cellIndex(row_type row, col_type column) const;
 390         ///
 391         void setUsebox(idx_type cell, BoxType);
 392         ///
 393         BoxType getUsebox(idx_type cell) const;
 394         //
 395         // Long Tabular Options support functions
 396         ///
 397         bool checkLTType(row_type row, ltType const &) const;
 398         ///
 399         void setLTHead(row_type row, bool flag, ltType const &, bool first);
 400         ///
 401         bool getRowOfLTHead(row_type row, ltType &) const;
 402         ///
 403         bool getRowOfLTFirstHead(row_type row, ltType &) const;
 404         ///
 405         void setLTFoot(row_type row, bool flag, ltType const &, bool last);
 406         ///
 407         bool getRowOfLTFoot(row_type row, ltType &) const;
 408         ///
 409         bool getRowOfLTLastFoot(row_type row, ltType &) const;
 410         ///
 411         void setLTNewPage(row_type row, bool what);
 412         ///
 413         bool getLTNewPage(row_type row) const;
 414         ///
 415         bool haveLTHead() const;
 416         ///
 417         bool haveLTFirstHead() const;
 418         ///
 419         bool haveLTFoot() const;
 420         ///
 421         bool haveLTLastFoot() const;
 422         ///
 423         // end longtable support
 424         ///
 425         boost::shared_ptr<InsetTableCell> cellInset(idx_type cell) const;
 426         ///
 427         boost::shared_ptr<InsetTableCell> cellInset(row_type row,
 428                                                   col_type column) const;
 429         ///
 430         void setCellInset(row_type row, col_type column,
 431                           boost::shared_ptr<InsetTableCell>) const;
 432         /// Search for \param inset in the tabular, with the
 433         ///
 434         idx_type cellFromInset(Inset const * inset) const;
 435         ///
 436         void validate(LaTeXFeatures &) const;
 437         ///
 438 //private:
 439         ///
 440         class CellData {
 441         public:
 442                 ///
 443                 CellData(Buffer const &, Tabular const &);
 444                 ///
 445                 CellData(CellData const &);
 446                 ///
 447                 CellData & operator=(CellData);
 448                 ///
 449                 void swap(CellData & rhs);
 450                 ///
 451                 idx_type cellno;
 452                 ///
 453                 int width;
 454                 ///
 455                 int multicolumn;
 456                 ///
 457                 LyXAlignment alignment;
 458                 ///
 459                 VAlignment valignment;
 460                 ///
 461                 bool top_line;
 462                 ///
 463                 bool bottom_line;
 464                 ///
 465                 bool left_line;
 466                 ///
 467                 bool right_line;
 468                 ///
 469                 BoxType usebox;
 470                 ///
 471                 bool rotate;
 472                 ///
 473                 docstring align_special;
 474                 ///
 475                 Length p_width; // this is only set for multicolumn!!!
 476                 ///
 477                 boost::shared_ptr<InsetTableCell> inset;
 478         };
 479         CellData & cellInfo(idx_type cell) const;
 480         ///
 481         typedef std::vector<CellData> cell_vector;
 482         ///
 483         typedef std::vector<cell_vector> cell_vvector;
 484
 485         ///
 486         class RowData {
 487         public:
 488                 ///
 489                 RowData();
 490                 ///
 491                 int ascent;
 492                 ///
 493                 int descent;
 494                 ///
 495                 bool top_line;
 496                 ///
 497                 bool bottom_line;
 498                 /// Extra space between the top line and this row
 499                 Length top_space;
 500                 /// Ignore top_space if true and use the default top space
 501                 bool top_space_default;
 502                 /// Extra space between this row and the bottom line
 503                 Length bottom_space;
 504                 /// Ignore bottom_space if true and use the default bottom space
 505                 bool bottom_space_default;
 506                 /// Extra space between the bottom line and the next top line
 507                 Length interline_space;
 508                 /// Ignore interline_space if true and use the default interline space
 509                 bool interline_space_default;
 510                 /// This are for longtabulars only
 511                 /// a row of endhead
 512                 bool endhead;
 513                 /// a row of endfirsthead
 514                 bool endfirsthead;
 515                 /// a row of endfoot
 516                 bool endfoot;
 517                 /// row of endlastfoot
 518                 bool endlastfoot;
 519                 /// row for a newpage
 520                 bool newpage;
 521         };
 522         ///
 523         typedef std::vector<RowData> row_vector;
 524
 525         ///
 526         class ColumnData {
 527                 public:
 528                 ///
 529                 ColumnData();
 530                 ///
 531                 LyXAlignment alignment;
 532                 ///
 533                 VAlignment valignment;
 534                 ///
 535                 bool left_line;
 536                 ///
 537                 bool right_line;
 538                 ///
 539                 int width;
 540                 ///
 541                 Length p_width;
 542                 ///
 543                 docstring align_special;
 544         };
 545         ///
 546         typedef std::vector<ColumnData> column_vector;
 547
 548         ///
 549         idx_type numberofcells;
 550         ///
 551         std::vector<row_type> rowofcell;
 552         ///
 553         std::vector<col_type> columnofcell;
 554         ///
 555         row_vector row_info;
 556         ///
 557         column_vector column_info;
 558         ///
 559         mutable cell_vvector cell_info;
 560         ///
 561         bool use_booktabs;
 562         ///
 563         bool rotate;
 564         //
 565         // for long tabulars
 566         //
 567         bool is_long_tabular;
 568         /// endhead data
 569         ltType endhead;
 570         /// endfirsthead data
 571         ltType endfirsthead;
 572         /// endfoot data
 573         ltType endfoot;
 574         /// endlastfoot data
 575         ltType endlastfoot;
 576
 577         ///
 578         void init(Buffer const &, row_type rows_arg,
 579                   col_type columns_arg);
 580         ///
 581         void updateIndexes();
 582         /// return true of update is needed
 583         bool updateColumnWidths();
 584         ///
 585         idx_type columnSpan(idx_type cell) const;
 586         ///
 587         BoxType useParbox(idx_type cell) const;
 588         ///
 589         // helper function for Latex returns number of newlines
 590         ///
 591         int TeXTopHLine(odocstream &, row_type row) const;
 592         ///
 593         int TeXBottomHLine(odocstream &, row_type row) const;
 594         ///
 595         int TeXCellPreamble(odocstream &, idx_type cell, bool & ismulticol) const;
 596         ///
 597         int TeXCellPostamble(odocstream &, idx_type cell, bool ismulticol) const;
 598         ///
 599         int TeXLongtableHeaderFooter(odocstream &, OutputParams const &) const;
 600         ///
 601         bool isValidRow(row_type const row) const;
 602         ///
 603         int TeXRow(odocstream &, row_type const row,
 604                    OutputParams const &) const;
 605         ///
 606         // helper functions for plain text
 607         ///
 608         bool plaintextTopHLine(odocstream &, row_type row,
 609                                std::vector<unsigned int> const &) const;
 610         ///
 611         bool plaintextBottomHLine(odocstream &, row_type row,
 612                                   std::vector<unsigned int> const &) const;
 613         ///
 614         void plaintextPrintCell(odocstream &,
 615                                 OutputParams const &,
 616                                 idx_type cell, row_type row, col_type column,
 617                                 std::vector<unsigned int> const &,
 618                                 bool onlydata) const;
 619         /// auxiliary function for docbook
 620         int docbookRow(odocstream & os, row_type, OutputParams const &) const;
 621
 622         /// change associated Buffer
 623         void setBuffer(Buffer const & buffer) { buffer_ = &buffer; }
 624         /// retrieve associated Buffer
 625         Buffer const & buffer() const { return *buffer_; }
 626
 627 private:
 628         Buffer const * buffer_;
 629
 630 }; // Tabular
 631
 632
 633 ///
 634 class InsetTableCell : public InsetText
 635 {
 636 public:
 637         ///
 638         InsetTableCell(Buffer const & buf,
 639                 Tabular::CellData const * cd, Tabular const * t);
 640         ///
 641         InsetCode lyxCode() const { return CELL_CODE; }
 642         ///
 643         Inset * clone() { return new InsetTableCell(*this); }
 644         ///
 645         virtual bool useEmptyLayout() const { return true; }
 646         ///
 647         virtual bool forceEmptyLayout(idx_type = 0) const;
 648         ///
 649         virtual bool allowParagraphCustomization(idx_type = 0) const;
 650         ///
 651         bool getStatus(Cursor & cur, FuncRequest const & cmd,
 652                 FuncStatus & status) const;
 653         ///
 654         virtual bool neverIndent() { return true; }
 655         ///
 656         void setCellData(Tabular::CellData const * cd) { cell_data_ = cd; }
 657         ///
 658         void setTabular(Tabular const * t) { table_ = t; }
 659 private:
 660         /// unimplemented
 661         InsetTableCell();
 662         /// unimplemented
 663         void operator=(InsetTableCell const &);
 664
 665         ///
 666         Tabular::CellData const * cell_data_;
 667         ///
 668         Tabular const * table_;
 669 };
 670
 671
 672 class InsetTabular : public Inset
 673 {
 674 public:
 675         ///
 676         InsetTabular(Buffer const &, row_type rows = 1,
 677                      col_type columns = 1);
 678         ///
 679         ~InsetTabular();
 680         ///
 681         static void string2params(std::string const &, InsetTabular &);
 682         ///
 683         static std::string params2string(InsetTabular const &);
 684         ///
 685         void read(Lexer &);
 686         ///
 687         void write(std::ostream &) const;
 688         ///
 689         void metrics(MetricsInfo &, Dimension &) const;
 690         ///
 691         void draw(PainterInfo & pi, int x, int y) const;
 692         ///
 693         void drawSelection(PainterInfo & pi, int x, int y) const;
 694         ///
 695         docstring editMessage() const;
 696         ///
 697         EDITABLE editable() const { return HIGHLY_EDITABLE; }
 698         ///
 699         bool insetAllowed(InsetCode code) const;
 700         ///
 701         bool allowSpellCheck() const { return true; }
 702         ///
 703         bool canTrackChanges() const { return true; }
 704         /** returns true if, when outputing LaTeX, font changes should
 705             be closed before generating this inset. This is needed for
 706             insets that may contain several paragraphs */
 707         bool noFontChange() const { return true; }
 708         ///
 709         DisplayType display() const { return tabular.is_long_tabular ? AlignCenter : Inline; }
 710         ///
 711         int latex(odocstream &, OutputParams const &) const;
 712         ///
 713         int plaintext(odocstream &, OutputParams const &) const;
 714         ///
 715         int docbook(odocstream &, OutputParams const &) const;
 716         ///
 717         void validate(LaTeXFeatures & features) const;
 718         ///
 719         InsetCode lyxCode() const { return TABULAR_CODE; }
 720         ///
 721         docstring contextMenu(BufferView const & bv, int x, int y) const;
 722         /// get offset of this cursor slice relative to our upper left corner
 723         void cursorPos(BufferView const & bv, CursorSlice const & sl,
 724                 bool boundary, int & x, int & y) const;
 725         ///
 726         bool tabularFeatures(Cursor & cur, std::string const & what);
 727         ///
 728         void tabularFeatures(Cursor & cur, Tabular::Feature feature,
 729                              std::string const & val = std::string());
 730         ///
 731         void openLayoutDialog(BufferView *) const;
 732         ///
 733         bool showInsetDialog(BufferView *) const;
 734         /// number of cells
 735         size_t nargs() const { return tabular.numberofcells; }
 736         ///
 737         boost::shared_ptr<InsetTableCell const> cell(idx_type) const;
 738         ///
 739         boost::shared_ptr<InsetTableCell> cell(idx_type);
 740         ///
 741         Text * getText(int) const;
 742
 743         /// set the change for the entire inset
 744         void setChange(Change const & change);
 745         /// accept the changes within the inset
 746         void acceptChanges(BufferParams const & bparams);
 747         /// reject the changes within the inset
 748         void rejectChanges(BufferParams const & bparams);
 749
 750         // this should return true if we have a "normal" cell, otherwise false.
 751         // "normal" means without width set!
 752         /// should all paragraphs be output with "Standard" layout?
 753         virtual bool allowParagraphCustomization(idx_type cell = 0) const;
 754         ///
 755         virtual bool forceEmptyLayout(idx_type cell = 0) const;
 756         ///
 757         virtual bool useEmptyLayout() { return true; }
 758         ///
 759         void addPreview(graphics::PreviewLoader &) const;
 760
 761         /// lock cell with given index
 762         void edit(Cursor & cur, bool front, EntryDirection entry_from);
 763         /// get table row from x coordinate
 764         int rowFromY(Cursor & cur, int y) const;
 765         /// get table column from y coordinate
 766         int columnFromX(Cursor & cur, int x) const;
 767         ///
 768         Inset * editXY(Cursor & cur, int x, int y);
 769         /// can we go further down on mouse click?
 770         bool descendable() const { return true; }
 771         // Update the counters of this inset and of its contents
 772         void updateLabels(ParIterator const &);
 773
 774         ///
 775         bool completionSupported(Cursor const &) const;
 776         ///
 777         bool inlineCompletionSupported(Cursor const & cur) const;
 778         ///
 779         bool automaticInlineCompletion() const;
 780         ///
 781         bool automaticPopupCompletion() const;
 782         ///
 783         bool showCompletionCursor() const;
 784         ///
 785         CompletionList const * createCompletionList(Cursor const & cur) const;
 786         ///
 787         docstring completionPrefix(Cursor const & cur) const;
 788         ///
 789         bool insertCompletion(Cursor & cur, docstring const & s, bool finished);
 790         ///
 791         void completionPosAndDim(Cursor const &, int & x, int & y, Dimension & dim) const;
 792
 793         ///
 794         virtual InsetTabular * asInsetTabular() { return this; }
 795         ///
 796         virtual InsetTabular const * asInsetTabular() const { return this; }
 797         ///
 798         bool isRightToLeft(Cursor & cur) const;
 799
 800         //
 801         // Public structures and variables
 802         ///
 803         mutable Tabular tabular;
 804
 805 private:
 806         ///
 807         InsetTabular(InsetTabular const &);
 808         ///
 809         void doDispatch(Cursor & cur, FuncRequest & cmd);
 810         ///
 811         bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
 812         ///
 813         int scroll() const { return scx_; }
 814         ///
 815         Inset * clone() const { return new InsetTabular(*this); }
 816
 817         ///
 818         void drawCellLines(frontend::Painter &, int x, int y, row_type row,
 819                            idx_type cell, bool erased) const;
 820         ///
 821         void setCursorFromCoordinates(Cursor & cur, int x, int y) const;
 822
 823         ///
 824         void moveNextCell(Cursor & cur,
 825                                 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
 826         ///
 827         void movePrevCell(Cursor & cur,
 828                                 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
 829         ///
 830         int cellXPos(idx_type cell) const;
 831         ///
 832         void resetPos(Cursor & cur) const;
 833         ///
 834         void removeTabularRow();
 835         ///
 836         bool copySelection(Cursor & cur);
 837         ///
 838         bool pasteClipboard(Cursor & cur);
 839         ///
 840         void cutSelection(Cursor & cur);
 841         ///
 842         void getSelection(Cursor & cur, row_type & rs, row_type & re,
 843                           col_type & cs, col_type & ce) const;
 844         ///
 845         bool insertPlaintextString(BufferView &, docstring const & buf, bool usePaste);
 846         /// are we operating on several cells?
 847         bool tablemode(Cursor & cur) const;
 848
 849         /// return the "Manhattan distance" to nearest corner
 850         int dist(BufferView &, idx_type cell, int x, int y) const;
 851         /// return the cell nearest to x, y
 852         idx_type getNearestCell(BufferView &, int x, int y) const;
 853
 854         /// test the rotation state of the give cell range.
 855         bool oneCellHasRotationState(bool rotated,
 856                                 row_type row_start, row_type row_end,
 857                                 col_type col_start, col_type col_end) const;
 858         ///
 859         mutable idx_type first_visible_cell;
 860         ///
 861         mutable int scx_;
 862         /// true when selecting rows with the mouse
 863         bool rowselect_;
 864         /// true when selecting columns with the mouse
 865         bool colselect_;
 866 };
 867
 868 std::string const featureAsString(Tabular::Feature feature);
 869
 870 } // namespace lyx
 871
 872 #endif // INSET_TABULAR_H