NDEVR
API Documentation
ApplicationSetup

Initializes the engine for most applications. More...

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

Public Member Functions

 ApplicationSetup ()
 Default constructor.
 ApplicationSetup (int argc, char **argv)
 Constructs the application setup with command-line arguments.
int launch () override
 Launches the application event loop.
void registerMetatypes () override
 Registers Qt metatypes required by the application for signal/slot communication.
void setupFactories () override
 Registers IO factories and other service factories with the application.
void setupUI () override
 Builds and initializes the main application UI, including the ribbon and workspace.
void setupUserOptions () override
 Configures default user options and application settings.
Public Member Functions inherited from WidgetInitialization
 WidgetInitialization ()
 Constructs a WidgetInitialization with default settings.
 WidgetInitialization (int argc, char **argv)
 Constructs a WidgetInitialization with command-line arguments.
virtual void errorHandlingInit ()
 Initializes error and crash handling.
virtual NDEVRApplicationinitializeApplication ()
 Creates and returns the NDEVRApplication instance.
virtual void setupAll ()
 Runs all setup steps in the correct order.
virtual void setUpdateChecker ()
 Registers the software update checker from loaded modules.
virtual void setupFileStructure ()
 Creates required directories and unpacks resources from loaded modules.
virtual void setupFonts ()
 Loads and configures application fonts.
virtual void setupLanguages ()
 Sets up language translations from loaded modules.
virtual void setupManuals ()
 Registers help manuals from loaded modules.
virtual void setupModules ()
 Loads and initializes all modules.
virtual void setupUIThemes ()
 Registers UI icon and color themes from loaded modules.
virtual void setupUnits ()
 Configures unit systems from loaded modules.

Public Attributes

std::function< void(QWidget *)> main_window_created_callback
 Optional callback invoked after the main window is created.
Public Attributes inherited from WidgetInitialization
NDEVRApplicationapp = nullptr
 The application instance.
int argc
 The command-line argument count.
char ** argv
 The command-line argument values.
bool auto_restart = true
 Whether to auto-restart the application on crash.
bool disable_auto_screen_factor = true
 Whether to disable automatic screen scale factor.
QTWindowManagergui = nullptr
 The window manager instance.
bool launch_model_manager = true
 Whether to launch the QTModelManager.
std::function< void()> load_modules_callback
 Optional callback invoked after modules are loaded.
bool load_user_settings = true
 Whether to load saved user settings.
String main_module_name
 The name of the primary application module.
QTModelManagermanager = nullptr
 The model manager instance.
bool qt_allow_virtual_keyboard = false
 Whether to enable the Qt virtual keyboard.
bool qt_enable_high_dpi_scaling = true
 Whether to enable Qt high-DPI scaling.
bool qt_use_high_dpi_bitmaps = true
 Whether to use high-DPI bitmaps.
bool setup_error_handling = true
 Whether to initialize error handling.
bool setup_factories = true
 Whether to register I/O factories.
bool setup_file_structure = true
 Whether to create required directories.
bool setup_fonts = true
 Whether to load and configure fonts.
bool setup_language = true
 Whether to initialize language translations.
bool setup_modules = true
 Whether to load and initialize modules.
bool validate_file_structure = true
 Whether to validate the file structure on startup.

Detailed Description

Initializes the engine for most applications.


Applications using the default workspace should call this function to layout and initialize the application. Calls all relevant module functions in the correct order.

Definition at line 40 of file ApplicationSetup.h.

Constructor & Destructor Documentation

◆ ApplicationSetup() [1/2]

ApplicationSetup::ApplicationSetup ( )

Default constructor.

Initializes the application setup with no command-line arguments.

◆ ApplicationSetup() [2/2]

ApplicationSetup::ApplicationSetup ( int argc,
char ** argv )

Constructs the application setup with command-line arguments.

Parameters
[in]argcThe number of command-line arguments.
[in]argvThe array of command-line argument strings.

References WidgetInitialization::argc, and WidgetInitialization::argv.

Member Function Documentation

◆ launch()

int ApplicationSetup::launch ( )
overridevirtual

Launches the application event loop.

Returns
The application exit code.

Reimplemented from WidgetInitialization.


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