Back to index

lightning-sunbird  0.9+nobinonly
nsIMsgCustomColumnHandler.idl
Go to the documentation of this file.
00001 /* -*- Mode: IDL; 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  * The Mozilla Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 2006
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Oren Nachmore <nachmore@gmail.com>
00024  *   David Bienvenu <bienvenu@mozilla.com>
00025  *
00026  * Alternatively, the contents of this file may be used under the terms of
00027  * either of the GNU General Public License Version 2 or later (the "GPL"),
00028  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00029  * in which case the provisions of the GPL or the LGPL are applicable instead
00030  * of those above. If you wish to allow use of your version of this file only
00031  * under the terms of either the GPL or the LGPL, and not to allow others to
00032  * use your version of this file under the terms of the MPL, indicate your
00033  * decision by deleting the provisions above and replace them with the notice
00034  * and other provisions required by the GPL or the LGPL. If you do not delete
00035  * the provisions above, a recipient may use your version of this file under
00036  * the terms of any one of the MPL, the GPL or the LGPL.
00037  *
00038  * ***** END LICENSE BLOCK ***** */
00039 
00040 #include "nsITreeView.idl"
00041 
00042 interface nsIMsgDBHdr;
00043 
00044     /* //TODO JavaDoc
00045        When implementing a js custom column handler (of type nsITreeView) you must implement the following
00046        functions:
00047        1. isEditable
00048        2. GetCellProperties
00049        3. GetImageSrc
00050        4. GetCellText
00051        5. CycleCell
00052        6. GetSortStringForRow
00053        7. GetSortLongForRow
00054        8. isString
00055        
00056        You can, at your option, implement 
00057        9.  GetRowProperties.
00058 
00059       If implementing a c++ custom column handler, you must define all 
00060       nsITreeView and nsIMsgCustomColumnHandler methods.
00061     */
00062 
00063 
00064 [scriptable, uuid(33ef10af-54fb-42ce-95d0-52d8f6f1e681)]
00065 interface nsIMsgCustomColumnHandler : nsITreeView
00066 {
00067   AString getSortStringForRow(in nsIMsgDBHdr aHdr);
00068   unsigned long getSortLongForRow(in nsIMsgDBHdr aHdr);
00069   boolean isString();
00070 }; 
00071