LogTable.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: LogTable
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/LogMessage.h>
#include <QAbstractTableModel>
#include <QObject>
#include <QSortFilterProxyModel>
namespace NDEVR
{
    /**--------------------------------------------------------------------------------------------------
    \brief A model for creating a table that displays logged records.
    **/
    class NDEVR_WIDGETS_API LogViewTable : public QAbstractTableModel
    {
    public:
        LogViewTable(QObject* parent = nullptr);
        LogViewTable(const Buffer<LogMessage>& messages, QObject* parent = nullptr);
        void setMessageSearchTerms(const Buffer<String>& search_terms, uint04 range);
        virtual ~LogViewTable() {}
        int rowCount(const QModelIndex& parent) const override;
        int columnCount(const QModelIndex& parent) const override;
        QVariant data(const QModelIndex& index, int role) const override;
        QVariant headerData(int section, Qt::Orientation orientation, int role) const override;
        Qt::ItemFlags flags(const QModelIndex& index) const override;
        void clear();
        void setMessages(const Buffer<LogMessage>& messages);
        bool setData(const QModelIndex& index, const QVariant& value, int role = Qt::EditRole) override;
        bool insertRows(int position, int rows, const QModelIndex& index = QModelIndex()) override;
        bool removeRows(int position, int rows, const QModelIndex& index = QModelIndex()) override;
        void addMessage(const LogMessage& message);
        void addMessages(const Buffer<LogMessage>& messages);
        const Buffer<LogMessage>& messages() const { return m_messages; }
        void setDetectNewLines(bool detect_new_lines);
        void setShowMicroSeconds(bool show_microseconds);
        bool showMicroSeconds() const;
    private:
        Buffer<String> m_message_search_terms;
        uint04 m_search_range = 0;
        Buffer<LogMessage> m_messages;
        bool m_detect_new_lines;
        bool m_show_micro_seconds = false;
    };
    /**--------------------------------------------------------------------------------------------------
    \brief Sorts the logged entries in time-order.
    **/
    class SortedLogViewTable : public QSortFilterProxyModel
    {
    public:
        SortedLogViewTable(QObject* parent = nullptr);
        void setLogViewTable(LogViewTable* table);
        void setMessageSearchTerms(const Buffer<String>& search_terms, uint04 range);
        void setTimeSearchTerms(const Buffer<String>& search_terms);
        void setMinimumLevel(uint01 minimal_level);
        virtual bool filterAcceptsRow(int source_row, const QModelIndex& source_parent) const override;
        virtual bool filterAcceptsColumn(int source_column, const QModelIndex& source_parent) const override;
        virtual bool lessThan(const QModelIndex& source_left, const QModelIndex& source_right) const override;
    protected:
        Buffer<String> m_message_search_terms;
        Buffer<String> m_time_search_terms;
        uint01 m_minimum_level;
        LogViewTable* m_raw_log_view;
        uint04 m_search_range = 0;
    };
}