Back to index

lightning-sunbird  0.9+nobinonly
nsBarProps.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 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  *
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 /* BarProps are the collection of little properties of DOM windows whose
00039    only property of their own is "visible".  They describe the window
00040    chrome which can be made visible or not through JavaScript by setting
00041    the appropriate property (window.menubar.visible)
00042 */
00043 
00044 #ifndef nsBarProps_h___
00045 #define nsBarProps_h___
00046 
00047 #include "nscore.h"
00048 #include "nsIScriptContext.h"
00049 #include "nsIDOMBarProp.h"
00050 #include "nsIWeakReference.h"
00051 
00052 class nsGlobalWindow;
00053 class nsIWebBrowserChrome;
00054 
00055 // Script "BarProp" object
00056 class nsBarProp : public nsIDOMBarProp
00057 {
00058 public:
00059   nsBarProp();
00060   virtual ~nsBarProp();
00061 
00062   NS_DECL_ISUPPORTS
00063 
00064   NS_IMETHOD SetWebBrowserChrome(nsIWebBrowserChrome* aBrowserChrome);
00065 
00066   NS_IMETHOD GetVisibleByFlag(PRBool *aVisible, PRUint32 aChromeFlag);
00067   NS_IMETHOD SetVisibleByFlag(PRBool aVisible, PRUint32 aChromeFlag);
00068 
00069 protected:
00070   // Weak Reference
00071   nsIWebBrowserChrome* mBrowserChrome;
00072 };
00073 
00074 // Script "menubar" object
00075 class nsMenubarProp : public nsBarProp
00076 {
00077 public:
00078   nsMenubarProp();
00079   virtual ~nsMenubarProp();
00080 
00081   NS_DECL_NSIDOMBARPROP
00082 };
00083 
00084 // Script "toolbar" object
00085 class nsToolbarProp : public nsBarProp
00086 {
00087 public:
00088   nsToolbarProp();
00089   virtual ~nsToolbarProp();
00090 
00091   NS_DECL_NSIDOMBARPROP
00092 };
00093 
00094 // Script "locationbar" object
00095 class nsLocationbarProp : public nsBarProp
00096 {
00097 public:
00098   nsLocationbarProp();
00099   virtual ~nsLocationbarProp();
00100 
00101   NS_DECL_NSIDOMBARPROP
00102 };
00103 
00104 // Script "personalbar" object
00105 class nsPersonalbarProp : public nsBarProp
00106 {
00107 public:
00108   nsPersonalbarProp();
00109   virtual ~nsPersonalbarProp();
00110 
00111   NS_DECL_NSIDOMBARPROP
00112 };
00113 
00114 // Script "statusbar" object
00115 class nsStatusbarProp : public nsBarProp
00116 {
00117 public:
00118   nsStatusbarProp();
00119   virtual ~nsStatusbarProp();
00120 
00121   NS_DECL_NSIDOMBARPROP
00122 };
00123 
00124 // Script "scrollbars" object
00125 class nsScrollbarsProp : public nsBarProp {
00126 public:
00127   nsScrollbarsProp(nsGlobalWindow *aWindow);
00128   virtual ~nsScrollbarsProp();
00129 
00130   NS_DECL_NSIDOMBARPROP
00131 
00132 private:
00133   nsGlobalWindow           *mDOMWindow;
00134   nsCOMPtr<nsIWeakReference>  mDOMWindowWeakref;
00135   /* Note the odd double reference to the owning global window.
00136      Since the corresponding DOM window nominally owns this object,
00137      yet refcounted ownership of this object can be handed off to
00138      owners unknown, we need a weak ref to back to the DOM window.
00139      However we also need access to properties of the DOM Window
00140      that aren't available through interfaces. Then it's either
00141      a weak ref and some skanky casting, or this funky double ref.
00142      Funky beats skanky, so here we are. */
00143 };
00144 
00145 #endif /* nsBarProps_h___ */
00146