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