NDEVR
API Documentation
ManualManager.h
1#pragma once
2#include "DLLInfo.h"
3#include <NDEVR/SoftwareService.h>
4#include <NDEVR/TranslatedString.h>
5namespace NDEVR
6{
27
30 class NDEVR_API ManualManager : public SoftwareServiceManager
31 {
32 public:
37 void addManual(const Manual& manual);
42 const Buffer<Manual>& manuals() const;
43 public:
49 protected:
51 };
52}
The equivelent of std::vector but with a bit more control.
Definition Buffer.hpp:58
Manages all available manuals in the software.
void addManual(const Manual &manual)
Registers a manual entry with this manager.
const Buffer< Manual > & manuals() const
Returns a read-only reference to all registered manuals.
Buffer< Manual > m_manuals
The collection of registered manuals.
static ManualManager & DefaultManager()
Returns the singleton default ManualManager instance.
Software Service Managers take a Software service to modify the behavior of the software.
Base interface for services that extend or modify software behavior through modules.
The core String View class for the NDEVR API.
Definition StringView.h:58
The core String class for the NDEVR API.
Definition String.h:95
Any text displayed to the user should be defined as a TranslatedString which allows the program to lo...
The primary namespace for the NDEVR SDK.
STL namespace.
Contains information for adding a manual to the software, usually shown in the "About" page.
TranslatedString title
The display title of the manual.
String resource_location
The file or resource path where the manual content is located.
Manual(TranslatedString title, StringView icon, StringView resource_location)
Constructs a Manual with the given title, icon, and resource location.
String icon
The icon name or resource path for the manual entry.