Developer Documentation
RecentFiles.hh
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 * $Revision$ *
45 * $LastChangedBy$ *
46 * $Date$ *
47 * *
48 \*===========================================================================*/
49 
50 
51 
52 
53 //=============================================================================
54 //
55 // Options used throughout the System
56 //
57 //=============================================================================
58 
65 #ifndef RECENTFILES_HH
66 #define RECENTFILES_HH
67 
68 #include <QDir>
69 #include <QStringList>
70 #include <QString>
71 #include <QComboBox>
72 #include <QFileDialog>
73 #include <stdexcept>
74 
76 
77 namespace OpenFlipper {
78 namespace Options {
79 
80 
81 //===========================================================================
84 //===========================================================================
85 
87  DLLEXPORT
88  void addRecentFile(QString _file, DataType _type);
89 
96  DLLEXPORT
97  void rememberRecentItem(const QString &propName, const QString &itemName, const int RECENT_ITEMS_MAX_SIZE = 10);
98 
102  DLLEXPORT
103  QStringList getRecentItems(const QString &propName);
104 
109  DLLEXPORT
110  QString getMostRecentItem(const QString &propName);
111 
119  inline static void updateComboBox(QComboBox *cb, const QString &value, const char *propName) {
120  if (propName != 0) {
121  cb->clear();
122  if (value.length() > 0)
123  rememberRecentItem(QString::fromUtf8(propName), value);
124  const QStringList content = getRecentItems(QString::fromUtf8(propName));
125  cb->insertItems(0, content);
126  }
127  cb->setEditText(value);
128  }
129 
130  enum DialogType {
131  DT_OPEN,
132  DT_SAVE,
133  DT_CHOOSE_PATH,
134  };
135 
144  inline static QString obtainPathName(QComboBox *cb, const char *title, const char *filters,
145  const char *propName, DialogType dialog_type = DT_OPEN) {
146  QString result;
147  switch (dialog_type) {
148  case DT_OPEN:
149  result = QFileDialog::getOpenFileName(0, QObject::tr(title), cb->currentText(), QObject::tr(filters));
150  break;
151  case DT_SAVE:
152  result = QFileDialog::getSaveFileName(0, QObject::tr(title), cb->currentText(), QObject::tr(filters));
153  break;
154  case DT_CHOOSE_PATH:
155  result = QFileDialog::getExistingDirectory(0, QObject::tr(title), cb->currentText());
156  break;
157  default:
158  throw std::logic_error("Unknown value for dialog_type.");
159  }
160 
161  if (result.length() > 0)
162  updateComboBox(cb, result, propName);
163 
164  return result;
165  }
169 }
170 }
171 
172 //=============================================================================
173 #endif // OPTIONS_HH defined
174 //=============================================================================
Predefined datatypes.
Definition: DataTypes.hh:96
#define DLLEXPORT