ui/views/widget/native_widget_private.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef UI_VIEWS_WIDGET_NATIVE_WIDGET_PRIVATE_H_
   6 #define UI_VIEWS_WIDGET_NATIVE_WIDGET_PRIVATE_H_
   7
   8 #include "base/strings/string16.h"
   9 #include "ui/base/ui_base_types.h"
  10 #include "ui/gfx/native_widget_types.h"
  11 #include "ui/views/widget/native_widget.h"
  12
  13 namespace gfx {
  14 class FontList;
  15 class ImageSkia;
  16 class Rect;
  17 }
  18
  19 namespace ui {
  20 class InputMethod;
  21 class NativeTheme;
  22 class OSExchangeData;
  23 }
  24
  25 namespace views {
  26 class InputMethod;
  27 class TooltipManager;
  28 namespace internal {
  29 class InputMethodDelegate;
  30
  31 ////////////////////////////////////////////////////////////////////////////////
  32 // NativeWidgetPrivate interface
  33 //
  34 //  A NativeWidget subclass internal to views that provides Widget a conduit for
  35 //  communication with a backend-specific native widget implementation.
  36 //
  37 //  Many of the methods here are pass-thrus for Widget, and as such there is no
  38 //  documentation for them here. In that case, see methods of the same name in
  39 //  widget.h.
  40 //
  41 //  IMPORTANT: This type is intended for use only by the views system and for
  42 //             NativeWidget implementations. This file should not be included
  43 //             in code that does not fall into one of these use cases.
  44 //
  45 class VIEWS_EXPORT NativeWidgetPrivate : public NativeWidget {
  46  public:
  47   ~NativeWidgetPrivate() override {}
  48
  49   // Creates an appropriate default NativeWidgetPrivate implementation for the
  50   // current OS/circumstance.
  51   static NativeWidgetPrivate* CreateNativeWidget(
  52       internal::NativeWidgetDelegate* delegate);
  53
  54   static NativeWidgetPrivate* GetNativeWidgetForNativeView(
  55       gfx::NativeView native_view);
  56   static NativeWidgetPrivate* GetNativeWidgetForNativeWindow(
  57       gfx::NativeWindow native_window);
  58
  59   // Retrieves the top NativeWidgetPrivate in the hierarchy containing the given
  60   // NativeView, or NULL if there is no NativeWidgetPrivate that contains it.
  61   static NativeWidgetPrivate* GetTopLevelNativeWidget(
  62       gfx::NativeView native_view);
  63
  64   static void GetAllChildWidgets(gfx::NativeView native_view,
  65                                  Widget::Widgets* children);
  66   static void GetAllOwnedWidgets(gfx::NativeView native_view,
  67                                  Widget::Widgets* owned);
  68   static void ReparentNativeView(gfx::NativeView native_view,
  69                                  gfx::NativeView new_parent);
  70
  71   // Returns true if any mouse button is currently down.
  72   static bool IsMouseButtonDown();
  73
  74   static gfx::FontList GetWindowTitleFontList();
  75
  76   // Initializes the NativeWidget.
  77   virtual void InitNativeWidget(const Widget::InitParams& params) = 0;
  78
  79   // Returns a NonClientFrameView for the widget's NonClientView, or NULL if
  80   // the NativeWidget wants no special NonClientFrameView.
  81   virtual NonClientFrameView* CreateNonClientFrameView() = 0;
  82
  83   virtual bool ShouldUseNativeFrame() const = 0;
  84   virtual bool ShouldWindowContentsBeTransparent() const = 0;
  85   virtual void FrameTypeChanged() = 0;
  86
  87   // Returns the Widget associated with this NativeWidget. This function is
  88   // guaranteed to return non-NULL for the lifetime of the NativeWidget.
  89   virtual Widget* GetWidget() = 0;
  90   virtual const Widget* GetWidget() const = 0;
  91
  92   // Returns the NativeView/Window associated with this NativeWidget.
  93   virtual gfx::NativeView GetNativeView() const = 0;
  94   virtual gfx::NativeWindow GetNativeWindow() const = 0;
  95
  96   // Returns the topmost Widget in a hierarchy.
  97   virtual Widget* GetTopLevelWidget() = 0;
  98
  99   // Returns the Compositor, or NULL if there isn't one associated with this
 100   // NativeWidget.
 101   virtual const ui::Compositor* GetCompositor() const = 0;
 102
 103   // Returns the NativeWidget's layer, if any.
 104   virtual const ui::Layer* GetLayer() const = 0;
 105
 106   // Reorders the widget's child NativeViews which are associated to the view
 107   // tree (eg via a NativeViewHost) to match the z-order of the views in the
 108   // view tree. The z-order of views with layers relative to views with
 109   // associated NativeViews is used to reorder the NativeView layers. This
 110   // method assumes that the widget's child layers which are owned by a view are
 111   // already in the correct z-order relative to each other and does no
 112   // reordering if there are no views with an associated NativeView.
 113   virtual void ReorderNativeViews() = 0;
 114
 115   // Notifies the NativeWidget that a view was removed from the Widget's view
 116   // hierarchy.
 117   virtual void ViewRemoved(View* view) = 0;
 118
 119   // Sets/Gets a native window property on the underlying native window object.
 120   // Returns NULL if the property does not exist. Setting the property value to
 121   // NULL removes the property.
 122   virtual void SetNativeWindowProperty(const char* name, void* value) = 0;
 123   virtual void* GetNativeWindowProperty(const char* name) const = 0;
 124
 125   // Returns the native widget's tooltip manager. Called from the View hierarchy
 126   // to update tooltips.
 127   virtual TooltipManager* GetTooltipManager() const = 0;
 128
 129   // Sets or releases event capturing for this native widget.
 130   virtual void SetCapture() = 0;
 131   virtual void ReleaseCapture() = 0;
 132
 133   // Returns true if this native widget is capturing events.
 134   virtual bool HasCapture() const = 0;
 135
 136   // Returns the InputMethod for this native widget.
 137   // Note that all widgets in a widget hierarchy share the same input method.
 138   // TODO(suzhe): rename to GetInputMethod() when NativeWidget implementation
 139   // class doesn't inherit Widget anymore.
 140   virtual InputMethod* CreateInputMethod() = 0;
 141
 142   // Returns the InputMethodDelegate for this native widget.
 143   virtual InputMethodDelegate* GetInputMethodDelegate() = 0;
 144
 145   // Returns the ui::InputMethod for this native widget.
 146   // TODO(yukishiino): Rename this method to GetInputMethod once we remove
 147   // views::InputMethod.
 148   virtual ui::InputMethod* GetHostInputMethod() = 0;
 149
 150   // Centers the window and sizes it to the specified size.
 151   virtual void CenterWindow(const gfx::Size& size) = 0;
 152
 153   // Retrieves the window's current restored bounds and "show" state, for
 154   // persisting.
 155   virtual void GetWindowPlacement(
 156       gfx::Rect* bounds,
 157       ui::WindowShowState* show_state) const = 0;
 158
 159   // Sets the NativeWindow title. Returns true if the title changed.
 160   virtual bool SetWindowTitle(const base::string16& title) = 0;
 161
 162   // Sets the Window icons. |window_icon| is a 16x16 icon suitable for use in
 163   // a title bar. |app_icon| is a larger size for use in the host environment
 164   // app switching UI.
 165   virtual void SetWindowIcons(const gfx::ImageSkia& window_icon,
 166                               const gfx::ImageSkia& app_icon) = 0;
 167
 168   // Initializes the modal type of the window to |modal_type|. Called from
 169   // NativeWidgetDelegate::OnNativeWidgetCreated() before the widget is
 170   // initially parented.
 171   virtual void InitModalType(ui::ModalType modal_type) = 0;
 172
 173   // See method documentation in Widget.
 174   virtual gfx::Rect GetWindowBoundsInScreen() const = 0;
 175   virtual gfx::Rect GetClientAreaBoundsInScreen() const = 0;
 176   virtual gfx::Rect GetRestoredBounds() const = 0;
 177   virtual void SetBounds(const gfx::Rect& bounds) = 0;
 178   virtual void SetSize(const gfx::Size& size) = 0;
 179   virtual void StackAbove(gfx::NativeView native_view) = 0;
 180   virtual void StackAtTop() = 0;
 181   virtual void StackBelow(gfx::NativeView native_view) = 0;
 182   virtual void SetShape(gfx::NativeRegion shape) = 0;
 183   virtual void Close() = 0;
 184   virtual void CloseNow() = 0;
 185   virtual void Show() = 0;
 186   virtual void Hide() = 0;
 187   // Invoked if the initial show should maximize the window. |restored_bounds|
 188   // is the bounds of the window when not maximized.
 189   virtual void ShowMaximizedWithBounds(const gfx::Rect& restored_bounds) = 0;
 190   virtual void ShowWithWindowState(ui::WindowShowState show_state) = 0;
 191   virtual bool IsVisible() const = 0;
 192   virtual void Activate() = 0;
 193   virtual void Deactivate() = 0;
 194   virtual bool IsActive() const = 0;
 195   virtual void SetAlwaysOnTop(bool always_on_top) = 0;
 196   virtual bool IsAlwaysOnTop() const = 0;
 197   virtual void SetVisibleOnAllWorkspaces(bool always_visible) = 0;
 198   virtual void Maximize() = 0;
 199   virtual void Minimize() = 0;
 200   virtual bool IsMaximized() const = 0;
 201   virtual bool IsMinimized() const = 0;
 202   virtual void Restore() = 0;
 203   virtual void SetFullscreen(bool fullscreen) = 0;
 204   virtual bool IsFullscreen() const = 0;
 205   virtual void SetOpacity(unsigned char opacity) = 0;
 206   virtual void SetUseDragFrame(bool use_drag_frame) = 0;
 207   virtual void FlashFrame(bool flash) = 0;
 208   virtual void RunShellDrag(View* view,
 209                             const ui::OSExchangeData& data,
 210                             const gfx::Point& location,
 211                             int operation,
 212                             ui::DragDropTypes::DragEventSource source) = 0;
 213   virtual void SchedulePaintInRect(const gfx::Rect& rect) = 0;
 214   virtual void SetCursor(gfx::NativeCursor cursor) = 0;
 215   virtual bool IsMouseEventsEnabled() const = 0;
 216   virtual void ClearNativeFocus() = 0;
 217   virtual gfx::Rect GetWorkAreaBoundsInScreen() const = 0;
 218   virtual Widget::MoveLoopResult RunMoveLoop(
 219       const gfx::Vector2d& drag_offset,
 220       Widget::MoveLoopSource source,
 221       Widget::MoveLoopEscapeBehavior escape_behavior) = 0;
 222   virtual void EndMoveLoop() = 0;
 223   virtual void SetVisibilityChangedAnimationsEnabled(bool value) = 0;
 224   virtual void SetVisibilityAnimationDuration(
 225       const base::TimeDelta& duration) = 0;
 226   virtual void SetVisibilityAnimationTransition(
 227       Widget::VisibilityTransition transition) = 0;
 228   virtual ui::NativeTheme* GetNativeTheme() const = 0;
 229   virtual void OnRootViewLayout() = 0;
 230   virtual bool IsTranslucentWindowOpacitySupported() const = 0;
 231   virtual void OnSizeConstraintsChanged() = 0;
 232
 233   // Repost an unhandled event to the native widget for default OS processing.
 234   virtual void RepostNativeEvent(gfx::NativeEvent native_event) = 0;
 235
 236   // Overridden from NativeWidget:
 237   internal::NativeWidgetPrivate* AsNativeWidgetPrivate() override;
 238 };
 239
 240 }  // namespace internal
 241 }  // namespace views
 242
 243 #endif  // UI_VIEWS_WIDGET_NATIVE_WIDGET_PRIVATE_H_