mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-11-13 23:17:57 +00:00
113 lines
4.9 KiB
C++
113 lines
4.9 KiB
C++
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
/* ***** BEGIN LICENSE BLOCK *****
|
|
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
|
|
*
|
|
* The contents of this file are subject to the Mozilla Public License Version
|
|
* 1.1 (the "License"); you may not use this file except in compliance with
|
|
* the License. You may obtain a copy of the License at
|
|
* http://www.mozilla.org/MPL/
|
|
*
|
|
* Software distributed under the License is distributed on an "AS IS" basis,
|
|
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
|
|
* for the specific language governing rights and limitations under the
|
|
* License.
|
|
*
|
|
* The Original Code is mozilla.org code.
|
|
*
|
|
* The Initial Developer of the Original Code is
|
|
* Netscape Communications Corporation.
|
|
* Portions created by the Initial Developer are Copyright (C) 1998
|
|
* the Initial Developer. All Rights Reserved.
|
|
*
|
|
* Contributor(s):
|
|
*
|
|
* Alternatively, the contents of this file may be used under the terms of
|
|
* either of the GNU General Public License Version 2 or later (the "GPL"),
|
|
* or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
|
|
* in which case the provisions of the GPL or the LGPL are applicable instead
|
|
* of those above. If you wish to allow use of your version of this file only
|
|
* under the terms of either the GPL or the LGPL, and not to allow others to
|
|
* use your version of this file under the terms of the MPL, indicate your
|
|
* decision by deleting the provisions above and replace them with the notice
|
|
* and other provisions required by the GPL or the LGPL. If you do not delete
|
|
* the provisions above, a recipient may use your version of this file under
|
|
* the terms of any one of the MPL, the GPL or the LGPL.
|
|
*
|
|
* ***** END LICENSE BLOCK ***** */
|
|
#ifndef nsITableLayout_h__
|
|
#define nsITableLayout_h__
|
|
|
|
#include "nsQueryFrame.h"
|
|
class nsIDOMElement;
|
|
|
|
/**
|
|
* nsITableLayout
|
|
* interface for layout objects that act like tables.
|
|
* initially, we use this to get cell info
|
|
*
|
|
* @author sclark
|
|
*/
|
|
class nsITableLayout
|
|
{
|
|
public:
|
|
|
|
NS_DECL_QUERYFRAME_TARGET(nsITableLayout)
|
|
|
|
/** 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)
|
|
* @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
|
|
* @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
|
|
* @param aIsSelected [OUT] true if the frame that maps aCell is selected
|
|
* in the presentation shell that owns this.
|
|
*/
|
|
NS_IMETHOD GetCellDataAt(PRInt32 aRowIndex, PRInt32 aColIndex,
|
|
nsIDOMElement* &aCell, //out params
|
|
PRInt32& aStartRowIndex, PRInt32& aStartColIndex,
|
|
PRInt32& aRowSpan, PRInt32& aColSpan,
|
|
PRInt32& aActualRowSpan, PRInt32& aActualColSpan,
|
|
bool& aIsSelected)=0;
|
|
|
|
/** 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
|
|
*/
|
|
NS_IMETHOD GetTableSize(PRInt32& aRowCount, PRInt32& aColCount)=0;
|
|
|
|
/**
|
|
* 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
|
|
*/
|
|
NS_IMETHOD GetIndexByRowAndColumn(PRInt32 aRow, PRInt32 aColumn,
|
|
PRInt32 *aIndex) = 0;
|
|
|
|
/**
|
|
* 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
|
|
*/
|
|
NS_IMETHOD GetRowAndColumnByIndex(PRInt32 aIndex,
|
|
PRInt32 *aRow, PRInt32 *aColumn) = 0;
|
|
};
|
|
|
|
#endif
|