OpenMS  3.0.0
INIFileEditorWindow.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: Timo Sachsenberg$
32 // $Authors: Marc Sturm $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
37 // OpenMS_GUI config
38 #include <OpenMS/VISUAL/OpenMS_GUIConfig.h>
39 
43 
44 #include <QtWidgets/QMdiArea>
45 #include <QtWidgets/QMainWindow>
46 
47 class QToolBar;
48 class QAction;
49 class QString;
50 class QFileDialog;
51 
52 namespace OpenMS
53 {
57  class OPENMS_GUI_DLLAPI INIFileEditorWindow :
58  public QMainWindow
59  {
60  Q_OBJECT
61 
62 public:
64  INIFileEditorWindow(QWidget * parent = nullptr);
66  void closeEvent(QCloseEvent * event) override;
67 
68 public slots:
70  bool openFile(const String & filename = "");
72  bool saveFile();
74  bool saveFileAs();
76  void updateWindowTitle(bool);
77 
78 private:
84  QString filename_;
87  };
88 }
89 
LogStream.h
OpenMS::INIFileEditorWindow::updateWindowTitle
void updateWindowTitle(bool)
if the user changes data in ParamEditor the title shows a '*'
Definition: INIFileEditorWindow.cpp:187
OpenMS::INIFileEditorWindow::param_
Param param_
Param object for storing data.
Definition: INIFileEditorWindow.h:82
OpenMS::INIFileEditorWindow::closeEvent
void closeEvent(QCloseEvent *event) override
when user closes window a message box asks the user if he wants to save
Definition: INIFileEditorWindow.cpp:156
OpenMS::File::basename
static String basename(const String &file)
OpenMS::StringUtils::toQString
static QString toQString(const String &this_s)
Definition: StringUtils.h:201
OpenMS::String
A more convenient string class.
Definition: String.h:58
ParamXMLFile.h
OpenMS::INIFileEditorWindow::saveFile
bool saveFile()
saves the users changes in a xml-file if the Param object is valid
Definition: INIFileEditorWindow.cpp:123
OpenMS::QApplicationTOPP
Extension to the QApplication for running TOPPs GUI tools.
Definition: QApplicationTOPP.h:50
OpenMS::ParamXMLFile
The file pendant of the Param class used to load and store the param datastructure as paramXML.
Definition: ParamXMLFile.h:49
OpenMS::Param::clear
void clear()
Deletes all entries.
QWidget
ParamEditor.h
OpenMS::Param::ParamIterator
Forward const iterator for the Param class.
Definition: Param.h:193
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
Exception.h
INIFileEditorWindow.h
OpenMS::ParamEditor::store
void store()
store edited data in Param object
OpenMS::INIFileEditorWindow::current_path_
String current_path_
path used as next default location of the load/store dialogs
Definition: INIFileEditorWindow.h:86
OpenMS::ParamEditor::isModified
bool isModified() const
Indicates if the data changed since last save.
OpenMS::INIFileEditorWindow::openFile
bool openFile(const String &filename="")
loads the xml-file into a Param object and loads Param into ParamEditor
Definition: INIFileEditorWindow.cpp:86
Param.h
OpenMS::Param::parseCommandLine
void parseCommandLine(const int argc, const char **argv, const std::string &prefix="")
Parses command line arguments.
OpenMS::INIFileEditorWindow::saveFileAs
bool saveFileAs()
like saveFile but with a file dialog to choose a filename
Definition: INIFileEditorWindow.cpp:138
OpenMS::Exception::BaseException
Exception base class.
Definition: Exception.h:89
OpenMS::Param::exists
bool exists(const std::string &key) const
Tests if a parameter is set (expecting its fully qualified name, e.g., TextExporter:1:proteins_only)
OpenMS::String::toQString
QString toQString() const
Conversion to Qt QString.
OpenMS::File::path
static String path(const String &file)
OpenMS::INIFileEditorWindow::filename_
QString filename_
filename of xml-file to store the Param object
Definition: INIFileEditorWindow.h:84
QMainWindow
OpenMS::ParamValue::toString
std::string toString(bool full_precision=true) const
Convert ParamValue to string.
main
int main(int argc, const char **argv)
Definition: INIFileEditor.cpp:71
OpenMS::Param::end
ParamIterator end() const
End iterator for the internal tree.
OPENMS_LOG_ERROR
#define OPENMS_LOG_ERROR
Macro to be used if non-fatal error are reported (processing continues)
Definition: LogStream.h:455
OpenMS::Param::begin
ParamIterator begin() const
Begin iterator for the internal tree.
OpenMS::INIFileEditorWindow::editor_
ParamEditor * editor_
ParamEditor object for visualization.
Definition: INIFileEditorWindow.h:80
ParamEditor
OpenMS::ParamEditor ParamEditor
Definition: SwathTabWidget.h:145
OpenMS::File::readable
static bool readable(const String &file)
Return true if the file exists and is readable.
OpenMS::ParamEditor
A GUI for editing or viewing a Param object.
Definition: ParamEditor.h:178
String.h
OpenMS::Param
Management and storage of parameters / INI files.
Definition: Param.h:69
OpenMS::ParamXMLFile::store
void store(const String &filename, const Param &param) const
Write XML file.
QApplicationTOPP.h
OpenMS::ParamXMLFile::load
void load(const String &filename, Param &param)
Read XML file.
OpenMS::INIFileEditorWindow
shows the ParamEditor widget in a QMainWindow with a toolbar
Definition: INIFileEditorWindow.h:57
OpenMS::ParamEditor::load
void load(Param &param)
load method for Param object
OpenMS::Param::getValue
const ParamValue & getValue(const std::string &key) const
Returns a value of a parameter.
File.h