ash/wm/overview/scoped_transform_overview_window.h

   1 // Copyright 2013 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_WM_OVERVIEW_SCOPED_TRANSFORM_OVERVIEW_WINDOW_H_
   6 #define ASH_WM_OVERVIEW_SCOPED_TRANSFORM_OVERVIEW_WINDOW_H_
   7
   8 #include "base/compiler_specific.h"
   9 #include "ui/gfx/rect.h"
  10 #include "ui/gfx/transform.h"
  11
  12 namespace aura {
  13 class RootWindow;
  14 class Window;
  15 }
  16
  17 namespace ui {
  18 class Layer;
  19 }
  20
  21 namespace views {
  22 class Widget;
  23 }
  24
  25 namespace ash {
  26
  27 // Manages a window in the overview mode. This class allows transforming the
  28 // window with a helper to determine the best fit in certain bounds and
  29 // copies the window if being moved to another display. The window's state is
  30 // restored on destruction of this object.
  31 class ScopedTransformOverviewWindow {
  32  public:
  33   // The duration of transitions used for window transforms.
  34   static const int kTransitionMilliseconds;
  35
  36   // Returns the transform necessary to fit |rect| into |bounds| preserving
  37   // aspect ratio and centering.
  38   static gfx::Transform GetTransformForRectPreservingAspectRatio(
  39       const gfx::Rect& rect,
  40       const gfx::Rect& bounds);
  41
  42   explicit ScopedTransformOverviewWindow(aura::Window* window);
  43   virtual ~ScopedTransformOverviewWindow();
  44
  45   // Returns true if this window selector window contains the |target|. This is
  46   // used to determine if an event targetted this window.
  47   bool Contains(const aura::Window* target) const;
  48
  49   // Returns the original bounds of all transformed windows.
  50   gfx::Rect GetBoundsInScreen() const;
  51
  52   // Restores the window if it was minimized.
  53   void RestoreWindow();
  54
  55   // Restores this window on exit rather than returning it to a minimized state
  56   // if it was minimized on entering overview mode.
  57   void RestoreWindowOnExit();
  58
  59   // Informs the ScopedTransformOverviewWindow that the window being watched was
  60   // destroyed. This resets the internal window pointer to avoid calling
  61   // anything on the window at destruction time.
  62   void OnWindowDestroyed();
  63
  64   // Prepares for overview mode by doing any necessary actions before entering.
  65   virtual void PrepareForOverview();
  66
  67   // Sets |transform| on the window and a copy of the window if the target
  68   // |root_window| is not the window's root window. If |animate| the transform
  69   // is animated in, otherwise it is immediately applied.
  70   void SetTransform(aura::RootWindow* root_window,
  71                     const gfx::Transform& transform,
  72                     bool animate);
  73
  74   aura::Window* window() const { return window_; }
  75
  76  private:
  77   // Applies the |transform| to the overview window and all of its transient
  78   // children using animations. If |animate| the transform is animated in,
  79   // otherwise it is applied immediately.
  80   void SetTransformOnWindowAndTransientChildren(const gfx::Transform& transform,
  81                                                 bool animate);
  82
  83   // A weak pointer to the real window in the overview.
  84   aura::Window* window_;
  85
  86   // A copy of the window used to transition the window to another root.
  87   views::Widget* window_copy_;
  88
  89   // A weak pointer to a deep copy of the window's layers.
  90   ui::Layer* layer_;
  91
  92   // If true, the window was minimized and should be restored if the window
  93   // was not selected.
  94   bool minimized_;
  95
  96   // Tracks if this window was ignored by the shelf.
  97   bool ignored_by_shelf_;
  98
  99   // True if the window has been transformed for overview mode.
 100   bool overview_started_;
 101
 102   // The original transform of the window before entering overview mode.
 103   gfx::Transform original_transform_;
 104
 105   DISALLOW_COPY_AND_ASSIGN(ScopedTransformOverviewWindow);
 106 };
 107
 108 }  // namespace ash
 109
 110 #endif  // ASH_WM_OVERVIEW_SCOPED_TRANSFORM_OVERVIEW_WINDOW_H_