* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
- * \author Lars Gullik Bjønnes
+ * \author Lars Gullik Bjønnes
* \author Matthias Ettrich
- * \author André Pönitz
- * \author Jürgen Vigna
+ * \author André Pönitz
+ * \author Jürgen Vigna
*
* Full author contact details are available in file CREDITS.
*/
// Lgb
-#ifndef INSETTABULAR_H
-#define INSETTABULAR_H
+#ifndef INSET_TABULAR_H
+#define INSET_TABULAR_H
#include "Inset.h"
#include "InsetText.h"
#include "Layout.h"
#include "Length.h"
-#include "MailInset.h"
#include <boost/shared_ptr.hpp>
namespace lyx {
class Buffer;
-class BufferParams;
class BufferView;
class CompletionList;
class CursorSlice;
class FuncStatus;
class Lexer;
class Paragraph;
+class XHTMLStream;
namespace frontend { class Painter; }
///
SET_LTNEWPAGE,
///
+ TOGGLE_LTCAPTION,
+ ///
SET_SPECIAL_COLUMN,
///
SET_SPECIAL_MULTI,
///
SET_BORDER_LINES,
///
+ TABULAR_VALIGN_TOP,
+ ///
+ TABULAR_VALIGN_MIDDLE,
+ ///
+ TABULAR_VALIGN_BOTTOM,
+ ///
+ LONGTABULAR_ALIGN_LEFT,
+ ///
+ LONGTABULAR_ALIGN_CENTER,
+ ///
+ LONGTABULAR_ALIGN_RIGHT,
+ ///
LAST_ACTION
};
///
///
LYX_VALIGN_TOP = 0,
///
- LYX_VALIGN_BOTTOM = 1,
+ LYX_VALIGN_MIDDLE = 1,
///
- LYX_VALIGN_MIDDLE = 2
+ LYX_VALIGN_BOTTOM = 2
+
+ };
+ ///
+ enum HAlignment {
+ ///
+ LYX_LONGTABULAR_ALIGN_LEFT = 0,
+ ///
+ LYX_LONGTABULAR_ALIGN_CENTER = 1,
+ ///
+ LYX_LONGTABULAR_ALIGN_RIGHT = 2
};
enum BoxType {
static const idx_type npos = static_cast<idx_type>(-1);
/// constructor
- Tabular();
- /// constructor
- Tabular(Buffer const &, col_type columns_arg, row_type rows_arg);
+ Tabular(Buffer * buf, col_type columns_arg, row_type rows_arg);
/// Returns true if there is a topline, returns false if not
bool topLine(idx_type cell) const;
///
Length const getPWidth(idx_type cell) const;
///
- Length const getColumnPWidth(idx_type cell) const;
- ///
- Length const getMColumnPWidth(idx_type cell) const;
- ///
- docstring const getAlignSpecial(idx_type cell, int what) const;
- ///
int cellWidth(idx_type cell) const;
///
int getBeginningOfTextInCell(idx_type cell) const;
///
idx_type getLastCellInRow(row_type row) const;
///
- idx_type cellCount() const;
- ///
idx_type numberOfCellsInRow(idx_type cell) const;
///
void write(std::ostream &) const;
void read(Lexer &);
///
int latex(odocstream &, OutputParams const &) const;
- //
+ ///
int docbook(odocstream & os, OutputParams const &) const;
///
+ docstring xhtml(XHTMLStream & os, OutputParams const &) const;
+ ///
void plaintext(odocstream &,
OutputParams const & runparams, int const depth,
bool onlydata, char_type delim) const;
///
col_type cellRightColumn(idx_type cell) const;
///
- void setBookTabs(bool);
- ///
- bool useBookTabs() const;
- ///
- void setLongTabular(bool);
- ///
- bool isLongTabular() const;
- ///
- void setRotateTabular(bool);
- ///
- bool getRotateTabular() const;
- ///
void setRotateCell(idx_type cell, bool);
///
bool getRotateCell(idx_type cell) const;
///
bool isLastCell(idx_type cell) const;
///
- idx_type getCellAbove(idx_type cell) const;
+ idx_type cellAbove(idx_type cell) const;
///
- idx_type getCellBelow(idx_type cell) const;
+ idx_type cellBelow(idx_type cell) const;
///
idx_type cellIndex(row_type row, col_type column) const;
///
///
bool getLTNewPage(row_type row) const;
///
+ idx_type setLTCaption(row_type row, bool what);
+ ///
+ bool ltCaption(row_type row) const;
+ ///
bool haveLTHead() const;
///
bool haveLTFirstHead() const;
///
bool haveLTLastFoot() const;
///
+ bool haveLTCaption() const;
+ ///
// end longtable support
///
- boost::shared_ptr<InsetTableCell> getCellInset(idx_type cell) const;
+ boost::shared_ptr<InsetTableCell> cellInset(idx_type cell) const;
///
- boost::shared_ptr<InsetTableCell> getCellInset(row_type row,
+ boost::shared_ptr<InsetTableCell> cellInset(row_type row,
col_type column) const;
///
void setCellInset(row_type row, col_type column,
boost::shared_ptr<InsetTableCell>) const;
/// Search for \param inset in the tabular, with the
///
- idx_type getCellFromInset(Inset const * inset) const;
- ///
- row_type rowCount() const { return row_info.size(); }
- ///
- col_type columnCount() const { return column_info.size();}
- ///
void validate(LaTeXFeatures &) const;
- ///
//private:
+ // FIXME Now that cells have an InsetTableCell as their insets, rather
+ // than an InsetText, it'd be possible to reverse the relationship here,
+ // so that cell_vector was a vector<InsetTableCell> rather than a
+ // vector<CellData>, and an InsetTableCell had a CellData as a member,
+ // or perhaps just had its members as members.
///
class CellData {
public:
///
- CellData(Buffer const &, Tabular const &);
+ CellData(Buffer *);
///
CellData(CellData const &);
///
///
boost::shared_ptr<InsetTableCell> inset;
};
- CellData & cellinfo_of_cell(idx_type cell) const;
+ CellData & cellInfo(idx_type cell) const;
///
typedef std::vector<CellData> cell_vector;
///
int ascent;
///
int descent;
- ///
- bool top_line;
- ///
- bool bottom_line;
/// Extra space between the top line and this row
Length top_space;
/// Ignore top_space if true and use the default top space
bool endlastfoot;
/// row for a newpage
bool newpage;
+ /// caption
+ bool caption;
};
///
typedef std::vector<RowData> row_vector;
///
VAlignment valignment;
///
- bool left_line;
- ///
- bool right_line;
- ///
int width;
///
Length p_width;
bool use_booktabs;
///
bool rotate;
+ ///
+ VAlignment tabular_valignment;
//
// for long tabulars
+ ///
+ HAlignment longtabular_alignment;
//
bool is_long_tabular;
/// endhead data
ltType endlastfoot;
///
- void init(Buffer const &, row_type rows_arg,
+ void init(Buffer *, row_type rows_arg,
col_type columns_arg);
///
void updateIndexes();
- /// Returns true if a complete update is necessary, otherwise false
- bool setWidthOfMulticolCell(idx_type cell, int new_width);
///
- void recalculateMulticolumnsOfColumn(col_type column);
- /// Returns true if change
- void calculate_width_of_column(col_type column);
+ bool setFixedWidth(row_type r, col_type c);
///
- bool calculate_width_of_column_NMC(col_type column); // no multi cells
+ void updateContentAlignment(row_type r, col_type c);
+ /// return true of update is needed
+ bool updateColumnWidths();
///
idx_type columnSpan(idx_type cell) const;
///
///
// helper function for Latex returns number of newlines
///
- int TeXTopHLine(odocstream &, row_type row) const;
+ int TeXTopHLine(odocstream &, row_type row, std::string const lang) const;
///
- int TeXBottomHLine(odocstream &, row_type row) const;
+ int TeXBottomHLine(odocstream &, row_type row, std::string const lang) const;
///
- int TeXCellPreamble(odocstream &, idx_type cell) const;
+ int TeXCellPreamble(odocstream &, idx_type cell, bool & ismulticol) const;
///
- int TeXCellPostamble(odocstream &, idx_type cell) const;
+ int TeXCellPostamble(odocstream &, idx_type cell, bool ismulticol) const;
///
int TeXLongtableHeaderFooter(odocstream &, OutputParams const &) const;
///
bool onlydata) const;
/// auxiliary function for docbook
int docbookRow(odocstream & os, row_type, OutputParams const &) const;
+ ///
+ docstring xhtmlRow(XHTMLStream & xs, row_type, OutputParams const &) const;
/// change associated Buffer
- void setBuffer(Buffer const & buffer) { buffer_ = &buffer; }
+ void setBuffer(Buffer & buffer);
/// retrieve associated Buffer
- Buffer const & buffer() const { return *buffer_; }
+ Buffer & buffer() const { return *buffer_; }
private:
- Buffer const * buffer_;
+ Buffer * buffer_;
- /// renumber cells after structural changes
- void fixCellNums();
}; // Tabular
///
-class InsetTableCell : public InsetText {
+class InsetTableCell : public InsetText
+{
public:
///
- explicit InsetTableCell(Buffer const & buf,
- Tabular::CellData const * cd, Tabular const * t);
+ InsetTableCell(Buffer * buf);
///
- virtual InsetCode lyxCode() const { return CELL_CODE; }
+ InsetCode lyxCode() const { return CELL_CODE; }
///
Inset * clone() { return new InsetTableCell(*this); }
///
- virtual bool useEmptyLayout() const { return true; }
- ///
- virtual bool forceEmptyLayout(idx_type = 0) const;
- ///
- virtual bool allowParagraphCustomization(idx_type = 0) const;
- ///
bool getStatus(Cursor & cur, FuncRequest const & cmd,
FuncStatus & status) const;
///
- virtual bool neverIndent() { return true; }
+ void toggleFixedWidth(bool fw) { isFixedWidth = fw; }
///
- void setCellData(Tabular::CellData const * cd) { cell_data_ = cd; }
+ void setContentAlignment(LyXAlignment al) {contentAlign = al; }
+ /// writes the contents of the cell as a string, optionally
+ /// descending into insets
+ docstring asString(bool intoInsets = true);
///
- void setTabular(Tabular const * t) { table_ = t; }
+ docstring xhtml(XHTMLStream &, OutputParams const &) const;
private:
- ///
- Tabular::CellData const * cell_data_;
- ///
- Tabular const * table_;
/// unimplemented
InsetTableCell();
/// unimplemented
void operator=(InsetTableCell const &);
+ // FIXME
+ // This boolean is supposed to track whether the cell has had its
+ // width explicitly set. We need to know this to determine whether
+ // layout changes and paragraph customization are allowed---that is,
+ // we need it in forcePlainLayout() and allowParagraphCustomization().
+ // Unfortunately, that information is not readily available in
+ // InsetTableCell. In the case of multicolumn cells, it is present
+ // in CellData, and so would be available here if CellData were to
+ // become a member of InsetTableCell. But in the other case, it isn't
+ // even available there, but is held in Tabular::ColumnData.
+ // So, the present solution uses this boolean to track the information
+ // we need to track, and tries to keep it updated. This is not ideal,
+ // but the other solutions are no better. These are:
+ // (i) Keep a pointer in InsetTableCell to the table;
+ // (ii) Find the table by iterating over the Buffer's insets.
+ // Solution (i) raises the problem of updating the pointer when an
+ // InsetTableCell is copied, and we'd therefore need a copy constructor
+ // in InsetTabular and then in Tabular, which seems messy, given how
+ // complicated those classes are. Solution (ii) involves a lot of
+ // iterating, since this information is needed quite often, and so may
+ // be quite slow.
+ // So, well, if someone can do better, please do!
+ // --rgh
+ ///
+ bool isFixedWidth;
+ // FIXME: Here the thoughts from the comment above also apply.
+ ///
+ LyXAlignment contentAlign;
+ /// should paragraph indendation be omitted in any case?
+ bool neverIndent() const { return true; }
+ ///
+ LyXAlignment contentAlignment() const { return contentAlign; }
+ ///
+ virtual bool usePlainLayout() const { return true; }
+ ///
+ virtual bool forcePlainLayout(idx_type = 0) const;
+ ///
+ virtual bool allowParagraphCustomization(idx_type = 0) const;
+ /// Is the width forced to some value?
+ bool hasFixedWidth() const { return isFixedWidth; }
};
-class InsetTabular : public Inset {
+class InsetTabular : public Inset
+{
public:
///
- InsetTabular(Buffer const &, row_type rows = 1,
+ InsetTabular(Buffer *, row_type rows = 1,
col_type columns = 1);
///
~InsetTabular();
///
+ void setBuffer(Buffer & buffer);
+
+ ///
+ static void string2params(std::string const &, InsetTabular &);
+ ///
+ static std::string params2string(InsetTabular const &);
+ ///
void read(Lexer &);
///
void write(std::ostream &) const;
///
void drawSelection(PainterInfo & pi, int x, int y) const;
///
- docstring editMessage() const;
+ bool editable() const { return true; }
///
- EDITABLE editable() const { return HIGHLY_EDITABLE; }
+ bool hasSettings() const { return true; }
///
bool insetAllowed(InsetCode code) const;
///
insets that may contain several paragraphs */
bool noFontChange() const { return true; }
///
- DisplayType display() const { return tabular.isLongTabular() ? AlignCenter : Inline; }
+ DisplayType display() const;
///
int latex(odocstream &, OutputParams const &) const;
///
///
int docbook(odocstream &, OutputParams const &) const;
///
+ docstring xhtml(XHTMLStream &, OutputParams const &) const;
+ ///
void validate(LaTeXFeatures & features) const;
///
InsetCode lyxCode() const { return TABULAR_CODE; }
+ ///
+ docstring contextMenu(BufferView const & bv, int x, int y) const;
/// 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 showInsetDialog(BufferView *) const;
/// number of cells
- size_t nargs() const { return tabular.cellCount(); }
+ size_t nargs() const { return tabular.numberofcells; }
///
boost::shared_ptr<InsetTableCell const> cell(idx_type) const;
///
/// set the change for the entire inset
void setChange(Change const & change);
/// accept the changes within the inset
- void acceptChanges(BufferParams const & bparams);
+ void acceptChanges();
/// reject the changes within the inset
- void rejectChanges(BufferParams const & bparams);
+ 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?
virtual bool allowParagraphCustomization(idx_type cell = 0) const;
///
- virtual bool forceEmptyLayout(idx_type cell = 0) const;
- ///
- virtual bool useEmptyLayout() { return true; }
+ virtual bool forcePlainLayout(idx_type cell = 0) const;
///
- void addPreview(graphics::PreviewLoader &) const;
+ void addPreview(DocIterator const & inset_pos,
+ graphics::PreviewLoader &) const;
/// lock cell with given index
void edit(Cursor & cur, bool front, EntryDirection entry_from);
///
Inset * editXY(Cursor & cur, int x, int y);
/// can we go further down on mouse click?
- bool descendable() const { return true; }
+ bool descendable(BufferView const &) const { return true; }
// Update the counters of this inset and of its contents
- void updateLabels(ParIterator const &);
+ void updateLabels(ParIterator const &, bool);
///
bool completionSupported(Cursor const &) const;
bool insertCompletion(Cursor & cur, docstring const & s, bool finished);
///
void completionPosAndDim(Cursor const &, int & x, int & y, Dimension & dim) const;
+ ///
+ virtual bool usePlainLayout() const { return true; }
+ ///
+ virtual InsetTabular * asInsetTabular() { return this; }
+ ///
+ virtual InsetTabular const * asInsetTabular() const { return this; }
+ ///
+ bool isRightToLeft(Cursor & cur) const;
+ /// writes the cells between stidx and enidx as a string, optionally
+ /// descending into the insets
+ docstring asString(idx_type stidx, idx_type enidx, bool intoInsets = true);
+
+ /// Returns whether the cell in the specified row and column is selected.
+ bool isCellSelected(Cursor & cur, row_type row, col_type col) const;
//
// Public structures and variables
///
///
void drawCellLines(frontend::Painter &, int x, int y, row_type row,
- idx_type cell, bool erased) const;
+ idx_type cell, Change const & change) const;
///
void setCursorFromCoordinates(Cursor & cur, int x, int y) const;
///
- void moveNextCell(Cursor & cur);
+ void moveNextCell(Cursor & cur,
+ EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
///
- void movePrevCell(Cursor & cur);
+ void movePrevCell(Cursor & cur,
+ EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
///
- int getCellXPos(idx_type cell) const;
+ int cellXPos(idx_type cell) const;
///
void resetPos(Cursor & cur) const;
///
///
void cutSelection(Cursor & cur);
///
- bool isRightToLeft(Cursor & cur) const;
- ///
void getSelection(Cursor & 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(Cursor & cur) const;
/// return the "Manhattan distance" to nearest corner
int dist(BufferView &, idx_type cell, int x, int y) const;
mutable idx_type first_visible_cell;
///
mutable int scx_;
-};
-
-
-class InsetTabularMailer : public MailInset {
-public:
- ///
- InsetTabularMailer(InsetTabular const & inset);
- ///
- virtual Inset & 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_;
+ /// true when selecting rows with the mouse
+ bool rowselect_;
+ /// true when selecting columns with the mouse
+ bool colselect_;
};
std::string const featureAsString(Tabular::Feature feature);
} // namespace lyx
-#endif
+#endif // INSET_TABULAR_H