qtexteditlog.h 3.24 KB
Newer Older
1
2
3
4
// ================================================================================================
// 
// This file is part of the CAMPVis Software Framework.
// 
5
// If not explicitly stated otherwise: Copyright (C) 2012-2014, all rights reserved,
6
7
//      Christian Schulte zu Berge <christian.szb@in.tum.de>
//      Chair for Computer Aided Medical Procedures
8
9
//      Technische Universitaet Muenchen
//      Boltzmannstr. 3, 85748 Garching b. Muenchen, Germany
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
// 
// For a full list of authors and contributors, please refer to the file "AUTHORS.txt".
// 
// Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file 
// except in compliance with the License. You may obtain a copy of the License at
// 
// http://www.apache.org/licenses/LICENSE-2.0
// 
// Unless required by applicable law or agreed to in writing, software distributed under the 
// License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, 
// either express or implied. See the License for the specific language governing permissions 
// and limitations under the License.
// 
// ================================================================================================

25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
#ifndef QTEXTEDITLOG_H__
#define QTEXTEDITLOG_H__

#include "tgt/logmanager.h"

#include <QObject>
#include <QTextEdit>
#include <QTextDocument>

using namespace tgt;

namespace campvis {

    /**
     * QTextEditLog implements logging to a QTextEdit instance.
     */
    class QTextEditLog : private QObject, public Log {

        Q_OBJECT

    public:
        /**
         * Creates a new QTextEditLog.
         *
         * QTextEditLog doesn't take ownership of the QTextEdit instance it's passed.
         *
         * \param   output           a QTextEdit instance to which messages will be logged
52
         * \param   parent           the log's parent object
53
54
55
56
57
         * \param   dateStamping     should logged messages be date-stamped
         * \param   timeStamping     should logged messages be time-stamped
         * \param   showCat          should the category be printed along with the messages
         * \param   showLevel        should the LogLevel be printed along with the messages
         */
58
        explicit QTextEditLog(QTextEdit* logDisplay, QObject* parent = 0, bool dateStamping = true,
59
                     bool timeStamping = true, bool showCat = true, bool showLevel = true);
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
        virtual ~QTextEditLog() {}
        bool isOpen() { return true; }

	signals:
        /** Internal signal used to pass messages to _logDisplay in a thread-safe way.
         *
         * This class' \c log method is called from several non-GUI
         * threads. If it were to directly access its underlying
         * QTextEdit widget, which is neither thread-safe nor reentrant,
         * the application would break badly. However, if we connect
         * a signal to _logDisplay's append slot to display log
         * messages, Qt takes care of queueing slot accesses in the GUI
         * thread for us.
         */
        void s_messageReady(const QString& message);

    protected:
        QTextEdit* _logDisplay;
        void logFiltered(const std::string &cat, LogLevel level, const std::string &msg, const std::string &extendedInfo="");
    };
}

#endif // QTEXTEDITLOG_H__