Back to index

lightning-sunbird  0.9+nobinonly
nsXULControllers.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) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Original Author: David W. Hyatt (hyatt@netscape.com)
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either of the GNU General Public License Version 2 or later (the "GPL"),
00027  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00028  * in which case the provisions of the GPL or the LGPL are applicable instead
00029  * of those above. If you wish to allow use of your version of this file only
00030  * under the terms of either the GPL or the LGPL, and not to allow others to
00031  * use your version of this file under the terms of the MPL, indicate your
00032  * decision by deleting the provisions above and replace them with the notice
00033  * and other provisions required by the GPL or the LGPL. If you do not delete
00034  * the provisions above, a recipient may use your version of this file under
00035  * the terms of any one of the MPL, the GPL or the LGPL.
00036  *
00037  * ***** END LICENSE BLOCK ***** */
00038 
00039 /*
00040 
00041   The XUL "controllers" object.
00042 
00043 */
00044 
00045 #ifndef nsXULControllers_h__
00046 #define nsXULControllers_h__
00047 
00048 #include "nsCOMPtr.h"
00049 #include "nsVoidArray.h"
00050 #include "nsWeakPtr.h"
00051 #include "nsIControllers.h"
00052 #include "nsISupportsArray.h"
00053 #include "nsISecurityCheckedComponent.h"
00054 
00055 class nsIDOMXULCommandDispatcher;
00056 
00057 
00058 /* non-XPCOM class for holding controllers and their IDs */
00059 class nsXULControllerData
00060 {
00061 public:
00062                             nsXULControllerData(PRUint32 inControllerID, nsIController* inController)
00063                             : mControllerID(inControllerID)
00064                             , mController(inController)
00065                             {                            
00066                             }
00067 
00068                             ~nsXULControllerData() {}
00069 
00070     PRUint32                GetControllerID()   { return mControllerID; }
00071 
00072     nsresult                GetController(nsIController **outController)
00073                             {
00074                               NS_IF_ADDREF(*outController = mController);
00075                               return NS_OK;
00076                             }
00077     
00078 protected:
00079 
00080     PRUint32                mControllerID;
00081     nsCOMPtr<nsIController> mController;
00082 };
00083 
00084 
00085 NS_IMETHODIMP NS_NewXULControllers(nsISupports* aOuter, REFNSIID aIID, void** aResult);
00086 
00087 class nsXULControllers : public nsIControllers,
00088                          public nsISecurityCheckedComponent
00089 {
00090 public:
00091     friend NS_IMETHODIMP
00092     NS_NewXULControllers(nsISupports* aOuter, REFNSIID aIID, void** aResult);
00093 
00094     NS_DECL_ISUPPORTS
00095     NS_DECL_NSICONTROLLERS
00096     NS_DECL_NSISECURITYCHECKEDCOMPONENT
00097   
00098 protected:
00099     nsXULControllers();
00100     virtual ~nsXULControllers(void);
00101 
00102     void        DeleteControllers();
00103 
00104     nsVoidArray mControllers;
00105     nsWeakPtr mCommandDispatcher;
00106     PRUint32    mCurControllerID;
00107 };
00108 
00109 
00110 
00111 
00112 #endif // nsXULControllers_h__