Developer Documentation

RecentFiles.cc
1 /*===========================================================================*\
2 * *
3 * OpenFlipper *
4 * Copyright (c) 2001-2015, RWTH-Aachen University *
5 * Department of Computer Graphics and Multimedia *
6 * All rights reserved. *
7 * www.openflipper.org *
8 * *
9 *---------------------------------------------------------------------------*
10 * This file is part of OpenFlipper. *
11 *---------------------------------------------------------------------------*
12 * *
13 * Redistribution and use in source and binary forms, with or without *
14 * modification, are permitted provided that the following conditions *
15 * are met: *
16 * *
17 * 1. Redistributions of source code must retain the above copyright notice, *
18 * this list of conditions and the following disclaimer. *
19 * *
20 * 2. Redistributions in binary form must reproduce the above copyright *
21 * notice, this list of conditions and the following disclaimer in the *
22 * documentation and/or other materials provided with the distribution. *
23 * *
24 * 3. Neither the name of the copyright holder nor the names of its *
25 * contributors may be used to endorse or promote products derived from *
26 * this software without specific prior written permission. *
27 * *
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS *
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
30 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A *
31 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
32 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, *
33 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, *
34 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR *
35 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF *
36 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING *
37 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS *
38 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *
39 * *
40 \*===========================================================================*/
41
42
43 //=============================================================================
44 //
45 // Options used throughout the System
46 //
47 //=============================================================================
48
49 #include <QDir>
50
51 #include "RecentFiles.hh"
52
53 #include <OpenFlipper/common/GlobalOptions.hh>
54
55 namespace OpenFlipper {
56 namespace Options {
57
58
59 void addRecentFile(QString _file, DataType _type) {
60
61
62 QStringList recentFiles = OpenFlipperSettings().value("Core/File/RecentFiles", QStringList()).toStringList();
63 QStringList recentTypes = OpenFlipperSettings().value("Core/File/RecentTypes", QStringList()).toStringList();
64
65 QString type = typeName(_type);
66
67 // Check if file already in recent list
68 for ( int i = 0 ; i < recentFiles.size() ; ++i)
69 if ( _file == recentFiles[i] && type == recentTypes[i] ){
70 recentFiles.removeAt(i);
71 recentTypes.removeAt(i);
72 }
73
74 // Erase if too many files in list
75 if ( recentFiles.size() >= OpenFlipperSettings().value("Core/File/MaxRecent",15).toInt() ) {
76 recentFiles.pop_back();
77 recentTypes.pop_back();
78 }
79
80 recentFiles.push_front(_file);
81 recentTypes.push_front(type);
82
83 OpenFlipperSettings().setValue("Core/File/RecentFiles", recentFiles);
84 OpenFlipperSettings().setValue("Core/File/RecentTypes", recentTypes);
85 }
86
87 void rememberRecentItem(const QString &propName, const QString &itemName, const int RECENT_ITEMS_MAX_SIZE) {
88 // Read setting.
89 QStringList recentItems = OpenFlipperSettings().value(propName, QStringList()).toStringList();
90
91 // If file already on list, remove it (so it appears on top, eventually).
92 int position = recentItems.indexOf(QRegExp(QRegExp::escape(itemName)));
93 if (position != -1) recentItems.removeAt(position);
94
95 // Truncate list if too long.
96 if (recentItems.size() >= RECENT_ITEMS_MAX_SIZE) recentItems.removeLast();
97
98 // Add new file to front.
99 recentItems.push_front(itemName);
100
101 // Write back setting.
102 OpenFlipperSettings().setValue(propName, recentItems);
103 }
104
105 QStringList getRecentItems(const QString &propName) {
106 return OpenFlipperSettings().value(propName, QStringList()).toStringList();
107 }
108
109 QString getMostRecentItem(const QString &propName) {
110 QStringList sl = OpenFlipperSettings().value(propName, QStringList()).toStringList();
111 if (sl.empty()) return QString();
112 return sl[0];
113 }
114
115 }
116 }
117
118 //=============================================================================
119
OpenFlipperSettings
DLLEXPORT OpenFlipperQSettings & OpenFlipperSettings()
QSettings object containing all program settings of OpenFlipper.
Definition: GlobalOptions.cc:1038
typeName
DLLEXPORT QString typeName(DataType _id)
Get the name of a type with given id.
Definition: Types.cc:154
OpenFlipperQSettings::setValue
void setValue(const QString &key, const QVariant &value)
Wrapper function which makes it possible to enable Debugging output with -DOPENFLIPPER_SETTINGS_DEBUG...
Definition: OpenFlipperQSettings.cc:61
GlobalOptions.hh
OpenFlipper
Definition: GlobalOptions.cc:57
DataType
Predefined datatypes.
Definition: DataTypes.hh:83
OpenFlipperQSettings::value
QVariant value(const QString &key, const QVariant &defaultValue=QVariant()) const
Definition: OpenFlipperQSettings.cc:46