#include <ModuleConfiguration.h>

Inheritance diagram for sf::ModuleConfiguration:

Collaboration diagram for sf::ModuleConfiguration:

Public Types
typedef QMap< QString, QString >	ModuleListType
	Mapped array for passing module library files. The key is the (relative) path to the dynamic library file. The pair contains the module name of and the description.

Public Member Functions
Q_SIGNAL void	libraryLoaded (bool startup)
	Signal emitted when library is loaded.

	ModuleConfiguration (QSettings settings, QObject parent=nullptr)
	Constructor.

	~ModuleConfiguration () override
	Virtual Destructor.

void	openDialog (QWidget *parent=nullptr)
	Opens a dialog for module configuration.

ModuleListType	getList () const
	Gets the configured modules in a list.

size_t	load (bool startup)
	Loads the module configuration from the settings.

void	save (const ModuleListType &list)
	Saves the module configuration to the settings.

QString	getModuleDir ()
	Gets the module library directory.

QSettings *	getSettings ()
	Gets the module library directory.

Member Typedef Documentation

◆ ModuleListType

typedef QMap<QString, QString> sf::ModuleConfiguration::ModuleListType

Mapped array for passing module library files. The key is the (relative) path to the dynamic library file. The pair contains the module name of and the description.

Constructor & Destructor Documentation

◆ ModuleConfiguration()

sf::ModuleConfiguration::ModuleConfiguration	(	QSettings *	settings,
		QObject *	parent = `nullptr`
	)

explicit

Constructor.

Parameters

settings	Settings for loading and storing the module configuration.
parent	Owning object.

◆ ~ModuleConfiguration()

sf::ModuleConfiguration::~ModuleConfiguration ( )

override

Virtual Destructor.

Member Function Documentation

◆ getList()

ModuleListType sf::ModuleConfiguration::getList ( ) const

Gets the configured modules in a list.

Returns: Mapped list of module

◆ getModuleDir()

QString sf::ModuleConfiguration::getModuleDir ( )

Gets the module library directory.

◆ getSettings()

QSettings * sf::ModuleConfiguration::getSettings ( )

inline

Gets the module library directory.

◆ libraryLoaded()

Q_SIGNAL void sf::ModuleConfiguration::libraryLoaded ( bool startup )

Signal emitted when library is loaded.

◆ load()

size_t sf::ModuleConfiguration::load ( bool startup )

Loads the module configuration from the settings.

Returns: True when at least a library was loaded.

◆ openDialog()

void sf::ModuleConfiguration::openDialog ( QWidget * parent = nullptr )

Opens a dialog for module configuration.

Parameters

parent Parent widget.

◆ save()

void sf::ModuleConfiguration::save ( const ModuleListType & list )

Saves the module configuration to the settings.

The documentation for this class was generated from the following file:

ModuleConfiguration.h

Public Types

Public Member Functions