Back to index

lightning-sunbird  0.9+nobinonly
nsITreeColumns.idl
Go to the documentation of this file.
00001 /* ***** BEGIN LICENSE BLOCK *****
00002  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00003  *
00004  * The contents of this file are subject to the Mozilla Public License Version
00005  * 1.1 (the "License"); you may not use this file except in compliance with
00006  * the License. You may obtain a copy of the License at
00007  * http://www.mozilla.org/MPL/
00008  *
00009  * Software distributed under the License is distributed on an "AS IS" basis,
00010  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00011  * for the specific language governing rights and limitations under the
00012  * License.
00013  *
00014  * The Original Code is mozilla.org code.
00015  *
00016  * The Initial Developer of the Original Code is Jan Varga.
00017  * Portions created by the Initial Developer are Copyright (C) 2003
00018  * the Initial Developer. All Rights Reserved.
00019  *
00020  * Contributor(s):
00021  *
00022  * Alternatively, the contents of this file may be used under the terms of
00023  * either of the GNU General Public License Version 2 or later (the "GPL"),
00024  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00025  * in which case the provisions of the GPL or the LGPL are applicable instead
00026  * of those above. If you wish to allow use of your version of this file only
00027  * under the terms of either the GPL or the LGPL, and not to allow others to
00028  * use your version of this file under the terms of the MPL, indicate your
00029  * decision by deleting the provisions above and replace them with the notice
00030  * and other provisions required by the GPL or the LGPL. If you do not delete
00031  * the provisions above, a recipient may use your version of this file under
00032  * the terms of any one of the MPL, the GPL or the LGPL.
00033  *
00034  * ***** END LICENSE BLOCK ***** */
00035 
00036 #include "nsISupports.idl"
00037 
00038 interface nsITreeColumns;
00039 interface nsIDOMElement;
00040 interface nsIAtom;
00041 
00042 [scriptable, uuid(58a8574d-15a8-4678-99a5-e1be56104093)]
00043 interface nsITreeColumn : nsISupports
00044 {
00045   readonly attribute nsIDOMElement element;
00046 
00047   readonly attribute nsITreeColumns columns;
00048 
00049   readonly attribute long x;
00050   readonly attribute long width;
00051 
00052   readonly attribute AString id;
00053   [noscript] void getIdConst([shared] out wstring idConst);
00054   [noscript] readonly attribute nsIAtom atom;
00055 
00056   readonly attribute long index;
00057 
00058   readonly attribute boolean primary;
00059   readonly attribute boolean cycler;
00060   readonly attribute boolean editable;
00061 
00062   const short TYPE_TEXT                = 1;
00063   const short TYPE_CHECKBOX            = 2;
00064   const short TYPE_PROGRESSMETER       = 3;
00065   readonly attribute short type;
00066 
00067   nsITreeColumn getNext();
00068   nsITreeColumn getPrevious();
00069 
00070   void invalidate();
00071 };
00072 
00073 interface nsITreeBoxObject;
00074 
00075 [scriptable, uuid(fcc7b6b5-f7d7-4e57-abd1-080602deb21d)]
00076 interface nsITreeColumns : nsISupports
00077 {
00081   readonly attribute nsITreeBoxObject tree;
00082 
00086   readonly attribute long count;
00087 
00091   nsITreeColumn getFirstColumn();
00092   nsITreeColumn getLastColumn();
00093 
00097   nsITreeColumn getPrimaryColumn();
00098   nsITreeColumn getSortedColumn();
00099   nsITreeColumn getKeyColumn();
00100 
00104   nsITreeColumn getColumnFor(in nsIDOMElement element);
00105 
00109   nsITreeColumn getNamedColumn(in AString id);
00110   nsITreeColumn getColumnAt(in long index);
00111 
00116   void invalidateColumns();
00117 
00118   void restoreNaturalOrder();
00119 };