1/*
2 Copyright (c) 2011 Volker Krause <vkrause@kde.org>
3
4 This library is free software; you can redistribute it and/or modify it
5 under the terms of the GNU Library General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or (at your
7 option) any later version.
8
9 This library is distributed in the hope that it will be useful, but WITHOUT
10 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
12 License for more details.
13
14 You should have received a copy of the GNU Library General Public License
15 along with this library; see the file COPYING.LIB. If not, write to the
16 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
17 02110-1301, USA.
18*/
19
20#ifndef AKSTANDARDDIRS_H
21#define AKSTANDARDDIRS_H
22
23#include <libs/xdgbasedirs_p.h>
24
25/**
26 * Convenience wrappers on top of XdgBaseDirs that are instance namespace aware.
27 * @since 1.7
28 */
29namespace AkStandardDirs {
30/**
31 * Returns path to the config file @p configFile.
32 */
33QString configFile(const QString &configFile, Akonadi::XdgBaseDirs::FileAccessMode openMode = Akonadi::XdgBaseDirs::ReadOnly);
34
35/**
36 * Returns the full path to the server config file (akonadiserverrc).
37 */
38QString serverConfigFile(Akonadi::XdgBaseDirs::FileAccessMode openMode = Akonadi::XdgBaseDirs::ReadOnly);
39
40/**
41 * Returns the full path to the connection config file (akonadiconnectionrc).
42 */
43QString connectionConfigFile(Akonadi::XdgBaseDirs::FileAccessMode openMode = Akonadi::XdgBaseDirs::ReadOnly);
44
45/**
46 * Returns the full path to the agent config file (agentsrc).
47 */
48QString agentConfigFile(Akonadi::XdgBaseDirs::FileAccessMode openMode = Akonadi::XdgBaseDirs::ReadOnly);
49
50/**
51 * Instance-aware wrapper for XdgBaseDirs::saveDir().
52 * @note @p relPath does not need to include the "akonadi/" folder.
53 * @see XdgBaseDirs::saveDir()
54 */
55QString saveDir(const char *resource, const QString &relPath = QString());
56}
57
58#endif
59