// -*- 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-2000 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
-#ifdef __GNUG__
-#pragma interface
-#endif
-
-#include "lyxinset.h"
+#include "inset.h"
#include "tabular.h"
-#include "LString.h"
-#include "lyxcursor.h"
-#include "lyxfunc.h"
+#include "mailinset.h"
+
+namespace lyx {
+class FuncStatus;
class LyXLex;
-class Painter;
class BufferView;
class Buffer;
-class Dialogs;
+class BufferParams;
+class Paragraph;
+class CursorSlice;
+
+namespace frontend { class Painter; }
-class InsetTabular : public UpdatableInset {
+class InsetTabular : public InsetOld {
public:
- ///
- enum UpdateCodes {
- NONE = 0,
- INIT,
- FULL,
- CELL,
- CURSOR,
- SELECTION
- };
- ///
- InsetTabular(Buffer *, int rows = 1, int columns = 1);
- ///
- InsetTabular(InsetTabular const &, Buffer *);
- ///
- ~InsetTabular();
- ///
- Inset * Clone() 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);
- ///
- bool doClearArea() const { return !locked; };
- ///
- void InsetUnlock(BufferView *);
- ///
- void UpdateLocal(BufferView *, UpdateCodes, bool mark_dirty) const;
- ///
- bool LockInsetInInset(BufferView *, UpdatableInset *);
- ///
- bool UnlockInsetInInset(BufferView *, UpdatableInset *, bool lr = false);
- ///
- bool UpdateInsetInInset(BufferView *, Inset *);
- ///
- int InsetInInsetY();
- ///
- UpdatableInset * GetLockingInset();
- ///
- UpdatableInset * GetFirstLockingInsetOfType(Inset::Code);
- ///
- bool InsertInset(BufferView *, Inset *);
- ///
- bool IsTextInset() const { return true; }
- ///
- bool display() const { return tabular->IsLongTabular(); }
- ///
- void InsetButtonRelease(BufferView *, int, int, int);
- ///
- void InsetButtonPress(BufferView *, int, int, int);
- ///
- void InsetMotionNotify(BufferView *, int, int, int);
- ///
- void InsetKeyPress(XKeyEvent *);
- ///
- UpdatableInset::RESULT LocalDispatch(BufferView *, int, 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;
- ///
- void Validate(LaTeXFeatures & features) const;
- ///
- Inset::Code LyxCode() const { return Inset::TABULAR_CODE; }
- ///
- void GetCursorPos(BufferView *, unsigned long & x,
- unsigned long & y) const;
- ///
- void ToggleInsetCursor(BufferView *);
- ///
- bool TabularFeatures(BufferView * bv, string const & what);
- ///
- void TabularFeatures(BufferView * bv, int feature,
- string const & val = string());
- ///
- int GetActCell() const { return actcell; }
- ///
- void SetFont(BufferView *, LyXFont const &, bool toggleall = false);
- ///
- int getMaxWidth(Painter & pain, UpdatableInset const *) const;
- ///
- Buffer * BufferOwner() const { return buffer; }
- ///
- LyXText * getLyXText(BufferView *) const;
- ///
- void resizeLyXText(BufferView *) const;
- ///
- void OpenLayoutDialog(BufferView *) const;
- ///
- LyXFunc::func_status getStatus(string const & argument) const;
+ ///
+ InsetTabular(Buffer const &, row_type rows = 1,
+ col_type columns = 1);
+ ///
+ ~InsetTabular();
+ ///
+ void read(Buffer const &, LyXLex &);
+ ///
+ void write(Buffer const &, std::ostream &) const;
+ ///
+ bool metrics(MetricsInfo &, Dimension &) const;
+ ///
+ void draw(PainterInfo & pi, int x, int y) const;
+ ///
+ void drawSelection(PainterInfo & pi, int x, int y) const;
+ ///
+ virtual docstring const editMessage() const;
+ ///
+ EDITABLE editable() const { return HIGHLY_EDITABLE; }
+ ///
+ bool insetAllowed(InsetBase::Code) const { return true; }
+ ///
+ bool allowSpellCheck() 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(); }
+ ///
+ int latex(Buffer const &, odocstream &,
+ OutputParams const &) const;
+ ///
+ int plaintext(Buffer const &, odocstream &,
+ OutputParams const &) const;
+ ///
+ int docbook(Buffer const &, odocstream &,
+ OutputParams const &) const;
+ ///
+ void validate(LaTeXFeatures & features) const;
+ ///
+ 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;
+ ///
+ bool tabularFeatures(LCursor & cur, std::string const & what);
+ ///
+ 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(); }
+ ///
+ boost::shared_ptr<InsetText const> cell(idx_type) const;
+ ///
+ boost::shared_ptr<InsetText> cell(idx_type);
+ ///
+ 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;
+
+ ///
+ void addPreview(graphics::PreviewLoader &) const;
+
+ ///
+ Buffer const & buffer() const;
+
+ /// set the owning buffer
+ void buffer(Buffer const * buf);
+ /// lock cell with given index
+ void edit(LCursor & cur, bool left);
+ ///
+ InsetBase * editXY(LCursor & cur, int x, int y);
+ /// can we go further down on mouse click?
+ bool descendable() const { return true; }
+
+ //
+ // Public structures and variables
+ ///
+ mutable LyXTabular tabular;
- //
- // Public structures and variables
- ///
- LyXTabular * tabular;
+protected:
+ ///
+ InsetTabular(InsetTabular const &);
+ ///
+ virtual void doDispatch(LCursor & cur, FuncRequest & cmd);
+ ///
+ bool getStatus(LCursor & cur, FuncRequest const & cmd, FuncStatus &) const;
+ ///
+ int scroll() const { return scx_; }
private:
- ///
- bool calculate_dimensions_of_cells(BufferView *, LyXFont const &,
- bool = false) 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 *);
- ///
- void HideInsetCursor(BufferView *);
- ///
- 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 *);
- ///
- UpdatableInset::RESULT moveDown(BufferView *);
- ///
- bool moveNextCell(BufferView *);
- ///
- bool movePrevCell(BufferView *);
- ///
- bool Delete();
- ///
- int getCellXPos(int cell) const;
- ///
- void resetPos(BufferView *) const;
- ///
- void RemoveTabularRow();
- ///
- bool hasSelection() const { return ((sel_pos_start != sel_pos_end) ||
- (sel_cell_start != sel_cell_end));}
- ///
- bool ActivateCellInset(BufferView *, int x = 0, int y = 0, int button = 0,
- bool behind = false);
- ///
- bool InsetHit(BufferView * bv, int x, int y) const;
- ///
- int GetMaxWidthOfCell(Painter &, int cell) const;
- ///
- bool hasPasteBuffer() const;
- ///
- bool copySelection();
- ///
- bool pasteSelection(BufferView *);
- ///
- bool cutSelection();
+ virtual std::auto_ptr<InsetBase> doClone() const;
- //
- // Private structures and variables
- ///
- InsetText * the_locking_inset;
- ///
- Buffer * buffer;
- ///
- mutable LyXCursor cursor;
- ///
- mutable LyXCursor old_cursor;
- ///
- mutable int inset_pos;
- ///
- mutable int inset_x;
- ///
- mutable unsigned long inset_y;
- ///
- mutable int sel_pos_start;
- ///
- mutable int sel_pos_end;
- ///
- mutable int sel_cell_start;
- ///
- mutable int sel_cell_end;
- ///
- mutable int actcell;
- ///
- mutable int oldcell;
- ///
- mutable int actcol;
- ///
- mutable int actrow;
- ///
- bool no_selection;
- ///
- mutable bool locked;
- ///
- mutable UpdateCodes need_update;
- ///
- mutable Dialogs * dialogs_;
+ ///
+ void drawCellLines(frontend::Painter &, int x, int y, row_type row,
+ idx_type cell, bool erased) const;
+ ///
+ void setCursorFromCoordinates(LCursor & cur, int x, int y) const;
+
+ ///
+ void moveNextCell(LCursor & cur);
+ ///
+ void movePrevCell(LCursor & cur);
+ ///
+ int getCellXPos(idx_type cell) const;
+ ///
+ void resetPos(LCursor & cur) const;
+ ///
+ void removeTabularRow();
+ ///
+ bool copySelection(LCursor & cur);
+ ///
+ bool pasteSelection(LCursor & cur);
+ ///
+ void cutSelection(LCursor & cur);
+ ///
+ bool isRightToLeft(LCursor & cur) const;
+ ///
+ void getSelection(LCursor & cur, row_type & rs, row_type & re,
+ col_type & cs, col_type & ce) 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;
+
+ ///
+ Buffer const * buffer_;
+ ///
+ mutable idx_type first_visible_cell;
+ ///
+ mutable int scx_;
};
+
+
+class InsetTabularMailer : public MailInset {
+public:
+ ///
+ InsetTabularMailer(InsetTabular const & inset);
+ ///
+ virtual InsetBase & inset() const { return inset_; }
+ ///
+ virtual std::string const & name() const { return name_; }
+ ///
+ virtual std::string const inset2string(Buffer const &) const;
+ ///
+ static void string2params(std::string const &, InsetTabular &);
+ ///
+ static std::string const params2string(InsetTabular const &);
+private:
+ ///
+ static std::string const name_;
+ ///
+ InsetTabular & inset_;
+};
+
+std::string const featureAsString(LyXTabular::Feature feature);
+
+} // namespace lyx
+
#endif
projects / lyx.git / blobdiff