1 : /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
2 : /* ***** BEGIN LICENSE BLOCK *****
3 : * Version: MPL 1.1/GPL 2.0/LGPL 2.1
4 : *
5 : * The contents of this file are subject to the Mozilla Public License Version
6 : * 1.1 (the "License"); you may not use this file except in compliance with
7 : * the License. You may obtain a copy of the License at
8 : * http://www.mozilla.org/MPL/
9 : *
10 : * Software distributed under the License is distributed on an "AS IS" basis,
11 : * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
12 : * for the specific language governing rights and limitations under the
13 : * License.
14 : *
15 : * The Original Code is mozilla.org code.
16 : *
17 : * The Initial Developer of the Original Code is
18 : * Netscape Communications Corporation.
19 : * Portions created by the Initial Developer are Copyright (C) 1998
20 : * the Initial Developer. All Rights Reserved.
21 : *
22 : * Contributor(s):
23 : *
24 : * Alternatively, the contents of this file may be used under the terms of
25 : * either of the GNU General Public License Version 2 or later (the "GPL"),
26 : * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
27 : * in which case the provisions of the GPL or the LGPL are applicable instead
28 : * of those above. If you wish to allow use of your version of this file only
29 : * under the terms of either the GPL or the LGPL, and not to allow others to
30 : * use your version of this file under the terms of the MPL, indicate your
31 : * decision by deleting the provisions above and replace them with the notice
32 : * and other provisions required by the GPL or the LGPL. If you do not delete
33 : * the provisions above, a recipient may use your version of this file under
34 : * the terms of any one of the MPL, the GPL or the LGPL.
35 : *
36 : * ***** END LICENSE BLOCK ***** */
37 : #ifndef nsITableLayout_h__
38 : #define nsITableLayout_h__
39 :
40 : #include "nsQueryFrame.h"
41 : class nsIDOMElement;
42 :
43 : /**
44 : * nsITableLayout
45 : * interface for layout objects that act like tables.
46 : * initially, we use this to get cell info
47 : *
48 : * @author sclark
49 : */
50 : class nsITableLayout
51 0 : {
52 : public:
53 :
54 : NS_DECL_QUERYFRAME_TARGET(nsITableLayout)
55 :
56 : /** return all the relevant layout information about a cell.
57 : * @param aRowIndex a row which the cell intersects
58 : * @param aColIndex a col which the cell intersects
59 : * @param aCell [OUT] the content representing the cell at (aRowIndex, aColIndex)
60 : * @param aStartRowIndex [IN/OUT] the row in which aCell starts
61 : * @param aStartColIndex [IN/OUT] the col in which aCell starts
62 : * Initialize these with the "candidate" start indexes to use
63 : * for searching through the table when a cell isn't found
64 : * because of "holes" in the cellmap
65 : * when ROWSPAN and/or COLSPAN > 1
66 : * @param aRowSpan [OUT] the value of the ROWSPAN attribute (may be 0 or actual number)
67 : * @param aColSpan [OUT] the value of the COLSPAN attribute (may be 0 or actual number)
68 : * @param aActualRowSpan [OUT] the actual number of rows aCell spans
69 : * @param aActualColSpan [OUT] the acutal number of cols aCell spans
70 : * @param aIsSelected [OUT] true if the frame that maps aCell is selected
71 : * in the presentation shell that owns this.
72 : */
73 : NS_IMETHOD GetCellDataAt(PRInt32 aRowIndex, PRInt32 aColIndex,
74 : nsIDOMElement* &aCell, //out params
75 : PRInt32& aStartRowIndex, PRInt32& aStartColIndex,
76 : PRInt32& aRowSpan, PRInt32& aColSpan,
77 : PRInt32& aActualRowSpan, PRInt32& aActualColSpan,
78 : bool& aIsSelected)=0;
79 :
80 : /** Get the number of rows and column for a table from the frame's cellmap
81 : * Some rows may not have enough cells (the number returned is the maximum possible),
82 : * which displays as a ragged-right edge table
83 : */
84 : NS_IMETHOD GetTableSize(PRInt32& aRowCount, PRInt32& aColCount)=0;
85 :
86 : /**
87 : * Retrieves the index of the cell at the given coordinates.
88 : *
89 : * @note The index is the order number of the cell calculated from top left
90 : * cell to the right bottom cell of the table.
91 : *
92 : * @param aRow [in] the row the cell is in
93 : * @param aColumn [in] the column the cell is in
94 : * @param aIndex [out] the index to be returned
95 : */
96 : NS_IMETHOD GetIndexByRowAndColumn(PRInt32 aRow, PRInt32 aColumn,
97 : PRInt32 *aIndex) = 0;
98 :
99 : /**
100 : * Retrieves the coordinates of the cell at the given index.
101 : *
102 : * @see nsITableLayout::GetIndexByRowAndColumn()
103 : *
104 : * @param aIndex [in] the index for which the coordinates are to be retrieved
105 : * @param aRow [out] the resulting row coordinate
106 : * @param aColumn [out] the resulting column coordinate
107 : */
108 : NS_IMETHOD GetRowAndColumnByIndex(PRInt32 aIndex,
109 : PRInt32 *aRow, PRInt32 *aColumn) = 0;
110 : };
111 :
112 : #endif
|