OpenFlipperQSettings.hh 4.9 KB
Newer Older
1 2 3
/*===========================================================================*\
*                                                                            *
*                              OpenFlipper                                   *
Martin Schultz's avatar
Martin Schultz committed
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
 *           Copyright (c) 2001-2015, RWTH-Aachen University                 *
 *           Department of Computer Graphics and Multimedia                  *
 *                          All rights reserved.                             *
 *                            www.openflipper.org                            *
 *                                                                           *
 *---------------------------------------------------------------------------*
 * This file is part of OpenFlipper.                                         *
 *---------------------------------------------------------------------------*
 *                                                                           *
 * Redistribution and use in source and binary forms, with or without        *
 * modification, are permitted provided that the following conditions        *
 * are met:                                                                  *
 *                                                                           *
 * 1. Redistributions of source code must retain the above copyright notice, *
 *    this list of conditions and the following disclaimer.                  *
 *                                                                           *
 * 2. Redistributions in binary form must reproduce the above copyright      *
 *    notice, this list of conditions and the following disclaimer in the    *
 *    documentation and/or other materials provided with the distribution.   *
 *                                                                           *
 * 3. Neither the name of the copyright holder nor the names of its          *
 *    contributors may be used to endorse or promote products derived from   *
 *    this software without specific prior written permission.               *
 *                                                                           *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS       *
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A           *
 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,  *
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,       *
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR        *
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF    *
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING      *
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS        *
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.              *
39 40 41
*                                                                            *
\*===========================================================================*/

Jan Möbius's avatar
Jan Möbius committed
42
#pragma once
43 44

#include <QSettings>
Jan Möbius's avatar
Jan Möbius committed
45
#include <OpenFlipper/common/GlobalDefines.hh>
46

Jan Möbius's avatar
Jan Möbius committed
47
class DLLEXPORT OpenFlipperQSettings : public QSettings
48 49 50
{
public:
    explicit OpenFlipperQSettings(const QString &organization,
Jan Möbius's avatar
Jan Möbius committed
51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67
                                  const QString &application = QString(),
                                  QObject *parent = 0) : QSettings(organization, application, parent) {};

    OpenFlipperQSettings(QSettings::Scope scope,
                         const QString &organization,
                         const QString &application = QString(),
                         QObject *parent = 0) : QSettings(scope, organization, application, parent) {};

    OpenFlipperQSettings(QSettings::Format format,
                         QSettings::Scope scope, const QString &organization,
	                       const QString &application = QString(),
	                       QObject *parent = 0) : QSettings (format, scope, organization, application, parent) {};

    OpenFlipperQSettings(const QString &fileName,
                         QSettings::Format format,
                         QObject *parent = 0) : QSettings(fileName, format, parent) {};

68 69 70 71
    explicit OpenFlipperQSettings(QObject *parent = 0) : QSettings(parent) {};
    
    /// Wrapper function for QSettings::value() that outputs an error message to console if the key was not found and no default value given.
    /// This is supposed to prevent Plugin authors from forgetting to specify the defaultValue. ;)
Jan Möbius's avatar
Jan Möbius committed
72
    /// Additionally it is possible to enable Debugging output with -DOPENFLIPPER_SETTINGS_DEBUG
73
    QVariant value(const QString &key, const QVariant &defaultValue = QVariant()) const;
Jan Möbius's avatar
Jan Möbius committed
74 75 76 77

    /// Wrapper function which makes it possible to enable Debugging output with -DOPENFLIPPER_SETTINGS_DEBUG
    void setValue ( const QString & key, const QVariant & value );

78 79
};