Signals | Public Member Functions | List of all members
pqSettings Class Reference

pqSettings extends QSettings to add support for following: More...

#include <pqSettings.h>

Inherits QSettings.

Signals

void modified ()
 

Public Member Functions

 pqSettings (const QString &organization, const QString &application=QString(), QObject *parent=nullptr)
 
 pqSettings (Scope scope, const QString &organization, const QString &application=QString(), QObject *parent=nullptr)
 
 pqSettings (Format format, Scope scope, const QString &organization, const QString &application=QString(), QObject *parent=nullptr)
 
 pqSettings (const QString &fileName, Format format, QObject *parent=nullptr)
 
 pqSettings (QObject *parent=nullptr)
 
 ~pqSettings () override
 
void saveState (const QMainWindow &window, const QString &key)
 
void saveState (const QDialog &dialog, const QString &key)
 
void restoreState (const QString &key, QMainWindow &window)
 
void restoreState (const QString &key, QDialog &dialog)
 
void alertSettingsModified ()
 Calling this method will cause the modified signal to be emitted. More...
 
void saveInQSettings (const char *key, vtkSMProperty *smproperty)
 Save a property value to a given setting name. More...
 
QString backup (const QString &filename=QString())
 Creates a new backup file for the current settings. More...
 

Detailed Description

pqSettings extends QSettings to add support for following:

Definition at line 19 of file pqSettings.h.

Constructor & Destructor Documentation

◆ pqSettings() [1/5]

pqSettings::pqSettings ( const QString &  organization,
const QString &  application = QString(),
QObject *  parent = nullptr 
)

◆ pqSettings() [2/5]

pqSettings::pqSettings ( Scope  scope,
const QString &  organization,
const QString &  application = QString(),
QObject *  parent = nullptr 
)

◆ pqSettings() [3/5]

pqSettings::pqSettings ( Format  format,
Scope  scope,
const QString &  organization,
const QString &  application = QString(),
QObject *  parent = nullptr 
)

◆ pqSettings() [4/5]

pqSettings::pqSettings ( const QString &  fileName,
Format  format,
QObject *  parent = nullptr 
)

◆ pqSettings() [5/5]

pqSettings::pqSettings ( QObject *  parent = nullptr)

◆ ~pqSettings()

pqSettings::~pqSettings ( )
override

Member Function Documentation

◆ saveState() [1/2]

void pqSettings::saveState ( const QMainWindow &  window,
const QString &  key 
)

◆ saveState() [2/2]

void pqSettings::saveState ( const QDialog &  dialog,
const QString &  key 
)

◆ restoreState() [1/2]

void pqSettings::restoreState ( const QString &  key,
QMainWindow &  window 
)

◆ restoreState() [2/2]

void pqSettings::restoreState ( const QString &  key,
QDialog &  dialog 
)

◆ alertSettingsModified()

void pqSettings::alertSettingsModified ( )

Calling this method will cause the modified signal to be emitted.

◆ saveInQSettings()

void pqSettings::saveInQSettings ( const char *  key,
vtkSMProperty smproperty 
)

Save a property value to a given setting name.

◆ backup()

QString pqSettings::backup ( const QString &  filename = QString())

Creates a new backup file for the current settings.

If filename is empty, then a backup file name will automatically be picked. On success returns the backup file name, on failure an empty string is returned.

◆ modified

void pqSettings::modified ( )
signal

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