2001-09-29 00:14:13 +04:00
|
|
|
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
2012-05-21 15:12:37 +04:00
|
|
|
/* This Source Code Form is subject to the terms of the Mozilla Public
|
|
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
1999-08-01 02:05:37 +04:00
|
|
|
#ifndef nsITableLayout_h__
|
|
|
|
#define nsITableLayout_h__
|
|
|
|
|
2009-01-12 22:20:59 +03:00
|
|
|
#include "nsQueryFrame.h"
|
1999-08-01 02:05:37 +04:00
|
|
|
class nsIDOMElement;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* nsITableLayout
|
|
|
|
* interface for layout objects that act like tables.
|
|
|
|
* initially, we use this to get cell info
|
|
|
|
*
|
|
|
|
* @author sclark
|
|
|
|
*/
|
2009-01-12 22:20:59 +03:00
|
|
|
class nsITableLayout
|
1999-08-01 02:05:37 +04:00
|
|
|
{
|
|
|
|
public:
|
|
|
|
|
2009-09-12 20:49:24 +04:00
|
|
|
NS_DECL_QUERYFRAME_TARGET(nsITableLayout)
|
1999-08-01 02:05:37 +04:00
|
|
|
|
|
|
|
/** return all the relevant layout information about a cell.
|
|
|
|
* @param aRowIndex a row which the cell intersects
|
|
|
|
* @param aColIndex a col which the cell intersects
|
|
|
|
* @param aCell [OUT] the content representing the cell at (aRowIndex, aColIndex)
|
1999-08-01 09:19:47 +04:00
|
|
|
* @param aStartRowIndex [IN/OUT] the row in which aCell starts
|
|
|
|
* @param aStartColIndex [IN/OUT] the col in which aCell starts
|
|
|
|
* Initialize these with the "candidate" start indexes to use
|
|
|
|
* for searching through the table when a cell isn't found
|
|
|
|
* because of "holes" in the cellmap
|
|
|
|
* when ROWSPAN and/or COLSPAN > 1
|
2000-01-26 17:56:06 +03:00
|
|
|
* @param aRowSpan [OUT] the value of the ROWSPAN attribute (may be 0 or actual number)
|
|
|
|
* @param aColSpan [OUT] the value of the COLSPAN attribute (may be 0 or actual number)
|
|
|
|
* @param aActualRowSpan [OUT] the actual number of rows aCell spans
|
|
|
|
* @param aActualColSpan [OUT] the acutal number of cols aCell spans
|
2011-10-17 18:59:28 +04:00
|
|
|
* @param aIsSelected [OUT] true if the frame that maps aCell is selected
|
1999-08-01 02:05:37 +04:00
|
|
|
* in the presentation shell that owns this.
|
|
|
|
*/
|
2012-08-22 19:56:38 +04:00
|
|
|
NS_IMETHOD GetCellDataAt(int32_t aRowIndex, int32_t aColIndex,
|
1999-08-01 02:05:37 +04:00
|
|
|
nsIDOMElement* &aCell, //out params
|
2012-08-22 19:56:38 +04:00
|
|
|
int32_t& aStartRowIndex, int32_t& aStartColIndex,
|
|
|
|
int32_t& aRowSpan, int32_t& aColSpan,
|
|
|
|
int32_t& aActualRowSpan, int32_t& aActualColSpan,
|
2011-09-29 10:19:26 +04:00
|
|
|
bool& aIsSelected)=0;
|
1999-08-01 20:20:14 +04:00
|
|
|
|
|
|
|
/** Get the number of rows and column for a table from the frame's cellmap
|
|
|
|
* Some rows may not have enough cells (the number returned is the maximum possible),
|
|
|
|
* which displays as a ragged-right edge table
|
|
|
|
*/
|
2012-08-22 19:56:38 +04:00
|
|
|
NS_IMETHOD GetTableSize(int32_t& aRowCount, int32_t& aColCount)=0;
|
2008-02-07 10:03:26 +03:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Retrieves the index of the cell at the given coordinates.
|
|
|
|
*
|
|
|
|
* @note The index is the order number of the cell calculated from top left
|
|
|
|
* cell to the right bottom cell of the table.
|
|
|
|
*
|
|
|
|
* @param aRow [in] the row the cell is in
|
|
|
|
* @param aColumn [in] the column the cell is in
|
|
|
|
* @param aIndex [out] the index to be returned
|
|
|
|
*/
|
2012-08-22 19:56:38 +04:00
|
|
|
NS_IMETHOD GetIndexByRowAndColumn(int32_t aRow, int32_t aColumn,
|
|
|
|
int32_t *aIndex) = 0;
|
2008-02-07 10:03:26 +03:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Retrieves the coordinates of the cell at the given index.
|
|
|
|
*
|
|
|
|
* @see nsITableLayout::GetIndexByRowAndColumn()
|
|
|
|
*
|
|
|
|
* @param aIndex [in] the index for which the coordinates are to be retrieved
|
|
|
|
* @param aRow [out] the resulting row coordinate
|
|
|
|
* @param aColumn [out] the resulting column coordinate
|
|
|
|
*/
|
2012-08-22 19:56:38 +04:00
|
|
|
NS_IMETHOD GetRowAndColumnByIndex(int32_t aIndex,
|
|
|
|
int32_t *aRow, int32_t *aColumn) = 0;
|
1999-08-01 02:05:37 +04:00
|
|
|
};
|
|
|
|
|
|
|
|
#endif
|