PimCommon::CustomLogWidget Class

The CustomLogWidget class provides a widget for displaying custom log messages Author: Laurent Montel <montel@kde.org>. More...

Header: #include <PimCommon/CustomLogWidget>
CMake: find_package(KPim6PimCommon REQUIRED)
target_link_libraries(mytarget PRIVATE KPim6::PimCommon)

Public Functions

CustomLogWidget(QWidget *parent = nullptr)
virtual ~CustomLogWidget() override
void addEndLineLogEntry()
void addErrorLogEntry(const QString &log)
void addInfoLogEntry(const QString &log)
void addTitleLogEntry(const QString &log)
bool isEmpty() const
QString toHtml() const
QString toPlainText() const

Detailed Description

Member Function Documentation

[explicit] CustomLogWidget::CustomLogWidget(QWidget *parent = nullptr)

Constructs a CustomLogWidget. @param parent The parent widget

[override virtual noexcept] CustomLogWidget::~CustomLogWidget()

Destructs the CustomLogWidget.

void CustomLogWidget::addEndLineLogEntry()

Adds an end-of-line log entry.

void CustomLogWidget::addErrorLogEntry(const QString &log)

Adds an error log entry to the widget. @param log The error message to add

void CustomLogWidget::addInfoLogEntry(const QString &log)

Adds an info log entry to the widget. @param log The log message to add

void CustomLogWidget::addTitleLogEntry(const QString &log)

Adds a title log entry to the widget. @param log The title to add

bool CustomLogWidget::isEmpty() const

Returns whether the log is empty. @return true if the log has no entries, false otherwise

QString CustomLogWidget::toHtml() const

Returns the log contents as HTML. @return The log as HTML string

QString CustomLogWidget::toPlainText() const

Returns the log contents as plain text. @return The log as plain text string