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