AbstractHelpManager

// The core and its managers are located in this header
#include "CoreInterface.h"

// Use this global function to access the help manager
mv::help()->...

Qualified name: mv::AbstractHelpManager

class AbstractHelpManager : public mv::AbstractManager

Abstract help manager class.

Base abstract help manager class

Author

Thomas Kroes

Public Functions

inline AbstractHelpManager(QObject *parent)

Construct manager with pointer to parent object.

Parameters:

parent – Pointer to parent object

virtual void addVideo(const util::LearningCenterVideo *video) = 0

Add video.

Parameters:

video – Pointer to video to add

virtual util::LearningCenterVideos getVideos(const QStringList &tags) const = 0

Get videos for tags.

Parameters:

tags – Filter tags (returns all videos if empty)

Returns:

Vector of videos

virtual const LearningCenterVideosModel &getVideosModel() const = 0

Get videos model.

Returns:

Const reference to videos model

virtual QMenu *getVideosMenu() const = 0

Get videos menu (e.g.

for use in the main menu)

Returns:

Pointer to videos menu

virtual void addTutorial(const util::LearningCenterTutorial *tutorial) = 0

Add tutorial.

Parameters:

tutorial – Pointer to tutorial to add

virtual util::LearningCenterTutorials getTutorials(const QStringList &includeTags, const QStringList &excludeTags = QStringList()) const = 0

Get tutorials for tags.

Parameters:
  • includeTags – Filter tags (returns all tutorials if empty)

  • excludeTags – Filter exclude tags

Returns:

Vector of tutorials

virtual const LearningCenterTutorialsModel &getTutorialsModel() const = 0

Get tutorials model.

Returns:

Const reference to tutorials model

virtual QMenu *getTutorialsMenu() const = 0

Get tutorials menu (e.g.

for use in the main menu)

Returns:

Pointer to tutorials menu

virtual void addNotification(const QString &title, const QString &description, const QIcon &icon = QIcon(), const util::Notification::DurationType &durationType = util::Notification::DurationType::Calculated, std::int32_t delayMs = 0) = 0

Add toaster notification in the main window.

Parameters:
  • title – Message title (maybe HTML)

  • description – Message description (maybe HTML)

  • icon – Icon to display in the notification

  • durationType – Duration type of the notification

  • delayMs – Delay in milliseconds before the notification is shown

virtual void initializeNotifications(QWidget *parentWidget) = 0

Initialize notifications manager with parentWidget widget.

Parameters:

parentWidget – Pointer to parent widget

void videosModelPopulatedFromWebsite()

Invoked when the videos model has been successfully populated from the website.

Protected Functions

virtual void addNotification(QPointer<Task> task) = 0

Add toaster notification for task in the main window.

Parameters:

taskTask containing the notification details