From 3a784227823967ce04067c1f6f88e2e63ed2909f Mon Sep 17 00:00:00 2001 From: Richard Heck Date: Sat, 9 Aug 2014 13:13:10 -0400 Subject: [PATCH] Add some comments about the behavior of cellInset and cellIndex. --- src/insets/InsetTabular.h | 30 +++++++++++++++++++++--------- 1 file changed, 21 insertions(+), 9 deletions(-) diff --git a/src/insets/InsetTabular.h b/src/insets/InsetTabular.h index 0001367a9d..2763eef0b8 100644 --- a/src/insets/InsetTabular.h +++ b/src/insets/InsetTabular.h @@ -545,7 +545,9 @@ public: idx_type cellAbove(idx_type cell) const; /// idx_type cellBelow(idx_type cell) const; - /// + /// \return the index of the VISIBLE cell at row, column + /// this will be the same as the cell in the previous row, + /// e.g., if the cell is part of a multirow idx_type cellIndex(row_type row, col_type column) const; /// void setUsebox(idx_type cell, BoxType); @@ -585,23 +587,33 @@ public: bool haveLTCaption(CaptionType captiontype = CAPTION_ANY) const; /// // end longtable support - /// + + //@{ + /// there is a subtle difference between these two methods. + /// cellInset(r,c); + /// and + /// cellInset(cellIndex(r,c)); + /// can return different things. this is because cellIndex(r,c) + /// returns the VISIBLE cell at r,c, which may be the same as the + /// cell at the previous row or column, if we're dealing with some + /// multirow or multicell. shared_ptr cellInset(idx_type cell) const; - /// shared_ptr cellInset(row_type row, col_type column) const; + //@} /// void setCellInset(row_type row, col_type column, shared_ptr) const; /// Search for \param inset in the tabular, with the /// 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 rather than a - // vector, and an InsetTableCell had a CellData as a member, - // or perhaps just had its members as members. + + //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 rather than a + // vector, and an InsetTableCell had a CellData as a member, + // or perhaps just had its members as members. /// class CellData { public: -- 2.39.2