src/insets/insettabular.h

   1 // -*- C++ -*-
   2 /* This file is part of
   3  * ======================================================
   4  *
   5  *           LyX, The Document Processor
   6  *
   7  *           Copyright (C) 1995-2000 The LyX Team.
   8  *
   9  *======================================================
  10  */
  11 // This is the rewrite of the tabular (table) support.
  12
  13 // It will probably be a lot of work.
  14
  15 // One first goal could be to make the inset read the old table format
  16 // and just output it again... no viewing at all.
  17
  18 // When making the internal structure of tabular support I really think
  19 // that STL containers should be used. This will separate the container from
  20 // the rest of the code, which is a good thing.
  21
  22 // Ideally the tabular support should do as the mathed and use
  23 // LaTeX in the .lyx file too.
  24
  25 // Things to think of when desingning the new tabular support:
  26 // - color support (colortbl, color)
  27 // - decimal alignment (dcloumn)
  28 // - custom lines (hhline)
  29 // - rotation
  30 // - multicolumn
  31 // - multirow
  32 // - column styles
  33
  34 // This is what I have written about tabular support in the LyX3-Tasks file:
  35 //
  36 //  o rewrite of table code. Should probably be written as some
  37 //          kind of an inset. At least get the code out of the kernel.
  38 //                - colortbl  -multirow
  39 //                - hhline    -multicolumn
  40 //                - dcolumn
  41 // o enhance longtable support
  42
  43 // Lgb
  44
  45 #ifndef INSETTABULAR_H
  46 #define INSETTABULAR_H
  47
  48 #ifdef __GNUG__
  49 #pragma interface
  50 #endif
  51
  52 #include "lyxinset.h"
  53 #include "tabular.h"
  54 #include "LString.h"
  55 #include "lyxcursor.h"
  56
  57 class LyXLex;
  58 class Painter;
  59 class BufferView;
  60 class Buffer;
  61
  62 class InsetTabular : public UpdatableInset {
  63 public:
  64     ///
  65     InsetTabular(Buffer *, int rows=1, int columns=1);
  66     ///
  67     InsetTabular(InsetTabular const &, Buffer *);
  68     ///
  69     ~InsetTabular();
  70     ///
  71     Inset * Clone() const;
  72     ///
  73     void Read(LyXLex &);
  74     ///
  75     void Write(std::ostream &) const;
  76     ///
  77     int ascent(Painter &, LyXFont const &) const;
  78     ///
  79     int descent(Painter &, LyXFont const &) const;
  80     ///
  81     int width(Painter &, LyXFont const & f) const;
  82     ///
  83     void draw(Painter & pain, const LyXFont &, int , float &) const;
  84     ///
  85     const char * EditMessage() const;
  86     ///
  87     void Edit(BufferView *, int x, int y, unsigned int);
  88     ///
  89     void InsetUnlock(BufferView *);
  90     ///
  91     void UpdateLocal(BufferView *, bool flag = true);
  92     ///
  93     bool LockInsetInInset(BufferView *, UpdatableInset *);
  94     ///
  95     bool UnlockInsetInInset(BufferView *, UpdatableInset *, bool lr=false);
  96     ///
  97     bool UpdateInsetInInset(BufferView *, Inset *);
  98     ///
  99     int InsetInInsetY();
 100     ///
 101     bool display() const { return tabular->IsLongTabular(); }
 102     ///
 103     void InsetButtonRelease(BufferView *, int, int, int);
 104     ///
 105     void InsetButtonPress(BufferView *, int, int, int);
 106     ///
 107     void InsetMotionNotify(BufferView *, int, int, int);
 108     ///
 109     void InsetKeyPress(XKeyEvent *);
 110     ///
 111     UpdatableInset::RESULT LocalDispatch(BufferView *, int, string const &);
 112     ///
 113     int Latex(std::ostream &, bool, bool) const;
 114     ///
 115     int Ascii(std::ostream &) const;
 116     ///
 117     int Linuxdoc(std::ostream &) const;
 118     ///
 119     int DocBook(std::ostream &) const;
 120     ///
 121     void Validate(LaTeXFeatures & features) const;
 122     ///
 123     Inset::Code LyxCode() const { return Inset::TABULAR_CODE; }
 124     ///
 125     void GetCursorPos(int & x, int & y) const;
 126     ///
 127     void ToggleInsetCursor(BufferView *);
 128     ///
 129     void TabularFeatures(int feature, string val="");
 130     ///
 131     int GetActCell() { return actcell; }
 132     ///
 133     void SetFont(BufferView *, LyXFont const &, bool toggleall = false);
 134     ///
 135     /// Public structures and variables
 136     ///
 137     LyXTabular * tabular;
 138
 139 private:
 140     void calculate_width_of_cells(Painter &, LyXFont const &) const;
 141     ///
 142     void DrawCellLines(Painter &, int x, int baseline, int row, int cell) const;
 143     ///
 144     void ShowInsetCursor(BufferView *);
 145     ///
 146     void HideInsetCursor(BufferView *);
 147     ///
 148     void setPos(Painter &, int x, int y) const;
 149     ///
 150     bool SetCellDimensions(Painter & pain, int cell, int row);
 151     ///
 152     UpdatableInset::RESULT moveRight(BufferView *, bool lock=true);
 153     UpdatableInset::RESULT moveLeft(BufferView *, bool lock=true);
 154     UpdatableInset::RESULT moveUp();
 155     UpdatableInset::RESULT moveDown();
 156     bool moveNextCell();
 157     bool movePrevCell();
 158     bool Delete();
 159     ///
 160     void resetPos(Painter &) const;
 161     ///
 162     void RemoveTabularRow();
 163     ///
 164     bool hasCharSelection() const {return (sel_pos_start != sel_pos_end);}
 165     bool hasCellSelection() const {return hasCharSelection() &&
 166                                  (sel_cell_start != sel_cell_end);}
 167     ///
 168     bool ActivateCellInset(BufferView *, int x=0, int y=0, int button=0);
 169     ///
 170     bool InsetHit(BufferView * bv, int x, int y) const;
 171
 172     ///
 173     /// Private structures and variables
 174     ///
 175     InsetText
 176         * the_locking_inset;
 177     Buffer
 178         * buffer;
 179     mutable LyXCursor
 180         cursor,
 181         old_cursor;
 182     mutable int
 183         inset_pos,
 184         inset_x, inset_y,
 185         sel_pos_start,
 186         sel_pos_end,
 187         sel_cell_start,
 188         sel_cell_end,
 189         actcell,
 190         actcol,
 191         actrow;
 192     bool
 193         no_selection;
 194     mutable bool
 195         init;
 196 };
 197 #endif