content/xul/document/src/nsXULControllers.h

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1998
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Original Author: David W. Hyatt (hyatt@netscape.com)
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either of the GNU General Public License Version 2 or later (the "GPL"),
  27  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 /*
  40
  41   The XUL "controllers" object.
  42
  43 */
  44
  45 #ifndef nsXULControllers_h__
  46 #define nsXULControllers_h__
  47
  48 #include "nsCOMPtr.h"
  49 #include "nsVoidArray.h"
  50 #include "nsWeakPtr.h"
  51 #include "nsIControllers.h"
  52 #include "nsISecurityCheckedComponent.h"
  53 #include "nsCycleCollectionParticipant.h"
  54
  55 /* non-XPCOM class for holding controllers and their IDs */
  56 class nsXULControllerData
  57 {
  58 public:
  59                             nsXULControllerData(PRUint32 inControllerID, nsIController* inController)
  60                             : mControllerID(inControllerID)
  61                             , mController(inController)
  62                             {
  63                             }
  64
  65                             ~nsXULControllerData() {}
  66
  67     PRUint32                GetControllerID()   { return mControllerID; }
  68
  69     nsresult                GetController(nsIController **outController)
  70                             {
  71                               NS_IF_ADDREF(*outController = mController);
  72                               return NS_OK;
  73                             }
  74
  75     PRUint32                mControllerID;
  76     nsCOMPtr<nsIController> mController;
  77 };
  78
  79
  80 NS_IMETHODIMP NS_NewXULControllers(nsISupports* aOuter, REFNSIID aIID, void** aResult);
  81
  82 class nsXULControllers : public nsIControllers,
  83                          public nsISecurityCheckedComponent
  84 {
  85 public:
  86     friend NS_IMETHODIMP
  87     NS_NewXULControllers(nsISupports* aOuter, REFNSIID aIID, void** aResult);
  88
  89     NS_DECL_CYCLE_COLLECTING_ISUPPORTS
  90     NS_DECL_CYCLE_COLLECTION_CLASS_AMBIGUOUS(nsXULControllers, nsIControllers)
  91     NS_DECL_NSICONTROLLERS
  92     NS_DECL_NSISECURITYCHECKEDCOMPONENT
  93
  94 protected:
  95     nsXULControllers();
  96     virtual ~nsXULControllers(void);
  97
  98     void        DeleteControllers();
  99
 100     nsVoidArray mControllers;
 101     PRUint32    mCurControllerID;
 102 };
 103
 104
 105
 106
 107 #endif // nsXULControllers_h__