dom/base/BarProps.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 /* BarProps are the collection of little properties of DOM windows whose
   8    only property of their own is "visible".  They describe the window
   9    chrome which can be made visible or not through JavaScript by setting
  10    the appropriate property (window.menubar.visible)
  11 */
  12
  13 #ifndef mozilla_dom_BarProps_h
  14 #define mozilla_dom_BarProps_h
  15
  16 #include "mozilla/Attributes.h"
  17 #include "nsCycleCollectionParticipant.h"
  18 #include "nsWrapperCache.h"
  19 #include "nsPIDOMWindow.h"
  20 #include "mozilla/dom/BindingDeclarations.h"
  21 #include "mozilla/dom/BrowsingContext.h"
  22
  23 class nsGlobalWindowInner;
  24 class nsIWebBrowserChrome;
  25
  26 namespace mozilla {
  27
  28 class ErrorResult;
  29
  30 namespace dom {
  31
  32 // Script "BarProp" object
  33 class BarProp : public nsISupports, public nsWrapperCache {
  34  public:
  35   explicit BarProp(nsGlobalWindowInner* aWindow);
  36
  37   NS_DECL_CYCLE_COLLECTING_ISUPPORTS
  38   NS_DECL_CYCLE_COLLECTION_WRAPPERCACHE_CLASS(BarProp)
  39
  40   nsPIDOMWindowInner* GetParentObject() const;
  41
  42   JSObject* WrapObject(JSContext* aCx, JS::Handle<JSObject*> aGivenProto) final;
  43
  44   virtual bool GetVisible(CallerType aCallerType, ErrorResult& aRv) = 0;
  45   virtual void SetVisible(bool aVisible, CallerType aCallerType,
  46                           ErrorResult& aRv) = 0;
  47
  48  protected:
  49   virtual ~BarProp();
  50
  51   bool GetVisibleByIsPopup();
  52   bool GetVisibleByFlag(uint32_t aChromeFlag, CallerType aCallerType,
  53                         ErrorResult& aRv);
  54   void SetVisibleByFlag(bool aVisible, uint32_t aChromeFlag,
  55                         CallerType aCallerType, ErrorResult& aRv);
  56
  57   already_AddRefed<nsIWebBrowserChrome> GetBrowserChrome();
  58
  59   BrowsingContext* GetBrowsingContext();
  60
  61   RefPtr<nsGlobalWindowInner> mDOMWindow;
  62 };
  63
  64 // Script "menubar" object
  65 class MenubarProp final : public BarProp {
  66  public:
  67   explicit MenubarProp(nsGlobalWindowInner* aWindow);
  68   virtual ~MenubarProp();
  69
  70   bool GetVisible(CallerType aCallerType, ErrorResult& aRv) override;
  71   void SetVisible(bool aVisible, CallerType aCallerType,
  72                   ErrorResult& aRv) override;
  73 };
  74
  75 // Script "toolbar" object
  76 class ToolbarProp final : public BarProp {
  77  public:
  78   explicit ToolbarProp(nsGlobalWindowInner* aWindow);
  79   virtual ~ToolbarProp();
  80
  81   bool GetVisible(CallerType aCallerType, ErrorResult& aRv) override;
  82   void SetVisible(bool aVisible, CallerType aCallerType,
  83                   ErrorResult& aRv) override;
  84 };
  85
  86 // Script "locationbar" object
  87 class LocationbarProp final : public BarProp {
  88  public:
  89   explicit LocationbarProp(nsGlobalWindowInner* aWindow);
  90   virtual ~LocationbarProp();
  91
  92   bool GetVisible(CallerType aCallerType, ErrorResult& aRv) override;
  93   void SetVisible(bool aVisible, CallerType aCallerType,
  94                   ErrorResult& aRv) override;
  95 };
  96
  97 // Script "personalbar" object
  98 class PersonalbarProp final : public BarProp {
  99  public:
 100   explicit PersonalbarProp(nsGlobalWindowInner* aWindow);
 101   virtual ~PersonalbarProp();
 102
 103   bool GetVisible(CallerType aCallerType, ErrorResult& aRv) override;
 104   void SetVisible(bool aVisible, CallerType aCallerType,
 105                   ErrorResult& aRv) override;
 106 };
 107
 108 // Script "statusbar" object
 109 class StatusbarProp final : public BarProp {
 110  public:
 111   explicit StatusbarProp(nsGlobalWindowInner* aWindow);
 112   virtual ~StatusbarProp();
 113
 114   bool GetVisible(CallerType aCallerType, ErrorResult& aRv) override;
 115   void SetVisible(bool aVisible, CallerType aCallerType,
 116                   ErrorResult& aRv) override;
 117 };
 118
 119 // Script "scrollbars" object
 120 class ScrollbarsProp final : public BarProp {
 121  public:
 122   explicit ScrollbarsProp(nsGlobalWindowInner* aWindow);
 123   virtual ~ScrollbarsProp();
 124
 125   bool GetVisible(CallerType aCallerType, ErrorResult& aRv) override;
 126   void SetVisible(bool aVisible, CallerType aCallerType,
 127                   ErrorResult& aRv) override;
 128 };
 129
 130 }  // namespace dom
 131 }  // namespace mozilla
 132
 133 #endif /* mozilla_dom_BarProps_h */