tbq::SettingsIni Class Reference

Class used to manage INI configuration file. More...

Public Types
using	CbHook = std::function< bool(const QFileInfo &fileInfo)>
	Custom callback hook use to implement custom behaviour.

Public Member Functions
bool	loadSettings (const QFileInfo &fileInfo)
	Load settings from INI configuration file.
QFileInfo	getPath () const
void	groupBegin (TB_QTCOMPAT_STR_VIEW keyGroup)
void	groupEnd ()
void	setValue (TB_QTCOMPAT_STR_VIEW key, const QVariant &value)
QVariant	getValue (TB_QTCOMPAT_STR_VIEW key, const QVariant &defaultValue=QVariant()) const
void	setHooksPreLoadSettings (CbHook hookPreload)
	Use to set custom behaviour before loading settings.
void	setHooksPostLoadSettings (CbHook hookPostload)
	Use to set custom behaviour after loading settings.

Static Public Member Functions
static SettingsIni &	instance ()

Detailed Description

Class used to manage INI configuration file.

This class allow to easily manage settings depending on a .ini file.
It will allow for example to not have to remember path of configuration file each time we need it !
This class used the singleton pattern, to use it, we can use:

• Method tbq::Settings::instance()
• Macro mSettings

Note

Don't use this class if INI format is not mandatory, QSettings already provide a way to manage other format without settings parameters each time at: https://doc.qt.io/qt-6/qsettings.html#basic-usage

To use this class in a project, we only have to initialize it in main method:

#include "mainwindow.h"
 
#include <QApplication>
 
#include "toolboxqt/core/settingsini.h"
 
/*****************************/
/* Macro definitions         */
/*****************************/
#define APP_CFG_FILE    "configurations/configuration.ini"
 
/*****************************/
/* Main method               */
/*****************************/
int main(int argc, char *argv[])
{
    /* Manage application properties */
    QApplication app(argc, argv);
 
    /* Set application configuration file */
    mSettings.loadSettings(QFileInfo(APP_CFG_FILE));
 
    /* Create main window */
    MainWindow mainWindow;
    mainWindow.show();
 
    return app.exec();
}

Then we can use it anywhere with:

mSettings.getValue("mySection/myKey");

This class also allow to have a custom behaviour for pre and post load operations of the configuration file via setHooksPreLoadSettings() and setHooksPostLoadSettings().
We can defines custom ones like this:

• Header file :

  #ifndef APPSETTINGS_H
  #define APPSETTINGS_H
   
  #include <QFileInfo>
   
  class AppSettings
  {
   
  public:
      static void setup(const QFileInfo &fileInfo);
   
  private:
      static bool preLoadSettings(const QFileInfo &fileInfo);
      static bool postLoadSettings(const QFileInfo &fileInfo);
   
  private:
      static constexpr int SUPPORT_VERSION_MAJOR = 1;
  };
   
  #endif // APPSETTINGS_H

• Source file :

  #include "appsettings.h"
   
  #include "toolboxqt/core/corehelper.h"
  #include "toolboxqt/core/settingsini.h"
   
  #include <QVersionNumber>
   
  void AppSettings::setup(const QFileInfo &fileInfo)
  {
      mSettings.setHooksPreLoadSettings(preLoadSettings);
      mSettings.setHooksPostLoadSettings(postLoadSettings);
   
      mSettings.loadSettings(fileInfo);
  }
   
  bool AppSettings::preLoadSettings(const QFileInfo &fileInfo)
  {
      /* Verify that configuration file exists */
      const QString filePath = fileInfo.absoluteFilePath();
      if(!QFile::exists(filePath)){
          const QString err = QString("Could not find configuration file: %1").arg(filePath);
          tbq::CoreHelper::quitApplication(err);
          return false;
      }
   
      return true;
  }
   
  bool AppSettings::postLoadSettings(const QFileInfo &fileInfo)
  {
      /* Verify configuration version compatibility */
      const QString semverStr = mSettings.getValue("informations/version_cfg_file").toString();
      const QVersionNumber semver = QVersionNumber::fromString(semverStr);
   
      if(semver.majorVersion() > SUPPORT_VERSION_MAJOR){
          QString err = QString("Unable to load configuration file of application, version is unsupported [read: %1, major-supported: %2]")
                            .arg(semver.toString()).arg(SUPPORT_VERSION_MAJOR);
          tbq::CoreHelper::quitApplication(err);
          return false;
      }
   
      return false;
  }

• Main file :

  #include "mainwindow.h"
   
  #include <QApplication>
   
  #include "appsettings.h"
   
  /*****************************/
  /* Macro definitions         */
  /*****************************/
  #define APP_CFG_FILE    "configurations/configuration.ini"
   
  /*****************************/
  /* Main method               */
  /*****************************/
  int main(int argc, char *argv[])
  {
      /* Manage application properties */
      QApplication app(argc, argv);
   
      /* Set application configuration file */
      AppSettings::setup(QFileInfo(APP_CFG_FILE));
   
      /* Create main window */
      MainWindow mainWindow;
      mainWindow.show();
   
      return app.exec();
  }

Member Typedef Documentation

CbHook

SettingsIni::CbHook

Custom callback hook use to implement custom behaviour.

Parameters

[in]

fileInfo

Path to configuration file used with loadSettings()

Note

Defining custom hook is not mandatory, default are provided (they do nothing excepting returning true).

Returns

Must return true if succeed.

See also

setHooksPreLoadSettings(), setHooksPostLoadSettings()

Member Function Documentation

loadSettings()

bool tbq::SettingsIni::loadSettings

(

const QFileInfo &

fileInfo

)

Load settings from INI configuration file.

Parameters

fileInfo

INI configuration file to use

Returns

Return true if loading succeed.

See also

setHooksPreLoadSettings(), setHooksPostLoadSettings()

setHooksPostLoadSettings()

void tbq::SettingsIni::setHooksPostLoadSettings

(

CbHook

hookPostload

)

Use to set custom behaviour after loading settings.

Parameters

hookPostload

Custom callback to use

See also

setHooksPreLoadSettings()

setHooksPreLoadSettings()

void tbq::SettingsIni::setHooksPreLoadSettings

(

CbHook

hookPreload

)

Use to set custom behaviour before loading settings.

Parameters

hookPreload

Custom callback to use

See also

setHooksPostLoadSettings()

---

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

• toolboxqt/core/settingsini.h
• toolboxqt/core/settingsini.cpp