Back to index

lightning-sunbird  0.9+nobinonly
nsITreeBoxObject.idl
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Dave Hyatt <hyatt@mozilla.org> (Original Author)
00024  *   Ben Goodger <ben@netscape.com>
00025  *   Jan Varga <varga@ku.sk>
00026  *
00027  * Alternatively, the contents of this file may be used under the terms of
00028  * either of the GNU General Public License Version 2 or later (the "GPL"),
00029  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00030  * in which case the provisions of the GPL or the LGPL are applicable instead
00031  * of those above. If you wish to allow use of your version of this file only
00032  * under the terms of either the GPL or the LGPL, and not to allow others to
00033  * use your version of this file under the terms of the MPL, indicate your
00034  * decision by deleting the provisions above and replace them with the notice
00035  * and other provisions required by the GPL or the LGPL. If you do not delete
00036  * the provisions above, a recipient may use your version of this file under
00037  * the terms of any one of the MPL, the GPL or the LGPL.
00038  *
00039  * ***** END LICENSE BLOCK ***** */
00040 
00041 #include "nsISupports.idl"
00042 #include "domstubs.idl"
00043 
00044 interface nsITreeView;
00045 interface nsITreeSelection;
00046 interface nsITreeColumn;
00047 interface nsITreeColumns;
00048 
00049 [scriptable, uuid(55f3b431-1aa8-4e23-ad3d-a9f5644bdaa6)]
00050 interface nsITreeBoxObject : nsISupports
00051 {
00055   readonly attribute nsITreeColumns columns;
00056 
00062   attribute nsITreeView view;
00063 
00067   attribute boolean focused;
00068 
00072   readonly attribute nsIDOMElement treeBody;
00073 
00077   readonly attribute long rowHeight;
00078 
00082   long getFirstVisibleRow();
00083 
00087   long getLastVisibleRow();
00088 
00092   long getPageLength();
00093 
00097   void ensureRowIsVisible(in long index);
00098 
00102   void scrollToRow(in long index);
00103 
00109   void scrollByLines(in long numLines);
00110 
00117   void scrollByPages(in long numPages);
00118   
00122   void invalidate();
00123   void invalidateColumn(in nsITreeColumn col);
00124   void invalidateRow(in long index);
00125   void invalidateCell(in long row, in nsITreeColumn col);
00126   void invalidateRange(in long startIndex, in long endIndex);
00127 
00135   long getRowAt(in long x, in long y);
00136 
00146   void getCellAt(in long x, in long y, out long row, out nsITreeColumn col, out ACString childElt);
00147 
00151   void getCoordsForCellItem(in long row, in nsITreeColumn col, in ACString element, 
00152                             out long x, out long y, out long width, out long height);
00153 
00157   boolean isCellCropped(in long row, in nsITreeColumn col);
00158 
00165   void rowCountChanged(in long index, in long count);
00166   
00173   void beginUpdateBatch();
00174 
00178   void endUpdateBatch();
00179 
00183   void clearStyleAndImageCaches();
00184 };