Re-land:

views/widget/widget.h

 // Copyright (c) 2011 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 VIEWS_WIDGET_WIDGET_H_
 #define VIEWS_WIDGET_WIDGET_H_
 #pragma once
 
 #include <vector>
 
@@ skipping 34 matching lines @@
 ////////////////////////////////////////////////////////////////////////////////
 // Widget class
 //
 //  Encapsulates the platform-specific rendering, event receiving and widget
 //  management aspects of the UI framework.
 //
 //  Owns a RootView and thus a View hierarchy. Can contain child Widgets.
 //  Widget is a platform-independent type that communicates with a platform or
 //  context specific NativeWidget implementation.
 //
-//  TODO(beng): Note that this class being non-abstract means that we have a
-//              violation of Google style in that we are using multiple
-//              inheritance. The intention is to split this into a separate
-//              object associated with but not equal to a NativeWidget
-//              implementation. Multiple inheritance is required for this
-//              transitional step.
+//  A special note on ownership:
+//
+//    Depending on the value of "delete_on_destroy", the Widget either owns or
+//    is owned by its NativeWidget:
+//
+//    delete_on_destroy = true (default)
+//      The Widget instance is owned by its NativeWidget. When the NativeWidget
+//      is destroyed (in response to a native destruction message), it deletes
+//      the Widget from its destructor.
+//    delete_on_destroy = false (non-default)
+//      The Widget instance owns its NativeWidget. This state implies someone
+//      else wants to control the lifetime of this object. When they destroy
+//      the Widget it is responsible for destroying the NativeWidget (from its
+//      destructor).
 //
 class Widget : public internal::NativeWidgetDelegate,
                public FocusTraversable {
  public:
   struct InitParams {
     enum Type {
       TYPE_WINDOW,      // A Window, like a frame window.
       TYPE_CONTROL,     // A control, like a button.
       TYPE_POPUP,       // An undecorated Window, with transient properties.
       TYPE_MENU         // An undecorated Window, with transient properties
                         // specialized to menus.
     };
 
     InitParams();
     explicit InitParams(Type type);
 
     Type type;
     bool child;
+    bool transient;
     bool transparent;
     bool accept_events;
     bool can_activate;
     bool keep_on_top;
     bool delete_on_destroy;
     bool mirror_origin_in_rtl;
     bool has_dropshadow;
     // Should the widget be double buffered? Default is false.
     bool double_buffer;
     gfx::NativeView parent;
     Widget* parent_widget;
     gfx::Rect bounds;
     NativeWidget* native_widget;
   };
   static InitParams WindowInitParams();
 
   Widget();
   virtual ~Widget();
 
-  // Creates a Widget instance with the supplied params.
-  static Widget* CreateWidget();
-
   // Enumerates all windows pertaining to us and notifies their
   // view hierarchies that the locale has changed.
   static void NotifyLocaleChanged();
 
+  // Closes all Widgets that aren't identified as "secondary widgets". Called
+  // during application shutdown when the last non-secondary widget is closed.
+  static void CloseAllSecondaryWidgets();
+
   // Converts a rectangle from one Widget's coordinate system to another's.
   // Returns false if the conversion couldn't be made, because either these two
   // Widgets do not have a common ancestor or they are not on the screen yet.
   // The value of |*rect| won't be changed when false is returned.
   static bool ConvertRect(const Widget* source,
                           const Widget* target,
                           gfx::Rect* rect);
 
   void Init(const InitParams& params);
 
   // Unconverted methods -------------------------------------------------------
 
-  // TODO(beng):
-  // Widget subclasses are still implementing these methods by overriding from
-  // here rather than by implementing NativeWidget.
+  // TODO(beng): reorder, they've been converted now.
 
   // Returns the gfx::NativeView associated with this Widget.
-  virtual gfx::NativeView GetNativeView() const;
+  gfx::NativeView GetNativeView() const;
 
   // Returns the gfx::NativeWindow associated with this Widget. This may return
   // NULL on some platforms if the widget was created with a type other than
   // TYPE_WINDOW.
-  virtual gfx::NativeWindow GetNativeWindow() const;
-
-  // Starts a drag operation for the specified view. |point| is a position in
-  // |view| coordinates that the drag was initiated from.
-  virtual void GenerateMousePressedForView(View* view,
-                                           const gfx::Point& point);
+  gfx::NativeWindow GetNativeWindow() const;
 
   // Returns the accelerator given a command id. Returns false if there is
   // no accelerator associated with a given id, which is a common condition.
   virtual bool GetAccelerator(int cmd_id, ui::Accelerator* accelerator);
 
   // Returns the Window containing this Widget, or NULL if not contained in a
   // window.
-  virtual Window* GetWindow();
-  virtual const Window* GetWindow() const;
+  Window* GetContainingWindow();
+  const Window* GetContainingWindow() const;
 
   // Forwarded from the RootView so that the widget can do any cleanup.
-  virtual void ViewHierarchyChanged(bool is_add, View* parent, View* child);
+  void ViewHierarchyChanged(bool is_add, View* parent, View* child);
 
   // Performs any necessary cleanup and forwards to RootView.
-  virtual void NotifyNativeViewHierarchyChanged(bool attached,
-                                                gfx::NativeView native_view);
+  void NotifyNativeViewHierarchyChanged(bool attached,
+                                        gfx::NativeView native_view);
 
   // Converted methods ---------------------------------------------------------
 
   // TODO(beng):
   // Widget subclasses are implementing these methods by implementing
   // NativeWidget. Remove this comment once complete.
 
   // Returns the topmost Widget in a hierarchy. Will return NULL if called
   // before the underlying Native Widget has been initialized.
   Widget* GetTopLevelWidget();
@@ skipping 22 matching lines @@
   void SetSize(const gfx::Size& size);
 
   // Places the widget in front of the specified widget in z-order.
   void MoveAboveWidget(Widget* widget);
   void MoveAbove(gfx::NativeView native_view);
 
   // Sets a shape on the widget. This takes ownership of shape.
   void SetShape(gfx::NativeRegion shape);
 
   // Hides the widget then closes it after a return to the message loop.
-  void Close();
+  virtual void Close();
 
   // TODO(beng): Move off public API.
   // Closes the widget immediately. Compare to |Close|. This will destroy the
   // window handle associated with this Widget, so should not be called from
   // any code that expects it to be valid beyond this call.
   void CloseNow();
 
   // Shows or hides the widget, without changing activation state.
   void Show();
   void Hide();
 
   // Sets the opacity of the widget. This may allow widgets behind the widget
   // in the Z-order to become visible, depending on the capabilities of the
   // underlying windowing system. Note that the caller must then schedule a
   // repaint to allow this change to take effect.
   void SetOpacity(unsigned char opacity);
 
   // Sets the widget to be on top of all other widgets in the windowing system.
   void SetAlwaysOnTop(bool on_top);
 
   // Returns the RootView contained by this Widget.
   RootView* GetRootView();
 
+  // A secondary widget is one that is automatically closed (via Close()) when
+  // all non-secondary widgets are closed.
+  // Default is true.
+  // TODO(beng): This is an ugly API, should be handled implicitly via
+  //             transience.
+  void set_is_secondary_widget(bool is_secondary_widget) {
+    is_secondary_widget_ = is_secondary_widget;
+  }
+  bool is_secondary_widget() const { return is_secondary_widget_; }
+
   // Returns whether the Widget is visible to the user.
   bool IsVisible() const;
 
   // Returns whether the Widget is the currently active window.
   bool IsActive() const;
 
   // Returns whether the Widget is customized for accessibility.
   bool IsAccessibleWidget() const;
 
   // Returns the ThemeProvider that provides theme resources for this Widget.
@@ skipping 25 matching lines @@
   View* dragged_view() { return dragged_view_; }
 
   // Adds the specified |rect| in client area coordinates to the rectangle to be
   // redrawn.
   void SchedulePaintInRect(const gfx::Rect& rect);
 
   // Sets the currently visible cursor. If |cursor| is NULL, the cursor used
   // before the current is restored.
   void SetCursor(gfx::NativeCursor cursor);
 
+  // Resets the last move flag so that we can go around the optimization
+  // that disregards duplicate mouse moves when ending animation requires
+  // a new hit-test to do some highlighting as in TabStrip::RemoveTabAnimation
+  // to cause the close button to highlight.
+  void ResetLastMouseMoveFlag();
+
   // Retrieves the focus traversable for this widget.
   FocusTraversable* GetFocusTraversable();
 
   // Notifies the view hierarchy contained in this widget that theme resources
   // changed.
   void ThemeChanged();
 
   // Notifies the view hierarchy contained in this widget that locale resources
   // changed.
   void LocaleChanged();
 
   void SetFocusTraversableParent(FocusTraversable* parent);
   void SetFocusTraversableParentView(View* parent_view);
 
   const ui::Compositor* compositor() const { return compositor_.get(); }
   ui::Compositor* compositor() { return compositor_.get(); }
 
   // Notifies assistive technology that an accessibility event has
   // occurred on |view|, such as when the view is focused or when its
   // value changes. Pass true for |send_native_event| except for rare
   // cases where the view is a native control that's already sending a
   // native accessibility event and the duplicate event would cause
   // problems.
-  virtual void NotifyAccessibilityEvent(
+  void NotifyAccessibilityEvent(
       View* view,
       ui::AccessibilityTypes::Event event_type,
-      bool send_native_event) = 0;
+      bool send_native_event);
 
   NativeWidget* native_widget() { return native_widget_; }
 
   // Overridden from NativeWidgetDelegate:
   virtual void OnNativeFocus(gfx::NativeView focused_view) OVERRIDE;
   virtual void OnNativeBlur(gfx::NativeView focused_view) OVERRIDE;
   virtual void OnNativeWidgetCreated() OVERRIDE;
   virtual void OnSizeChanged(const gfx::Size& new_size) OVERRIDE;
   virtual bool HasFocusManager() const OVERRIDE;
   virtual bool OnNativeWidgetPaintAccelerated(
       const gfx::Rect& dirty_region) OVERRIDE;
   virtual void OnNativeWidgetPaint(gfx::Canvas* canvas) OVERRIDE;
   virtual bool OnKeyEvent(const KeyEvent& event) OVERRIDE;
   virtual bool OnMouseEvent(const MouseEvent& event) OVERRIDE;
   virtual void OnMouseCaptureLost() OVERRIDE;
+  virtual Widget* AsWidget() OVERRIDE;
+  virtual const Widget* AsWidget() const OVERRIDE;
 
   // Overridden from FocusTraversable:
   virtual FocusSearch* GetFocusSearch() OVERRIDE;
   virtual FocusTraversable* GetFocusTraversableParent() OVERRIDE;
   virtual View* GetFocusTraversableParentView() OVERRIDE;
 
  protected:
+  // TODO(beng): Remove WidgetGtk's dependence on the mouse state flags.
+  friend class WidgetGtk;
+
   // Creates the RootView to be used within this Widget. Subclasses may override
   // to create custom RootViews that do specialized event processing.
   // TODO(beng): Investigate whether or not this is needed.
   virtual RootView* CreateRootView();
 
   // Provided to allow the WidgetWin/Gtk implementations to destroy the RootView
   // _before_ the focus manager/tooltip manager.
   // TODO(beng): remove once we fold those objects onto this one.
   void DestroyRootView();
 
-  // TODO(beng): Temporarily provided as a way to associate the subclass'
-  //             implementation of NativeWidget with this.
-  void set_native_widget(NativeWidget* native_widget) {
-    native_widget_ = native_widget;
-  }
-
   // Used for testing.
   void ReplaceFocusManager(FocusManager* focus_manager);
 
+  // TODO(beng): Remove WidgetGtk's dependence on these:
   // TODO(msw): Make this mouse state member private.
   // If true, the mouse is currently down.
   bool is_mouse_button_pressed_;
 
+  // TODO(beng): Remove WidgetGtk's dependence on these:
   // TODO(msw): Make these mouse state members private.
   // The following are used to detect duplicate mouse move events and not
   // deliver them. Displaying a window may result in the system generating
   // duplicate move events even though the mouse hasn't moved.
   bool last_mouse_event_was_move_;
   gfx::Point last_mouse_event_position_;
 
  private:
   // Try to create a compositor if one hasn't been created yet.
   void EnsureCompositor();
@@ skipping 21 matching lines @@
   // A theme provider to use when no other theme provider is specified.
   scoped_ptr<DefaultThemeProvider> default_theme_provider_;
 
   // Valid for the lifetime of RunShellDrag(), indicates the view the drag
   // started from.
   View* dragged_view_;
 
   // The compositor for accelerated drawing.
   scoped_refptr<ui::Compositor> compositor_;
 
+  // See class documentation for Widget above for a note about ownership.
+  bool delete_on_destroy_;
+
+  // See set_is_secondary_widget().
+  bool is_secondary_widget_;
+
   DISALLOW_COPY_AND_ASSIGN(Widget);
 };
 
 }  // namespace views
 
 #endif // VIEWS_WIDGET_WIDGET_H_