Back to index

lightning-sunbird  0.9+nobinonly
nsMenuItemIcon.h
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 support for icons in native menu items on Mac OS X.
00016  *
00017  * The Initial Developer of the Original Code is Google Inc.
00018  * Portions created by the Initial Developer are Copyright (C) 2006
00019  * the Initial Developer. All Rights Reserved.
00020  *
00021  * Contributor(s):
00022  *  Mark Mentovai <mark@moxienet.com> (Original Author)
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either the GNU General Public License Version 2 or later (the "GPL"), or
00026  * 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 /*
00039  * Retrieves and displays icons in native menu items on Mac OS X.
00040  */
00041 
00042 
00043 #ifndef nsMenuItemIcon_h__
00044 #define nsMenuItemIcon_h__
00045 
00046 
00047 #include "nsCOMPtr.h"
00048 #include "imgIDecoderObserver.h"
00049 
00050 class nsIURI;
00051 class nsIContent;
00052 class imgIRequest;
00053 class nsIMenu_MOZILLA_1_8_BRANCH;
00054 
00055 #include <Carbon/Carbon.h>
00056 
00057 
00058 class nsMenuItemIcon : public imgIDecoderObserver,
00059                        public imgIDecoderObserver_MOZILLA_1_8_BRANCH
00060 {
00061 public:
00062   nsMenuItemIcon(nsISupports*                aMenuItem,
00063                  nsIMenu_MOZILLA_1_8_BRANCH* aMenu,
00064                  nsIContent*                 aContent);
00065 private:
00066   ~nsMenuItemIcon();
00067 
00068 public:
00069   NS_DECL_ISUPPORTS
00070   NS_DECL_IMGICONTAINEROBSERVER
00071   NS_DECL_IMGIDECODEROBSERVER
00072   NS_DECL_IMGIDECODEROBSERVER_MOZILLA_1_8_BRANCH
00073 
00074   // SetupIcon succeeds if it was able to set up the icon, or if there should
00075   // be no icon, in which case it clears any existing icon but still succeeds.
00076   nsresult SetupIcon();
00077 
00078   // GetIconURI fails if the item should not have any icon.
00079   nsresult GetIconURI(nsIURI** aIconURI);
00080 
00081   // LoadIcon will set a placeholder image and start a load request for the
00082   // icon.  The request may not complete until after LoadIcon returns.
00083   nsresult LoadIcon(nsIURI* aIconURI);
00084 
00085   // ShouldLoadSync returns PR_TRUE if the LoadIcon should load the icon
00086   // synchronously.
00087   PRBool ShouldLoadSync(nsIURI* aURI);
00088 
00089 protected:
00090   nsCOMPtr<nsIContent>        mContent;
00091   nsCOMPtr<imgIRequest>       mIconRequest;
00092   nsISupports*                mMenuItem;
00093   nsIMenu_MOZILLA_1_8_BRANCH* mMenu;
00094   MenuRef                     mMenuRef;
00095   PRUint16                    mMenuItemIndex;
00096   PRPackedBool                mLoadedIcon;
00097   PRPackedBool                mSetIcon;
00098 };
00099 
00100 #endif /* nsMenuItemIcon_h__ */