Screenshot effect non-obvious

chrome/browser/ui/ash/screenshot_taker.h

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef CHROME_BROWSER_UI_ASH_SCREENSHOT_TAKER_H_
 #define CHROME_BROWSER_UI_ASH_SCREENSHOT_TAKER_H_
 
 #include "ash/screenshot_delegate.h"
 #include "base/basictypes.h"
 #include "base/compiler_specific.h"
+#include "base/files/file_path.h"
+#include "base/memory/scoped_ptr.h"
+#include "base/memory/weak_ptr.h"
+#include "base/observer_list.h"
 #include "base/time.h"
-#include "ui/compositor/layer.h"
 
+class Profile;
+
+namespace ash {
+namespace test {
+class ScreenshotTakerTest;
+}
+}
 namespace aura {
 class Window;
-}  // namespace aura
+}
 
-class ScreenshotTaker : public ash::ScreenshotDelegate {
+class ScreenshotTakerObserver {
  public:
-  ScreenshotTaker();
+  enum Result {
+    SCREENSHOT_SUCCESS = 0,
+    SCREENSHOT_GRABWINDOW_PARTIAL_FAILED,
+    SCREENSHOT_GRABWINDOW_FULL_FAILED,
+    SCREENSHOT_CREATE_DIR_FAILED,
+    SCREENSHOT_GET_DIR_FAILED,
+    SCREENSHOT_CHECK_DIR_FAILED,
+    SCREENSHOT_CREATE_FILE_FAILED,
+    SCREENSHOT_WRITE_FILE_FAILED,
+    SCREENSHOT_RESULT_COUNT
+  };
+
+  virtual void OnScreenshotCompleted(
+      Result screenshot_result, const base::FilePath& screenshot_path) = 0;
+
+ protected:
+  virtual ~ScreenshotTakerObserver() {}
+};
+
+class ScreenshotTaker : public ash::ScreenshotDelegate
+{

[sky, 2013/04/03 04:24:46]

{ on previous line.

[sschmitz, 2013/04/03 17:57:40]

old habits die hard;) Done.

+ public:
+  explicit ScreenshotTaker(Profile* profile);
+
   virtual ~ScreenshotTaker();
 
   // Overridden from ash::ScreenshotDelegate:
   virtual void HandleTakeScreenshotForAllRootWindows() OVERRIDE;

[James Cook, 2013/04/02 22:47:18]

I wish there was a way to pass the profile in here, but I don't see one.  :-(

[sky, 2013/04/03 04:24:46]

This is invoked from ash, which doesn't know about profiles. Taking a Profile in
the constructor seems best to me.

   virtual void HandleTakePartialScreenshot(aura::Window* window,
                                            const gfx::Rect& rect) OVERRIDE;
   virtual bool CanTakeScreenshot() OVERRIDE;
 
+  void ShowNotification(
+      ScreenshotTakerObserver::Result screenshot_result,
+      const base::FilePath& screenshot_path);
+
+  void AddObserver(ScreenshotTakerObserver* observer);
+  void RemoveObserver(ScreenshotTakerObserver* observer);
+  bool HasObserver(ScreenshotTakerObserver* observer) const;
+
  private:
-  // Flashes the screen to provide visual feedback that a screenshot has
-  // been taken.
-  void DisplayVisualFeedback(const gfx::Rect& rect);
+  // For test we override the screenshot directory and basename.
+  void OverrideScreenshotDirectory(const base::FilePath& directory);

[James Cook, 2013/04/02 22:47:18]

We usually call these SetScreenshotDirectoryForTest(), etc.

[sschmitz, 2013/04/03 17:57:40]

Done.

+  void OverrideScreenshotBasename(const std::string& basename);
 
-  // Closes the visual feedback layer.
-  void CloseVisualFeedbackLayer();
+  Profile* profile_;
+
+  base::WeakPtrFactory<ScreenshotTaker> factory_;
 
   // The timestamp when the screenshot task was issued last time.
   base::Time last_screenshot_timestamp_;
 
-  // The flashing effect of the screen for the visual feedback when taking a
-  // screenshot.
-  scoped_ptr<ui::Layer> visual_feedback_layer_;
+  ObserverList<ScreenshotTakerObserver> observers_;
+
+  base::FilePath screenshot_directory_override_;
+  std::string screenshot_basename_override_;
+
+  friend class ash::test::ScreenshotTakerTest;

[James Cook, 2013/04/02 22:47:18]

friends go at top of private section

[sschmitz, 2013/04/03 17:57:40]

Done.

 
   DISALLOW_COPY_AND_ASSIGN(ScreenshotTaker);
 };
 
 #endif  // CHROME_BROWSER_UI_ASH_SCREENSHOT_TAKER_H_