← Back to branch summary

~ubuntu-branches/ubuntu/precise/kompozer/precise

« back to all changes in this revision

Viewing changes to mozilla/layout/html/table/public/nsITableLayout.h

  • Committer: Bazaar Package Importer
  • Author(s): Anthony Yarusso
  • Date: 2007-08-27 01:11:03 UTC
  • Revision ID: james.westby@ubuntu.com-20070827011103-2jgf4s6532gqu2ka
Tags: upstream-0.7.10
Import upstream version 0.7.10

Show diffs side-by-side

added added

removed removed

Lines of Context:
mozilla/layout/html/table/public/nsITableLayout.h
 
1
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
 
2
/* ***** BEGIN LICENSE BLOCK *****
 
3
 * Version: NPL 1.1/GPL 2.0/LGPL 2.1
 
4
 *
 
5
 * The contents of this file are subject to the Netscape Public License
 
6
 * Version 1.1 (the "License"); you may not use this file except in
 
7
 * compliance with the License. You may obtain a copy of the License at
 
8
 * http://www.mozilla.org/NPL/
 
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 the GNU General Public License Version 2 or later (the "GPL"), or 
 
26
 * 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 NPL, 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 NPL, the GPL or the LGPL.
 
35
 *
 
36
 * ***** END LICENSE BLOCK ***** */
 
37
#ifndef nsITableLayout_h__
 
38
#define nsITableLayout_h__
 
39
 
 
40
#include "nsISupports.h"
 
41
class nsIDOMElement;
 
42
 
 
43
// IID for the nsITableLayout interface 
 
44
// A9222E6B-437E-11d3-B227-004095E27A10
 
45
#define NS_ITABLELAYOUT_IID \
 
46
 { 0xa9222e6b, 0x437e, 0x11d3, { 0xb2, 0x27, 0x0, 0x40, 0x95, 0xe2, 0x7a, 0x10 }}
 
47
 
 
48
/**
 
49
 * nsITableLayout
 
50
 * interface for layout objects that act like tables.
 
51
 * initially, we use this to get cell info 
 
52
 *
 
53
 * @author  sclark
 
54
 */
 
55
class nsITableLayout : public nsISupports
 
56
{
 
57
public:
 
58
 
 
59
  NS_DEFINE_STATIC_IID_ACCESSOR(NS_ITABLELAYOUT_IID)
 
60
 
 
61
  /** return all the relevant layout information about a cell.
 
62
   *  @param aRowIndex       a row which the cell intersects
 
63
   *  @param aColIndex       a col which the cell intersects
 
64
   *  @param aCell           [OUT] the content representing the cell at (aRowIndex, aColIndex)
 
65
   *  @param aStartRowIndex  [IN/OUT] the row in which aCell starts
 
66
   *  @param aStartColIndex  [IN/OUT] the col in which aCell starts
 
67
   *                         Initialize these with the "candidate" start indexes to use
 
68
   *                           for searching through the table when a cell isn't found 
 
69
   *                           because of "holes" in the cellmap
 
70
   *                           when ROWSPAN and/or COLSPAN > 1
 
71
   *  @param aRowSpan        [OUT] the value of the ROWSPAN attribute (may be 0 or actual number)
 
72
   *  @param aColSpan        [OUT] the value of the COLSPAN attribute (may be 0 or actual number)
 
73
   *  @param aActualRowSpan  [OUT] the actual number of rows aCell spans
 
74
   *  @param aActualColSpan  [OUT] the acutal number of cols aCell spans
 
75
   *  @param aIsSelected     [OUT] PR_TRUE if the frame that maps aCell is selected
 
76
   *                               in the presentation shell that owns this.
 
77
   */
 
78
  NS_IMETHOD GetCellDataAt(PRInt32 aRowIndex, PRInt32 aColIndex,
 
79
                           nsIDOMElement* &aCell,   //out params
 
80
                           PRInt32& aStartRowIndex, PRInt32& aStartColIndex, 
 
81
                           PRInt32& aRowSpan, PRInt32& aColSpan,
 
82
                           PRInt32& aActualRowSpan, PRInt32& aActualColSpan,
 
83
                           PRBool& aIsSelected)=0;
 
84
 
 
85
  /** Get the number of rows and column for a table from the frame's cellmap 
 
86
   *  Some rows may not have enough cells (the number returned is the maximum possible),
 
87
   *  which displays as a ragged-right edge table
 
88
   */
 
89
  NS_IMETHOD GetTableSize(PRInt32& aRowCount, PRInt32& aColCount)=0;
 
90
};
 
91
 
 
92
#endif