NDEVR
API Documentation
SettingsDialog

The main Settings dialog for the application. More...

Collaboration diagram for SettingsDialog:
[legend]

Public Member Functions

 SettingsDialog (WindowManager *window_manager, QTModelManager *model_manager, QWidget *parent=nullptr)
 Constructs the main settings dialog.
void addSettingsMenu (QWidget *menu, std::function< void()> reset_to_defaults, uint04 location=1)
 Adds a custom settings menu tab to the dialog.
void prepareToShow ()
 Prepares the dialog for display, refreshing all tab contents.
void removeSettingsMenu (QWidget *menu)
 Removes a previously added settings menu tab.
void settingsAcceptedSignal ()
 Emitted when the user accepts the settings.

Protected Member Functions

void createBackground ()
 Creates the background visual for the settings dialog.
void releaseTypesChangedSlot ()
 Handles changes to the release type selection.
void resetGeneralToDefaults ()
 Resets general settings to their default values.
void resetUIToDefaults ()
 Resets UI settings to their default values.
void retranslate ()
 Retranslates all UI strings for the current language.
void setupExportTab ()
 Sets up the export settings tab.
void setupFolderTab ()
 Sets up the file and folder settings tab.
void setupGraphicsTab ()
 Sets up the graphics settings tab.
void setupImportTab ()
 Sets up the import settings tab.
void setupKeystrokeTab ()
 Sets up the keystroke settings tab.
void setupMainTab ()
 Sets up the main (general) settings tab.
void setupMouseSettingsTab ()
 Sets up the mouse settings tab.
void setupStationTab ()
 Sets up the station settings tab.
void setupUITab ()
 Sets up the user interface settings tab.
void setupUnitsTab ()
 Sets up the units settings tab.
void updateExportSettingsRibbon ()
 Updates the export settings ribbon to reflect current state.
void updateImportSettingsRibbon ()
 Updates the import settings ribbon to reflect current state.
void updateLayout ()
 Updates the layout of all tabs after changes.
void updateTabLocation ()
 Updates the tab position and orientation in the dialog.

Protected Attributes

QTResourceListenerm_camera_background_listener = nullptr
 Listener for camera background changes.
ModelFileDialogm_export_settings_dialog = nullptr
 The export settings file dialog.
RibbonSubGroupm_export_settings_ribbon_group = nullptr
 Ribbon group for export settings.
FileAndFolderSettingsDialogm_file_and_folder_settings = nullptr
 The file and folder settings dialog.
ModelFileDialogm_import_settings_dialog = nullptr
 The import settings file dialog.
RibbonSubGroupm_import_settings_ribbon_group = nullptr
 Ribbon group for import settings.
KeystrokeWidgetm_keystroke_widget = nullptr
 The keystroke configuration widget.
LanguageEditorm_language_editor = nullptr
 The language selection editor.
QTModelManagerm_model_manager = nullptr
 The model manager.
ModulesDialogm_modules_dialog = nullptr
 The modules management dialog.
MouseEditorWidgetm_mouse_editor = nullptr
 The mouse settings editor.
Dictionary< QWidget *, std::function< void()> > m_reset_to_default_settings
 Map of tabs to their reset callbacks.
bool m_shown_to_user = false
 Whether the dialog has been shown at least once.
UnitsDialogm_units_dialog = nullptr
 The units configuration dialog.
WindowManagerm_window_manager = nullptr
 The window manager.
Ui::SettingsUI * ui
 The UI form for the settings dialog.

Detailed Description

The main Settings dialog for the application.


Submenus can be added by the WindowManager or directly.

Definition at line 61 of file SettingsDialog.h.

Constructor & Destructor Documentation

◆ SettingsDialog()

SettingsDialog::SettingsDialog ( WindowManager * window_manager,
QTModelManager * model_manager,
QWidget * parent = nullptr )

Constructs the main settings dialog.

Parameters
[in]window_managerThe window manager for dialog management.
[in]model_managerThe model manager providing application state.
[in]parentThe parent widget.

References SettingsDialog().

Referenced by SettingsDialog().

Member Function Documentation

◆ addSettingsMenu()

void SettingsDialog::addSettingsMenu ( QWidget * menu,
std::function< void()> reset_to_defaults,
uint04 location = 1 )

Adds a custom settings menu tab to the dialog.

Parameters
[in]menuThe widget to add as a tab.
[in]reset_to_defaultsA callback to reset the tab's settings to defaults.
[in]locationThe tab insertion index.

◆ removeSettingsMenu()

void SettingsDialog::removeSettingsMenu ( QWidget * menu)

Removes a previously added settings menu tab.

Parameters
[in]menuThe widget to remove.

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