File: settingsfactory.h

package info (click to toggle)
libdrumstick 2.10.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 3,876 kB
  • sloc: cpp: 25,685; xml: 122; sh: 14; makefile: 5
file content (75 lines) | stat: -rw-r--r-- 1,980 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
/*
 Drumstick Widgets
 Copyright (C) 2018-2024 Pedro Lopez-Cabanillas <plcl@users.sf.net>

 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation, either version 3 of the License, or
 (at your option) any later version.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.

 You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef SETTINGS_H
#define SETTINGS_H

#include <QSettings>
#include <QScopedPointer>
#include "macros.h"

/**
 * @file settingsfactory.h
 * SettingsFactory class declaration
 */

#if defined(DRUMSTICK_STATIC)
#define DRUMSTICK_WIDGETS_EXPORT
#else
#if defined(drumstick_widgets_EXPORTS)
#define DRUMSTICK_WIDGETS_EXPORT Q_DECL_EXPORT
#else
#define DRUMSTICK_WIDGETS_EXPORT Q_DECL_IMPORT
#endif
#endif

/**
 * @class QSettings
 * @brief The QSettings class provides persistent platform-independent application settings.
 * @see https://doc.qt.io/qt-5/qsettings.html
 */

namespace drumstick { namespace widgets {

/**
 * @addtogroup Widgets
 * @{
 *
 * @class SettingsFactory
 * @brief The SettingsFactory class holds a global QSettings object.
 * This class creates and returns a QSettings object globally configured
 * instance using native or file storage.
 */
class DRUMSTICK_WIDGETS_EXPORT SettingsFactory
{
public:
    QSettings *getQSettings();
    QSettings *operator->();
    static void setFileName(const QString name);
    static QString fileName();
    static QSettings::Format format();

private:
    QScopedPointer<QSettings> m_settings{nullptr};
    static QString s_fileName;
};

/** @} */
}} // namespace drumstick::widgets

#endif // SETTINGS_H