]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetTabular.h
Move isMultiCell() to Cursor, and use it.
[lyx.git] / src / insets / InsetTabular.h
index f149f6b91c14e9d87cf0320f09f67c102c7e0b1d..66862d68f132e5a7e5fb18e0a145df2a6c27053c 100644 (file)
 
 // 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>
 
@@ -161,6 +160,8 @@ public:
                ///
                SET_LTNEWPAGE,
                ///
+               TOGGLE_LTCAPTION,
+               ///
                SET_SPECIAL_COLUMN,
                ///
                SET_SPECIAL_MULTI,
@@ -234,9 +235,7 @@ public:
        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 &, 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;
@@ -317,12 +316,6 @@ public:
        ///
        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;
@@ -347,8 +340,6 @@ public:
        ///
        idx_type getLastCellInRow(row_type row) const;
        ///
-       idx_type cellCount() const;
-       ///
        idx_type numberOfCellsInRow(idx_type cell) const;
        ///
        void write(std::ostream &) const;
@@ -379,18 +370,6 @@ public:
        ///
        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;
@@ -429,6 +408,10 @@ public:
        ///
        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;
@@ -448,20 +431,18 @@ public:
                          boost::shared_ptr<InsetTableCell>) const;
        /// Search for \param inset in the tabular, with the
        ///
-       idx_type cellFromInset(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 &);
                ///
@@ -512,10 +493,6 @@ public:
                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
@@ -539,6 +516,8 @@ public:
                bool endlastfoot;
                /// row for a newpage
                bool newpage;
+               /// caption
+               bool caption;
        };
        ///
        typedef std::vector<RowData> row_vector;
@@ -553,10 +532,6 @@ public:
                ///
                VAlignment valignment;
                ///
-               bool left_line;
-               ///
-               bool right_line;
-               ///
                int width;
                ///
                Length p_width;
@@ -596,10 +571,12 @@ public:
        ltType endlastfoot;
 
        ///
-       void init(Buffer const &, row_type rows_arg,
+       void init(Buffer &, row_type rows_arg,
                  col_type columns_arg);
        ///
        void updateIndexes();
+       ///
+       bool setFixedWidth(row_type r, col_type c);
        /// return true of update is needed
        bool updateColumnWidths();
        ///
@@ -641,61 +618,93 @@ public:
        int docbookRow(odocstream & os, 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_;
 
 }; // 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 setCellData(Tabular::CellData const * cd) { cell_data_ = cd; }
-       ///
-       void setTabular(Tabular const * t) { table_ = t; }
+       void toggleFixedWidth(bool fw) { isFixedWidth = fw; }
+       /// writes the contents of the cell as a string, optionally
+       /// descending into insets
+       docstring asString(bool intoInsets = true);
 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;
+       /// should paragraph indendation be omitted in any case?
+       bool neverIndent() const { return true; }
+       ///
+       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;
@@ -720,7 +729,7 @@ public:
            insets that may contain several paragraphs */
        bool noFontChange() const { return true; }
        ///
-       DisplayType display() const { return tabular.isLongTabular() ? AlignCenter : Inline; }
+       DisplayType display() const { return tabular.is_long_tabular ? AlignCenter : Inline; }
        ///
        int latex(odocstream &, OutputParams const &) const;
        ///
@@ -731,6 +740,8 @@ public:
        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;
@@ -744,7 +755,7 @@ public:
        ///
        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;
        ///
@@ -764,9 +775,9 @@ public:
        /// 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 forcePlainLayout(idx_type cell = 0) const;
        ///
-       virtual bool useEmptyLayout() { return true; }
+       virtual bool usePlainLayout() { return true; }
        ///
        void addPreview(graphics::PreviewLoader &) const;
 
@@ -801,6 +812,18 @@ public:
        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);
 
        //
        // Public structures and variables
@@ -826,9 +849,11 @@ private:
        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 cellXPos(idx_type cell) const;
        ///
@@ -842,14 +867,10 @@ private:
        ///
        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;
@@ -864,32 +885,14 @@ private:
        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