/* * Copyright (c) 2018-2020, Andreas Kling * All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: * * 1. Redistributions of source code must retain the above copyright notice, this * list of conditions and the following disclaimer. * * 2. Redistributions in binary form must reproduce the above copyright notice, * this list of conditions and the following disclaimer in the documentation * and/or other materials provided with the distribution. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #pragma once #include #include #include #include #include #include #include #include #include #include namespace GUI { enum class StandardCursor { None = 0, Arrow, IBeam, ResizeHorizontal, ResizeVertical, ResizeDiagonalTLBR, ResizeDiagonalBLTR, ResizeColumn, ResizeRow, Hand, Help, Drag, Move, Wait, }; class Window : public Core::Object { C_OBJECT(Window) public: virtual ~Window() override; static Window* from_window_id(int); bool is_modal() const { return m_modal; } void set_modal(bool); bool is_fullscreen() const { return m_fullscreen; } void set_fullscreen(bool); bool is_maximized() const; bool is_frameless() const { return m_frameless; } void set_frameless(bool frameless) { m_frameless = frameless; } bool is_resizable() const { return m_resizable; } void set_resizable(bool resizable) { m_resizable = resizable; } bool is_minimizable() const { return m_minimizable; } void set_minimizable(bool minimizable) { m_minimizable = minimizable; } void set_double_buffering_enabled(bool); void set_has_alpha_channel(bool); void set_opacity(float); WindowType window_type() const { return m_window_type; } void set_window_type(WindowType); int window_id() const { return m_window_id; } String title() const; void set_title(const StringView&); Color background_color() const { return m_background_color; } void set_background_color(Color color) { m_background_color = color; } enum class CloseRequestDecision { StayOpen, Close, }; Function on_close_request; Function on_active_input_change; Function on_activity_change; int x() const { return rect().x(); } int y() const { return rect().y(); } int width() const { return rect().width(); } int height() const { return rect().height(); } Gfx::IntRect rect() const; Gfx::IntRect rect_in_menubar() const; Gfx::IntSize size() const { return rect().size(); } void set_rect(const Gfx::IntRect&); void set_rect(int x, int y, int width, int height) { set_rect({ x, y, width, height }); } Gfx::IntPoint position() const { return rect().location(); } void move_to(int x, int y) { move_to({ x, y }); } void move_to(const Gfx::IntPoint& point) { set_rect({ point, size() }); } void resize(int width, int height) { resize({ width, height }); } void resize(const Gfx::IntSize& size) { set_rect({ position(), size }); } void center_on_screen(); virtual void event(Core::Event&) override; bool is_visible() const; bool is_active() const { return m_is_active; } bool is_active_input() const { return m_is_active_input; } bool is_accessory() const { return m_accessory; } void set_accessory(bool accessory) { m_accessory = accessory; } void show(); void hide(); virtual void close(); void move_to_front(); void start_wm_resize(); Widget* main_widget() { return m_main_widget; } const Widget* main_widget() const { return m_main_widget; } void set_main_widget(Widget*); template inline T& set_main_widget(Args&&... args) { auto widget = T::construct(forward(args)...); set_main_widget(widget.ptr()); return *widget; } Widget* focused_widget() { return m_focused_widget; } const Widget* focused_widget() const { return m_focused_widget; } void set_focused_widget(Widget*, FocusSource = FocusSource::Programmatic); void update(); void update(const Gfx::IntRect&); void set_global_cursor_tracking_widget(Widget*); Widget* global_cursor_tracking_widget() { return m_global_cursor_tracking_widget.ptr(); } const Widget* global_cursor_tracking_widget() const { return m_global_cursor_tracking_widget.ptr(); } void set_automatic_cursor_tracking_widget(Widget*); Widget* automatic_cursor_tracking_widget() { return m_automatic_cursor_tracking_widget.ptr(); } const Widget* automatic_cursor_tracking_widget() const { return m_automatic_cursor_tracking_widget.ptr(); } Widget* hovered_widget() { return m_hovered_widget.ptr(); } const Widget* hovered_widget() const { return m_hovered_widget.ptr(); } void set_hovered_widget(Widget*); Gfx::Bitmap* front_bitmap() { return m_front_bitmap.ptr(); } Gfx::Bitmap* back_bitmap() { return m_back_bitmap.ptr(); } Gfx::IntSize size_increment() const { return m_size_increment; } void set_size_increment(const Gfx::IntSize&); Gfx::IntSize base_size() const { return m_base_size; } void set_base_size(const Gfx::IntSize&); const Optional& resize_aspect_ratio() const { return m_resize_aspect_ratio; } void set_resize_aspect_ratio(int width, int height) { set_resize_aspect_ratio(Gfx::IntSize(width, height)); } void set_no_resize_aspect_ratio() { set_resize_aspect_ratio({}); } void set_resize_aspect_ratio(const Optional& ratio); void set_override_cursor(StandardCursor); void set_override_cursor(const Gfx::Bitmap&); void set_icon(const Gfx::Bitmap*); void apply_icon(); const Gfx::Bitmap* icon() const { return m_icon.ptr(); } Vector focusable_widgets() const; virtual void save_to(AK::JsonObject&) override; void schedule_relayout(); static void for_each_window(Badge, Function); static void update_all_windows(Badge); void notify_state_changed(Badge, bool minimized, bool occluded); virtual bool is_visible_for_timer_purposes() const override { return m_visible_for_timer_purposes; } Action* action_for_key_event(const KeyEvent&); void did_add_widget(Badge, Widget&); void did_remove_widget(Badge, Widget&); Window* find_parent_window(); void set_progress(int); protected: Window(Core::Object* parent = nullptr); virtual void wm_event(WMEvent&); private: virtual bool is_window() const override final { return true; } void handle_drop_event(DropEvent&); void handle_mouse_event(MouseEvent&); void handle_multi_paint_event(MultiPaintEvent&); void handle_key_event(KeyEvent&); void handle_resize_event(ResizeEvent&); void handle_input_entered_or_left_event(Core::Event&); void handle_became_active_or_inactive_event(Core::Event&); void handle_close_request(); void handle_theme_change_event(ThemeChangeEvent&); void handle_drag_move_event(DragEvent&); void handle_left_event(); void server_did_destroy(); RefPtr create_backing_bitmap(const Gfx::IntSize&); RefPtr create_shared_bitmap(Gfx::BitmapFormat, const Gfx::IntSize&); void set_current_backing_bitmap(Gfx::Bitmap&, bool flush_immediately = false); void flip(const Vector& dirty_rects); void force_update(); RefPtr m_front_bitmap; RefPtr m_back_bitmap; RefPtr m_icon; RefPtr m_custom_cursor; int m_window_id { 0 }; float m_opacity_when_windowless { 1.0f }; RefPtr m_main_widget; WeakPtr m_focused_widget; WeakPtr m_global_cursor_tracking_widget; WeakPtr m_automatic_cursor_tracking_widget; WeakPtr m_hovered_widget; Gfx::IntRect m_rect_when_windowless; String m_title_when_windowless; Vector m_pending_paint_event_rects; Gfx::IntSize m_size_increment; Gfx::IntSize m_base_size; Color m_background_color { Color::WarmGray }; WindowType m_window_type { WindowType::Normal }; StandardCursor m_override_cursor { StandardCursor::None }; bool m_is_active { false }; bool m_is_active_input { false }; bool m_has_alpha_channel { false }; bool m_double_buffering_enabled { true }; bool m_modal { false }; bool m_resizable { true }; Optional m_resize_aspect_ratio {}; bool m_minimizable { true }; bool m_fullscreen { false }; bool m_frameless { false }; bool m_layout_pending { false }; bool m_visible_for_timer_purposes { true }; bool m_visible { false }; bool m_accessory { false }; bool m_moved_by_client { false }; }; } AK_BEGIN_TYPE_TRAITS(GUI::Window) static bool is_type(const Core::Object& object) { return object.is_window(); } AK_END_TYPE_TRAITS()