Refactor: Shelf Widget

ash/shelf/shelf_widget.h

Index: ash/shelf/shelf_widget.h
diff --git a/ash/shelf/shelf_widget.h b/ash/shelf/shelf_widget.h
new file mode 100644
index 0000000000000000000000000000000000000000..30ea6689f43fc5c07da9a640c936502051be035a
--- /dev/null
+++ b/ash/shelf/shelf_widget.h
@@ -0,0 +1,100 @@
+// 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 ASH_SHELF_SHELF_WIDGET_H_
+#define ASH_SHELF_SHELF_WIDGET_H_
+
+#include "ash/ash_export.h"
+#include "ash/shelf/background_animator.h"
+#include "ash/shelf/shelf_types.h"
+#include "ui/views/widget/widget.h"
+#include "ui/views/widget/widget_observer.h"
+
+namespace aura {
+class Window;
+}
+
+namespace ash {
+class Launcher;
+
+namespace internal {
+class FocusCycler;
+class StatusAreaWidget;
+class ShelfLayoutManager;
+class WorkspaceController;
+}
+
+class ASH_EXPORT ShelfWidget : public views::Widget,
+                               public views::WidgetObserver {
+ public:
+  ShelfWidget(
+      aura::Window* shelf_container,
+      aura::Window* status_container,
+      internal::WorkspaceController* workspace_controller);
+  virtual ~ShelfWidget();
+
+  // Set the alignment of the shelf.

[James Cook, 2013/03/05 20:30:38]

This comment is not useful. Either explain that layout is left/right/etc or
delete it.

[Harry McCleave, 2013/03/06 01:59:49]

Done.

+  void SetAlignment(ShelfAlignment alignmnet);
+  ShelfAlignment GetAlignment() const;
+
+  // Sets/gets the shelf auto-hide behavior.

[James Cook, 2013/03/05 20:30:38]

ditto

[Harry McCleave, 2013/03/06 01:59:49]

Done.

+  ShelfAutoHideBehavior GetAutoHideBehavior() const;
+  void SetAutoHideBehavior(ShelfAutoHideBehavior behavior);
+
+  // Sets whether the shelf paints a background. Default is false, but is set

[James Cook, 2013/03/05 20:30:38]

For example, this is a much more useful comment.

+  // to true if a window overlaps the shelf.
+  void SetPaintsBackground(
+      bool value,
+      internal::BackgroundAnimator::ChangeType change_type);
+  bool paints_background() const {
+    return background_animator_.paints_background();
+  }
+
+  // Causes shelf items to be slightly dimmed.
+  void SetDimsShelf(bool dimming);
+  bool GetDimsShelf() const;
+
+  internal::ShelfLayoutManager* shelf_layout_manager() {
+    return shelf_layout_manager_;
+  }
+  Launcher* launcher() const { return launcher_.get(); }
+  internal::StatusAreaWidget* status_area_widget() const {
+    return status_area_widget_;
+  }
+
+  void CreateLauncher();
+
+  // Set visibility of the launcher component is visible on the shelf.

[James Cook, 2013/03/05 20:30:38]

"Set visibility of the launcher component on the shelf." ?

[Harry McCleave, 2013/03/06 01:59:49]

I can has english readability plz?

+  void SetLauncherVisibility(bool visible);
+  bool LauncherVisible() const;

[James Cook, 2013/03/05 20:30:38]

Maybe IsLauncherVisible()?

[Harry McCleave, 2013/03/06 01:59:49]

Done.

+
+  // Sets the focus cycler.  Also adds the launcher to the cycle.
+  void SetFocusCycler(internal::FocusCycler* focus_cycler);
+  internal::FocusCycler* GetFocusCycler();
+
+  // Called by the activation delegate, before the launcher is activated
+  // when no other windows are visible.
+  void WillActivateAsFallback() { activating_as_fallback_ = true; }
+
+  // Overridden from views::WidgetObserver:
+  virtual void OnWidgetActivationChanged(
+      views::Widget* widget, bool active) OVERRIDE;
+
+  aura::Window* window_container() { return window_container_; }

[James Cook, 2013/03/05 20:30:38]

Hooray, no const!

+
+ private:
+  class DelegateView;
+
+  internal::ShelfLayoutManager* shelf_layout_manager_;
+  scoped_ptr<Launcher> launcher_;
+  internal::StatusAreaWidget* status_area_widget_;
+  DelegateView* delegate_view_;

[James Cook, 2013/03/05 20:30:38]

Comment on the memory ownership of this view (since you aren't explicitly
cleaning it up).

[Harry McCleave, 2013/03/06 01:59:49]

Done.

+  internal::BackgroundAnimator background_animator_;
+  bool activating_as_fallback_;
+  aura::Window* window_container_;
+};
+
+}  // namespace ash
+
+#endif  // ASH_SHELF_SHELF_WIDGET_H_