OpenMS  3.0.0
LogWindow.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 <QTextEdit>
43 
44 namespace OpenMS
45 {
46  class String;
47 
53  class LogWindow
54  : public QTextEdit
55  {
56  Q_OBJECT
57  Q_PROPERTY(int max_length READ maxLength WRITE setMaxLength)
58 
59  public:
61  enum LogState
62  {
66  };
67 
69  LogWindow(QWidget* parent);
70 
72  void appendText(const QString& text);
73 
75  void appendNewHeader(const LogState state, const String& heading, const String& body);
76 
78  void addNewline();
79 
81  int maxLength() const;
83  void setMaxLength(int max_length);
84 
85  signals:
86 
87  protected slots:
89  void trimText_();
90 
91  private:
92  void contextMenuEvent(QContextMenuEvent* event) override;
93  int max_length_ { -1 };
94  };
95 
96 } //namespace
97 
OpenMS::LogWindow::maxLength
int maxLength() const
read max_length
OpenMS::LogWindow
A log window (QTextEdit) with convenience functions.
Definition: LogWindow.h:53
QTextEdit
OpenMS::LogWindow::appendNewHeader
void appendNewHeader(const LogState state, const String &heading, const String &body)
appends a new block with heading and a body
OpenMS::LogWindow::LogWindow
LogWindow(QWidget *parent)
Default constructor.
OpenMS::LogWindow::NOTICE
Notice.
Definition: LogWindow.h:63
OpenMS::String
A more convenient string class.
Definition: String.h:58
QWidget
OpenMS::LogWindow::CRITICAL
Fatal error.
Definition: LogWindow.h:65
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
OpenMS::LogWindow::max_length
int max_length
Definition: LogWindow.h:57
OpenMS::LogWindow::trimText_
void trimText_()
if text length reached max_length_, then delete prefix until length of text is 1/2 of max_length_
OpenMS::LogWindow::LogState
LogState
Log message states.
Definition: LogWindow.h:61
OpenMS::LogWindow::contextMenuEvent
void contextMenuEvent(QContextMenuEvent *event) override
OpenMS::LogWindow::WARNING
Warning.
Definition: LogWindow.h:64
OpenMS::LogWindow::addNewline
void addNewline()
appends a line break (same as append(""))
StandardTypes.h
OpenMS::LogWindow::max_length_
int max_length_
-1 by default, which means there is no maximum length
Definition: LogWindow.h:93
OpenMS::LogWindow::setMaxLength
void setMaxLength(int max_length)
set max_length
OpenMS::LogWindow::appendText
void appendText(const QString &text)
appends text without adding line breaks and shows the log-window