// -*- C++ -*-
-/* This file is part of
- * ======================================================
- *
- * LyX, The Document Processor
+/**
+ * \file insettabular.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
*
- * Copyright 1995-2001 The LyX Team.
+ * \author Jürgen Vigna
*
- *======================================================
+ * 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
-#include <sigc++/signal_system.h>
-#include <boost/smart_ptr.hpp>
-
-#ifdef __GNUG__
-#pragma interface
-#endif
-
#include "inset.h"
#include "tabular.h"
-#include "LString.h"
-#include "lyxcursor.h"
-#include "FuncStatus.h"
+#include "mailinset.h"
+
+namespace lyx {
+class FuncStatus;
class LyXLex;
-class Painter;
class BufferView;
class Buffer;
+class BufferParams;
class Paragraph;
+class CursorSlice;
-class InsetTabular : public UpdatableInset {
+namespace frontend { class Painter; }
+
+class InsetTabular : public InsetOld {
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(Buffer const &, row_type rows = 1,
+ col_type columns = 1);
///
~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, unsigned int);
- ///
- void edit(BufferView * bv, bool front = true);
- ///
- bool doClearArea() const;
- ///
- void insetUnlock(BufferView *);
- ///
- void updateLocal(BufferView *, UpdateCodes, bool mark_dirty) const;
+ void read(Buffer const &, LyXLex &);
///
- bool lockInsetInInset(BufferView *, UpdatableInset *);
+ void write(Buffer const &, std::ostream &) const;
///
- bool unlockInsetInInset(BufferView *, UpdatableInset *,
- bool lr = false);
+ bool metrics(MetricsInfo &, Dimension &) const;
///
- bool updateInsetInInset(BufferView *, Inset *);
+ void draw(PainterInfo & pi, int x, int y) const;
///
- unsigned int insetInInsetY();
+ void drawSelection(PainterInfo & pi, int x, int y) const;
///
- UpdatableInset * getLockingInset() const;
+ virtual docstring const editMessage() const;
///
- UpdatableInset * getFirstLockingInsetOfType(Inset::Code);
+ EDITABLE editable() const { return HIGHLY_EDITABLE; }
///
- bool insertInset(BufferView *, Inset *);
+ bool insetAllowed(InsetBase::Code) const { return true; }
///
- bool insetAllowed(Inset::Code code) const;
+ bool allowSpellCheck() const { return true; }
///
- bool isTextInset() const { return true; }
+ bool canTrackChanges() 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 */
+ bool noFontChange() const { return true; }
///
- bool display() const { return tabular->IsLongTabular(); }
+ bool display() const { return tabular.isLongTabular(); }
///
- bool insetButtonRelease(BufferView *, int, int, int);
+ int latex(Buffer const &, odocstream &,
+ OutputParams const &) const;
///
- void insetButtonPress(BufferView *, int, int, int);
+ int plaintext(Buffer const &, odocstream &,
+ OutputParams const &) const;
///
- void insetMotionNotify(BufferView *, int, int, int);
- ///
- void insetKeyPress(XKeyEvent *);
- ///
- UpdatableInset::RESULT localDispatch(BufferView *, kb_action,
- string const &);
- ///
- int latex(Buffer const *, std::ostream &, bool, bool) const;
- ///
- int ascii(Buffer const *, std::ostream &, int linelen) const;
- ///
- int linuxdoc(Buffer const *, std::ostream &) const;
- ///
- int docbook(Buffer const *, std::ostream &) const;
+ int docbook(Buffer const &, odocstream &,
+ 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());
- ///
- int getActCell() const { return actcell; }
+ Code lyxCode() const { return InsetBase::TABULAR_CODE; }
+ /// get offset of this cursor slice relative to our upper left corner
+ void cursorPos(BufferView const & bv, CursorSlice const & sl,
+ bool boundary, int & x, int & y) const;
///
- void setFont(BufferView *, LyXFont const &, bool toggleall = false,
- bool selectall = false);
+ bool tabularFeatures(LCursor & cur, std::string const & what);
///
- 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;
+ /// number of cells
+ size_t nargs() const { return tabular.getNumberOfCells(); }
///
- 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;
+ boost::shared_ptr<InsetText const> cell(idx_type) const;
///
- Inset * getInsetFromID(int id) const;
+ boost::shared_ptr<InsetText> cell(idx_type);
///
- Paragraph * firstParagraph() const;
- ///
- Paragraph * getFirstParagraph(int) const;
+ LyXText * getText(int) const;
+
+ /// set the change for the entire inset
+ void setChange(Change const & change);
+ /// accept the changes within the inset
+ void acceptChanges();
+ /// reject the changes within the inset
+ void rejectChanges();
+
+ // this should return true if we have a "normal" cell, otherwise false.
+ // "normal" means without width set!
+ /// should all paragraphs be output with "Standard" layout?
+ bool forceDefaultParagraphs(idx_type cell = 0) const;
+
///
- LyXCursor const & cursor(BufferView *) const;
+ void addPreview(graphics::PreviewLoader &) const;
+
///
- bool allowSpellcheck() { return true; }
- string const selectNextWordToSpellcheck(BufferView *, float & value) const;
- void selectSelectedWord(BufferView *);
- void toggleSelection(BufferView *, bool kill_selection);
+ Buffer const & buffer() const;
+
+ /// set the owning buffer
+ void buffer(Buffer const * buf);
+ /// lock cell with given index
+ void edit(LCursor & cur, bool left);
///
- bool searchForward(BufferView *, string const &,
- bool = true, bool = false);
- bool searchBackward(BufferView *, string const &,
- bool = true, bool = false);
+ InsetBase * editXY(LCursor & cur, int x, int y);
+ /// can we go further down on mouse click?
+ bool descendable() const { return true; }
- // this should return true if we have a "normal" cell, otherwise true.
- // "normal" means without width set!
- bool forceDefaultParagraphs(Inset const * in) const;
-
//
// Public structures and variables
///
- boost::scoped_ptr<LyXTabular> tabular;
- ///
- SigC::Signal0<void> hideDialog;
+ mutable LyXTabular tabular;
-private:
- ///
- bool calculate_dimensions_of_cells(BufferView *, LyXFont const &,
- bool = false) const;
+protected:
///
- void drawCellLines(Painter &, int x, int baseline,
- int row, int cell) const;
+ InsetTabular(InsetTabular const &);
///
- void drawCellSelection(Painter &, int x, int baseline,
- int row, int column, int cell) const;
+ virtual void doDispatch(LCursor & cur, FuncRequest & cmd);
///
- void showInsetCursor(BufferView *, bool show=true);
+ bool getStatus(LCursor & cur, FuncRequest const & cmd, FuncStatus &) const;
///
- void hideInsetCursor(BufferView *);
- ///
- void fitInsetCursor(BufferView *) const;
- ///
- void setPos(BufferView *, int x, int y) const;
- ///
- UpdatableInset::RESULT moveRight(BufferView *, bool lock = true);
- ///
- UpdatableInset::RESULT moveLeft(BufferView *, bool lock = true);
- ///
- UpdatableInset::RESULT moveUp(BufferView *, bool lock = true);
+ int scroll() const { return scx_; }
+
+private:
+ virtual std::auto_ptr<InsetBase> doClone() const;
+
///
- UpdatableInset::RESULT moveDown(BufferView *, bool lock = true);
+ void drawCellLines(frontend::Painter &, int x, int y, row_type row,
+ idx_type cell, bool erased) const;
///
- bool moveNextCell(BufferView *, bool lock = false);
+ void setCursorFromCoordinates(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;
+ int getCellXPos(idx_type cell) const;
///
- void resetPos(BufferView *) const;
+ void resetPos(LCursor & cur) const;
///
void removeTabularRow();
///
- bool hasSelection() const {
- return has_selection;
- }
- ///
- 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 copySelection(LCursor & cur);
///
- bool activateCellInset(BufferView *, int x = 0, int y = 0,
- int button = 0,
- bool behind = false);
+ bool pasteSelection(LCursor & cur);
///
- bool activateCellInsetAbs(BufferView *, int x = 0, int y = 0,
- int button = 0);
+ void cutSelection(LCursor & cur);
///
- bool insetHit(BufferView * bv, int x, int y) const;
+ bool isRightToLeft(LCursor & cur) const;
///
- int getMaxWidthOfCell(BufferView * bv, int cell) const;
+ void getSelection(LCursor & cur, row_type & rs, row_type & re,
+ col_type & cs, col_type & ce) const;
///
- bool hasPasteBuffer() const;
- ///
- bool copySelection(BufferView *);
- ///
- bool pasteSelection(BufferView *);
- ///
- bool cutSelection();
- ///
- bool isRightToLeft(BufferView *);
- ///
- void getSelection(int & scol, int & ecol,
- int & srow, int & erow) const;
- ///
- string selectNextWordInt(BufferView *, float & value) const;
+ bool insertPlaintextString(BufferView &, docstring const & buf, bool usePaste);
+ /// are we operating on several cells?
+ bool tablemode(LCursor & cur) const;
+
+ /// return the "Manhattan distance" to nearest corner
+ int dist(BufferView &, idx_type cell, int x, int y) const;
+ /// return the cell nearest to x, y
+ idx_type getNearestCell(BufferView &, int x, int y) 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 idx_type first_visible_cell;
///
- mutable int oldcell;
+ mutable int scx_;
+};
+
+
+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 bool in_reset_pos;
+ InsetTabular & inset_;
};
+
+std::string const featureAsString(LyXTabular::Feature feature);
+
+} // namespace lyx
+
#endif