widget/nsBaseScreen.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  * vim: sw=2 ts=8 et :
   3  */
   4 /* This Source Code Form is subject to the terms of the Mozilla Public
   5  * License, v. 2.0. If a copy of the MPL was not distributed with this
   6  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   7
   8 #ifndef nsBaseScreen_h
   9 #define nsBaseScreen_h
  10
  11 #include "mozilla/Attributes.h"
  12 #include "nsIScreen.h"
  13
  14 class nsBaseScreen : public nsIScreen
  15 {
  16 public:
  17   nsBaseScreen();
  18
  19   NS_DECL_ISUPPORTS
  20
  21   // nsIScreen interface
  22
  23   // These simply forward to the device-pixel versions;
  24   // implementations where global display pixels may not correspond
  25   // to per-screen device pixels must override.
  26   NS_IMETHOD GetRectDisplayPix(int32_t *outLeft,  int32_t *outTop,
  27                                int32_t *outWidth, int32_t *outHeight) MOZ_OVERRIDE;
  28   NS_IMETHOD GetAvailRectDisplayPix(int32_t *outLeft,  int32_t *outTop,
  29                                     int32_t *outWidth, int32_t *outHeight) MOZ_OVERRIDE;
  30
  31   /**
  32    * Simple management of screen brightness locks. This abstract base class
  33    * allows all widget implementations to share brightness locking code.
  34    */
  35   NS_IMETHOD LockMinimumBrightness(uint32_t aBrightness) MOZ_OVERRIDE;
  36   NS_IMETHOD UnlockMinimumBrightness(uint32_t aBrightness) MOZ_OVERRIDE;
  37
  38   NS_IMETHOD GetRotation(uint32_t* aRotation) MOZ_OVERRIDE {
  39     *aRotation = nsIScreen::ROTATION_0_DEG;
  40     return NS_OK;
  41   }
  42   NS_IMETHOD SetRotation(uint32_t aRotation) MOZ_OVERRIDE { return NS_ERROR_NOT_AVAILABLE; }
  43
  44   NS_IMETHOD GetContentsScaleFactor(double* aContentsScaleFactor) MOZ_OVERRIDE;
  45
  46 protected:
  47   virtual ~nsBaseScreen();
  48
  49   /**
  50    * Manually set the current level of brightness locking. This is called after
  51    * we determine, based on the current active locks, what the strongest
  52    * lock is. You should normally not call this function - it will be
  53    * called automatically by this class.
  54    *
  55    * Each widget implementation should implement this in a way that
  56    * makes sense there. This is normally the only function that
  57    * contains widget-specific code.
  58    *
  59    * The default implementation does nothing.
  60    *
  61    * @param aBrightness The current brightness level to set. If this is
  62    *                    nsIScreen::BRIGHTNESS_LEVELS
  63    *                    (an impossible value for a brightness level to be),
  64    *                    then that signifies that there is no current
  65    *                    minimum brightness level, and the screen can shut off.
  66    */
  67   virtual void ApplyMinimumBrightness(uint32_t aBrightness) { }
  68
  69 private:
  70   /**
  71    * Checks what the minimum brightness value is, and calls
  72    * ApplyMinimumBrightness.
  73    */
  74   void CheckMinimumBrightness();
  75
  76   uint32_t mBrightnessLocks[nsIScreen::BRIGHTNESS_LEVELS];
  77 };
  78
  79 #endif // nsBaseScreen_h