OpenMS  3.0.0
RecentFilesMenu.h
Go to the documentation of this file.
1 // --------------------------------------------------------------------------
2 // OpenMS -- Open-Source Mass Spectrometry
3 // --------------------------------------------------------------------------
4 // Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
5 // ETH Zurich, and Freie Universitaet Berlin 2002-2022.
6 //
7 // This software is released under a three-clause BSD license:
8 // * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 // notice, this list of conditions and the following disclaimer in the
12 // documentation and/or other materials provided with the distribution.
13 // * Neither the name of any author or any participating institution
14 // may be used to endorse or promote products derived from this software
15 // without specific prior written permission.
16 // For a full list of authors, refer to the file AUTHORS.
17 // --------------------------------------------------------------------------
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 // ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
22 // INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
27 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
28 // ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 //
30 // --------------------------------------------------------------------------
31 // $Maintainer: Chris Bielow $
32 // $Authors: Chris Bielow $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
37 // OpenMS_GUI config
38 #include <OpenMS/VISUAL/OpenMS_GUIConfig.h>
39 
41 
42 #include <QMenu>
43 #include <QStringList>
44 
45 #include <vector>
46 
47 class QAction;
48 
49 namespace OpenMS
50 {
51  class Param;
52  class String;
53 
60  : public QObject
61  {
62  Q_OBJECT
63 
64  signals:
66  void recentFileClicked(const String& filename);
67 
68  public:
70  RecentFilesMenu(int max_entries = 15);
71 
73  void set(const QStringList& initial);
74 
83  unsigned setFromParam(const Param& filenames);
84 
89  Param getAsParam() const;
90 
92  QMenu* getMenu();
93 
95  const QStringList& get() const;
96 
97  public slots:
99  void add(const String& filename);
100 
101  private slots:
103  void itemClicked_();
104 
105  private:
107  void sync_();
108 
114  QStringList recent_files_;
116  std::vector<QAction*> recent_actions_;
117  };
118 
119 } //namespace
120 
QObject
OpenMS::RecentFilesMenu::itemClicked_
void itemClicked_()
invoked by the QAction when it was clicked; emits recentFileClicked(String filename)
OpenMS::RecentFilesMenu::set
void set(const QStringList &initial)
sets a list of recent files (up to max_entries many – see C'tor)
Param
@TODO loop over all runs
Definition: BayesianProteinInferenceAlgorithm.h:98
OpenMS::String
A more convenient string class.
Definition: String.h:58
OpenMS::RecentFilesMenu::recent_menu_
QMenu recent_menu_
holds the menu and the filenames (as QActions)
Definition: RecentFilesMenu.h:110
OpenMS::RecentFilesMenu::sync_
void sync_()
updates the menu by synching text and and visibility of actions using the current list of recent file...
OpenMS::RecentFilesMenu::setFromParam
unsigned setFromParam(const Param &filenames)
Extracts all values from all elements in the param object and tries to interpret them as filenames If...
OpenMS::RecentFilesMenu::add
void add(const String &filename)
put a new recent file at the top (removing any duplicates in other positions); will update the QMenu
OpenMS::RecentFilesMenu::get
const QStringList & get() const
current list of recent files (most recent first)
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
OpenMS::RecentFilesMenu
Manages recent files opened by the user and provides a QMenu to go with it.
Definition: RecentFilesMenu.h:59
OpenMS::RecentFilesMenu::recentFileClicked
void recentFileClicked(const String &filename)
when a recent file action item from the getMenu() was clicked
OpenMS::RecentFilesMenu::max_entries_
int max_entries_
maximum of entries; adding more will delete the oldest one
Definition: RecentFilesMenu.h:112
OpenMS::RecentFilesMenu::recent_actions_
std::vector< QAction * > recent_actions_
.. and the actions to go with it
Definition: RecentFilesMenu.h:116
OpenMS::RecentFilesMenu::getMenu
QMenu * getMenu()
get a menu-pointer to an internal member which always contains the up-to-date recent items
OpenMS::Param
Management and storage of parameters / INI files.
Definition: Param.h:69
StandardTypes.h
OpenMS::RecentFilesMenu::RecentFilesMenu
RecentFilesMenu(int max_entries=15)
C'tor.
OpenMS::RecentFilesMenu::recent_files_
QStringList recent_files_
list of the recently opened files actions (menu entries)
Definition: RecentFilesMenu.h:114
OpenMS::RecentFilesMenu::getAsParam
Param getAsParam() const
Convert current file list to Param. Their names are just numbers, starting at "0"....