LogView.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
The above copyright notice and this permission notice shall be included in all 
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
 
Library: Widgets
File: LogView
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/LogStream.h>
#include <QWidget>
#include <QPointer>
class QPushButton;
class QComboBox;
class QLabel;
class QProgressBar;
class QTableView;
namespace NDEVR
{
    class FileChooserDialog;
    class AsciiFileOutputStream;
    class LogViewTable;
    class SortedLogViewTable;
    class Button;
    class Toggle;
    class QCustomLineEdit;
    class QCustomComboBox;
    /**--------------------------------------------------------------------------------------------------
    \brief A table showing a specific log that allows the user to scroll around to view various log entries.
    **/
    class NDEVR_WIDGETS_API LogView : public QWidget, public LogStream
    {
        Q_OBJECT
    public:
        LogView(QWidget *parent = nullptr);
        ~LogView();
        void showTimes(bool show_times);
        void showLogConsole(bool show_log_console);
        QSize sizeHint() const override;
        QPointer<QProgressBar> createProgressBar(bool auto_hide = true);
        void attachProgressBar(QPointer<QProgressBar> bar, bool auto_hide = true);
        void clearLog();
        void jumpToBottom();
        void addWidgetToTop(QWidget* widget);
        bool isAtBottom() const;
        void changeEvent(QEvent* e) override;
        void setProgressFormat(const String& format);
        void resizeEvent(QResizeEvent* size) override;
        void setDetectNewLines(bool detect);
        void setProgress(fltp04 progress) final override;
        void addMessage(const LogMessage& message) final override;
        void addMessages(const Buffer<LogMessage>& messages) final override;
        void attach(ProgressInfo* stream) final override;
        void setMinimumLogLevel(uint01 log_level);
    signals:
        void requestUpdateLogSignal();
    private slots:
        void contextMenu(const QPoint &pos);
        void updateLog();
        void setLogFile();
        void moveSliderToBottom(int, int);
        void selected();
        void updateSearch();
    private:
        void createMessageTable();
        void allowCancel(bool) final override {}
    private:
        Button* m_save_button;
        QCustomLineEdit* m_search_show_span;
        QCustomComboBox* m_log_level;
        QCustomLineEdit* m_search_edit;
        QTableView* m_message_view;
        LogViewTable* m_message_table;
        SortedLogViewTable* m_sorted_table;
        Buffer<QPointer<QProgressBar>> m_progress_bars;
        Buffer<bool> m_progress_auto_hide;
        Buffer<LogMessage> m_pending_messages;
        FileChooserDialog* m_file_chooser;
        AsciiFileOutputStream* m_ascii_stream;
        Time m_last_scroll_time;
        Toggle* m_show_micro_seconds;
        fltp04 m_progress;
        bool m_update_messages; 
        bool m_show_times;
        bool m_show_log_console;
        bool m_auto_scroll_to_bottom;
    };
}