qgsuserprofilemanager.h

Go to the documentation of this file.

/***************************************************************************
                        qgsuserprofilemanager.h
     --------------------------------------
    Date                 :  Jul-2017
    Copyright            : (C) 2017 by Nathan Woodrow
    Email                : woodrow.nathan at gmail dot com
 ***************************************************************************
 *                                                                         *
 *   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 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
#ifndef QGSUSERPROFILEMANAGER_H
#define QGSUSERPROFILEMANAGER_H
 
#include <memory>
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgserror.h"
#include "qgsuserprofile.h"
 
#include <QFileSystemWatcher>
#include <QSettings>
 
class QgsSettingsEntryBool;
class QgsSettingsEntryString;

class CORE_EXPORT QgsUserProfileManager : public QObject
{
    Q_OBJECT
 
  public:
    static const QgsSettingsEntryBool *settingsOverrideLocalProfile SIP_SKIP;
 
    static const QgsSettingsEntryString *settingsDefaultProfile SIP_SKIP;

    QgsUserProfileManager( const QString &rootLocation = QString(), QObject *parent = nullptr );

    static QString resolveProfilesFolder( const QString &basePath = QString() );

    std::unique_ptr< QgsUserProfile > getProfile( const QString &defaultProfile = "default", bool createNew = true, bool initSettings = true );

    void setRootLocation( const QString &rootProfileLocation );

    QString rootLocation() const { return mRootProfilePath; }

    void setNewProfileNotificationEnabled( bool enabled );

    bool isNewProfileNotificationEnabled() const;

    bool rootLocationIsSet() const;

    QStringList allProfiles() const;

    bool profileExists( const QString &name ) const;

    QString defaultProfileName() const;

    void setDefaultProfileName( const QString &name );

    void setDefaultFromActive();

    QString lastProfileName() const;

    void updateLastProfileName() SIP_SKIP;

    Qgis::UserProfileSelectionPolicy userProfileSelectionPolicy() const;

    void setUserProfileSelectionPolicy( Qgis::UserProfileSelectionPolicy policy );

    std::unique_ptr< QgsUserProfile > profileForName( const QString &name ) const;

    QgsError createUserProfile( const QString &name );

    QgsError deleteProfile( const QString &name );

    QgsUserProfile *userProfile();

    void setActiveUserProfile( const QString &profile );

    void loadUserProfile( const QString &name );

    QSettings *settings();
 
  signals:

    void profilesChanged();
 
  private:
    bool mWatchProfiles = false;
    std::unique_ptr<QFileSystemWatcher> mWatcher;
 
    QString mRootProfilePath;
 
    std::unique_ptr<QgsUserProfile> mUserProfile;
 
    QString settingsFile() const;
 
    std::unique_ptr< QSettings > mSettings;
};
 
// clazy:excludeall=qstring-allocations
 
#endif // QGSUSERPROFILEMANAGER_H