i_native_window.hpp

Go to the documentation of this file.

// i_native_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/core/event.hpp>
#include <neogfx/core/i_property.hpp>
#include <neogfx/core/geometrical.hpp>
#include <neogfx/hid/i_native_surface.hpp>
#include <neogfx/gui/window/window_events.hpp>
 
namespace neogfx
{
    class i_surface_window;
 
    class i_native_window : public i_property_owner, public i_reference_counted
    {
    public:
        typedef neolib::variant<window_event, mouse_event, non_client_mouse_event, keyboard_event> native_event;
    public:
        declare_event(filter, native_event&)
        declare_event(added_to_nest)
    public:
        struct window_not_attached_to_surface : std::logic_error { window_not_attached_to_surface() : std::logic_error("neogfx::i_native_window::window_not_attached_to_surface") {} };
        struct no_current_event : std::logic_error { no_current_event() : std::logic_error("neogfx::i_native_window::no_current_event") {} };
        struct no_parent : std::logic_error { no_parent() : std::logic_error("neogfx::i_native_window::no_parent") {} };
    public:
        typedef i_native_window abstract_type;
    public:
        virtual ~i_native_window() = default;
    public:
        virtual bool has_parent() const = 0;
        virtual const i_native_window& parent() const = 0;
        virtual i_native_window& parent() = 0;
        virtual bool is_nested() const = 0;
    public:
        virtual i_surface_window& surface_window() const = 0;
    public:
        virtual void* target_handle() const = 0;
        virtual void* target_device_handle() const = 0;
        virtual bool attached() const = 0;
        virtual i_native_surface& attachment() const = 0;
        virtual void attach(i_native_surface& aSurface) = 0;
        virtual void detach() = 0;
    public:
        virtual size& pixel_density() const = 0;
        virtual void handle_dpi_changed() = 0;
    public:
        virtual bool initialising() const = 0;
        virtual void initialisation_complete() = 0;
        virtual void* handle() const = 0;
        virtual void* native_handle() const = 0;
        virtual point surface_position() const = 0;
        virtual void move_surface(const point& aPosition) = 0;
        virtual size surface_extents() const = 0;
        virtual void resize_surface(const size& aExtents) = 0;
    public:
        virtual void display_error_message(std::string const& aTitle, std::string const& aMessage) const = 0;
        virtual bool events_queued() const = 0;
        virtual void push_event(const native_event& aEvent) = 0;
        virtual bool pump_event() = 0;
        virtual void handle_event(const native_event& aNativeEvent) = 0;
        virtual bool has_current_event() const = 0;
        virtual const native_event& current_event() const = 0;
        virtual native_event& current_event() = 0;
        virtual void handle_event() = 0;
        virtual bool processing_event() const = 0;
        virtual void close(bool aForce = false) = 0;
        virtual bool placement_changed_explicitly() const = 0;
        virtual void set_placement_changed_explicitly() = 0;
        virtual bool visible() const = 0;
        virtual void show(bool aActivate = false) = 0;
        virtual void hide() = 0;
        virtual double opacity() const = 0;
        virtual void set_opacity(double aOpacity) = 0;
        virtual double transparency() const = 0;
        virtual void set_transparency(double aTransparency) = 0;
        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 bool enabled() const = 0;
        virtual void enable(bool aEnable) = 0;
        virtual bool is_capturing() const = 0;
        virtual void set_capture() = 0;
        virtual void release_capture() = 0;
        virtual void non_client_set_capture() = 0;
        virtual void non_client_release_capture() = 0;
        virtual i_string const& title_text() const = 0;
        virtual void set_title_text(i_string const& aTitleText) = 0;
        virtual border border_thickness() const = 0;
    public:
        virtual bool can_render() const = 0;
        virtual void render(bool aOOBRequest = false) = 0;
        virtual void display() = 0;
    };
}