API Documentation
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros
Module Struct Reference

Base class for extensions, typically added as external DLL's that can modify or enhance the behavior of the software. More...

#include <ModuleManager.h>

Inheritance diagram for Module:
[legend]
Collaboration diagram for Module:
[legend]

Public Types

enum  ModuleType : uint04 { e_application , e_utility , e_library_dependency , e_undefined }
 

Public Member Functions

void callModuleFunction (const String &function) const
 
void callModuleFunction (const String &function, QTModelManager *model_manager, QTWindowManager *window_manager) const
 
void defineModuleResources (ModuleResourceManager *resources) const
 
void initialize ()
 
bool isValid () const
 
 Module ()
 
 Module (const String &name)
 
 Module (const String &name, const File &library)
 

Public Attributes

String activation_id
 
bool allow_user_toggle_active = false
 
TranslatedString description
 
TranslatedString display_name
 
String icon
 
bool is_active = true
 
File library
 
String license_agreement
 
Dictionary< String, void * > loaded_functions
 
String name
 
ModuleType type = ModuleType::e_undefined
 
String version
 
String website
 

Protected Attributes

void * module_ptr = nullptr
 

Detailed Description

Base class for extensions, typically added as external DLL's that can modify or enhance the behavior of the software.


Member Enumeration Documentation

◆ ModuleType

Enumerator
e_application 
e_utility 
e_library_dependency 
e_undefined 

Constructor & Destructor Documentation

◆ Module() [1/3]

Module ( )

◆ Module() [2/3]

Module ( const String & name)

◆ Module() [3/3]

Module ( const String & name,
const File & library )

Member Function Documentation

◆ callModuleFunction() [1/2]

void callModuleFunction ( const String & function) const

◆ callModuleFunction() [2/2]

void callModuleFunction ( const String & function,
QTModelManager * model_manager,
QTWindowManager * window_manager ) const

◆ defineModuleResources()

void defineModuleResources ( ModuleResourceManager * resources) const

◆ initialize()

void initialize ( )

◆ isValid()

bool isValid ( ) const

Member Data Documentation

◆ activation_id

String activation_id

◆ allow_user_toggle_active

bool allow_user_toggle_active = false

◆ description

TranslatedString description

◆ display_name

TranslatedString display_name

◆ icon

String icon

◆ is_active

bool is_active = true

◆ library

File library

◆ license_agreement

String license_agreement

◆ loaded_functions

Dictionary<String, void*> loaded_functions
mutable

◆ module_ptr

void* module_ptr = nullptr
protected

◆ name

String name

◆ type

◆ version

String version

◆ website

String website

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