i_window.hpp

Go to the documentation of this file.

// i_window.hpp
/*
  neogfx C++ App/Game Engine
  Copyright (c) 2015, 2020 Leigh Johnston.  All Rights Reserved.
  
  This program is free software: you can redistribute it and / or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.
  
  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.
  
  You should have received a copy of the GNU General Public License
  along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/
 
#pragma once
 
#include <neogfx/neogfx.hpp>
#include <neogfx/hid/i_surface.hpp>
#include <neogfx/hid/i_window_manager.hpp>
#include <neogfx/gfx/i_graphics_context.hpp>
#include <neogfx/gui/window/window_events.hpp>
#include <neogfx/gui/window/window_bits.hpp>
#include <neogfx/gui/layout/i_layout.hpp>
#include <neogfx/gui/widget/widget_bits.hpp>
#include <neogfx/gui/widget/i_widget.hpp>
#include <neogfx/gui/widget/i_dock.hpp>
 
namespace neogfx
{
    class i_native_surface;
    class i_native_window;
    class i_nested_window;
    class i_nest;
    class i_drag_drop_target;
 
    class i_window : public i_widget, public virtual i_standard_layout_container
    {
    public:
        declare_event(window_event, neogfx::window_event&)
        declare_event(dismissing_children, const i_widget*)
        declare_event(activated)
        declare_event(deactivated)
        declare_event(closed)
        declare_event(paint_overlay, i_graphics_context&)
    private:
        friend class window;
        friend class surface_window;
    public:
        enum dismissal_type_e
        {
            CannotDismiss,
            CloseOnDismissal,
            HideOnDismissal
        };
    public:
        struct no_native_surface : std::logic_error { no_native_surface() : std::logic_error("neogfx::i_window::no_native_surface") {} };
        struct no_native_window : std::logic_error { no_native_window() : std::logic_error("neogfx::i_window::no_native_window") {} };
        struct no_parent_window : std::logic_error { no_parent_window() : std::logic_error("neogfx::i_window::no_parent_window") {} };
        struct not_in_nest : std::logic_error { not_in_nest() : std::logic_error("neogfx::i_window::not_in_nest") {} };
        struct not_nested : std::logic_error { not_nested() : std::logic_error("neogfx::i_window::not_nested") {} };
        struct not_a_nest : std::logic_error { not_a_nest() : std::logic_error("neogfx::i_window::not_a_nest") {} };
    public:
        virtual const i_window_manager& window_manager() const = 0;
        virtual i_window_manager& window_manager() = 0;
    public:
        virtual bool is_surface() const = 0;
        virtual bool has_surface() const = 0;
        virtual const i_surface& surface() const = 0;
        virtual i_surface& surface() = 0;
        virtual void set_surface(i_surface_window& aSurfaceWindow) = 0;
        virtual bool has_native_surface() const = 0;
        virtual const i_native_surface& native_surface() const = 0;
        virtual i_native_surface& native_surface() = 0;
        virtual bool has_native_window() const = 0;
        virtual const i_native_window& native_window() const = 0;
        virtual i_native_window& native_window() = 0;
    public:
        virtual bool has_parent_window() const = 0;
        virtual const i_window& parent_window() const = 0;
        virtual i_window& parent_window() = 0;
        virtual bool is_parent_of(const i_window& aChildWindow) const = 0;
        virtual bool is_owner_of(const i_window& aChildWindow) const = 0;
        virtual const i_window& ultimate_ancestor() const = 0;
        virtual i_window& ultimate_ancestor() = 0;
    public:
        virtual bool is_nested() const = 0;
    public:
        virtual bool is_strong() const = 0;
        virtual bool is_weak() const = 0;
    public:
        virtual bool can_close() const = 0;
        virtual bool is_closed() const = 0;
        virtual void close() = 0;
    public:
        virtual void widget_added(i_widget&) = 0;
        virtual void widget_removed(i_widget& aWidget) = 0;
    public:
        virtual window_style style() const = 0;
        virtual void set_style(window_style aStyle) = 0;
    public:
        virtual i_string const& title_text() const = 0;
        virtual void set_title_text(i_string const& aTitleText) = 0;
    public:
        virtual bool is_effectively_active() const = 0;
        virtual bool is_active() const = 0;
        virtual void activate() = 0;
        virtual void deactivate() = 0;
        virtual bool is_iconic() const = 0;
        virtual void iconize() = 0;
        virtual bool is_maximized() const = 0;
        virtual void maximize() = 0;
        virtual bool is_restored() const = 0;
        virtual void restore() = 0;
        virtual bool is_fullscreen() const = 0;
        virtual void enter_fullscreen(const video_mode& aVideoMode) = 0;
        virtual point window_position() const = 0;
        virtual const window_placement& placement() const = 0;
        virtual void set_placement(const window_placement& aPlacement) = 0;
        virtual void center(bool aSetMinimumSize = true) = 0;
        virtual void center_on_parent(bool aSetMinimumSize = true) = 0;
        virtual bool window_enabled() const = 0;
        virtual void counted_window_enable(bool aEnable) = 0;
        virtual void modal_enable(bool aEnable) = 0;
    public:
        virtual bool is_dismissing_children() const = 0;
        virtual bool can_dismiss(const i_widget* aClickedWidget) const = 0;
        virtual dismissal_type_e dismissal_type() const = 0;
        virtual bool dismissed() const = 0;
        virtual void dismiss() = 0;
    public:
        virtual bool ready_to_render() const = 0;
        virtual void set_ready_to_render(bool aReady) = 0;
        virtual double rendering_priority() const = 0;
        virtual double fps() const = 0;
        virtual double potential_fps() const = 0;
    public:
        virtual point mouse_position() const = 0;
    public:
        virtual neogfx::border window_border() const = 0;
        virtual rect widget_part_rect(widget_part_e aWidgetPart) const = 0;
    public:
        virtual const i_widget& client_widget() const = 0;
        virtual i_widget& client_widget() = 0;
    public:
        virtual bool requires_owner_focus() const = 0;
        virtual bool has_entered_widget() const = 0;
        virtual i_widget& entered_widget() const = 0;
    public:
        virtual bool has_focused_widget() const = 0;
        virtual i_widget& focused_widget() const = 0;
        virtual void set_focused_widget(i_widget& aWidget, focus_reason aFocusReason) = 0;
        virtual void release_focused_widget(i_widget& aWidget) = 0;
    protected:
        virtual void update_modality(bool aEnableAncestors) = 0;
        virtual void update_click_focus(i_widget& aCandidateWidget, const point& aClickPos) = 0;
        virtual void dismiss_children(const i_widget* aClickedWidget = nullptr) = 0;
    public:
        virtual const i_widget& as_widget() const = 0;
        virtual i_widget& as_widget() = 0;
    public:
        virtual const i_drag_drop_target& default_drag_drop_target() const = 0;
        virtual i_drag_drop_target& default_drag_drop_target() = 0;
        // helpers
    public:
        const i_surface_window* find_surface() const
        {
            if (is_surface())
                return &surface().as_surface_window();
            else if (has_parent_window())
                return parent_window().find_surface();
            else
                return nullptr;
        }
        i_surface_window* find_surface()
        {
            return const_cast<i_surface_window*>(to_const(*this).find_surface());
        }
        const i_surface_window* find_real_surface() const
        {
            if (is_surface() && !surface().is_nested_window())
                return &surface().as_surface_window();
            else if (has_parent_window())
                return parent_window().find_real_surface();
            else
                return nullptr;
        }
        i_surface_window* find_real_surface()
        {
            return const_cast<i_surface_window*>(to_const(*this).find_real_surface());
        }
        bool is_ancestor_of(const i_window& aWindow) const
        {
            const i_window* w = &aWindow;
            while (w != this && w->has_parent_window())
                w = &w->parent_window();
            return w == this;
        }
        bool is_descendent_of(const i_window& aWindow) const
        {
            return aWindow.is_ancestor_of(*this);
        }
     };
 
    rect corrected_popup_rect(i_window& aPopup, rect aPopupRect);
    rect corrected_popup_rect(i_window& aPopup);
    void correct_popup_rect(i_window& aPopup);
 
    class pause_rendering
    {
    public:
        pause_rendering(i_window& aWindow);
        pause_rendering(pause_rendering&& aOther);
        ~pause_rendering();
    public:
        pause_rendering& operator=(pause_rendering&& aOther);
    private:
        i_surface* iSurface;
        neolib::optional_destroyed_flag iSurfaceDestroyed;
        neolib::optional_destroyed_flag iWindowDestroyed;
    };
}