source: vbox/trunk/src/VBox/Frontends/VirtualBox/src/UIVMLogViewer.h@ 59833

/* $Id: UIVMLogViewer.h 59833 2016-02-26 10:19:23Z vboxsync $ */
/** @file
 * VBox Qt GUI - UIVMLogViewer class declaration.
 */

/*
 * Copyright (C) 2010-2015 Oracle Corporation
 *
 * This file is part of VirtualBox Open Source Edition (OSE), as
 * available from http://www.virtualbox.org. This file is free software;
 * you can redistribute it and/or modify it under the terms of the GNU
 * General Public License (GPL) as published by the Free Software
 * Foundation, in version 2 as it comes in the "COPYING" file of the
 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
 */

#ifndef ___UIVMLogViewer_h___
#define ___UIVMLogViewer_h___

/* Qt includes: */
#include <QMainWindow>
#include <QMap>
#include <QPair>

/* GUI includes: */
#include "QIWithRetranslateUI.h"
#include "UIVMLogViewer.gen.h"

/* COM includes: */
#include "COMEnums.h"
#include "CMachine.h"

/* Forward declarations: */
class QComboBox;
class QITabWidget;
class QPushButton;
class QTextEdit;
class UIVMLogViewer;
class UIVMLogViewerFilterPanel;
class UIVMLogViewerSearchPanel;

/* Type definitions: */
typedef QMap<QString, UIVMLogViewer*> VMLogViewerMap;
typedef QPair<QString, QTextEdit*> LogPage;
typedef QList<LogPage> LogBook;
typedef QMap<QTextEdit*, QString> VMLogMap;

/** QMainWindow extension
  * providing GUI with VirtualBox LogViewer. */
class UIVMLogViewer : public QIWithRetranslateUI2<QMainWindow>,
                      public Ui::UIVMLogViewer
{
    Q_OBJECT;

public:

    /** Static method to create/show VM Log Viewer by passing @a pParent to QWidget base-class constructor.
      * @param  machine  Specifies the machine for which VM Log-Viewer is requested. */
    static void showLogViewerFor(QWidget *pParent, const CMachine &machine);

protected:

    /** Constructs the VM Log-Viewer by passing @a pParent to QWidget base-class constructor.
      * @param  flags    Specifies Qt window flags.
      * @param  machine  Specifies the machine for which VM Log-Viewer is requested. */
    UIVMLogViewer(QWidget *pParent, Qt::WindowFlags flags, const CMachine &machine);
    /** Destructs the VM Log-Viewer. */
    ~UIVMLogViewer();

private slots:

    /** Handles search action triggering. */
    void search();
    /** Handles refresh action triggering. */
    void refresh();
    /** Handles close action triggering. */
    bool close();
    /** Handles save action triggering. */
    void save();
    /** Handles filter action triggering. */
    void filter();

private:

    /** @name Prepare/Cleanup
      * @{ */
        /** Prepares VM Log-Viewer. */
        void prepare();
        /** Prepares widgets. */
        void prepareWidgets();
        /** Prepares connections. */
        void prepareConnections();
        /** Load settings helper. */
        void loadSettings();

        /** Save settings helper. */
        void saveSettings();
        /** Cleanups VM Log-Viewer. */
        void cleanup();
    /** @} */

    /** @name Event handling stuff.
      * @{ */
        /** Handles translation event. */
        void retranslateUi();

        /** Handles Qt show @a pEvent. */
        void showEvent(QShowEvent *pEvent);
        /** Handles Qt key-press @a pEvent. */
        void keyPressEvent(QKeyEvent *pEvent);
    /** @} */

    /** Returns the current log-page. */
    QTextEdit* currentLogPage();
    /** Returns the newly created log-page using @a strPage filename. */
    QTextEdit* createLogPage(const QString &strPage);
    /** Returns the content of current log-page. */
    const QString& currentLog();

    /** Holds the list of all VM Log Viewers. */
    static VMLogViewerMap m_viewers;

    /** Holds whether the dialog is polished. */
    bool m_fIsPolished;

    /** Holds the machine instance. */
    CMachine m_machine;

    /** Holds container for log-pages. */
    QITabWidget *m_pViewerContainer;

    /** Holds the instance of search-panel. */
    UIVMLogViewerSearchPanel *m_pSearchPanel;

    /** Holds the list of log-pages. */
    LogBook m_book;

    /** Holds the instance of filter panel. */
    UIVMLogViewerFilterPanel *m_pFilterPanel;

    /** Holds the list of log-content. */
    VMLogMap m_logMap;

    /** Holds the current dialog geometry. */
    QRect m_geometry;

    /** Holds the help button instance. */
    QPushButton *m_pButtonHelp;
    /** Holds the find button instance. */
    QPushButton *m_pButtonFind;
    /** Holds the refresh button instance. */
    QPushButton *m_pButtonRefresh;
    /** Holds the close button instance. */
    QPushButton *m_pButtonClose;
    /** Holds the save button instance. */
    QPushButton *m_pButtonSave;
    /** Holds the filter button instance. */
    QPushButton *m_pButtonFilter;

    friend class UIVMLogViewerSearchPanel;
    friend class UIVMLogViewerFilterPanel;
};

#endif /* !___UIVMLogViewer_h___ */