ash/system/chromeos/rotation/tray_rotation_lock.h

   1 // Copyright 2014 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef ASH_SYSTEM_CHROMEOS_ROTATION_TRAY_ROTATION_LOCK_H_
   6 #define ASH_SYSTEM_CHROMEOS_ROTATION_TRAY_ROTATION_LOCK_H_
   7
   8 #include "ash/content/display/screen_orientation_controller_chromeos.h"
   9 #include "ash/shell_observer.h"
  10 #include "ash/system/tray/tray_image_item.h"
  11
  12 namespace ash {
  13
  14 namespace tray {
  15 class RotationLockDefaultView;
  16 }  // namespace tray
  17
  18 // TrayRotationLock is a provider of views for the SystemTray. Both a tray view
  19 // and a default view are provided. Each view indicates the current state of
  20 // the rotation lock for the display which it appears on. The default view can
  21 // be interacted with, it toggles the state of the rotation lock.
  22 // TrayRotationLock is only available on the primary display.
  23 class ASH_EXPORT TrayRotationLock
  24     : public TrayImageItem,
  25       public ScreenOrientationController::Observer,
  26       public ShellObserver {
  27  public:
  28   explicit TrayRotationLock(SystemTray* system_tray);
  29   ~TrayRotationLock() override;
  30
  31   // ScreenOrientationController::Observer:
  32   void OnRotationLockChanged(bool rotation_locked) override;
  33
  34   // SystemTrayItem:
  35   views::View* CreateDefaultView(user::LoginStatus status) override;
  36
  37   // ShellObserver:
  38   void OnMaximizeModeStarted() override;
  39   void OnMaximizeModeEnded() override;
  40
  41   // TrayImageItem:
  42   void DestroyTrayView() override;
  43
  44  protected:
  45   // TrayImageItem:
  46   bool GetInitialVisibility() override;
  47
  48  private:
  49   friend class TrayRotationLockTest;
  50
  51   // True if |on_primary_display_|, maximize mode is enabled, and rotation is
  52   // locked.
  53   bool ShouldBeVisible();
  54
  55   // True if this is owned by a SystemTray on the primary display.
  56   bool OnPrimaryDisplay() const;
  57
  58   // Removes TrayRotationLock as a ScreenOrientationController::Observer if
  59   // currently observing.
  60   void StopObservingRotation();
  61
  62   // Removes TrayRotationLock as a ShellObserver if currently observing.
  63   void StopObservingShell();
  64
  65   // True while added as a ScreenOrientationController::Observer.
  66   bool observing_rotation_;
  67
  68   // True while added as a ShellObserver.
  69   bool observing_shell_;
  70
  71   DISALLOW_COPY_AND_ASSIGN(TrayRotationLock);
  72 };
  73
  74 }  // namespace ash
  75
  76 #endif  // ASH_SYSTEM_CHROMEOS_ROTATION_TRAY_ROTATION_LOCK_H_