File indexing completed on 2024-11-24 04:53:03

 
 /* Copyright (C) 2006 - 2014 Jan Kundrát <jkt@flaska.net>
 
    This file is part of the Trojita Qt IMAP e-mail client,
    http://trojita.flaska.net/
 
    This program is free software; you can redistribute it and/or
    modify it under the terms of the GNU General Public License as
    published by the Free Software Foundation; either version 2 of
    the License or (at your option) version 3 or any later version
    accepted by the membership of KDE e.V. (or its successor approved
    by the membership of KDE e.V.), which shall act as a proxy
    defined in Section 14 of version 3 of the license.
 
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 #ifndef GUI_PROTOCOLLOGGERWIDGET_H
 #define GUI_PROTOCOLLOGGERWIDGET_H
 
 #include <QMap>
 #include <QWidget>
 #include "Common/FileLogger.h"
 #include "Common/RingBuffer.h"
 #include "Imap/ConnectionState.h"
 
 class QPushButton;
 class QTabWidget;
 class QPlainTextEdit;
 class QTimer;
 
 namespace Common {
 class FileLogger;
 }
 
 namespace Gui {
 
 /** @short Widget (etc) for a single connection */
 struct ConnectionLog {
     ConnectionLog();
     QPlainTextEdit *widget;
     Common::RingBuffer<Common::LogMessage> buffer;
     qint64 closedTime;
 };
 
 /** @short Protocol chat logger
 
 A widget used for displaying a log of textual communication between
 the client and the IMAP mail server.
 */
 class ProtocolLoggerWidget : public QWidget
 {
     Q_OBJECT
 public:
     explicit ProtocolLoggerWidget(QWidget *parent = 0);
     virtual ~ProtocolLoggerWidget();
 
 public slots:
     /** @short A protocol handler wants to log something */
     void log(uint connectionId, Common::LogMessage message);
 
     void onConnectionClosed(uint connectionId, Imap::ConnectionState state);
 
     /** @short Enable/disable persistent logging */
     void slotSetPersistentLogging(const bool enabled);
 
 private slots:
     /** @short A tab is requested to close */
     void closeTab(int index);
     /** @short Clear all logs */
     void clearLogDisplay();
 
     /** @short Copy contents of all buffers into the GUI widgets */
     void slotShowLogs();
 
 signals:
     void persistentLoggingChanged(const bool active);
 
 private:
     QTabWidget *tabs;
     QMap<uint, ConnectionLog> logs;
     QPushButton *clearAll;
     bool loggingActive;
     QTimer *delayedDisplay;
     Common::FileLogger *m_fileLogger;
 
     /** @short Return (possibly newly created) logger widget for a given parser */
     QPlainTextEdit *getLogger(const uint connectionId);
 
     /** @short Dump the log bufer contents to the GUI widget */
     void flushToWidget(const uint connectionId, Common::RingBuffer<Common::LogMessage> &buf);
 
     virtual void showEvent(QShowEvent *e);
     virtual void hideEvent(QHideEvent *e);
 };
 
 }
 
 #endif // GUI_PROTOCOLLOGGERWIDGET_H