ash/shelf/shelf_widget.h

   1 // Copyright (c) 2012 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_SHELF_SHELF_WIDGET_H_
   6 #define ASH_SHELF_SHELF_WIDGET_H_
   7
   8 #include "ash/ash_export.h"
   9 #include "ash/shelf/background_animator.h"
  10 #include "ash/shelf/shelf_types.h"
  11 #include "ui/views/widget/widget.h"
  12 #include "ui/views/widget/widget_observer.h"
  13
  14 namespace aura {
  15 class Window;
  16 }
  17
  18 namespace ash {
  19 class Launcher;
  20
  21 namespace internal {
  22 class FocusCycler;
  23 class StatusAreaWidget;
  24 class ShelfLayoutManager;
  25 class WorkspaceController;
  26 }
  27
  28 class ASH_EXPORT ShelfWidget : public views::Widget,
  29                                public views::WidgetObserver {
  30  public:
  31   ShelfWidget(
  32       aura::Window* shelf_container,
  33       aura::Window* status_container,
  34       internal::WorkspaceController* workspace_controller);
  35   virtual ~ShelfWidget();
  36
  37   void SetAlignment(ShelfAlignment alignmnet);
  38   ShelfAlignment GetAlignment() const;
  39
  40   // Sets whether the shelf paints a background. Default is false, but is set
  41   // to true if a window overlaps the shelf.
  42   void SetPaintsBackground(
  43       bool value,
  44       internal::BackgroundAnimator::ChangeType change_type);
  45   bool paints_background() const {
  46     return background_animator_.paints_background();
  47   }
  48
  49   // Causes shelf items to be slightly dimmed (eg when a window is maximized).
  50   void SetDimsShelf(bool dimming);
  51   bool GetDimsShelf() const;
  52
  53   internal::ShelfLayoutManager* shelf_layout_manager() {
  54     return shelf_layout_manager_;
  55   }
  56   Launcher* launcher() const { return launcher_.get(); }
  57   internal::StatusAreaWidget* status_area_widget() const {
  58     return status_area_widget_;
  59   }
  60
  61   void CreateLauncher();
  62
  63   // Set visibility of the launcher component of the shelf.
  64   void SetLauncherVisibility(bool visible);
  65   bool IsLauncherVisible() const;
  66
  67   // Sets the focus cycler.  Also adds the launcher to the cycle.
  68   void SetFocusCycler(internal::FocusCycler* focus_cycler);
  69   internal::FocusCycler* GetFocusCycler();
  70
  71   // Called by the activation delegate, before the launcher is activated
  72   // when no other windows are visible.
  73   void WillActivateAsFallback() { activating_as_fallback_ = true; }
  74
  75   aura::Window* window_container() { return window_container_; }
  76
  77   // TODO(harrym): Remove when Status Area Widget is a child view.
  78   void ShutdownStatusAreaWidget();
  79
  80   // Set the bounds of the widget and the dim shelf overlay.
  81   void SetWidgetBounds(const gfx::Rect& rect);
  82
  83   // Force the shelf to be presented in an undimmed state.
  84   void ForceUndimming(bool force);
  85
  86   // Overridden from views::WidgetObserver:
  87   virtual void OnWidgetActivationChanged(
  88       views::Widget* widget, bool active) OVERRIDE;
  89
  90   // A function to test the current alpha used by the dimming bar. If there is
  91   // no dimmer active, the function will return -1.
  92   int GetDimmingAlphaForTest();
  93
  94   // A function to test the bounds of the dimming bar. Returns gfx::Rect() if
  95   // the dimmer is inactive.
  96   gfx::Rect GetDimmerBoundsForTest();
  97
  98   // Disable dimming animations for running tests.
  99   void DisableDimmingAnimationsForTest();
 100
 101  private:
 102   class DelegateView;
 103
 104   internal::ShelfLayoutManager* shelf_layout_manager_;
 105   scoped_ptr<Launcher> launcher_;
 106   internal::StatusAreaWidget* status_area_widget_;
 107
 108   // delegate_view_ is attached to window_container_ and is cleaned up
 109   // during CloseChildWindows of the associated RootWindowController.
 110   DelegateView* delegate_view_;
 111   internal::BackgroundAnimator background_animator_;
 112   bool activating_as_fallback_;
 113   aura::Window* window_container_;
 114 };
 115
 116 }  // namespace ash
 117
 118 #endif  // ASH_SHELF_SHELF_WIDGET_H_