ManualManager.h

Go to the documentation of this file.

#pragma once
#include "DLLInfo.h"
#include <NDEVR/SoftwareService.h>
#include <NDEVR/TranslatedString.h>
namespace NDEVR
{
    /**--------------------------------------------------------------------------------------------------
    \brief Contains information for adding a manual to the software, usually shown in the "About" page.
    **/
    struct Manual : public SoftwareService
    {
        String icon;
        TranslatedString title;
        String resource_location;
        Manual(TranslatedString title, String icon, String resource_location)
            : icon(std::move(icon))
            , title(std::move(title))
            , resource_location(std::move(resource_location))
        {}
    };
    /**--------------------------------------------------------------------------------------------------
    \brief Manages all available manuals in the software.
    **/
    class NDEVR_API ManualManager : public SoftwareServiceManager
    {
    public:
        void addManual(const Manual& manual);
        const Buffer<Manual>& manuals() const;
        
    public:
        static ManualManager& DefaultManager();
    protected:
        Buffer<Manual> m_manuals;
    };
}