]> git.lyx.org Git - lyx.git/blobdiff - src/insets/insettabular.h
changelogs
[lyx.git] / src / insets / insettabular.h
index 83a45fedcc1dc0c9c064756022bce75206f172a7..b6a6f93970afbe7cb5beb1799c06f86e05c2b3eb 100644 (file)
@@ -6,23 +6,13 @@
  *
  * \author Jürgen Vigna
  *
- * Full author contact details are available in file CREDITS
+ * Full author contact details are available in file CREDITS.
  */
-// This is the rewrite of the tabular (table) support.
 
-// It will probably be a lot of work.
 
-// One first goal could be to make the inset read the old table format
-// and just output it again... no viewing at all.
+// This is Juergen's rewrite of the tabular (table) support.
 
-// When making the internal structure of tabular support I really think
-// that STL containers should be used. This will separate the container from
-// the rest of the code, which is a good thing.
-
-// Ideally the tabular support should do as the mathed and use
-// LaTeX in the .lyx file too.
-
-// Things to think of when desingning the new tabular support:
+// Things to think of when designing the new tabular support:
 // - color support (colortbl, color)
 // - decimal alignment (dcloumn)
 // - custom lines (hhline)
 // This is what I have written about tabular support in the LyX3-Tasks file:
 //
 //  o rewrite of table code. Should probably be written as some
-//          kind of an inset. At least get the code out of the kernel.
-//                - colortbl  -multirow
-//                - hhline    -multicolumn
-//                - dcolumn
+//    kind of an inset. [Done]
 // o enhance longtable support
 
 // Lgb
 #ifndef INSETTABULAR_H
 #define INSETTABULAR_H
 
-#ifdef __GNUG__
-#pragma interface
-#endif
-
 #include "inset.h"
 #include "tabular.h"
-#include "LString.h"
-#include "lyxcursor.h"
-#include "FuncStatus.h"
-
-#include <boost/scoped_ptr.hpp>
-
-#include <boost/signals/signal0.hpp>
 
+class FuncStatus;
 class LyXLex;
 class Painter;
 class BufferView;
 class Buffer;
+class BufferParams;
 class Paragraph;
+class CursorSlice;
+
 
 class InsetTabular : public UpdatableInset {
 public:
-       ///
-       enum UpdateCodes {
-               NONE = 0,
-               CURSOR = 1,
-               CELL = 2,
-               SELECTION = 3,
-               FULL = 4,
-               INIT = 5
-       };
        ///
        InsetTabular(Buffer const &, int rows = 1, int columns = 1);
        ///
-       InsetTabular(InsetTabular const &, Buffer const &, bool same_id = false);
-       ///
        ~InsetTabular();
        ///
-       Inset * clone(Buffer const &, bool same_id = false) const;
-       ///
-       void read(Buffer const *, LyXLex &);
-       ///
-       void write(Buffer const *, std::ostream &) const;
-       ///
-       int ascent(BufferView *, LyXFont const &) const;
-       ///
-       int descent(BufferView *, LyXFont const &) const;
-       ///
-       int width(BufferView *, LyXFont const & f) const;
-       ///
-       void draw(BufferView *, const LyXFont &, int , float &, bool) const;
-       ///
-       void update(BufferView *, LyXFont const &, bool = false);
-       ///
-       string const editMessage() const;
-       ///
-       void edit(BufferView *, int x, int y, mouse_button::state);
-       ///
-       void edit(BufferView * bv, bool front = true);
-       ///
-       bool doClearArea() const;
-       ///
-       void insetUnlock(BufferView *);
-       ///
-       void updateLocal(BufferView *, UpdateCodes, bool mark_dirty) const;
-       ///
-       bool lockInsetInInset(BufferView *, UpdatableInset *);
-       ///
-       bool unlockInsetInInset(BufferView *, UpdatableInset *,
-                               bool lr = false);
+       void read(Buffer const &, LyXLex &);
        ///
-       bool updateInsetInInset(BufferView *, Inset *);
+       void write(Buffer const &, std::ostream &) const;
        ///
-       int insetInInsetY() const;
+       void metrics(MetricsInfo &, Dimension &) const;
        ///
-       UpdatableInset * getLockingInset() const;
+       void draw(PainterInfo & pi, int x, int y) const;
        ///
-       UpdatableInset * getFirstLockingInsetOfType(Inset::Code);
+       std::string const editMessage() const;
        ///
-       bool insertInset(BufferView *, Inset *);
-       ///
-       bool insetAllowed(Inset::Code code) const;
+       bool insetAllowed(InsetBase::Code) const { return true; }
        ///
        bool isTextInset() const { return true; }
        /** returns true if, when outputing LaTeX, font changes should
-            be closed before generating this inset. This is needed for
-            insets that may contain several paragraphs */
+           be closed before generating this inset. This is needed for
+           insets that may contain several paragraphs */
        bool noFontChange() const { return true; }
        ///
-       bool display() const { return tabular->IsLongTabular(); }
-       ///
-       RESULT localDispatch(FuncRequest const &);
+       bool display() const { return tabular.isLongTabular(); }
        ///
-       int latex(Buffer const *, std::ostream &, bool, bool) const;
+       int latex(Buffer const &, std::ostream &,
+                 OutputParams const &) const;
        ///
-       int ascii(Buffer const *, std::ostream &, int linelen) const;
+       int plaintext(Buffer const &, std::ostream &,
+                 OutputParams const &) const;
        ///
-       int linuxdoc(Buffer const *, std::ostream &) const;
+       int linuxdoc(Buffer const &, std::ostream &,
+                    OutputParams const &) const;
        ///
-       int docbook(Buffer const *, std::ostream &, bool mixcont) const;
+       int docbook(Buffer const &, std::ostream &,
+                   OutputParams const &) const;
        ///
        void validate(LaTeXFeatures & features) const;
        ///
-       Inset::Code lyxCode() const { return Inset::TABULAR_CODE; }
-       ///
-       void getCursorPos(BufferView *, int & x, int & y) const;
-       ///
-       void toggleInsetCursor(BufferView *);
-       ///
-       bool tabularFeatures(BufferView * bv, string const & what);
-       ///
-       void tabularFeatures(BufferView * bv, LyXTabular::Feature feature,
-                            string const & val = string());
+       Code lyxCode() const { return InsetBase::TABULAR_CODE; }
+       /// get the absolute screen x,y of the cursor
+       void getCursorPos(LCursor const & cur, int & x, int & y) const;
        ///
-       int getActCell() const { return actcell; }
+       bool tabularFeatures(LCursor & cur, std::string const & what);
        ///
-       void setFont(BufferView *, LyXFont const &, bool toggleall = false,
-                    bool selectall = false);
-       ///
-       int getMaxWidth(BufferView *, UpdatableInset const *) const;
-       ///
-       Buffer * bufferOwner() const { return const_cast<Buffer *>(buffer); }
-       ///
-       LyXText * getLyXText(BufferView const *,
-                            bool const recursive = false) const;
-       ///
-       void deleteLyXText(BufferView *, bool recursive = true) const;
-       ///
-       void resizeLyXText(BufferView *, bool force = false) const;
+       void tabularFeatures(LCursor & cur, LyXTabular::Feature feature,
+                            std::string const & val = std::string());
        ///
        void openLayoutDialog(BufferView *) const;
        ///
        bool showInsetDialog(BufferView *) const;
+       /// Appends \c list with all labels found within this inset.
+       void getLabelList(Buffer const &, std::vector<std::string> & list) const;
+       /// number of cells
+       size_t nargs() const;
        ///
-       FuncStatus getStatus(string const & argument) const;
-       ///
-       std::vector<string> const getLabelList() const;
-       ///
-       void nodraw(bool b) const {
-               UpdatableInset::nodraw(b);
-       }
-       bool nodraw() const;
-       ///
-       int scroll(bool recursive=true) const;
-       ///
-       void scroll(BufferView *bv, float sx) const {
-               UpdatableInset::scroll(bv, sx);
-       }
-       ///
-       void scroll(BufferView *bv, int offset) const {
-               UpdatableInset::scroll(bv, offset);
-       }
-       ///
-       Paragraph * getParFromID(int id) const;
-       ///
-       Inset * getInsetFromID(int id) const;
-       ///
-       Paragraph * firstParagraph() const;
-       ///
-       Paragraph * getFirstParagraph(int) const;
-       ///
-       LyXCursor const & cursor(BufferView *) const;
-       ///
-       bool allowSpellcheck() { return true; }
-       ///
-       WordLangTuple const
-       selectNextWordToSpellcheck(BufferView *, float & value) const;
+       boost::shared_ptr<InsetText const> cell(int) const;
        ///
-       void selectSelectedWord(BufferView *);
+       boost::shared_ptr<InsetText> cell(int);
        ///
-       void toggleSelection(BufferView *, bool kill_selection);
+       LyXText * getText(int) const;
+
        ///
-       bool searchForward(BufferView *, string const &,
-                          bool = true, bool = false);
-       bool searchBackward(BufferView *, string const &,
-                           bool = true, bool = false);
+       void markErased();
 
        // this should return true if we have a "normal" cell, otherwise true.
        // "normal" means without width set!
-       bool forceDefaultParagraphs(Inset const * in) const;
+       bool forceDefaultParagraphs(InsetBase const * in) const;
 
        ///
-       void addPreview(grfx::PreviewLoader &) const;
+       void addPreview(lyx::graphics::PreviewLoader &) const;
 
-       //
-       // Public structures and variables
        ///
-       boost::scoped_ptr<LyXTabular> tabular;
-       ///
-       boost::signal0<void> hideDialog;
+       Buffer const & buffer() const;
 
-       /// are some cells selected ?
-       bool hasSelection() const {
-               return has_selection;
-       }
-private:
-       ///
-       void lfunMousePress(FuncRequest const &);
+       /// set the owning buffer
+       void buffer(Buffer const * buf);
+       /// lock cell with given index
+       void edit(LCursor & cur, bool left);
        ///
-       // the bool return is used to see if we opened a dialog so that we can
-       // check this from an outer inset and open the dialog of the outer inset
-       // if that one has one!
-       ///
-       bool lfunMouseRelease(FuncRequest const &);
+       InsetBase * editXY(LCursor & cur, int x, int y) const;
+       /// can we go further down on mouse click?
+       bool descendable() const { return true; }
+
+       //
+       // Public structures and variables
        ///
-       void lfunMouseMotion(FuncRequest const &);
+       mutable LyXTabular tabular;
+
+protected:
+       InsetTabular(InsetTabular const &);
+
+       virtual void doDispatch(LCursor & cur, FuncRequest & cmd);
+
        ///
-       bool calculate_dimensions_of_cells(BufferView *, LyXFont const &,
-                                          bool = false) const;
+       bool getStatus(LCursor & cur, FuncRequest const & cmd, FuncStatus &) const;
+private:
+       virtual std::auto_ptr<InsetBase> doClone() const;
+
        ///
        void drawCellLines(Painter &, int x, int baseline,
-                          int row, int cell) const;
-       ///
-       void drawCellSelection(Painter &, int x, int baseline,
-                              int row, int column, int cell) const;
-       ///
-       void showInsetCursor(BufferView *, bool show=true);
-       ///
-       void hideInsetCursor(BufferView *);
+               int row, int cell) const;
        ///
-       void fitInsetCursor(BufferView *) const;
+       void drawCellSelection(PainterInfo &, int x, int baseline,
+               int row, int column, int cell) const;
        ///
-       void setPos(BufferView *, int x, int y) const;
-       ///
-       RESULT moveRight(BufferView *, bool lock = true);
-       ///
-       RESULT moveLeft(BufferView *, bool lock = true);
-       ///
-       RESULT moveUp(BufferView *, bool lock = true);
-       ///
-       RESULT moveDown(BufferView *, bool lock = true);
-       ///
-       bool moveNextCell(BufferView *, bool lock = false);
+       InsetBase * setPos(LCursor & cur, int x, int y) const;
+
        ///
-       bool movePrevCell(BufferView *, bool lock = false);
+       void moveNextCell(LCursor & cur);
        ///
-       bool deletable() const;
+       void movePrevCell(LCursor & cur);
        ///
        int getCellXPos(int cell) const;
        ///
-       void resetPos(BufferView *) const;
+       void resetPos(LCursor & cur) const;
        ///
        void removeTabularRow();
        ///
-       void clearSelection() const {
-               sel_cell_start = sel_cell_end = 0;
-               has_selection = false;
-       }
-       void setSelection(int start, int end) const {
-               sel_cell_start = start;
-               sel_cell_end = end;
-               has_selection = true;
-       }
-       ///
-       bool activateCellInset(BufferView *, int x = 0, int y = 0,
-                              mouse_button::state button = mouse_button::none,
-                              bool behind = false);
-       ///
-       bool activateCellInsetAbs(BufferView *, int x = 0, int y = 0,
-                                 mouse_button::state button = mouse_button::none);
-       ///
-       bool insetHit(BufferView * bv, int x, int y) const;
-       ///
-       int getMaxWidthOfCell(BufferView * bv, int cell) const;
-       ///
        bool hasPasteBuffer() const;
        ///
-       bool copySelection(BufferView *);
-       ///
-       bool pasteSelection(BufferView *);
+       bool copySelection(LCursor & cur);
        ///
-       bool cutSelection();
+       bool pasteSelection(LCursor & cur);
        ///
-       bool isRightToLeft(BufferView *);
+       void cutSelection(LCursor & cur);
        ///
-       void getSelection(int & scol, int & ecol,
-                         int & srow, int & erow) const;
+       bool isRightToLeft(LCursor & cur) const;
        ///
-       WordLangTuple selectNextWordInt(BufferView *, float & value) const;
+       void getSelection(LCursor & cur,
+               int & rs, int & re, int & cs, int & ce) const;
        ///
-       bool insertAsciiString(BufferView *, string const & buf, bool usePaste);
+       bool insertAsciiString(BufferView &, std::string const & buf, bool usePaste);
+       /// are we operating on several cells?
+       bool tablemode(LCursor & cur) const;
 
-       //
-       // Private structures and variables
-       ///
-       InsetText * the_locking_inset;
-       ///
-       InsetText * old_locking_inset;
-       ///
-       Buffer const * buffer;
-       ///
-       mutable LyXCursor cursor_;
-       ///
-       mutable unsigned int inset_x;
        ///
-       mutable unsigned int inset_y;
-       /// true if a set of cells are selected
-       mutable bool has_selection;
-       /// the starting cell selection nr
-       mutable int sel_cell_start;
-       /// the ending cell selection nr
-       mutable int sel_cell_end;
+       Buffer const * buffer_;
        ///
-       mutable int actcell;
+       mutable int cursorx_;
        ///
-       mutable int oldcell;
+       mutable int first_visible_cell;
+};
+
+
+#include "mailinset.h"
+
+
+class InsetTabularMailer : public MailInset {
+public:
        ///
-       mutable int actcol;
+       InsetTabularMailer(InsetTabular const & inset);
        ///
-       mutable int actrow;
+       virtual InsetBase & inset() const { return inset_; }
        ///
-       mutable int first_visible_cell;
+       virtual std::string const & name() const { return name_; }
        ///
-       bool no_selection;
+       virtual std::string const inset2string(Buffer const &) const;
        ///
-       mutable bool locked;
+       static void string2params(std::string const &, InsetTabular &);
        ///
-       mutable UpdateCodes need_update;
+       static std::string const params2string(InsetTabular const &);
+private:
        ///
-       bool in_update;
+       static std::string const name_;
        ///
-       mutable int in_reset_pos;
+       InsetTabular & inset_;
 };
+
+std::string const featureAsString(LyXTabular::Feature feature);
+
 #endif