diff options
Diffstat (limited to 'ui/views/widget/native_widget_private.h')
-rw-r--r-- | ui/views/widget/native_widget_private.h | 216 |
1 files changed, 216 insertions, 0 deletions
diff --git a/ui/views/widget/native_widget_private.h b/ui/views/widget/native_widget_private.h new file mode 100644 index 0000000..229a530 --- /dev/null +++ b/ui/views/widget/native_widget_private.h @@ -0,0 +1,216 @@ +// Copyright (c) 2011 The Chromium Authors. All rights reserved. +// Use of this source code is governed by a BSD-style license that can be +// found in the LICENSE file. + +#ifndef UI_VIEWS_WIDGET_NATIVE_WIDGET_PRIVATE_H_ +#define UI_VIEWS_WIDGET_NATIVE_WIDGET_PRIVATE_H_ +#pragma once + +#include "base/string16.h" +#include "ui/gfx/native_widget_types.h" +#include "ui/views/ime/input_method_delegate.h" +#include "ui/views/widget/native_widget.h" + +namespace gfx { +class Rect; +} + +namespace ui { +class OSExchangeData; +} + +namespace views { +class InputMethod; +class TooltipManager; +namespace internal { + +//////////////////////////////////////////////////////////////////////////////// +// NativeWidgetPrivate interface +// +// A NativeWidget subclass internal to views that provides Widget a conduit for +// communication with a backend-specific native widget implementation. +// +// Many of the methods here are pass-thrus for Widget, and as such there is no +// documentation for them here. In that case, see methods of the same name in +// widget.h. +// +// IMPORTANT: This type is intended for use only by the views system and for +// NativeWidget implementations. This file should not be included +// in code that does not fall into one of these use cases. +// +class VIEWS_EXPORT NativeWidgetPrivate : public NativeWidget, + public internal::InputMethodDelegate { + public: + virtual ~NativeWidgetPrivate() {} + + // Creates an appropriate default NativeWidgetPrivate implementation for the + // current OS/circumstance. + static NativeWidgetPrivate* CreateNativeWidget( + internal::NativeWidgetDelegate* delegate); + + static NativeWidgetPrivate* GetNativeWidgetForNativeView( + gfx::NativeView native_view); + static NativeWidgetPrivate* GetNativeWidgetForNativeWindow( + gfx::NativeWindow native_window); + + // Retrieves the top NativeWidgetPrivate in the hierarchy containing the given + // NativeView, or NULL if there is no NativeWidgetPrivate that contains it. + static NativeWidgetPrivate* GetTopLevelNativeWidget( + gfx::NativeView native_view); + + static void GetAllChildWidgets(gfx::NativeView native_view, + Widget::Widgets* children); + static void ReparentNativeView(gfx::NativeView native_view, + gfx::NativeView new_parent); + + // Returns true if any mouse button is currently down. + static bool IsMouseButtonDown(); + + // Initializes the NativeWidget. + virtual void InitNativeWidget(const Widget::InitParams& params) = 0; + + // Returns a NonClientFrameView for the widget's NonClientView, or NULL if + // the NativeWidget wants no special NonClientFrameView. + virtual NonClientFrameView* CreateNonClientFrameView() = 0; + + virtual void UpdateFrameAfterFrameChange() = 0; + virtual bool ShouldUseNativeFrame() const = 0; + virtual void FrameTypeChanged() = 0; + + // Returns the Widget associated with this NativeWidget. This function is + // guaranteed to return non-NULL for the lifetime of the NativeWidget. + virtual Widget* GetWidget() = 0; + virtual const Widget* GetWidget() const = 0; + + // Returns the NativeView/Window associated with this NativeWidget. + virtual gfx::NativeView GetNativeView() const = 0; + virtual gfx::NativeWindow GetNativeWindow() const = 0; + + // Returns the topmost Widget in a hierarchy. + virtual Widget* GetTopLevelWidget() = 0; + + // Returns the Compositor, or NULL if there isn't one associated with this + // NativeWidget. + virtual const ui::Compositor* GetCompositor() const = 0; + virtual ui::Compositor* GetCompositor() = 0; + + // See description in View for details. + virtual void CalculateOffsetToAncestorWithLayer(gfx::Point* offset, + ui::Layer** layer_parent) = 0; + virtual void ReorderLayers() = 0; + + // Notifies the NativeWidget that a view was removed from the Widget's view + // hierarchy. + virtual void ViewRemoved(View* view) = 0; + + // 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. + virtual void SetNativeWindowProperty(const char* name, void* value) = 0; + virtual void* GetNativeWindowProperty(const char* name) const = 0; + + // Returns the native widget's tooltip manager. Called from the View hierarchy + // to update tooltips. + virtual TooltipManager* GetTooltipManager() const = 0; + + // Returns true if a system screen reader is active for the NativeWidget. + virtual bool IsScreenReaderActive() const = 0; + + // Notify native Accessibility clients of an event. + virtual void SendNativeAccessibilityEvent( + View* view, + ui::AccessibilityTypes::Event event_type) = 0; + + // Sets or releases event capturing for this native widget. + virtual void SetMouseCapture() = 0; + virtual void ReleaseMouseCapture() = 0; + + // Returns true if this native widget is capturing mouse events. + virtual bool HasMouseCapture() const = 0; + + // Returns the InputMethod for this native widget. + // Note that all widgets in a widget hierarchy share the same input method. + // TODO(suzhe): rename to GetInputMethod() when NativeWidget implementation + // class doesn't inherit Widget anymore. + virtual InputMethod* CreateInputMethod() = 0; + + + // Centers the window and sizes it to the specified size. + virtual void CenterWindow(const gfx::Size& size) = 0; + + // Retrieves the window's current restored bounds and "show" state, for + // persisting. + virtual void GetWindowPlacement( + gfx::Rect* bounds, + ui::WindowShowState* show_state) const = 0; + + // Sets the NativeWindow title. + virtual void SetWindowTitle(const string16& title) = 0; + + // Sets the Window icons. |window_icon| is a 16x16 icon suitable for use in + // a title bar. |app_icon| is a larger size for use in the host environment + // app switching UI. + virtual void SetWindowIcons(const SkBitmap& window_icon, + const SkBitmap& app_icon) = 0; + + // Update native accessibility properties on the native window. + virtual void SetAccessibleName(const string16& name) = 0; + virtual void SetAccessibleRole(ui::AccessibilityTypes::Role role) = 0; + virtual void SetAccessibleState(ui::AccessibilityTypes::State state) = 0; + + // Makes the NativeWindow modal. + virtual void BecomeModal() = 0; + + // See method documentation in Widget. + virtual gfx::Rect GetWindowScreenBounds() const = 0; + virtual gfx::Rect GetClientAreaScreenBounds() const = 0; + virtual gfx::Rect GetRestoredBounds() const = 0; + virtual void SetBounds(const gfx::Rect& bounds) = 0; + virtual void SetSize(const gfx::Size& size) = 0; + virtual void MoveAbove(gfx::NativeView native_view) = 0; + virtual void MoveToTop() = 0; + virtual void SetShape(gfx::NativeRegion shape) = 0; + virtual void Close() = 0; + virtual void CloseNow() = 0; + virtual void EnableClose(bool enable) = 0; + virtual void Show() = 0; + virtual void Hide() = 0; + // Invoked if the initial show should maximize the window. |restored_bounds| + // is the bounds of the window when not maximized. + virtual void ShowMaximizedWithBounds(const gfx::Rect& restored_bounds) = 0; + virtual void ShowWithWindowState(ui::WindowShowState show_state) = 0; + virtual bool IsVisible() const = 0; + virtual void Activate() = 0; + virtual void Deactivate() = 0; + virtual bool IsActive() const = 0; + virtual void SetAlwaysOnTop(bool always_on_top) = 0; + virtual void Maximize() = 0; + virtual void Minimize() = 0; + virtual bool IsMaximized() const = 0; + virtual bool IsMinimized() const = 0; + virtual void Restore() = 0; + virtual void SetFullscreen(bool fullscreen) = 0; + virtual bool IsFullscreen() const = 0; + virtual void SetOpacity(unsigned char opacity) = 0; + virtual void SetUseDragFrame(bool use_drag_frame) = 0; + virtual bool IsAccessibleWidget() const = 0; + virtual void RunShellDrag(View* view, + const ui::OSExchangeData& data, + int operation) = 0; + virtual void SchedulePaintInRect(const gfx::Rect& rect) = 0; + virtual void SetCursor(gfx::NativeCursor cursor) = 0; + virtual void ClearNativeFocus() = 0; + virtual void FocusNativeView(gfx::NativeView native_view) = 0; + virtual bool ConvertPointFromAncestor( + const Widget* ancestor, gfx::Point* point) const = 0; + virtual gfx::Rect GetWorkAreaBoundsInScreen() const = 0; + virtual void SetInactiveRenderingDisabled(bool value) = 0; + + // Overridden from NativeWidget: + virtual internal::NativeWidgetPrivate* AsNativeWidgetPrivate() OVERRIDE; +}; + +} // namespace internal +} // namespace views + +#endif // UI_VIEWS_WIDGET_NATIVE_WIDGET_PRIVATE_H_ |