| // Copyright 2015 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 COMPONENTS_EXO_SHELL_SURFACE_BASE_H_ |
| #define COMPONENTS_EXO_SHELL_SURFACE_BASE_H_ |
| |
| #include <cstdint> |
| #include <memory> |
| #include <string> |
| |
| #include "ash/display/window_tree_host_manager.h" |
| #include "ash/public/interfaces/window_state_type.mojom.h" |
| #include "base/containers/circular_deque.h" |
| #include "base/macros.h" |
| #include "base/optional.h" |
| #include "base/strings/string16.h" |
| #include "components/exo/surface_observer.h" |
| #include "components/exo/surface_tree_host.h" |
| #include "ui/aura/window_observer.h" |
| #include "ui/base/hit_test.h" |
| #include "ui/compositor/compositor_lock.h" |
| #include "ui/display/display_observer.h" |
| #include "ui/gfx/geometry/point.h" |
| #include "ui/gfx/geometry/rect.h" |
| #include "ui/gfx/geometry/vector2d.h" |
| #include "ui/views/widget/widget_delegate.h" |
| #include "ui/wm/public/activation_change_observer.h" |
| |
| namespace ash { |
| class WindowResizer; |
| namespace wm { |
| class WindowState; |
| } |
| } |
| |
| namespace base { |
| namespace trace_event { |
| class TracedValue; |
| } |
| } // namespace base |
| |
| namespace ui { |
| class CompositorLock; |
| } // namespace ui |
| |
| namespace exo { |
| class Surface; |
| |
| // This class provides functions for treating a surfaces like toplevel, |
| // fullscreen or popup widgets, move, resize or maximize them, associate |
| // metadata like title and class, etc. |
| class ShellSurfaceBase : public SurfaceTreeHost, |
| public SurfaceObserver, |
| public aura::WindowObserver, |
| public views::WidgetDelegate, |
| public views::View, |
| public wm::ActivationChangeObserver { |
| public: |
| // The |origin| is the initial position in screen coordinates. The position |
| // specified as part of the geometry is relative to the shell surface. |
| ShellSurfaceBase(Surface* surface, |
| const gfx::Point& origin, |
| bool activatable, |
| bool can_minimize, |
| int container); |
| ~ShellSurfaceBase() override; |
| |
| // Set the callback to run when the user wants the shell surface to be closed. |
| // The receiver can chose to not close the window on this signal. |
| void set_close_callback(const base::RepeatingClosure& close_callback) { |
| close_callback_ = close_callback; |
| } |
| |
| // Set the callback to run when the surface is destroyed. |
| void set_surface_destroyed_callback( |
| base::OnceClosure surface_destroyed_callback) { |
| surface_destroyed_callback_ = std::move(surface_destroyed_callback); |
| } |
| |
| // Set the callback to run when the client is asked to configure the surface. |
| // The size is a hint, in the sense that the client is free to ignore it if |
| // it doesn't resize, pick a smaller size (to satisfy aspect ratio or resize |
| // in steps of NxM pixels). |
| using ConfigureCallback = |
| base::RepeatingCallback<uint32_t(const gfx::Size& size, |
| ash::mojom::WindowStateType state_type, |
| bool resizing, |
| bool activated, |
| const gfx::Vector2d& origin_offset)>; |
| void set_configure_callback(const ConfigureCallback& configure_callback) { |
| configure_callback_ = configure_callback; |
| } |
| |
| // When the client is asked to configure the surface, it should acknowledge |
| // the configure request sometime before the commit. |serial| is the serial |
| // from the configure callback. |
| void AcknowledgeConfigure(uint32_t serial); |
| |
| // Activates the shell surface. |
| void Activate(); |
| |
| // Set title for the surface. |
| void SetTitle(const base::string16& title); |
| |
| // Set icon for the surface. |
| void SetIcon(const gfx::ImageSkia& icon); |
| |
| // Sets the system modality. |
| void SetSystemModal(bool system_modal); |
| |
| // Start an interactive move of surface. |
| // TODO(oshima): Move this to ShellSurface. |
| void Move(); |
| |
| // Sets the application ID for the window. The application ID identifies the |
| // general class of applications to which the window belongs. |
| static void SetApplicationId(aura::Window* window, const std::string& id); |
| static const std::string* GetApplicationId(aura::Window* window); |
| |
| // Set the application ID for the surface. |
| void SetApplicationId(const std::string& application_id); |
| |
| // Signal a request to close the window. It is up to the implementation to |
| // actually decide to do so though. |
| void Close(); |
| |
| // Set geometry for surface. The geometry represents the "visible bounds" |
| // for the surface from the user's perspective. |
| void SetGeometry(const gfx::Rect& geometry); |
| |
| // Set origin in screen coordinate space. |
| void SetOrigin(const gfx::Point& origin); |
| |
| // Set activatable state for surface. |
| void SetActivatable(bool activatable); |
| |
| // Set container for surface. |
| void SetContainer(int container); |
| |
| // Set the maximum size for the surface. |
| void SetMaximumSize(const gfx::Size& size); |
| |
| // Set the miniumum size for the surface. |
| void SetMinimumSize(const gfx::Size& size); |
| |
| void SetCanMinimize(bool can_minimize); |
| |
| // Prevents shell surface from being moved. |
| void DisableMovement(); |
| |
| // Sets the main surface for the window. |
| static void SetMainSurface(aura::Window* window, Surface* surface); |
| |
| // Returns the main Surface instance or nullptr if it is not set. |
| // |window| must not be nullptr. |
| static Surface* GetMainSurface(const aura::Window* window); |
| |
| // Returns a trace value representing the state of the surface. |
| std::unique_ptr<base::trace_event::TracedValue> AsTracedValue() const; |
| |
| // Overridden from SurfaceDelegate: |
| void OnSurfaceCommit() override; |
| bool IsInputEnabled(Surface* surface) const override; |
| void OnSetFrame(SurfaceFrameType type) override; |
| void OnSetFrameColors(SkColor active_color, SkColor inactive_color) override; |
| void OnSetParent(Surface* parent, const gfx::Point& position) override; |
| |
| // Overridden from SurfaceObserver: |
| void OnSurfaceDestroying(Surface* surface) override; |
| |
| // Overridden from views::WidgetDelegate: |
| bool CanResize() const override; |
| bool CanMaximize() const override; |
| bool CanMinimize() const override; |
| base::string16 GetWindowTitle() const override; |
| gfx::ImageSkia GetWindowIcon() override; |
| void WindowClosing() override; |
| views::Widget* GetWidget() override; |
| const views::Widget* GetWidget() const override; |
| views::View* GetContentsView() override; |
| views::NonClientFrameView* CreateNonClientFrameView( |
| views::Widget* widget) override; |
| bool WidgetHasHitTestMask() const override; |
| void GetWidgetHitTestMask(gfx::Path* mask) const override; |
| |
| // Overridden from views::View: |
| gfx::Size CalculatePreferredSize() const override; |
| gfx::Size GetMinimumSize() const override; |
| gfx::Size GetMaximumSize() const override; |
| |
| // Overridden from aura::WindowObserver: |
| void OnWindowBoundsChanged(aura::Window* window, |
| const gfx::Rect& old_bounds, |
| const gfx::Rect& new_bounds, |
| ui::PropertyChangeReason reason) override; |
| void OnWindowDestroying(aura::Window* window) override; |
| |
| // Overridden from wm::ActivationChangeObserver: |
| void OnWindowActivated(ActivationReason reason, |
| aura::Window* gained_active, |
| aura::Window* lost_active) override; |
| |
| // Overridden from ui::EventHandler: |
| void OnKeyEvent(ui::KeyEvent* event) override; |
| void OnMouseEvent(ui::MouseEvent* event) override; |
| void OnGestureEvent(ui::GestureEvent* event) override; |
| |
| // Overridden from ui::AcceleratorTarget: |
| bool AcceleratorPressed(const ui::Accelerator& accelerator) override; |
| |
| Surface* surface_for_testing() { return root_surface(); } |
| |
| protected: |
| // Helper class used to coalesce a number of changes into one "configure" |
| // callback. Callbacks are suppressed while an instance of this class is |
| // instantiated and instead called when the instance is destroyed. |
| // If |force_configure_| is true ShellSurfaceBase::Configure() will be called |
| // even if no changes to shell surface took place during the lifetime of the |
| // ScopedConfigure instance. |
| class ScopedConfigure { |
| public: |
| ScopedConfigure(ShellSurfaceBase* shell_surface, bool force_configure); |
| ~ScopedConfigure(); |
| |
| void set_needs_configure() { needs_configure_ = true; } |
| |
| private: |
| ShellSurfaceBase* const shell_surface_; |
| const bool force_configure_; |
| bool needs_configure_ = false; |
| |
| DISALLOW_COPY_AND_ASSIGN(ScopedConfigure); |
| }; |
| |
| // Creates the |widget_| for |surface_|. |show_state| is the initial state |
| // of the widget (e.g. maximized). |
| void CreateShellSurfaceWidget(ui::WindowShowState show_state); |
| |
| // Asks the client to configure its surface. |
| void Configure(); |
| |
| // Returns true if surface is currently being resized. |
| bool IsResizing() const; |
| |
| // Updates the bounds of widget to match the current surface bounds. |
| void UpdateWidgetBounds(); |
| |
| // Called by UpdateWidgetBounds to set widget bounds. |
| virtual void SetWidgetBounds(const gfx::Rect& bounds); |
| |
| // Updates the bounds of surface to match the current widget bounds. |
| void UpdateSurfaceBounds(); |
| |
| // Creates, deletes and update the shadow bounds based on |
| // |shadow_bounds_|. |
| void UpdateShadow(); |
| |
| // Applies |system_modal_| to |widget_|. |
| void UpdateSystemModal(); |
| |
| // Returns the "visible bounds" for the surface from the user's perspective. |
| gfx::Rect GetVisibleBounds() const; |
| |
| // In the coordinate system of the parent root window. |
| gfx::Point GetMouseLocation() const; |
| |
| // In the local coordinate system of the window. |
| virtual gfx::Rect GetShadowBounds() const; |
| |
| // Attempt to start a drag operation. The type of drag operation to start is |
| // determined by |component|. |
| // TODO(oshima): Move this to ShellSurface. |
| void AttemptToStartDrag(int component); |
| |
| // Set the parent window of this surface. |
| void SetParentWindow(aura::Window* parent); |
| |
| views::Widget* widget_ = nullptr; |
| aura::Window* parent_ = nullptr; |
| bool movement_disabled_ = false; |
| gfx::Point origin_; |
| |
| // Container Window Id (see ash/public/cpp/shell_window_ids.h) |
| int container_; |
| bool ignore_window_bounds_changes_ = false; |
| gfx::Vector2d origin_offset_; |
| gfx::Vector2d pending_origin_offset_; |
| gfx::Vector2d pending_origin_offset_accumulator_; |
| int resize_component_ = HTCAPTION; // HT constant (see ui/base/hit_test.h) |
| int pending_resize_component_ = HTCAPTION; |
| base::Optional<gfx::Rect> shadow_bounds_; |
| bool shadow_bounds_changed_ = false; |
| std::unique_ptr<ash::WindowResizer> resizer_; |
| base::string16 title_; |
| std::unique_ptr<ui::CompositorLock> configure_compositor_lock_; |
| ConfigureCallback configure_callback_; |
| // TODO(oshima): Remove this once the transition to new drag/resize |
| // complete. https://crbug.com/801666. |
| bool client_controlled_move_resize_ = true; |
| |
| private: |
| struct Config; |
| |
| // Called on widget creation to initialize its window state. |
| // TODO(reveman): Remove virtual functions below to avoid FBC problem. |
| virtual void InitializeWindowState(ash::wm::WindowState* window_state) = 0; |
| |
| // Returns the scale of the surface tree relative to the shell surface. |
| virtual float GetScale() const; |
| |
| // Returns the window that has capture during dragging. |
| virtual aura::Window* GetDragWindow(); |
| |
| // Creates the resizer for a dragging/resizing operation. |
| virtual std::unique_ptr<ash::WindowResizer> CreateWindowResizer( |
| aura::Window* window, |
| int component); |
| |
| // Overridden from ui::EventHandler: |
| bool OnMouseDragged(const ui::MouseEvent& event) override; |
| |
| // End current drag operation. |
| void EndDrag(bool revert); |
| |
| // Return the origin of the widget/surface taking visible bounds and current |
| // resize direction into account. |
| virtual gfx::Point GetWidgetOrigin() const; |
| virtual gfx::Point GetSurfaceOrigin() const; |
| |
| bool activatable_ = true; |
| bool can_minimize_ = true; |
| bool frame_enabled_ = false; |
| bool has_frame_colors_ = false; |
| SkColor active_frame_color_ = SK_ColorBLACK; |
| SkColor inactive_frame_color_ = SK_ColorBLACK; |
| bool pending_show_widget_ = false; |
| std::string application_id_; |
| gfx::Rect geometry_; |
| gfx::Rect pending_geometry_; |
| base::RepeatingClosure close_callback_; |
| base::OnceClosure surface_destroyed_callback_; |
| ScopedConfigure* scoped_configure_ = nullptr; |
| base::circular_deque<std::unique_ptr<Config>> pending_configs_; |
| bool system_modal_ = false; |
| bool non_system_modal_window_was_active_ = false; |
| gfx::ImageSkia icon_; |
| gfx::Size minimum_size_; |
| gfx::Size pending_minimum_size_; |
| gfx::Size maximum_size_; |
| gfx::Size pending_maximum_size_; |
| |
| DISALLOW_COPY_AND_ASSIGN(ShellSurfaceBase); |
| }; |
| |
| } // namespace exo |
| |
| #endif // COMPONENTS_EXO_SHELL_SURFACE_BASE_H_ |