i_app.hpp

Go to the documentation of this file.

// i_app.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 <boost/program_options.hpp>
#include <neolib/app/i_application.hpp>
#include <neogfx/core/event.hpp>
#include <neogfx/gfx/i_rendering_engine.hpp>
#include <neogfx/gfx/i_texture.hpp>
#include <neogfx/app/i_event_processing_context.hpp>
#include <neogfx/app/i_action.hpp>
#include <neogfx/app/i_style.hpp>
#include <neogfx/app/i18n.hpp>
 
namespace neogfx
{
    class i_widget;
    class i_mnemonic;
    class i_image;
    class i_menu;
 
    class i_help;
 
    class event_processing_context;
 
    enum standard_menu
    {
        File,
        Edit
    };
 
    class i_program_options
    {
    public:
        struct invalid_options : std::runtime_error { invalid_options(std::string const& aReason) : std::runtime_error("Invalid program options: " + aReason) {} };
    public:
        virtual ~i_program_options() = default;
    public:
        virtual const boost::program_options::variables_map& options() const = 0;
    public:
        virtual bool console() const = 0;
        virtual neogfx::renderer renderer() const = 0;
        virtual std::optional<size_u32> full_screen() const = 0;
        virtual std::optional<size_u32> dpi_override() const = 0;
        virtual bool turbo() const = 0;
        virtual bool nest() const = 0;
    };
 
    class i_app : public i_property_owner, public neolib::i_application, public i_action_container, public i_service
    {
    public:
        declare_event(execution_started)
        declare_event(name_changed)
        declare_event(current_style_changed, style_aspect)
    public:
        struct main_window_closed_prematurely : std::runtime_error { main_window_closed_prematurely() : std::runtime_error("Main window closed prematurely!") {} };
        struct unknown_standard_menu : std::logic_error { unknown_standard_menu() : std::logic_error("neogfx::i_app::unknown_standard_menu") {} };
    public:
        virtual const i_program_options& program_options() const = 0;
        virtual std::string const& name() const = 0;
        virtual void set_name(std::string const& aName) = 0;
        virtual int exec(bool aQuitWhenLastWindowClosed = true) = 0;
        virtual bool in_exec() const = 0;
        virtual void quit(int aResultCode) = 0;
    public:
        virtual dimension x2_dpi_scale_factor() const = 0;
        virtual dimension xn_dpi_scale_factor() const = 0;
    public:
        virtual const i_texture& default_window_icon() const = 0;
        virtual void set_default_window_icon(const i_texture& aIcon) = 0;
        virtual void set_default_window_icon(const i_image& aIcon) = 0;
        virtual const i_style& current_style() const = 0;
        virtual i_style& current_style() = 0;
        virtual i_style& change_style(std::string const& aStyleName) = 0;
        virtual i_style& register_style(const i_style& aStyle) = 0;
    public:
        virtual i_string const& translate(i_string const& aTranslatableString, i_string const& aContext = string{}, std::int64_t aPlurality = 1) const = 0;
    public:
        virtual i_action& action_file_new() = 0;
        virtual i_action& action_file_open() = 0;
        virtual i_action& action_file_close() = 0;
        virtual i_action& action_file_close_all() = 0;
        virtual i_action& action_file_save() = 0;
        virtual i_action& action_file_save_all() = 0;
        virtual i_action& action_file_exit() = 0;
        virtual i_action& action_undo() = 0;
        virtual i_action& action_redo() = 0;
        virtual i_action& action_cut() = 0;
        virtual i_action& action_copy() = 0;
        virtual i_action& action_paste() = 0;
        virtual i_action& action_delete() = 0;
        virtual i_action& action_select_all() = 0;
        using i_action_container::add_action;
        virtual i_action& add_action(i_string const& aText) = 0;
        virtual i_action& add_action(i_string const& aText, i_string const& aImageUri, dimension aDpiScaleFactor = 1.0, texture_sampling aSampling = texture_sampling::Normal) = 0;
        virtual i_action& add_action(i_string const& aText, const i_texture& aImage) = 0;
        virtual i_action& add_action(i_string const& aText, const i_image& aImage) = 0;
        virtual void remove_action(i_action& aAction) = 0;
        virtual i_action& find_action(i_string const& aText) = 0;
        virtual void add_mnemonic(i_mnemonic& aMnemonic) = 0;
        virtual void remove_mnemonic(i_mnemonic& aMnemonic) = 0;
    public:
        virtual i_menu& add_standard_menu(i_menu& aParentMenu, standard_menu aStandardMenu) = 0;
    public:
        virtual i_help& help() const = 0;
    public:
        virtual bool process_events() = 0;
        virtual bool process_events(i_event_processing_context& aContext) = 0;
        virtual i_event_processing_context& event_processing_context() = 0;
    public:
        static uuid const& iid() { static uuid const sIid{ 0xa8bd88d7, 0xbd19, 0x4501, 0xb199, { 0x84, 0x84, 0x55, 0xfc, 0x80, 0x45 } }; return sIid; }
    };
}