File indexing completed on 2024-04-21 04:18:47
0001 // vim: set tabstop=4 shiftwidth=4 expandtab: 0002 /* 0003 Gwenview: an image viewer 0004 Copyright 2009 Aurélien Gâteau <agateau@kde.org> 0005 0006 This program is free software; you can redistribute it and/or 0007 modify it under the terms of the GNU General Public License 0008 as published by the Free Software Foundation; either version 2 0009 of the License, or (at your option) any later version. 0010 0011 This program is distributed in the hope that it will be useful, 0012 but WITHOUT ANY WARRANTY; without even the implied warranty of 0013 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 0014 GNU General Public License for more details. 0015 0016 You should have received a copy of the GNU General Public License 0017 along with this program; if not, write to the Free Software 0018 Foundation, Inc., 51 Franklin Street, Fifth Floor, Cambridge, MA 02110-1301, USA. 0019 0020 */ 0021 #ifndef FILENAMEFORMATER_H 0022 #define FILENAMEFORMATER_H 0023 0024 // Qt 0025 #include <QMap> 0026 0027 // KF 0028 0029 // Local 0030 0031 class QDateTime; 0032 class QString; 0033 class QUrl; 0034 0035 namespace Gwenview 0036 { 0037 struct FileNameFormaterPrivate; 0038 class FileNameFormater 0039 { 0040 public: 0041 using HelpMap = QMap<QString, QString>; 0042 0043 explicit FileNameFormater(const QString &format); 0044 ~FileNameFormater(); 0045 0046 /** 0047 * Given an url and its dateTime, returns a filename according to the 0048 * format passed to the constructor 0049 */ 0050 QString format(const QUrl &url, const QDateTime &dateTime); 0051 0052 /** 0053 * Returns a map whose keys are the available keywords and values are the 0054 * keyword help 0055 */ 0056 static HelpMap helpMap(); 0057 0058 private: 0059 FileNameFormaterPrivate *const d; 0060 }; 0061 0062 } // namespace 0063 0064 #endif /* FILENAMEFORMATER_H */