Back to index

lightning-sunbird  0.9+nobinonly
nsMsgResultElement.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
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) 1999
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either of the GNU General Public License Version 2 or later (the "GPL"),
00026  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #ifndef __nsMsgResultElement_h
00039 #define __nsMsgResultElement_h
00040 
00041 #include "nsMsgSearchCore.h"
00042 #include "nsIMsgSearchAdapter.h"
00043 #include "nsMsgSearchArray.h"
00044 
00045 // nsMsgResultElement specifies a single search hit.
00046 
00047 //---------------------------------------------------------------------------
00048 // nsMsgResultElement is a list of attribute/value pairs which are used to
00049 // represent a search hit without requiring a message header or server connection
00050 //---------------------------------------------------------------------------
00051 
00052 class nsMsgResultElement
00053 {
00054 public:
00055        nsMsgResultElement (nsIMsgSearchAdapter *);
00056        virtual ~nsMsgResultElement ();
00057 
00058        static nsresult AssignValues (nsIMsgSearchValue *src, nsMsgSearchValue *dst);
00059        nsresult GetValue (nsMsgSearchAttribValue, nsMsgSearchValue **) const;
00060        nsresult AddValue (nsIMsgSearchValue*);
00061     nsresult AddValue (nsMsgSearchValue*);
00062 
00063        nsresult GetPrettyName (nsMsgSearchValue**);
00064 
00065 
00066        nsresult GetValueRef (nsMsgSearchAttribValue, nsIMsgSearchValue**) const;
00067        nsresult Open (void *window);
00068 
00069        // added as part of the search as view capabilities...
00070        static int CompareByFolderInfoPtrs (const void *, const void *);  
00071 
00072        static int Compare (const void *, const void *);
00073        static nsresult DestroyValue (nsIMsgSearchValue *value);
00074 
00075     nsCOMPtr<nsISupportsArray> m_valueList;
00076        nsIMsgSearchAdapter *m_adapter;
00077 
00078 protected:
00079 };
00080 
00081 #endif