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