Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(788)

Unified Diff: ui/views/widget/widget.h

Issue 54983005: Plumb native AppWindow input region through to window shape under Aura. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: Fix typo in X11 patch Created 7 years, 1 month ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « ui/views/widget/desktop_aura/desktop_root_window_host_x11.cc ('k') | no next file » | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: ui/views/widget/widget.h
diff --git a/ui/views/widget/widget.h b/ui/views/widget/widget.h
index 3ff89e45c26b1dafa69616be183ee0b39895b058..524843983bb064c4f0050b5f28a9280b90ada0ca 100644
--- a/ui/views/widget/widget.h
+++ b/ui/views/widget/widget.h
@@ -1,901 +1,902 @@
-// 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 UI_VIEWS_WIDGET_WIDGET_H_
-#define UI_VIEWS_WIDGET_WIDGET_H_
-
-#include <set>
-#include <stack>
-#include <vector>
-
-#include "base/gtest_prod_util.h"
-#include "base/memory/scoped_ptr.h"
-#include "base/observer_list.h"
-#include "ui/base/ui_base_types.h"
-#include "ui/compositor/layer_type.h"
-#include "ui/gfx/native_widget_types.h"
-#include "ui/gfx/rect.h"
-#include "ui/views/focus/focus_manager.h"
-#include "ui/views/widget/native_widget_delegate.h"
-#include "ui/views/window/client_view.h"
-#include "ui/views/window/non_client_view.h"
-
-#if defined(OS_WIN)
-// Windows headers define macros for these function names which screw with us.
-#if defined(IsMaximized)
-#undef IsMaximized
-#endif
-#if defined(IsMinimized)
-#undef IsMinimized
-#endif
-#if defined(CreateWindow)
-#undef CreateWindow
-#endif
-#endif
-
-namespace gfx {
-class Canvas;
-class Point;
-class Rect;
-}
-
-namespace ui {
-class Accelerator;
-class Compositor;
-class DefaultThemeProvider;
-class Layer;
-class NativeTheme;
-class OSExchangeData;
-class ThemeProvider;
-}
-
-namespace views {
-
-class DesktopRootWindowHost;
-class InputMethod;
-class NativeWidget;
-class NonClientFrameView;
-class TooltipManager;
-class View;
-class WidgetDelegate;
-class WidgetObserver;
-
-namespace internal {
-class NativeWidgetPrivate;
-class RootView;
-}
-
-////////////////////////////////////////////////////////////////////////////////
-// 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.
-//
-// A special note on ownership:
-//
-// Depending on the value of the InitParams' ownership field, the Widget
-// either owns or is owned by its NativeWidget:
-//
-// ownership = NATIVE_WIDGET_OWNS_WIDGET (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.
-// ownership = WIDGET_OWNS_NATIVE_WIDGET (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 VIEWS_EXPORT Widget : public internal::NativeWidgetDelegate,
- public FocusTraversable {
- public:
- typedef std::set<Widget*> Widgets;
-
- enum FrameType {
- FRAME_TYPE_DEFAULT, // Use whatever the default would be.
- FRAME_TYPE_FORCE_CUSTOM, // Force the custom frame.
- FRAME_TYPE_FORCE_NATIVE // Force the native frame.
- };
-
- // Result from RunMoveLoop().
- enum MoveLoopResult {
- // The move loop completed successfully.
- MOVE_LOOP_SUCCESSFUL,
-
- // The user canceled the move loop.
- MOVE_LOOP_CANCELED
- };
-
- // Source that initiated the move loop.
- enum MoveLoopSource {
- MOVE_LOOP_SOURCE_MOUSE,
- MOVE_LOOP_SOURCE_TOUCH,
- };
-
- // Behavior when escape is pressed during a move loop.
- enum MoveLoopEscapeBehavior {
- // Indicates the window should be hidden.
- MOVE_LOOP_ESCAPE_BEHAVIOR_HIDE,
-
- // Indicates the window should not be hidden.
- MOVE_LOOP_ESCAPE_BEHAVIOR_DONT_HIDE,
- };
-
- struct VIEWS_EXPORT InitParams {
- enum Type {
- TYPE_WINDOW, // A decorated Window, like a frame window.
- // Widgets of TYPE_WINDOW will have a NonClientView.
- TYPE_PANEL, // Always on top window managed by PanelManager.
- // Widgets of TYPE_PANEL will have a NonClientView.
- TYPE_WINDOW_FRAMELESS,
- // An undecorated 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.
- TYPE_TOOLTIP,
- TYPE_BUBBLE,
- };
-
- enum WindowOpacity {
- // Infer fully opaque or not. For WinAura, top-level windows that are not
- // of TYPE_WINDOW are translucent so that they can be made to fade in. In
- // all other cases, windows are fully opaque.
- INFER_OPACITY,
- // Fully opaque.
- OPAQUE_WINDOW,
- // Possibly translucent/transparent.
- TRANSLUCENT_WINDOW,
- };
-
- enum Ownership {
- // Default. Creator is not responsible for managing the lifetime of the
- // Widget, it is destroyed when the corresponding NativeWidget is
- // destroyed.
- NATIVE_WIDGET_OWNS_WIDGET,
- // Used when the Widget is owned by someone other than the NativeWidget,
- // e.g. a scoped_ptr in tests.
- WIDGET_OWNS_NATIVE_WIDGET
- };
-
- InitParams();
- explicit InitParams(Type type);
-
- // Will return the first of the following that isn't NULL: the native view,
- // |parent|, |context|.
- gfx::NativeView GetContext() const;
-
- Type type;
- // If NULL, a default implementation will be constructed.
- WidgetDelegate* delegate;
- bool child;
- // If TRANSLUCENT_WINDOW, the widget may be fully or partially transparent.
- // If OPAQUE_WINDOW, we can perform optimizations based on the widget being
- // fully opaque. Defaults to TRANSLUCENT_WINDOW if
- // ViewsDelegate::UseTransparentWindows(). Defaults to OPAQUE_WINDOW for
- // non-window widgets.
- WindowOpacity opacity;
- bool accept_events;
- bool can_activate;
- bool keep_on_top;
- Ownership ownership;
- bool mirror_origin_in_rtl;
- bool has_dropshadow;
- // Only used by Windows. Specifies that the system default caption and icon
- // should not be rendered, and that the client area should be equivalent to
- // the window area.
- bool remove_standard_frame;
- // Only used by ShellWindow on Windows. Specifies that the default icon of
- // packaged app should be the system default icon.
- bool use_system_default_icon;
- // Whether the widget should be maximized or minimized.
- ui::WindowShowState show_state;
- // Should the widget be double buffered? Default is false.
- bool double_buffer;
- gfx::NativeView parent;
- // Specifies the initial bounds of the Widget. Default is empty, which means
- // the NativeWidget may specify a default size. If the parent is specified,
- // |bounds| is in the parent's coordinate system. If the parent is not
- // specified, it's in screen's global coordinate system.
- gfx::Rect bounds;
- // When set, this value is used as the Widget's NativeWidget implementation.
- // The Widget will not construct a default one. Default is NULL.
- NativeWidget* native_widget;
- // Aura-only. Provides a DesktopRootWindowHost implementation to use instead
- // of the default one.
- // TODO(beng): Figure out if there's a better way to expose this, e.g. get
- // rid of NW subclasses and do this all via message handling.
- DesktopRootWindowHost* desktop_root_window_host;
- // Whether this window is intended to be a toplevel window with no
- // attachment to any other window. (This may be a transient window if
- // |parent| is set.)
- bool top_level;
- // Only used by NativeWidgetAura. Specifies the type of layer for the
- // aura::Window. Default is LAYER_TEXTURED.
- ui::LayerType layer_type;
- // Only used by Aura. Provides a context window whose RootWindow is
- // consulted during widget creation to determine where in the Window
- // hierarchy this widget should be placed. (This is separate from |parent|;
- // if you pass a RootWindow to |parent|, your window will be parented to
- // |parent|. If you pass a RootWindow to |context|, we ask that RootWindow
- // where it wants your window placed.) NULL is not allowed if you are using
- // aura.
- gfx::NativeView context;
- // Only used by X11, for root level windows. Specifies the res_name and
- // res_class fields, respectively, of the WM_CLASS window property. Controls
- // window grouping and desktop file matching in Linux window managers.
- std::string wm_class_name;
- std::string wm_class_class;
- };
-
- Widget();
- virtual ~Widget();
-
- // Creates a toplevel window with no context. These methods should only be
- // used in cases where there is no contextual information because we're
- // creating a toplevel window connected to no other event.
- //
- // If you have any parenting or context information, or can pass that
- // information, prefer the WithParent or WithContext versions of these
- // methods.
- static Widget* CreateWindow(WidgetDelegate* delegate);
- static Widget* CreateWindowWithBounds(WidgetDelegate* delegate,
- const gfx::Rect& bounds);
-
- // Creates a decorated window Widget with the specified properties.
- static Widget* CreateWindowWithParent(WidgetDelegate* delegate,
- gfx::NativeWindow parent);
- static Widget* CreateWindowWithParentAndBounds(WidgetDelegate* delegate,
- gfx::NativeWindow parent,
- const gfx::Rect& bounds);
-
- // Creates a decorated window Widget in the same desktop context as
- // |context|.
- static Widget* CreateWindowWithContext(WidgetDelegate* delegate,
- gfx::NativeView context);
- static Widget* CreateWindowWithContextAndBounds(WidgetDelegate* delegate,
- gfx::NativeView context,
- const gfx::Rect& bounds);
-
- // Creates an undecorated child window Widget. |new_style_parent| is the
- // parent to use for new style dialogs, |parent| for currently-styled dialogs.
- //
- // TODO(wittman): use a single parent parameter once we move fully to
- // new-style dialogs.
- static Widget* CreateWindowAsFramelessChild(WidgetDelegate* widget_delegate,
- gfx::NativeView parent,
- gfx::NativeView new_style_parent);
-
- // Enumerates all windows pertaining to us and notifies their
- // view hierarchies that the locale has changed.
- // TODO(beng): remove post-Aurafication of ChromeOS.
- 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);
-
- // Retrieves the Widget implementation associated with the given
- // NativeView or Window, or NULL if the supplied handle has no associated
- // Widget.
- static Widget* GetWidgetForNativeView(gfx::NativeView native_view);
- static Widget* GetWidgetForNativeWindow(gfx::NativeWindow native_window);
-
- // Retrieves the top level widget in a native view hierarchy
- // starting at |native_view|. Top level widget is a widget with TYPE_WINDOW,
- // TYPE_PANEL, TYPE_WINDOW_FRAMELESS, POPUP or MENU and has its own
- // focus manager. This may be itself if the |native_view| is top level,
- // or NULL if there is no toplevel in a native view hierarchy.
- static Widget* GetTopLevelWidgetForNativeView(gfx::NativeView native_view);
-
- // Returns all Widgets in |native_view|'s hierarchy, including itself if
- // it is one.
- static void GetAllChildWidgets(gfx::NativeView native_view,
- Widgets* children);
-
- // Returns all non-child Widgets owned by |native_view|.
- static void GetAllOwnedWidgets(gfx::NativeView native_view,
- Widgets* owned);
-
- // Re-parent a NativeView and notify all Widgets in |native_view|'s hierarchy
- // of the change.
- static void ReparentNativeView(gfx::NativeView native_view,
- gfx::NativeView new_parent);
-
- // Returns the preferred size of the contents view of this window based on
- // its localized size data. The width in cols is held in a localized string
- // resource identified by |col_resource_id|, the height in the same fashion.
- // TODO(beng): This should eventually live somewhere else, probably closer to
- // ClientView.
- static int GetLocalizedContentsWidth(int col_resource_id);
- static int GetLocalizedContentsHeight(int row_resource_id);
- static gfx::Size GetLocalizedContentsSize(int col_resource_id,
- int row_resource_id);
-
- // Returns true if the specified type requires a NonClientView.
- static bool RequiresNonClientView(InitParams::Type type);
-
- void Init(const InitParams& params);
-
- // Returns the gfx::NativeView associated with this Widget.
- 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 or TYPE_PANEL.
- gfx::NativeWindow GetNativeWindow() const;
-
- // Add/remove observer.
- void AddObserver(WidgetObserver* observer);
- void RemoveObserver(WidgetObserver* observer);
- bool HasObserver(WidgetObserver* observer);
-
- // 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);
-
- // Forwarded from the RootView so that the widget can do any cleanup.
- void ViewHierarchyChanged(const View::ViewHierarchyChangedDetails& details);
-
- // Called right before changing the widget's parent NativeView to do any
- // cleanup.
- void NotifyNativeViewHierarchyWillChange();
-
- // Called after changing the widget's parent NativeView. Notifies the RootView
- // about the change.
- void NotifyNativeViewHierarchyChanged();
-
- // Returns the top level widget in a hierarchy (see is_top_level() for
- // the definition of top level widget.) Will return NULL if called
- // before the widget is attached to the top level widget's hierarchy.
- Widget* GetTopLevelWidget();
- const Widget* GetTopLevelWidget() const;
-
- // Gets/Sets the WidgetDelegate.
- WidgetDelegate* widget_delegate() const { return widget_delegate_; }
-
- // Sets the specified view as the contents of this Widget. There can only
- // be one contents view child of this Widget's RootView. This view is sized to
- // fit the entire size of the RootView. The RootView takes ownership of this
- // View, unless it is set as not being parent-owned.
- void SetContentsView(View* view);
- View* GetContentsView();
-
- // Returns the bounds of the Widget in screen coordinates.
- gfx::Rect GetWindowBoundsInScreen() const;
-
- // Returns the bounds of the Widget's client area in screen coordinates.
- gfx::Rect GetClientAreaBoundsInScreen() const;
-
- // Retrieves the restored bounds for the window.
- gfx::Rect GetRestoredBounds() const;
-
- // Sizes and/or places the widget to the specified bounds, size or position.
- void SetBounds(const gfx::Rect& bounds);
- void SetSize(const gfx::Size& size);
-
- // Sizes the window to the specified size and centerizes it.
- void CenterWindow(const gfx::Size& size);
-
- // Like SetBounds(), but ensures the Widget is fully visible on screen,
- // resizing and/or repositioning as necessary. This is only useful for
- // non-child widgets.
- void SetBoundsConstrained(const gfx::Rect& bounds);
-
- // Sets whether animations that occur when visibility is changed are enabled.
- // Default is true.
- void SetVisibilityChangedAnimationsEnabled(bool value);
-
- // Starts a nested message loop that moves the window. This can be used to
- // start a window move operation from a mouse or touch event. This returns
- // when the move completes. |drag_offset| is the offset from the top left
- // corner of the window to the point where the cursor is dragging, and is used
- // to offset the bounds of the window from the cursor.
- MoveLoopResult RunMoveLoop(const gfx::Vector2d& drag_offset,
- MoveLoopSource source,
- MoveLoopEscapeBehavior escape_behavior);
-
- // Stops a previously started move loop. This is not immediate.
- void EndMoveLoop();
-
- // Places the widget in front of the specified widget in z-order.
- void StackAboveWidget(Widget* widget);
- void StackAbove(gfx::NativeView native_view);
- void StackAtTop();
-
- // Places the widget below the specified NativeView.
- void StackBelow(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.
- 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();
-
- // Whether the widget has been asked to close itself. In particular this is
- // set to true after Close() has been invoked on the NativeWidget.
- bool IsClosed() const;
-
- // Shows or hides the widget, without changing activation state.
- virtual void Show();
- void Hide();
-
- // Like Show(), but does not activate the window.
- void ShowInactive();
-
- // Activates the widget, assuming it already exists and is visible.
- void Activate();
-
- // Deactivates the widget, making the next window in the Z order the active
- // window.
- void Deactivate();
-
- // Returns whether the Widget is the currently active window.
- virtual bool IsActive() const;
-
- // Prevents the window from being rendered as deactivated. This state is
- // reset automatically as soon as the window becomes activated again. There is
- // no ability to control the state through this API as this leads to sync
- // problems.
- void DisableInactiveRendering();
-
- // Sets the widget to be on top of all other widgets in the windowing system.
- void SetAlwaysOnTop(bool on_top);
-
- // Returns whether the widget has been set to be on top of most other widgets
- // in the windowing system.
- bool IsAlwaysOnTop() const;
-
- // Maximizes/minimizes/restores the window.
- void Maximize();
- void Minimize();
- void Restore();
-
- // Whether or not the window is maximized or minimized.
- virtual bool IsMaximized() const;
- bool IsMinimized() const;
-
- // Accessors for fullscreen state.
- void SetFullscreen(bool fullscreen);
- bool IsFullscreen() const;
-
- // 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.
- void SetOpacity(unsigned char opacity);
-
- // Sets whether or not the window should show its frame as a "transient drag
- // frame" - slightly transparent and without the standard window controls.
- void SetUseDragFrame(bool use_drag_frame);
-
- // Flashes the frame of the window to draw attention to it. Currently only
- // implemented on Windows for non-Aura.
- void FlashFrame(bool flash);
-
- // Returns the View at the root of the View hierarchy contained by this
- // Widget.
- View* GetRootView();
- const View* GetRootView() const;
-
- // 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.
- virtual bool IsVisible() const;
-
- // Returns the ThemeProvider that provides theme resources for this Widget.
- virtual ui::ThemeProvider* GetThemeProvider() const;
-
- ui::NativeTheme* GetNativeTheme() {
- return const_cast<ui::NativeTheme*>(
- const_cast<const Widget*>(this)->GetNativeTheme());
- }
- const ui::NativeTheme* GetNativeTheme() const;
-
- // Returns the FocusManager for this widget.
- // Note that all widgets in a widget hierarchy share the same focus manager.
- FocusManager* GetFocusManager();
- const FocusManager* GetFocusManager() const;
-
- // Returns the InputMethod for this widget.
- // Note that all widgets in a widget hierarchy share the same input method.
- InputMethod* GetInputMethod();
- const InputMethod* GetInputMethod() const;
-
- // Starts a drag operation for the specified view. This blocks until the drag
- // operation completes. |view| can be NULL.
- // If the view is non-NULL it can be accessed during the drag by calling
- // dragged_view(). If the view has not been deleted during the drag,
- // OnDragDone() is called on it. |location| is in the widget's coordinate
- // system.
- void RunShellDrag(View* view,
- const ui::OSExchangeData& data,
- const gfx::Point& location,
- int operation,
- ui::DragDropTypes::DragEventSource source);
-
- // Returns the view that requested the current drag operation via
- // RunShellDrag(), or NULL if there is no such view or drag operation.
- View* dragged_view() { return dragged_view_; }
-
- // Adds the specified |rect| in client area coordinates to the rectangle to be
- // redrawn.
- virtual 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);
-
- // Returns true if and only if mouse events are enabled.
- bool IsMouseEventsEnabled() const;
-
- // Sets/Gets a native window property on the underlying native window object.
- // Returns NULL if the property does not exist. Setting the property value to
- // NULL removes the property.
- void SetNativeWindowProperty(const char* name, void* value);
- void* GetNativeWindowProperty(const char* name) const;
-
- // Tell the window to update its title from the delegate.
- void UpdateWindowTitle();
-
- // Tell the window to update its icon from the delegate.
- void UpdateWindowIcon();
-
- // 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);
-
- // Clear native focus set to the Widget's NativeWidget.
- void ClearNativeFocus();
-
- void set_frame_type(FrameType frame_type) { frame_type_ = frame_type; }
- FrameType frame_type() const { return frame_type_; }
-
- // Creates an appropriate NonClientFrameView for this widget. The
- // WidgetDelegate is given the first opportunity to create one, followed by
- // the NativeWidget implementation. If both return NULL, a default one is
- // created.
- virtual NonClientFrameView* CreateNonClientFrameView();
-
- // Whether we should be using a native frame.
- bool ShouldUseNativeFrame() const;
-
- // Forces the frame into the alternate frame type (custom or native) depending
- // on its current state.
- void DebugToggleFrameType();
-
- // Tell the window that something caused the frame type to change.
- void FrameTypeChanged();
-
- NonClientView* non_client_view() {
- return const_cast<NonClientView*>(
- const_cast<const Widget*>(this)->non_client_view());
- }
- const NonClientView* non_client_view() const {
- return non_client_view_;
- }
-
- ClientView* client_view() {
- return const_cast<ClientView*>(
- const_cast<const Widget*>(this)->client_view());
- }
- const ClientView* client_view() const {
- // non_client_view_ may be NULL, especially during creation.
- return non_client_view_ ? non_client_view_->client_view() : NULL;
- }
-
- const ui::Compositor* GetCompositor() const;
- ui::Compositor* GetCompositor();
-
- // Returns the widget's layer, if any.
- ui::Layer* GetLayer();
-
- // Reorders the widget's child NativeViews which are associated to the view
- // tree (eg via a NativeViewHost) to match the z-order of the views in the
- // view tree. The z-order of views with layers relative to views with
- // associated NativeViews is used to reorder the NativeView layers. This
- // method assumes that the widget's child layers which are owned by a view are
- // already in the correct z-order relative to each other and does no
- // reordering if there are no views with an associated NativeView.
- void ReorderNativeViews();
-
- // Schedules an update to the root layers. The actual processing occurs when
- // GetRootLayers() is invoked.
- void UpdateRootLayers();
-
- const NativeWidget* native_widget() const;
- NativeWidget* native_widget();
-
- internal::NativeWidgetPrivate* native_widget_private() {
- return native_widget_;
- }
- const internal::NativeWidgetPrivate* native_widget_private() const {
- return native_widget_;
- }
-
- // Sets capture to the specified view. This makes it so that all mouse, touch
- // and gesture events go to |view|. If |view| is NULL, the widget still
- // obtains event capture, but the events will go to the view they'd normally
- // go to.
- void SetCapture(View* view);
-
- // Releases capture.
- void ReleaseCapture();
-
- // Returns true if the widget has capture.
- bool HasCapture();
-
- void set_auto_release_capture(bool auto_release_capture) {
- auto_release_capture_ = auto_release_capture;
- }
-
- // Returns the font used for tooltips.
- TooltipManager* GetTooltipManager();
- const TooltipManager* GetTooltipManager() const;
-
- // Sets-up the focus manager with the view that should have focus when the
- // window is shown the first time. Returns true if the initial focus has been
- // set or the widget should not set the initial focus, or false if the caller
- // should set the initial focus (if any).
- bool SetInitialFocus();
-
- void set_focus_on_creation(bool focus_on_creation) {
- focus_on_creation_ = focus_on_creation;
- }
-
- // True if the widget is considered top level widget. Top level widget
- // is a widget of TYPE_WINDOW, TYPE_PANEL, TYPE_WINDOW_FRAMELESS, BUBBLE,
- // POPUP or MENU, and has a focus manager and input method object associated
- // with it. TYPE_CONTROL and TYPE_TOOLTIP is not considered top level.
- bool is_top_level() const { return is_top_level_; }
-
- // True when window movement via mouse interaction with the frame is disabled.
- bool movement_disabled() const { return movement_disabled_; }
- void set_movement_disabled(bool disabled) { movement_disabled_ = disabled; }
-
- // Returns the work area bounds of the screen the Widget belongs to.
- gfx::Rect GetWorkAreaBoundsInScreen() const;
-
- // Creates and dispatches synthesized mouse move event using the current
- // mouse location to refresh hovering status in the widget.
- void SynthesizeMouseMoveEvent();
-
- // Called by our RootView after it has performed a Layout. Used to forward
- // window sizing information to the window server on some platforms.
- void OnRootViewLayout();
-
- // Notification that our owner is closing.
- // NOTE: this is not invoked for aura as it's currently not needed there.
- // Under aura menus close by way of activation getting reset when the owner
- // closes.
- virtual void OnOwnerClosing();
-
- // Overridden from NativeWidgetDelegate:
- virtual bool IsModal() const OVERRIDE;
- virtual bool IsDialogBox() const OVERRIDE;
- virtual bool CanActivate() const OVERRIDE;
- virtual bool IsInactiveRenderingDisabled() const OVERRIDE;
- virtual void EnableInactiveRendering() OVERRIDE;
- virtual void OnNativeWidgetActivationChanged(bool active) OVERRIDE;
- virtual void OnNativeFocus(gfx::NativeView old_focused_view) OVERRIDE;
- virtual void OnNativeBlur(gfx::NativeView new_focused_view) OVERRIDE;
- virtual void OnNativeWidgetVisibilityChanging(bool visible) OVERRIDE;
- virtual void OnNativeWidgetVisibilityChanged(bool visible) OVERRIDE;
- virtual void OnNativeWidgetCreated(bool desktop_widget) OVERRIDE;
- virtual void OnNativeWidgetDestroying() OVERRIDE;
- virtual void OnNativeWidgetDestroyed() OVERRIDE;
- virtual gfx::Size GetMinimumSize() OVERRIDE;
- virtual gfx::Size GetMaximumSize() OVERRIDE;
- virtual void OnNativeWidgetMove() OVERRIDE;
- virtual void OnNativeWidgetSizeChanged(const gfx::Size& new_size) OVERRIDE;
- virtual void OnNativeWidgetBeginUserBoundsChange() OVERRIDE;
- virtual void OnNativeWidgetEndUserBoundsChange() OVERRIDE;
- virtual bool HasFocusManager() const OVERRIDE;
- virtual bool OnNativeWidgetPaintAccelerated(
- const gfx::Rect& dirty_region) OVERRIDE;
- virtual void OnNativeWidgetPaint(gfx::Canvas* canvas) OVERRIDE;
- virtual int GetNonClientComponent(const gfx::Point& point) OVERRIDE;
- virtual void OnKeyEvent(ui::KeyEvent* event) OVERRIDE;
- virtual void OnMouseEvent(ui::MouseEvent* event) OVERRIDE;
- virtual void OnMouseCaptureLost() OVERRIDE;
- virtual void OnTouchEvent(ui::TouchEvent* event) OVERRIDE;
- virtual void OnScrollEvent(ui::ScrollEvent* event) OVERRIDE;
- virtual void OnGestureEvent(ui::GestureEvent* event) OVERRIDE;
- virtual bool ExecuteCommand(int command_id) OVERRIDE;
- virtual InputMethod* GetInputMethodDirect() OVERRIDE;
- virtual const std::vector<ui::Layer*>& GetRootLayers() OVERRIDE;
- virtual bool HasHitTestMask() const OVERRIDE;
- virtual void GetHitTestMask(gfx::Path* mask) const 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:
- // 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 internal::RootView* CreateRootView();
-
- // Provided to allow the NativeWidget implementations to destroy the RootView
- // _before_ the focus manager/tooltip manager.
- // TODO(beng): remove once we fold those objects onto this one.
- void DestroyRootView();
-
- private:
- friend class ComboboxTest;
- friend class NativeTextfieldViewsTest;
-
- // Sets the value of |disable_inactive_rendering_|. If the value changes,
- // both the NonClientView and WidgetDelegate are notified.
- void SetInactiveRenderingDisabled(bool value);
-
- // Persists the window's restored position and "show" state using the
- // window delegate.
- void SaveWindowPlacement();
-
- // Sizes and positions the window just after it is created.
- void SetInitialBounds(const gfx::Rect& bounds);
-
- // Sizes and positions the frameless window just after it is created.
- void SetInitialBoundsForFramelessWindow(const gfx::Rect& bounds);
-
- // Returns the bounds and "show" state from the delegate. Returns true if
- // the delegate wants to use a specified bounds.
- bool GetSavedWindowPlacement(gfx::Rect* bounds,
- ui::WindowShowState* show_state);
-
- // Creates and initializes a new InputMethod and returns it, otherwise null.
- scoped_ptr<InputMethod> CreateInputMethod();
-
- // Sets a different InputMethod instance to this widget. The instance
- // must not be initialized, the ownership will be assumed by the widget.
- // It's only for testing purpose.
- void ReplaceInputMethod(InputMethod* input_method);
-
- internal::NativeWidgetPrivate* native_widget_;
-
- ObserverList<WidgetObserver> observers_;
-
- // Non-owned pointer to the Widget's delegate. If a NULL delegate is supplied
- // to Init() a default WidgetDelegate is created.
- WidgetDelegate* widget_delegate_;
-
- // The root of the View hierarchy attached to this window.
- // WARNING: see warning in tooltip_manager_ for ordering dependencies with
- // this and tooltip_manager_.
- scoped_ptr<internal::RootView> root_view_;
-
- // The View that provides the non-client area of the window (title bar,
- // window controls, sizing borders etc). To use an implementation other than
- // the default, this class must be sub-classed and this value set to the
- // desired implementation before calling |InitWindow()|.
- NonClientView* non_client_view_;
-
- // The focus manager keeping track of focus for this Widget and any of its
- // children. NULL for non top-level widgets.
- // WARNING: RootView's destructor calls into the FocusManager. As such, this
- // must be destroyed AFTER root_view_. This is enforced in DestroyRootView().
- scoped_ptr<FocusManager> focus_manager_;
-
- // A theme provider to use when no other theme provider is specified.
- scoped_ptr<ui::DefaultThemeProvider> default_theme_provider_;
-
- // Valid for the lifetime of RunShellDrag(), indicates the view the drag
- // started from.
- View* dragged_view_;
-
- // See class documentation for Widget above for a note about ownership.
- InitParams::Ownership ownership_;
-
- // See set_is_secondary_widget().
- bool is_secondary_widget_;
-
- // The current frame type in use by this window. Defaults to
- // FRAME_TYPE_DEFAULT.
- FrameType frame_type_;
-
- // True when the window should be rendered as active, regardless of whether
- // or not it actually is.
- bool disable_inactive_rendering_;
-
- // Set to true if the widget is in the process of closing.
- bool widget_closed_;
-
- // The saved "show" state for this window. See note in SetInitialBounds
- // that explains why we save this.
- ui::WindowShowState saved_show_state_;
-
- // The restored bounds used for the initial show. This is only used if
- // |saved_show_state_| is maximized.
- gfx::Rect initial_restored_bounds_;
-
- // Focus is automatically set to the view provided by the delegate
- // when the widget is shown. Set this value to false to override
- // initial focus for the widget.
- bool focus_on_creation_;
-
- mutable scoped_ptr<InputMethod> input_method_;
-
- // See |is_top_level()| accessor.
- bool is_top_level_;
-
- // Tracks whether native widget has been initialized.
- bool native_widget_initialized_;
-
- // Whether native widget has been destroyed.
- bool native_widget_destroyed_;
-
- // TODO(beng): Remove NativeWidgetGtk's dependence on these:
- // If true, the mouse is currently down.
- bool is_mouse_button_pressed_;
-
- // If true, a touch device is currently down.
- bool is_touch_down_;
-
- // TODO(beng): Remove NativeWidgetGtk's dependence on these:
- // 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_;
-
- // True if event capture should be released on a mouse up event. Default is
- // true.
- bool auto_release_capture_;
-
- // See description in GetRootLayers().
- std::vector<ui::Layer*> root_layers_;
-
- // Is |root_layers_| out of date?
- bool root_layers_dirty_;
-
- // True when window movement via mouse interaction with the frame should be
- // disabled.
- bool movement_disabled_;
-
- DISALLOW_COPY_AND_ASSIGN(Widget);
-};
-
-} // namespace views
-
-#endif // UI_VIEWS_WIDGET_WIDGET_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 UI_VIEWS_WIDGET_WIDGET_H_
+#define UI_VIEWS_WIDGET_WIDGET_H_
+
+#include <set>
+#include <stack>
+#include <vector>
+
+#include "base/gtest_prod_util.h"
+#include "base/memory/scoped_ptr.h"
+#include "base/observer_list.h"
+#include "ui/base/ui_base_types.h"
+#include "ui/compositor/layer_type.h"
+#include "ui/gfx/native_widget_types.h"
+#include "ui/gfx/rect.h"
+#include "ui/views/focus/focus_manager.h"
+#include "ui/views/widget/native_widget_delegate.h"
+#include "ui/views/window/client_view.h"
+#include "ui/views/window/non_client_view.h"
+
+#if defined(OS_WIN)
+// Windows headers define macros for these function names which screw with us.
+#if defined(IsMaximized)
+#undef IsMaximized
+#endif
+#if defined(IsMinimized)
+#undef IsMinimized
+#endif
+#if defined(CreateWindow)
+#undef CreateWindow
+#endif
+#endif
+
+namespace gfx {
+class Canvas;
+class Point;
+class Rect;
+}
+
+namespace ui {
+class Accelerator;
+class Compositor;
+class DefaultThemeProvider;
+class Layer;
+class NativeTheme;
+class OSExchangeData;
+class ThemeProvider;
+}
+
+namespace views {
+
+class DesktopRootWindowHost;
+class InputMethod;
+class NativeWidget;
+class NonClientFrameView;
+class TooltipManager;
+class View;
+class WidgetDelegate;
+class WidgetObserver;
+
+namespace internal {
+class NativeWidgetPrivate;
+class RootView;
+}
+
+////////////////////////////////////////////////////////////////////////////////
+// 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.
+//
+// A special note on ownership:
+//
+// Depending on the value of the InitParams' ownership field, the Widget
+// either owns or is owned by its NativeWidget:
+//
+// ownership = NATIVE_WIDGET_OWNS_WIDGET (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.
+// ownership = WIDGET_OWNS_NATIVE_WIDGET (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 VIEWS_EXPORT Widget : public internal::NativeWidgetDelegate,
+ public FocusTraversable {
+ public:
+ typedef std::set<Widget*> Widgets;
+
+ enum FrameType {
+ FRAME_TYPE_DEFAULT, // Use whatever the default would be.
+ FRAME_TYPE_FORCE_CUSTOM, // Force the custom frame.
+ FRAME_TYPE_FORCE_NATIVE // Force the native frame.
+ };
+
+ // Result from RunMoveLoop().
+ enum MoveLoopResult {
+ // The move loop completed successfully.
+ MOVE_LOOP_SUCCESSFUL,
+
+ // The user canceled the move loop.
+ MOVE_LOOP_CANCELED
+ };
+
+ // Source that initiated the move loop.
+ enum MoveLoopSource {
+ MOVE_LOOP_SOURCE_MOUSE,
+ MOVE_LOOP_SOURCE_TOUCH,
+ };
+
+ // Behavior when escape is pressed during a move loop.
+ enum MoveLoopEscapeBehavior {
+ // Indicates the window should be hidden.
+ MOVE_LOOP_ESCAPE_BEHAVIOR_HIDE,
+
+ // Indicates the window should not be hidden.
+ MOVE_LOOP_ESCAPE_BEHAVIOR_DONT_HIDE,
+ };
+
+ struct VIEWS_EXPORT InitParams {
+ enum Type {
+ TYPE_WINDOW, // A decorated Window, like a frame window.
+ // Widgets of TYPE_WINDOW will have a NonClientView.
+ TYPE_PANEL, // Always on top window managed by PanelManager.
+ // Widgets of TYPE_PANEL will have a NonClientView.
+ TYPE_WINDOW_FRAMELESS,
+ // An undecorated 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.
+ TYPE_TOOLTIP,
+ TYPE_BUBBLE,
+ };
+
+ enum WindowOpacity {
+ // Infer fully opaque or not. For WinAura, top-level windows that are not
+ // of TYPE_WINDOW are translucent so that they can be made to fade in. In
+ // all other cases, windows are fully opaque.
+ INFER_OPACITY,
+ // Fully opaque.
+ OPAQUE_WINDOW,
+ // Possibly translucent/transparent.
+ TRANSLUCENT_WINDOW,
+ };
+
+ enum Ownership {
+ // Default. Creator is not responsible for managing the lifetime of the
+ // Widget, it is destroyed when the corresponding NativeWidget is
+ // destroyed.
+ NATIVE_WIDGET_OWNS_WIDGET,
+ // Used when the Widget is owned by someone other than the NativeWidget,
+ // e.g. a scoped_ptr in tests.
+ WIDGET_OWNS_NATIVE_WIDGET
+ };
+
+ InitParams();
+ explicit InitParams(Type type);
+
+ // Will return the first of the following that isn't NULL: the native view,
+ // |parent|, |context|.
+ gfx::NativeView GetContext() const;
+
+ Type type;
+ // If NULL, a default implementation will be constructed.
+ WidgetDelegate* delegate;
+ bool child;
+ // If TRANSLUCENT_WINDOW, the widget may be fully or partially transparent.
+ // If OPAQUE_WINDOW, we can perform optimizations based on the widget being
+ // fully opaque. Defaults to TRANSLUCENT_WINDOW if
+ // ViewsDelegate::UseTransparentWindows(). Defaults to OPAQUE_WINDOW for
+ // non-window widgets.
+ WindowOpacity opacity;
+ bool accept_events;
+ bool can_activate;
+ bool keep_on_top;
+ Ownership ownership;
+ bool mirror_origin_in_rtl;
+ bool has_dropshadow;
+ // Only used by Windows. Specifies that the system default caption and icon
+ // should not be rendered, and that the client area should be equivalent to
+ // the window area.
+ bool remove_standard_frame;
+ // Only used by ShellWindow on Windows. Specifies that the default icon of
+ // packaged app should be the system default icon.
+ bool use_system_default_icon;
+ // Whether the widget should be maximized or minimized.
+ ui::WindowShowState show_state;
+ // Should the widget be double buffered? Default is false.
+ bool double_buffer;
+ gfx::NativeView parent;
+ // Specifies the initial bounds of the Widget. Default is empty, which means
+ // the NativeWidget may specify a default size. If the parent is specified,
+ // |bounds| is in the parent's coordinate system. If the parent is not
+ // specified, it's in screen's global coordinate system.
+ gfx::Rect bounds;
+ // When set, this value is used as the Widget's NativeWidget implementation.
+ // The Widget will not construct a default one. Default is NULL.
+ NativeWidget* native_widget;
+ // Aura-only. Provides a DesktopRootWindowHost implementation to use instead
+ // of the default one.
+ // TODO(beng): Figure out if there's a better way to expose this, e.g. get
+ // rid of NW subclasses and do this all via message handling.
+ DesktopRootWindowHost* desktop_root_window_host;
+ // Whether this window is intended to be a toplevel window with no
+ // attachment to any other window. (This may be a transient window if
+ // |parent| is set.)
+ bool top_level;
+ // Only used by NativeWidgetAura. Specifies the type of layer for the
+ // aura::Window. Default is LAYER_TEXTURED.
+ ui::LayerType layer_type;
+ // Only used by Aura. Provides a context window whose RootWindow is
+ // consulted during widget creation to determine where in the Window
+ // hierarchy this widget should be placed. (This is separate from |parent|;
+ // if you pass a RootWindow to |parent|, your window will be parented to
+ // |parent|. If you pass a RootWindow to |context|, we ask that RootWindow
+ // where it wants your window placed.) NULL is not allowed if you are using
+ // aura.
+ gfx::NativeView context;
+ // Only used by X11, for root level windows. Specifies the res_name and
+ // res_class fields, respectively, of the WM_CLASS window property. Controls
+ // window grouping and desktop file matching in Linux window managers.
+ std::string wm_class_name;
+ std::string wm_class_class;
+ };
+
+ Widget();
+ virtual ~Widget();
+
+ // Creates a toplevel window with no context. These methods should only be
+ // used in cases where there is no contextual information because we're
+ // creating a toplevel window connected to no other event.
+ //
+ // If you have any parenting or context information, or can pass that
+ // information, prefer the WithParent or WithContext versions of these
+ // methods.
+ static Widget* CreateWindow(WidgetDelegate* delegate);
+ static Widget* CreateWindowWithBounds(WidgetDelegate* delegate,
+ const gfx::Rect& bounds);
+
+ // Creates a decorated window Widget with the specified properties.
+ static Widget* CreateWindowWithParent(WidgetDelegate* delegate,
+ gfx::NativeWindow parent);
+ static Widget* CreateWindowWithParentAndBounds(WidgetDelegate* delegate,
+ gfx::NativeWindow parent,
+ const gfx::Rect& bounds);
+
+ // Creates a decorated window Widget in the same desktop context as
+ // |context|.
+ static Widget* CreateWindowWithContext(WidgetDelegate* delegate,
+ gfx::NativeView context);
+ static Widget* CreateWindowWithContextAndBounds(WidgetDelegate* delegate,
+ gfx::NativeView context,
+ const gfx::Rect& bounds);
+
+ // Creates an undecorated child window Widget. |new_style_parent| is the
+ // parent to use for new style dialogs, |parent| for currently-styled dialogs.
+ //
+ // TODO(wittman): use a single parent parameter once we move fully to
+ // new-style dialogs.
+ static Widget* CreateWindowAsFramelessChild(WidgetDelegate* widget_delegate,
+ gfx::NativeView parent,
+ gfx::NativeView new_style_parent);
+
+ // Enumerates all windows pertaining to us and notifies their
+ // view hierarchies that the locale has changed.
+ // TODO(beng): remove post-Aurafication of ChromeOS.
+ 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);
+
+ // Retrieves the Widget implementation associated with the given
+ // NativeView or Window, or NULL if the supplied handle has no associated
+ // Widget.
+ static Widget* GetWidgetForNativeView(gfx::NativeView native_view);
+ static Widget* GetWidgetForNativeWindow(gfx::NativeWindow native_window);
+
+ // Retrieves the top level widget in a native view hierarchy
+ // starting at |native_view|. Top level widget is a widget with TYPE_WINDOW,
+ // TYPE_PANEL, TYPE_WINDOW_FRAMELESS, POPUP or MENU and has its own
+ // focus manager. This may be itself if the |native_view| is top level,
+ // or NULL if there is no toplevel in a native view hierarchy.
+ static Widget* GetTopLevelWidgetForNativeView(gfx::NativeView native_view);
+
+ // Returns all Widgets in |native_view|'s hierarchy, including itself if
+ // it is one.
+ static void GetAllChildWidgets(gfx::NativeView native_view,
+ Widgets* children);
+
+ // Returns all non-child Widgets owned by |native_view|.
+ static void GetAllOwnedWidgets(gfx::NativeView native_view,
+ Widgets* owned);
+
+ // Re-parent a NativeView and notify all Widgets in |native_view|'s hierarchy
+ // of the change.
+ static void ReparentNativeView(gfx::NativeView native_view,
+ gfx::NativeView new_parent);
+
+ // Returns the preferred size of the contents view of this window based on
+ // its localized size data. The width in cols is held in a localized string
+ // resource identified by |col_resource_id|, the height in the same fashion.
+ // TODO(beng): This should eventually live somewhere else, probably closer to
+ // ClientView.
+ static int GetLocalizedContentsWidth(int col_resource_id);
+ static int GetLocalizedContentsHeight(int row_resource_id);
+ static gfx::Size GetLocalizedContentsSize(int col_resource_id,
+ int row_resource_id);
+
+ // Returns true if the specified type requires a NonClientView.
+ static bool RequiresNonClientView(InitParams::Type type);
+
+ void Init(const InitParams& params);
+
+ // Returns the gfx::NativeView associated with this Widget.
+ 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 or TYPE_PANEL.
+ gfx::NativeWindow GetNativeWindow() const;
+
+ // Add/remove observer.
+ void AddObserver(WidgetObserver* observer);
+ void RemoveObserver(WidgetObserver* observer);
+ bool HasObserver(WidgetObserver* observer);
+
+ // 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);
+
+ // Forwarded from the RootView so that the widget can do any cleanup.
+ void ViewHierarchyChanged(const View::ViewHierarchyChangedDetails& details);
+
+ // Called right before changing the widget's parent NativeView to do any
+ // cleanup.
+ void NotifyNativeViewHierarchyWillChange();
+
+ // Called after changing the widget's parent NativeView. Notifies the RootView
+ // about the change.
+ void NotifyNativeViewHierarchyChanged();
+
+ // Returns the top level widget in a hierarchy (see is_top_level() for
+ // the definition of top level widget.) Will return NULL if called
+ // before the widget is attached to the top level widget's hierarchy.
+ Widget* GetTopLevelWidget();
+ const Widget* GetTopLevelWidget() const;
+
+ // Gets/Sets the WidgetDelegate.
+ WidgetDelegate* widget_delegate() const { return widget_delegate_; }
+
+ // Sets the specified view as the contents of this Widget. There can only
+ // be one contents view child of this Widget's RootView. This view is sized to
+ // fit the entire size of the RootView. The RootView takes ownership of this
+ // View, unless it is set as not being parent-owned.
+ void SetContentsView(View* view);
+ View* GetContentsView();
+
+ // Returns the bounds of the Widget in screen coordinates.
+ gfx::Rect GetWindowBoundsInScreen() const;
+
+ // Returns the bounds of the Widget's client area in screen coordinates.
+ gfx::Rect GetClientAreaBoundsInScreen() const;
+
+ // Retrieves the restored bounds for the window.
+ gfx::Rect GetRestoredBounds() const;
+
+ // Sizes and/or places the widget to the specified bounds, size or position.
+ void SetBounds(const gfx::Rect& bounds);
+ void SetSize(const gfx::Size& size);
+
+ // Sizes the window to the specified size and centerizes it.
+ void CenterWindow(const gfx::Size& size);
+
+ // Like SetBounds(), but ensures the Widget is fully visible on screen,
+ // resizing and/or repositioning as necessary. This is only useful for
+ // non-child widgets.
+ void SetBoundsConstrained(const gfx::Rect& bounds);
+
+ // Sets whether animations that occur when visibility is changed are enabled.
+ // Default is true.
+ void SetVisibilityChangedAnimationsEnabled(bool value);
+
+ // Starts a nested message loop that moves the window. This can be used to
+ // start a window move operation from a mouse or touch event. This returns
+ // when the move completes. |drag_offset| is the offset from the top left
+ // corner of the window to the point where the cursor is dragging, and is used
+ // to offset the bounds of the window from the cursor.
+ MoveLoopResult RunMoveLoop(const gfx::Vector2d& drag_offset,
+ MoveLoopSource source,
+ MoveLoopEscapeBehavior escape_behavior);
+
+ // Stops a previously started move loop. This is not immediate.
+ void EndMoveLoop();
+
+ // Places the widget in front of the specified widget in z-order.
+ void StackAboveWidget(Widget* widget);
+ void StackAbove(gfx::NativeView native_view);
+ void StackAtTop();
+
+ // Places the widget below the specified NativeView.
+ void StackBelow(gfx::NativeView native_view);
+
+ // Sets a shape on the widget. Passing a NULL |shape| reverts the widget to
+ // be rectangular. Takes ownership of |shape|.
+ void SetShape(gfx::NativeRegion shape);
+
+ // Hides the widget then closes it after a return to the message loop.
+ 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();
+
+ // Whether the widget has been asked to close itself. In particular this is
+ // set to true after Close() has been invoked on the NativeWidget.
+ bool IsClosed() const;
+
+ // Shows or hides the widget, without changing activation state.
+ virtual void Show();
+ void Hide();
+
+ // Like Show(), but does not activate the window.
+ void ShowInactive();
+
+ // Activates the widget, assuming it already exists and is visible.
+ void Activate();
+
+ // Deactivates the widget, making the next window in the Z order the active
+ // window.
+ void Deactivate();
+
+ // Returns whether the Widget is the currently active window.
+ virtual bool IsActive() const;
+
+ // Prevents the window from being rendered as deactivated. This state is
+ // reset automatically as soon as the window becomes activated again. There is
+ // no ability to control the state through this API as this leads to sync
+ // problems.
+ void DisableInactiveRendering();
+
+ // Sets the widget to be on top of all other widgets in the windowing system.
+ void SetAlwaysOnTop(bool on_top);
+
+ // Returns whether the widget has been set to be on top of most other widgets
+ // in the windowing system.
+ bool IsAlwaysOnTop() const;
+
+ // Maximizes/minimizes/restores the window.
+ void Maximize();
+ void Minimize();
+ void Restore();
+
+ // Whether or not the window is maximized or minimized.
+ virtual bool IsMaximized() const;
+ bool IsMinimized() const;
+
+ // Accessors for fullscreen state.
+ void SetFullscreen(bool fullscreen);
+ bool IsFullscreen() const;
+
+ // 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.
+ void SetOpacity(unsigned char opacity);
+
+ // Sets whether or not the window should show its frame as a "transient drag
+ // frame" - slightly transparent and without the standard window controls.
+ void SetUseDragFrame(bool use_drag_frame);
+
+ // Flashes the frame of the window to draw attention to it. Currently only
+ // implemented on Windows for non-Aura.
+ void FlashFrame(bool flash);
+
+ // Returns the View at the root of the View hierarchy contained by this
+ // Widget.
+ View* GetRootView();
+ const View* GetRootView() const;
+
+ // 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.
+ virtual bool IsVisible() const;
+
+ // Returns the ThemeProvider that provides theme resources for this Widget.
+ virtual ui::ThemeProvider* GetThemeProvider() const;
+
+ ui::NativeTheme* GetNativeTheme() {
+ return const_cast<ui::NativeTheme*>(
+ const_cast<const Widget*>(this)->GetNativeTheme());
+ }
+ const ui::NativeTheme* GetNativeTheme() const;
+
+ // Returns the FocusManager for this widget.
+ // Note that all widgets in a widget hierarchy share the same focus manager.
+ FocusManager* GetFocusManager();
+ const FocusManager* GetFocusManager() const;
+
+ // Returns the InputMethod for this widget.
+ // Note that all widgets in a widget hierarchy share the same input method.
+ InputMethod* GetInputMethod();
+ const InputMethod* GetInputMethod() const;
+
+ // Starts a drag operation for the specified view. This blocks until the drag
+ // operation completes. |view| can be NULL.
+ // If the view is non-NULL it can be accessed during the drag by calling
+ // dragged_view(). If the view has not been deleted during the drag,
+ // OnDragDone() is called on it. |location| is in the widget's coordinate
+ // system.
+ void RunShellDrag(View* view,
+ const ui::OSExchangeData& data,
+ const gfx::Point& location,
+ int operation,
+ ui::DragDropTypes::DragEventSource source);
+
+ // Returns the view that requested the current drag operation via
+ // RunShellDrag(), or NULL if there is no such view or drag operation.
+ View* dragged_view() { return dragged_view_; }
+
+ // Adds the specified |rect| in client area coordinates to the rectangle to be
+ // redrawn.
+ virtual 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);
+
+ // Returns true if and only if mouse events are enabled.
+ bool IsMouseEventsEnabled() const;
+
+ // Sets/Gets a native window property on the underlying native window object.
+ // Returns NULL if the property does not exist. Setting the property value to
+ // NULL removes the property.
+ void SetNativeWindowProperty(const char* name, void* value);
+ void* GetNativeWindowProperty(const char* name) const;
+
+ // Tell the window to update its title from the delegate.
+ void UpdateWindowTitle();
+
+ // Tell the window to update its icon from the delegate.
+ void UpdateWindowIcon();
+
+ // 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);
+
+ // Clear native focus set to the Widget's NativeWidget.
+ void ClearNativeFocus();
+
+ void set_frame_type(FrameType frame_type) { frame_type_ = frame_type; }
+ FrameType frame_type() const { return frame_type_; }
+
+ // Creates an appropriate NonClientFrameView for this widget. The
+ // WidgetDelegate is given the first opportunity to create one, followed by
+ // the NativeWidget implementation. If both return NULL, a default one is
+ // created.
+ virtual NonClientFrameView* CreateNonClientFrameView();
+
+ // Whether we should be using a native frame.
+ bool ShouldUseNativeFrame() const;
+
+ // Forces the frame into the alternate frame type (custom or native) depending
+ // on its current state.
+ void DebugToggleFrameType();
+
+ // Tell the window that something caused the frame type to change.
+ void FrameTypeChanged();
+
+ NonClientView* non_client_view() {
+ return const_cast<NonClientView*>(
+ const_cast<const Widget*>(this)->non_client_view());
+ }
+ const NonClientView* non_client_view() const {
+ return non_client_view_;
+ }
+
+ ClientView* client_view() {
+ return const_cast<ClientView*>(
+ const_cast<const Widget*>(this)->client_view());
+ }
+ const ClientView* client_view() const {
+ // non_client_view_ may be NULL, especially during creation.
+ return non_client_view_ ? non_client_view_->client_view() : NULL;
+ }
+
+ const ui::Compositor* GetCompositor() const;
+ ui::Compositor* GetCompositor();
+
+ // Returns the widget's layer, if any.
+ ui::Layer* GetLayer();
+
+ // Reorders the widget's child NativeViews which are associated to the view
+ // tree (eg via a NativeViewHost) to match the z-order of the views in the
+ // view tree. The z-order of views with layers relative to views with
+ // associated NativeViews is used to reorder the NativeView layers. This
+ // method assumes that the widget's child layers which are owned by a view are
+ // already in the correct z-order relative to each other and does no
+ // reordering if there are no views with an associated NativeView.
+ void ReorderNativeViews();
+
+ // Schedules an update to the root layers. The actual processing occurs when
+ // GetRootLayers() is invoked.
+ void UpdateRootLayers();
+
+ const NativeWidget* native_widget() const;
+ NativeWidget* native_widget();
+
+ internal::NativeWidgetPrivate* native_widget_private() {
+ return native_widget_;
+ }
+ const internal::NativeWidgetPrivate* native_widget_private() const {
+ return native_widget_;
+ }
+
+ // Sets capture to the specified view. This makes it so that all mouse, touch
+ // and gesture events go to |view|. If |view| is NULL, the widget still
+ // obtains event capture, but the events will go to the view they'd normally
+ // go to.
+ void SetCapture(View* view);
+
+ // Releases capture.
+ void ReleaseCapture();
+
+ // Returns true if the widget has capture.
+ bool HasCapture();
+
+ void set_auto_release_capture(bool auto_release_capture) {
+ auto_release_capture_ = auto_release_capture;
+ }
+
+ // Returns the font used for tooltips.
+ TooltipManager* GetTooltipManager();
+ const TooltipManager* GetTooltipManager() const;
+
+ // Sets-up the focus manager with the view that should have focus when the
+ // window is shown the first time. Returns true if the initial focus has been
+ // set or the widget should not set the initial focus, or false if the caller
+ // should set the initial focus (if any).
+ bool SetInitialFocus();
+
+ void set_focus_on_creation(bool focus_on_creation) {
+ focus_on_creation_ = focus_on_creation;
+ }
+
+ // True if the widget is considered top level widget. Top level widget
+ // is a widget of TYPE_WINDOW, TYPE_PANEL, TYPE_WINDOW_FRAMELESS, BUBBLE,
+ // POPUP or MENU, and has a focus manager and input method object associated
+ // with it. TYPE_CONTROL and TYPE_TOOLTIP is not considered top level.
+ bool is_top_level() const { return is_top_level_; }
+
+ // True when window movement via mouse interaction with the frame is disabled.
+ bool movement_disabled() const { return movement_disabled_; }
+ void set_movement_disabled(bool disabled) { movement_disabled_ = disabled; }
+
+ // Returns the work area bounds of the screen the Widget belongs to.
+ gfx::Rect GetWorkAreaBoundsInScreen() const;
+
+ // Creates and dispatches synthesized mouse move event using the current
+ // mouse location to refresh hovering status in the widget.
+ void SynthesizeMouseMoveEvent();
+
+ // Called by our RootView after it has performed a Layout. Used to forward
+ // window sizing information to the window server on some platforms.
+ void OnRootViewLayout();
+
+ // Notification that our owner is closing.
+ // NOTE: this is not invoked for aura as it's currently not needed there.
+ // Under aura menus close by way of activation getting reset when the owner
+ // closes.
+ virtual void OnOwnerClosing();
+
+ // Overridden from NativeWidgetDelegate:
+ virtual bool IsModal() const OVERRIDE;
+ virtual bool IsDialogBox() const OVERRIDE;
+ virtual bool CanActivate() const OVERRIDE;
+ virtual bool IsInactiveRenderingDisabled() const OVERRIDE;
+ virtual void EnableInactiveRendering() OVERRIDE;
+ virtual void OnNativeWidgetActivationChanged(bool active) OVERRIDE;
+ virtual void OnNativeFocus(gfx::NativeView old_focused_view) OVERRIDE;
+ virtual void OnNativeBlur(gfx::NativeView new_focused_view) OVERRIDE;
+ virtual void OnNativeWidgetVisibilityChanging(bool visible) OVERRIDE;
+ virtual void OnNativeWidgetVisibilityChanged(bool visible) OVERRIDE;
+ virtual void OnNativeWidgetCreated(bool desktop_widget) OVERRIDE;
+ virtual void OnNativeWidgetDestroying() OVERRIDE;
+ virtual void OnNativeWidgetDestroyed() OVERRIDE;
+ virtual gfx::Size GetMinimumSize() OVERRIDE;
+ virtual gfx::Size GetMaximumSize() OVERRIDE;
+ virtual void OnNativeWidgetMove() OVERRIDE;
+ virtual void OnNativeWidgetSizeChanged(const gfx::Size& new_size) OVERRIDE;
+ virtual void OnNativeWidgetBeginUserBoundsChange() OVERRIDE;
+ virtual void OnNativeWidgetEndUserBoundsChange() OVERRIDE;
+ virtual bool HasFocusManager() const OVERRIDE;
+ virtual bool OnNativeWidgetPaintAccelerated(
+ const gfx::Rect& dirty_region) OVERRIDE;
+ virtual void OnNativeWidgetPaint(gfx::Canvas* canvas) OVERRIDE;
+ virtual int GetNonClientComponent(const gfx::Point& point) OVERRIDE;
+ virtual void OnKeyEvent(ui::KeyEvent* event) OVERRIDE;
+ virtual void OnMouseEvent(ui::MouseEvent* event) OVERRIDE;
+ virtual void OnMouseCaptureLost() OVERRIDE;
+ virtual void OnTouchEvent(ui::TouchEvent* event) OVERRIDE;
+ virtual void OnScrollEvent(ui::ScrollEvent* event) OVERRIDE;
+ virtual void OnGestureEvent(ui::GestureEvent* event) OVERRIDE;
+ virtual bool ExecuteCommand(int command_id) OVERRIDE;
+ virtual InputMethod* GetInputMethodDirect() OVERRIDE;
+ virtual const std::vector<ui::Layer*>& GetRootLayers() OVERRIDE;
+ virtual bool HasHitTestMask() const OVERRIDE;
+ virtual void GetHitTestMask(gfx::Path* mask) const 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:
+ // 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 internal::RootView* CreateRootView();
+
+ // Provided to allow the NativeWidget implementations to destroy the RootView
+ // _before_ the focus manager/tooltip manager.
+ // TODO(beng): remove once we fold those objects onto this one.
+ void DestroyRootView();
+
+ private:
+ friend class ComboboxTest;
+ friend class NativeTextfieldViewsTest;
+
+ // Sets the value of |disable_inactive_rendering_|. If the value changes,
+ // both the NonClientView and WidgetDelegate are notified.
+ void SetInactiveRenderingDisabled(bool value);
+
+ // Persists the window's restored position and "show" state using the
+ // window delegate.
+ void SaveWindowPlacement();
+
+ // Sizes and positions the window just after it is created.
+ void SetInitialBounds(const gfx::Rect& bounds);
+
+ // Sizes and positions the frameless window just after it is created.
+ void SetInitialBoundsForFramelessWindow(const gfx::Rect& bounds);
+
+ // Returns the bounds and "show" state from the delegate. Returns true if
+ // the delegate wants to use a specified bounds.
+ bool GetSavedWindowPlacement(gfx::Rect* bounds,
+ ui::WindowShowState* show_state);
+
+ // Creates and initializes a new InputMethod and returns it, otherwise null.
+ scoped_ptr<InputMethod> CreateInputMethod();
+
+ // Sets a different InputMethod instance to this widget. The instance
+ // must not be initialized, the ownership will be assumed by the widget.
+ // It's only for testing purpose.
+ void ReplaceInputMethod(InputMethod* input_method);
+
+ internal::NativeWidgetPrivate* native_widget_;
+
+ ObserverList<WidgetObserver> observers_;
+
+ // Non-owned pointer to the Widget's delegate. If a NULL delegate is supplied
+ // to Init() a default WidgetDelegate is created.
+ WidgetDelegate* widget_delegate_;
+
+ // The root of the View hierarchy attached to this window.
+ // WARNING: see warning in tooltip_manager_ for ordering dependencies with
+ // this and tooltip_manager_.
+ scoped_ptr<internal::RootView> root_view_;
+
+ // The View that provides the non-client area of the window (title bar,
+ // window controls, sizing borders etc). To use an implementation other than
+ // the default, this class must be sub-classed and this value set to the
+ // desired implementation before calling |InitWindow()|.
+ NonClientView* non_client_view_;
+
+ // The focus manager keeping track of focus for this Widget and any of its
+ // children. NULL for non top-level widgets.
+ // WARNING: RootView's destructor calls into the FocusManager. As such, this
+ // must be destroyed AFTER root_view_. This is enforced in DestroyRootView().
+ scoped_ptr<FocusManager> focus_manager_;
+
+ // A theme provider to use when no other theme provider is specified.
+ scoped_ptr<ui::DefaultThemeProvider> default_theme_provider_;
+
+ // Valid for the lifetime of RunShellDrag(), indicates the view the drag
+ // started from.
+ View* dragged_view_;
+
+ // See class documentation for Widget above for a note about ownership.
+ InitParams::Ownership ownership_;
+
+ // See set_is_secondary_widget().
+ bool is_secondary_widget_;
+
+ // The current frame type in use by this window. Defaults to
+ // FRAME_TYPE_DEFAULT.
+ FrameType frame_type_;
+
+ // True when the window should be rendered as active, regardless of whether
+ // or not it actually is.
+ bool disable_inactive_rendering_;
+
+ // Set to true if the widget is in the process of closing.
+ bool widget_closed_;
+
+ // The saved "show" state for this window. See note in SetInitialBounds
+ // that explains why we save this.
+ ui::WindowShowState saved_show_state_;
+
+ // The restored bounds used for the initial show. This is only used if
+ // |saved_show_state_| is maximized.
+ gfx::Rect initial_restored_bounds_;
+
+ // Focus is automatically set to the view provided by the delegate
+ // when the widget is shown. Set this value to false to override
+ // initial focus for the widget.
+ bool focus_on_creation_;
+
+ mutable scoped_ptr<InputMethod> input_method_;
+
+ // See |is_top_level()| accessor.
+ bool is_top_level_;
+
+ // Tracks whether native widget has been initialized.
+ bool native_widget_initialized_;
+
+ // Whether native widget has been destroyed.
+ bool native_widget_destroyed_;
+
+ // TODO(beng): Remove NativeWidgetGtk's dependence on these:
+ // If true, the mouse is currently down.
+ bool is_mouse_button_pressed_;
+
+ // If true, a touch device is currently down.
+ bool is_touch_down_;
+
+ // TODO(beng): Remove NativeWidgetGtk's dependence on these:
+ // 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_;
+
+ // True if event capture should be released on a mouse up event. Default is
+ // true.
+ bool auto_release_capture_;
+
+ // See description in GetRootLayers().
+ std::vector<ui::Layer*> root_layers_;
+
+ // Is |root_layers_| out of date?
+ bool root_layers_dirty_;
+
+ // True when window movement via mouse interaction with the frame should be
+ // disabled.
+ bool movement_disabled_;
+
+ DISALLOW_COPY_AND_ASSIGN(Widget);
+};
+
+} // namespace views
+
+#endif // UI_VIEWS_WIDGET_WIDGET_H_
« no previous file with comments | « ui/views/widget/desktop_aura/desktop_root_window_host_x11.cc ('k') | no next file » | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698