# openPilotLog: src/classes/astandardpaths.h Source File

astandardpaths.h
/*
*openPilotLog - A FOSS Pilot Logbook Application
*Copyright (C) 2020-2021 Felix Turowsky
*
*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 <https://www.gnu.org/licenses/>.
*/
#ifndef ASTANDARDPATHS_H
#define ASTANDARDPATHS_H
#include <QStandardPaths>
#include <QString>
#include <QMap>
#include <QDir>
class AStandardPaths{
public:
enum Directories {
Database,
Templates,
Backup,
Log,
JSON
};
private:
static QMap<Directories, QDir> directories;
static bool scan_directories();
public:
static bool setup();
static const QDir &directory(Directories location);
static const QString asChildOfDir(Directories location, const QString& filename);
static const QMap<Directories, QDir> &allDirectories();
};
#endif // ASTANDARDPATHS_H
AStandardPaths::directory
static const QDir & directory(Directories location)
Returns the QDir for the standard directory referenced by the Directories enum 'loc'.
Definition: astandardpaths.cpp:43
AStandardPaths::setup
static bool setup()
Creates and verifies a static map of the standard paths used in the app.
Definition: astandardpaths.cpp:23
AStandardPaths::allDirectories
static const QMap< Directories, QDir > & allDirectories()
returns the static map of all standard directories
Definition: astandardpaths.cpp:53
AStandardPaths::asChildOfDir
static const QString asChildOfDir(Directories location, const QString &filename)
Returns a string of the absolute path to directory location concatenated with filename.
Definition: astandardpaths.cpp:48
AStandardPaths
The AStandardAppPaths class encapsulates a static QMap holding the standard paths of the application.
Definition: astandardpaths.h:30