Back to index

lightning-sunbird  0.9+nobinonly
nsIconURI.h
Go to the documentation of this file.
00001 /* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
00002  *
00003  * ***** BEGIN LICENSE BLOCK *****
00004  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00005  *
00006  * The contents of this file are subject to the Mozilla Public License Version
00007  * 1.1 (the "License"); you may not use this file except in compliance with
00008  * the License. You may obtain a copy of the License at
00009  * http://www.mozilla.org/MPL/
00010  *
00011  * Software distributed under the License is distributed on an "AS IS" basis,
00012  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00013  * for the specific language governing rights and limitations under the
00014  * License.
00015  *
00016  * The Original Code is mozilla.org Code.
00017  *
00018  * The Initial Developer of the Original Code is
00019  * Netscape Communications Corporation.
00020  * Portions created by the Initial Developer are Copyright (C) 1998
00021  * the Initial Developer. All Rights Reserved.
00022  *
00023  * Contributor(s):
00024  *   Scott MacGregor <mscott@netscape.com>
00025  *
00026  * Alternatively, the contents of this file may be used under the terms of
00027  * either the GNU General Public License Version 2 or later (the "GPL"), or
00028  * 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 #ifndef nsMozIconURI_h__
00041 #define nsMozIconURI_h__
00042 
00043 #include "nsIIconURI.h"
00044 #include "nsCOMPtr.h"
00045 #include "nsString.h"
00046 struct nsStaticAtom;
00047 
00048 class nsIAtom;
00049 
00050 #define NS_MOZICONURI_CID                            \
00051 {                                                    \
00052     0x43a88e0e,                                      \
00053     0x2d37,                                          \
00054     0x11d5,                                          \
00055     { 0x99, 0x7, 0x0, 0x10, 0x83, 0x1, 0xe, 0x9b }   \
00056 }
00057 
00058 class nsMozIconURI : public nsIMozIconURI
00059 {
00060 public:    
00061   NS_DECL_ISUPPORTS
00062   NS_DECL_NSIURI
00063   NS_DECL_NSIMOZICONURI
00064 
00065   static void InitAtoms();
00066 
00067   // nsJARURI
00068   nsMozIconURI();
00069   virtual ~nsMozIconURI();
00070 
00071 protected:
00072   nsCOMPtr<nsIURI> mFileIcon; // the file url we want the icon for....
00073   PRUint32 mSize; // the # of pixels in a row that we want for this image. Typically 16, 32, 128, etc.
00074   nsCString mContentType; // optional field explicitly specifying the content type
00075   nsCString mDummyFilePath; // if we don't have a valid file url, the file path is stored here....i.e if mFileIcon is null.....
00076   nsCString mStockIcon;
00077   nsCOMPtr<nsIAtom> mIconSize;
00078   nsCOMPtr<nsIAtom> mIconState;
00079 
00080   static const nsStaticAtom sSizeAtoms[];
00081   static const nsStaticAtom sStateAtoms[];
00082 
00083   nsresult FormatSpec(nsACString &result);
00084 };
00085 
00086 #endif // nsMozIconURI_h__