| OLD | NEW |
| 1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. | 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 | 2 // Use of this source code is governed by a BSD-style license that can be |
| 3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
| 4 | 4 |
| 5 #ifndef ASH_DESKTOP_BACKGROUND_DESKTOP_BACKGROUND_CONTROLLER_H_ | 5 #ifndef ASH_DESKTOP_BACKGROUND_DESKTOP_BACKGROUND_CONTROLLER_H_ |
| 6 #define ASH_DESKTOP_BACKGROUND_DESKTOP_BACKGROUND_CONTROLLER_H_ | 6 #define ASH_DESKTOP_BACKGROUND_DESKTOP_BACKGROUND_CONTROLLER_H_ |
| 7 | 7 |
| 8 #include "ash/ash_export.h" | 8 #include "ash/ash_export.h" |
| 9 #include "ash/display/display_controller.h" | 9 #include "ash/display/display_controller.h" |
| 10 #include "base/basictypes.h" | 10 #include "base/basictypes.h" |
| 11 #include "base/files/file_path.h" | 11 #include "base/files/file_path.h" |
| 12 #include "base/gtest_prod_util.h" | 12 #include "base/gtest_prod_util.h" |
| 13 #include "base/memory/scoped_ptr.h" | 13 #include "base/memory/scoped_ptr.h" |
| 14 #include "base/memory/weak_ptr.h" | 14 #include "base/memory/weak_ptr.h" |
| 15 #include "base/observer_list.h" | 15 #include "base/observer_list.h" |
| 16 #include "base/timer/timer.h" | 16 #include "base/timer/timer.h" |
| 17 #include "ui/compositor/layer.h" | 17 #include "ui/compositor/layer.h" |
| 18 #include "ui/gfx/image/image_skia.h" | 18 #include "ui/gfx/image/image_skia.h" |
| 19 | 19 |
| 20 typedef unsigned int SkColor; | 20 typedef unsigned int SkColor; |
| 21 | 21 |
| 22 namespace aura { | 22 namespace aura { |
| 23 class Window; | 23 class Window; |
| 24 } | 24 } |
| 25 | 25 |
| 26 namespace base { | |
| 27 class CommandLine; | |
| 28 } | |
| 29 | |
| 30 namespace ash { | 26 namespace ash { |
| 31 | 27 |
| 32 enum WallpaperLayout { | 28 enum WallpaperLayout { |
| 33 // Center the wallpaper on the desktop without scaling it. The wallpaper | 29 // Center the wallpaper on the desktop without scaling it. The wallpaper |
| 34 // may be cropped. | 30 // may be cropped. |
| 35 WALLPAPER_LAYOUT_CENTER, | 31 WALLPAPER_LAYOUT_CENTER, |
| 36 // Scale the wallpaper (while preserving its aspect ratio) to cover the | 32 // Scale the wallpaper (while preserving its aspect ratio) to cover the |
| 37 // desktop; the wallpaper may be cropped. | 33 // desktop; the wallpaper may be cropped. |
| 38 WALLPAPER_LAYOUT_CENTER_CROPPED, | 34 WALLPAPER_LAYOUT_CENTER_CROPPED, |
| 39 // Scale the wallpaper (without preserving its aspect ratio) to match the | 35 // Scale the wallpaper (without preserving its aspect ratio) to match the |
| 40 // desktop's size. | 36 // desktop's size. |
| 41 WALLPAPER_LAYOUT_STRETCH, | 37 WALLPAPER_LAYOUT_STRETCH, |
| 42 // Tile the wallpaper over the background without scaling it. | 38 // Tile the wallpaper over the background without scaling it. |
| 43 WALLPAPER_LAYOUT_TILE, | 39 WALLPAPER_LAYOUT_TILE, |
| 44 }; | 40 }; |
| 45 | 41 |
| 46 enum WallpaperResolution { | |
| 47 WALLPAPER_RESOLUTION_LARGE, | |
| 48 WALLPAPER_RESOLUTION_SMALL | |
| 49 }; | |
| 50 | |
| 51 const SkColor kLoginWallpaperColor = 0xFEFEFE; | 42 const SkColor kLoginWallpaperColor = 0xFEFEFE; |
| 52 | 43 |
| 53 // The width and height of small/large resolution wallpaper. When screen size is | |
| 54 // smaller than |kSmallWallpaperMaxWidth| and |kSmallWallpaperMaxHeight|, the | |
| 55 // small resolution wallpaper should be used. Otherwise, uses the large | |
| 56 // resolution wallpaper. | |
| 57 ASH_EXPORT extern const int kSmallWallpaperMaxWidth; | |
| 58 ASH_EXPORT extern const int kSmallWallpaperMaxHeight; | |
| 59 ASH_EXPORT extern const int kLargeWallpaperMaxWidth; | |
| 60 ASH_EXPORT extern const int kLargeWallpaperMaxHeight; | |
| 61 | |
| 62 // The width and heigh of wallpaper thumbnails. | |
| 63 ASH_EXPORT extern const int kWallpaperThumbnailWidth; | |
| 64 ASH_EXPORT extern const int kWallpaperThumbnailHeight; | |
| 65 | |
| 66 class DesktopBackgroundControllerObserver; | 44 class DesktopBackgroundControllerObserver; |
| 67 class WallpaperResizer; | 45 class WallpaperResizer; |
| 68 | 46 |
| 69 // Loads selected desktop wallpaper from file system asynchronously and updates | 47 // Updates background layer if necessary. |
| 70 // background layer if loaded successfully. | |
| 71 class ASH_EXPORT DesktopBackgroundController | 48 class ASH_EXPORT DesktopBackgroundController |
| 72 : public DisplayController::Observer { | 49 : public DisplayController::Observer { |
| 73 public: | 50 public: |
| 51 class TestAPI; |
| 52 |
| 74 enum BackgroundMode { | 53 enum BackgroundMode { |
| 75 BACKGROUND_NONE, | 54 BACKGROUND_NONE, |
| 76 BACKGROUND_IMAGE, | 55 BACKGROUND_IMAGE, |
| 77 }; | 56 }; |
| 78 | 57 |
| 79 DesktopBackgroundController(); | 58 DesktopBackgroundController(); |
| 80 virtual ~DesktopBackgroundController(); | 59 virtual ~DesktopBackgroundController(); |
| 81 | 60 |
| 82 BackgroundMode desktop_background_mode() const { | 61 BackgroundMode desktop_background_mode() const { |
| 83 return desktop_background_mode_; | 62 return desktop_background_mode_; |
| 84 } | 63 } |
| 85 | 64 |
| 86 void set_command_line_for_testing(base::CommandLine* command_line) { | |
| 87 command_line_for_testing_ = command_line; | |
| 88 } | |
| 89 | |
| 90 // Add/Remove observers. | 65 // Add/Remove observers. |
| 91 void AddObserver(DesktopBackgroundControllerObserver* observer); | 66 void AddObserver(DesktopBackgroundControllerObserver* observer); |
| 92 void RemoveObserver(DesktopBackgroundControllerObserver* observer); | 67 void RemoveObserver(DesktopBackgroundControllerObserver* observer); |
| 93 | 68 |
| 94 // Provides current image on the background, or empty gfx::ImageSkia if there | 69 // Provides current image on the background, or empty gfx::ImageSkia if there |
| 95 // is no image, e.g. background is none. | 70 // is no image, e.g. background is none. |
| 96 gfx::ImageSkia GetWallpaper() const; | 71 gfx::ImageSkia GetWallpaper() const; |
| 97 | 72 |
| 98 WallpaperLayout GetWallpaperLayout() const; | 73 WallpaperLayout GetWallpaperLayout() const; |
| 99 | 74 |
| 100 // Initialize root window's background. | 75 // Initialize root window's background. |
| 101 void OnRootWindowAdded(aura::Window* root_window); | 76 void OnRootWindowAdded(aura::Window* root_window); |
| 102 | 77 |
| 103 // Loads builtin wallpaper asynchronously and sets to current wallpaper | 78 // Sets wallpaper. This is mostly called by WallpaperManager to set |
| 104 // after loaded. Returns true if the controller started loading the | 79 // the default or user selected custom wallpaper. |
| 105 // wallpaper and false otherwise (i.e. the appropriate wallpaper was | 80 // Returns true if new image was actually set. And false when duplicate set |
| 106 // already loading or loaded). | 81 // request detected. |
| 107 bool SetDefaultWallpaper(bool is_guest); | 82 bool SetWallpaperImage(const gfx::ImageSkia& image, WallpaperLayout layout); |
| 108 | 83 // The same, but image from resources is used. |
| 109 // Sets the user selected custom wallpaper. Called when user selected a file | 84 bool SetWallpaperResource(int resource_id, WallpaperLayout layout); |
| 110 // from file system or changed the layout of wallpaper. | |
| 111 void SetCustomWallpaper(const gfx::ImageSkia& image, WallpaperLayout layout); | |
| 112 | |
| 113 // Cancels |default_wallpaper_loader_| if non-NULL. | |
| 114 void CancelDefaultWallpaperLoader(); | |
| 115 | 85 |
| 116 // Creates an empty wallpaper. Some tests require a wallpaper widget is ready | 86 // Creates an empty wallpaper. Some tests require a wallpaper widget is ready |
| 117 // when running. However, the wallpaper widgets are now created | 87 // when running. However, the wallpaper widgets are now created |
| 118 // asynchronously. If loading a real wallpaper, there are cases that these | 88 // asynchronously. If loading a real wallpaper, there are cases that these |
| 119 // tests crash because the required widget is not ready. This function | 89 // tests crash because the required widget is not ready. This function |
| 120 // synchronously creates an empty widget for those tests to prevent | 90 // synchronously creates an empty widget for those tests to prevent |
| 121 // crashes. An example test is SystemGestureEventFilterTest.ThreeFingerSwipe. | 91 // crashes. An example test is SystemGestureEventFilterTest.ThreeFingerSwipe. |
| 122 void CreateEmptyWallpaper(); | 92 void CreateEmptyWallpaper(); |
| 123 | 93 |
| 124 // Returns the appropriate wallpaper resolution for all root windows. | |
| 125 WallpaperResolution GetAppropriateResolution(); | |
| 126 | |
| 127 // Move all desktop widgets to locked container. | 94 // Move all desktop widgets to locked container. |
| 128 // Returns true if the desktop moved. | 95 // Returns true if the desktop moved. |
| 129 bool MoveDesktopToLockedContainer(); | 96 bool MoveDesktopToLockedContainer(); |
| 130 | 97 |
| 131 // Move all desktop widgets to unlocked container. | 98 // Move all desktop widgets to unlocked container. |
| 132 // Returns true if the desktop moved. | 99 // Returns true if the desktop moved. |
| 133 bool MoveDesktopToUnlockedContainer(); | 100 bool MoveDesktopToUnlockedContainer(); |
| 134 | 101 |
| 135 // Overrides DisplayController::Observer: | 102 // Overrides DisplayController::Observer: |
| 136 virtual void OnDisplayConfigurationChanged() OVERRIDE; | 103 virtual void OnDisplayConfigurationChanged() OVERRIDE; |
| 137 | 104 |
| 105 // Returns the maximum size of all displays combined in native |
| 106 // resolutions. Note that this isn't the bounds of the display who |
| 107 // has maximum resolutions. Instead, this returns the size of the |
| 108 // maximum width of all displays, and the maximum height of all displays. |
| 109 static gfx::Size GetMaxDisplaySizeInNative(); |
| 110 |
| 138 private: | 111 private: |
| 139 friend class DesktopBackgroundControllerTest; | 112 friend class DesktopBackgroundControllerTest; |
| 113 // friend class chromeos::WallpaperManagerBrowserTestDefaultWallpaper; |
| 140 FRIEND_TEST_ALL_PREFIXES(DesktopBackgroundControllerTest, GetMaxDisplaySize); | 114 FRIEND_TEST_ALL_PREFIXES(DesktopBackgroundControllerTest, GetMaxDisplaySize); |
| 141 | 115 |
| 142 // An operation to asynchronously loads wallpaper. | 116 // Returns true if the specified wallpaper is already stored |
| 143 class WallpaperLoader; | |
| 144 | |
| 145 // Returns true if the specified default wallpaper is already being | |
| 146 // loaded by |wallpaper_loader_| or stored in |current_wallpaper_|. | |
| 147 bool DefaultWallpaperIsAlreadyLoadingOrLoaded( | |
| 148 const base::FilePath& image_file, int image_resource_id) const; | |
| 149 | |
| 150 // Returns true if the specified custom wallpaper is already stored | |
| 151 // in |current_wallpaper_|. | 117 // in |current_wallpaper_|. |
| 152 bool CustomWallpaperIsAlreadyLoaded(const gfx::ImageSkia& image) const; | 118 // If |image| is NULL, resource_id is compared. |
| 119 bool WallpaperIsAlreadyLoaded(const gfx::ImageSkia* image, |
| 120 int resource_id, |
| 121 WallpaperLayout layout) const; |
| 153 | 122 |
| 154 // Creates view for all root windows, or notifies them to repaint if they | 123 // Creates view for all root windows, or notifies them to repaint if they |
| 155 // already exist. | 124 // already exist. |
| 156 void SetDesktopBackgroundImageMode(); | 125 void SetDesktopBackgroundImageMode(); |
| 157 | 126 |
| 158 // Creates a new background widget and sets the background mode to image mode. | |
| 159 // Called after a default wallpaper has been loaded successfully. | |
| 160 void OnDefaultWallpaperLoadCompleted(scoped_refptr<WallpaperLoader> loader); | |
| 161 | |
| 162 // Creates and adds component for current mode (either Widget or Layer) to | 127 // Creates and adds component for current mode (either Widget or Layer) to |
| 163 // |root_window|. | 128 // |root_window|. |
| 164 void InstallDesktopController(aura::Window* root_window); | 129 void InstallDesktopController(aura::Window* root_window); |
| 165 | 130 |
| 166 // Creates and adds component for current mode (either Widget or Layer) to | 131 // Creates and adds component for current mode (either Widget or Layer) to |
| 167 // all root windows. | 132 // all root windows. |
| 168 void InstallDesktopControllerForAllWindows(); | 133 void InstallDesktopControllerForAllWindows(); |
| 169 | 134 |
| 170 // Moves all desktop components from one container to other across all root | 135 // Moves all desktop components from one container to other across all root |
| 171 // windows. Returns true if a desktop moved. | 136 // windows. Returns true if a desktop moved. |
| 172 bool ReparentBackgroundWidgets(int src_container, int dst_container); | 137 bool ReparentBackgroundWidgets(int src_container, int dst_container); |
| 173 | 138 |
| 174 // Returns id for background container for unlocked and locked states. | 139 // Returns id for background container for unlocked and locked states. |
| 175 int GetBackgroundContainerId(bool locked); | 140 int GetBackgroundContainerId(bool locked); |
| 176 | 141 |
| 177 // Send notification that background animation finished. | 142 // Send notification that background animation finished. |
| 178 void NotifyAnimationFinished(); | 143 void NotifyAnimationFinished(); |
| 179 | 144 |
| 180 // Reload the wallpaper. | 145 // Reload the wallpaper. |
| 181 void UpdateWallpaper(); | 146 void UpdateWallpaper(); |
| 182 | 147 |
| 183 void set_wallpaper_reload_delay_for_test(bool value) { | 148 void set_wallpaper_reload_delay_for_test(bool value) { |
| 184 wallpaper_reload_delay_ = value; | 149 wallpaper_reload_delay_ = value; |
| 185 } | 150 } |
| 186 | 151 |
| 187 // Returns the maximum size of all displays combined in native | |
| 188 // resolutions. Note that this isn't the bounds of the display who | |
| 189 // has maximum resolutions. Instead, this returns the size of the | |
| 190 // maximum width of all displays, and the maximum height of all displays. | |
| 191 static gfx::Size GetMaxDisplaySizeInNative(); | |
| 192 | |
| 193 // If non-NULL, used in place of the real command line. | |
| 194 base::CommandLine* command_line_for_testing_; | |
| 195 | |
| 196 // Can change at runtime. | 152 // Can change at runtime. |
| 197 bool locked_; | 153 bool locked_; |
| 198 | 154 |
| 199 BackgroundMode desktop_background_mode_; | 155 BackgroundMode desktop_background_mode_; |
| 200 | 156 |
| 201 SkColor background_color_; | 157 SkColor background_color_; |
| 202 | 158 |
| 203 ObserverList<DesktopBackgroundControllerObserver> observers_; | 159 ObserverList<DesktopBackgroundControllerObserver> observers_; |
| 204 | 160 |
| 205 // The current wallpaper. | 161 // The current wallpaper. |
| 206 scoped_ptr<WallpaperResizer> current_wallpaper_; | 162 scoped_ptr<WallpaperResizer> current_wallpaper_; |
| 207 | 163 |
| 208 // If a default wallpaper is stored in |current_wallpaper_|, the path and | |
| 209 // resource ID that were passed to WallpaperLoader when loading it. | |
| 210 // Otherwise, empty and -1, respectively. | |
| 211 base::FilePath current_default_wallpaper_path_; | |
| 212 int current_default_wallpaper_resource_id_; | |
| 213 | |
| 214 gfx::Size current_max_display_size_; | 164 gfx::Size current_max_display_size_; |
| 215 | 165 |
| 216 // Loads default wallpaper from disk. | |
| 217 scoped_refptr<WallpaperLoader> default_wallpaper_loader_; | |
| 218 | |
| 219 base::WeakPtrFactory<DesktopBackgroundController> weak_ptr_factory_; | |
| 220 | |
| 221 base::OneShotTimer<DesktopBackgroundController> timer_; | 166 base::OneShotTimer<DesktopBackgroundController> timer_; |
| 222 | 167 |
| 223 int wallpaper_reload_delay_; | 168 int wallpaper_reload_delay_; |
| 224 | 169 |
| 225 DISALLOW_COPY_AND_ASSIGN(DesktopBackgroundController); | 170 DISALLOW_COPY_AND_ASSIGN(DesktopBackgroundController); |
| 226 }; | 171 }; |
| 227 | 172 |
| 228 } // namespace ash | 173 } // namespace ash |
| 229 | 174 |
| 230 #endif // ASH_DESKTOP_BACKGROUND_DESKTOP_BACKGROUND_CONTROLLER_H_ | 175 #endif // ASH_DESKTOP_BACKGROUND_DESKTOP_BACKGROUND_CONTROLLER_H_ |
| OLD | NEW |