LogDockerDock Class Reference

#include <LogDockerDock.h>

Inheritance diagram for LogDockerDock:

Public Member Functions
	LogDockerDock ()
QString	observerName () override
void	setCanvas (KoCanvasBase *canvas) override
void	setViewManager (KisViewManager *kisview) override
void	unsetCanvas () override
Public Member Functions inherited from KisMainwindowObserver
	KisMainwindowObserver ()
	~KisMainwindowObserver () override
Public Member Functions inherited from KoCanvasObserverBase
	KoCanvasObserverBase ()
KoCanvasBase *	observedCanvas () const
void	setObservedCanvas (KoCanvasBase *canvas)
void	unsetObservedCanvas ()
virtual	~KoCanvasObserverBase ()

Private Slots
void	changeTheme ()
void	clearLog ()
void	insertMessage (QtMsgType type, const QString &msg)
void	saveLog ()
void	settings ()
void	toggleLogging (bool toggle)

Private Member Functions
void	applyCategories ()

Static Private Member Functions
static void	messageHandler (QtMsgType type, const QMessageLogContext &context, const QString &msg)

Static Private Attributes
static QTextCharFormat	s_critical
static QTextCharFormat	s_debug
static QTextCharFormat	s_fatal
static QTextCharFormat	s_info
static MessageSender *	s_messageSender {new MessageSender()}
static QTextCharFormat	s_warning

Additional Inherited Members

Detailed Description

Definition at line 31 of file LogDockerDock.h.

Constructor & Destructor Documentation

LogDockerDock()

LogDockerDock::LogDockerDock

(

)

Definition at line 40 of file LogDockerDock.cpp.

    : QDockWidget(i18n("Log Viewer"))
{
    QWidget *page = new QWidget(this);
    setupUi(page);
    setWidget(page);
 
    bnToggle->setIcon(koIcon("view-list-text-16"));
    connect(bnToggle, SIGNAL(clicked(bool)), SLOT(toggleLogging(bool)));
    bnToggle->setChecked(KisConfig(true).readEntry<bool>("logviewer_enabled", false));
    toggleLogging(KisConfig(true).readEntry<bool>("logviewer_enabled", false));
 
    bnClear->setIcon(koIcon("edit-clear-16"));
    connect(bnClear, SIGNAL(clicked(bool)), SLOT(clearLog()));
 
    bnSave->setIcon(koIcon("document-save-16"));
    connect(bnSave, SIGNAL(clicked(bool)), SLOT(saveLog()));
 
    bnSettings->setIcon(koIcon("configure-thicker"));
    connect(bnSettings, SIGNAL(clicked(bool)), SLOT(settings()));
 
    qRegisterMetaType<QtMsgType>("QtMsgType");
    connect(s_messageSender, SIGNAL(emitMessage(QtMsgType,QString)), this, SLOT(insertMessage(QtMsgType,QString)), Qt::AutoConnection);
 
    changeTheme();
}

References changeTheme(), clearLog(), connect(), insertMessage(), koIcon, s_messageSender, saveLog(), settings(), and toggleLogging().

Member Function Documentation

applyCategories()

void LogDockerDock::applyCategories ( )

private

Definition at line 237 of file LogDockerDock.cpp.

{
    QStringList filters;
    KConfigGroup cfg( KSharedConfig::openConfig(), "LogDocker");
 
    filters << cfgToString("krita.general", cfg.readEntry("krita_41000", false));
    filters << cfgToString("krita.lib.resources", cfg.readEntry("resources_30009", false));
    filters << cfgToString("krita.core", cfg.readEntry("image_41001", false));
    filters << cfgToString("krita.registry", cfg.readEntry("registry_41002", false));
 
    filters << cfgToString("krita.tools", cfg.readEntry("tools_41003", false));
    filters << cfgToString("krita.lib.flake", cfg.readEntry("tools_41003", false));
 
    filters << cfgToString("krita.tiles", cfg.readEntry("tiles_41004", false));
    filters << cfgToString("krita.filters", cfg.readEntry("filters_41005", false));
 
    filters << cfgToString("krita.plugins", cfg.readEntry("plugins_41006", false));
    filters << cfgToString("krita.lib.plugin", cfg.readEntry("plugins_41006", false));
 
    filters << cfgToString("krita.ui", cfg.readEntry("ui_41007", false));
    filters << cfgToString("krita.widgets", cfg.readEntry("ui_41007", false));
    filters << cfgToString("krita.widgetutils", cfg.readEntry("ui_41007", false));
 
    filters << cfgToString("krita.file", cfg.readEntry("file_41008", false));
    filters << cfgToString("krita.lib.store", cfg.readEntry("file_41008", false));
    filters << cfgToString("krita.lib.odf", cfg.readEntry("file_41008", false));
 
    filters << cfgToString("krita.math", cfg.readEntry("math_41009", false));
    filters << cfgToString("krita.grender", cfg.readEntry("render_41010", false));
    filters << cfgToString("krita.scripting", cfg.readEntry("script_41011", false));
    filters << cfgToString("krita.input", cfg.readEntry("input_41012", false));
    filters << cfgToString("krita.action", cfg.readEntry("action_41013", false));
    filters << cfgToString("krita.tablet", cfg.readEntry("tablet_41014", false));
    filters << cfgToString("krita.opengl", cfg.readEntry("opengl_41015", false));
    filters << cfgToString("krita.metadata", cfg.readEntry("metadata_41016", false));
 
    filters << cfgToString("krita.lib.pigment", cfg.readEntry("pigment", false));
 
    QLoggingCategory::setFilterRules(filters.join("\n"));
}

References cfgToString().

changeTheme

void LogDockerDock::changeTheme ( )

privateslot

Definition at line 315 of file LogDockerDock.cpp.

{
    clearLog();
    QColor background = qApp->palette().window().color();
    if (background.value() > 100) {
        s_debug.setForeground(Qt::black);
        s_info.setForeground(Qt::darkGreen);
        s_warning.setForeground(Qt::darkYellow);
        s_critical.setForeground(Qt::darkRed);
        s_fatal.setForeground(Qt::darkRed);
    }
    else {
        s_debug.setForeground(Qt::white);
        s_info.setForeground(Qt::green);
        s_warning.setForeground(Qt::yellow);
        s_critical.setForeground(Qt::red);
        s_fatal.setForeground(Qt::red);
    }
    s_fatal.setFontWeight(QFont::Bold);
}

References clearLog(), s_critical, s_debug, s_fatal, s_info, and s_warning.

clearLog

void LogDockerDock::clearLog ( )

privateslot

Definition at line 94 of file LogDockerDock.cpp.

{
    txtLogViewer->document()->clear();
}

insertMessage

void LogDockerDock::insertMessage ( QtMsgType type, const QString & msg )

privateslot

Definition at line 286 of file LogDockerDock.cpp.

{
    QTextDocument *doc = txtLogViewer->document();
    QTextCursor cursor(doc);
    cursor.movePosition(QTextCursor::End, QTextCursor::MoveAnchor);
    cursor.beginEditBlock();
 
    switch (type) {
    case QtDebugMsg:
        cursor.insertText(msg + "\n", s_debug);
        break;
    case QtInfoMsg:
        cursor.insertText(msg + "\n", s_info);
        break;
    case QtWarningMsg:
        cursor.insertText(msg + "\n", s_warning);
        break;
    case QtCriticalMsg:
        cursor.insertText(msg + "\n", s_critical);
        break;
    case QtFatalMsg:
        cursor.insertText(msg + "\n", s_fatal);
        break;
    }
 
    cursor.endEditBlock();
    txtLogViewer->verticalScrollBar()->setValue(txtLogViewer->verticalScrollBar()->maximum());
}

References s_critical, s_debug, s_fatal, s_info, and s_warning.

messageHandler()

void LogDockerDock::messageHandler ( QtMsgType type, const QMessageLogContext & context, const QString & msg )

staticprivate

Definition at line 278 of file LogDockerDock.cpp.

{
    s_messageSender->sendMessage(type, msg);
    if (s_originalMessageHandler) {
        s_originalMessageHandler(type, context, msg);
    }
}

References s_messageSender, s_originalMessageHandler, and MessageSender::sendMessage().

observerName()

QString LogDockerDock::observerName ( )

inlineoverridevirtual

Reimplemented from KoCanvasObserverBase.

Definition at line 35 of file LogDockerDock.h.

{ return "LogDockerDock"; }

saveLog

void LogDockerDock::saveLog ( )

privateslot

Definition at line 99 of file LogDockerDock.cpp.

{
    KoFileDialog fileDialog(this, KoFileDialog::SaveFile, "logfile");
    fileDialog.setDefaultDir(QStandardPaths::writableLocation(QStandardPaths::DesktopLocation) + "/" + QString("krita_%1.log").arg(QDateTime::currentDateTime().toString("yyyy-MM-ddThh")));
    QString filename = fileDialog.filename();
    if (!filename.isEmpty()) {
        QFile f(filename);
        f.open(QFile::WriteOnly);
        f.write(txtLogViewer->document()->toPlainText().toUtf8());
        f.close();
    }
}

References KoFileDialog::filename(), KoFileDialog::SaveFile, and KoFileDialog::setDefaultDir().

setCanvas()

void LogDockerDock::setCanvas ( KoCanvasBase * canvas )

overridevirtual

re-implement this method in your canvas observer. It will be called whenever a canvas becomes active. Note that you are responsible for not connecting more than one time to the signals of a canvas or any of the QObjects you can access through the canvas.

Implements KoCanvasObserverBase.

Definition at line 67 of file LogDockerDock.cpp.

{
    setEnabled(true);
}

settings

void LogDockerDock::settings ( )

privateslot

Definition at line 112 of file LogDockerDock.cpp.

{
    KoDialog dlg(this);
    dlg.setButtons(KoDialog::Ok | KoDialog::Cancel);
    dlg.setCaption(i18n("Log Settings"));
    QWidget *page = new QWidget(&dlg);
    dlg.setMainWidget(page);
    QVBoxLayout *layout = new QVBoxLayout(page);
 
    KConfigGroup cfg( KSharedConfig::openConfig(), "LogDocker");
 
    QCheckBox *chkKrita = new QCheckBox(i18n("General"), page);
    chkKrita->setChecked(cfg.readEntry("krita_41000", false));
    layout->addWidget(chkKrita);
 
    QCheckBox *chkResources = new QCheckBox(i18n("Resource Management"), page);
    chkResources->setChecked(cfg.readEntry("resources_30009", false));
    layout->addWidget(chkResources);
 
    QCheckBox *chkImage = new QCheckBox(i18n("Image Core"), page);
    chkImage->setChecked(cfg.readEntry("image_41001", false));
    layout->addWidget(chkImage);
 
    QCheckBox *chkRegistry = new QCheckBox(i18n("Registries"), page);
    chkRegistry->setChecked(cfg.readEntry("registry_41002", false));
    layout->addWidget(chkRegistry);
 
    QCheckBox *chkTools = new QCheckBox(i18n("Tools"), page);
    chkTools->setChecked(cfg.readEntry("tools_41003", false));
    layout->addWidget(chkTools);
 
    QCheckBox *chkTiles = new QCheckBox(i18n("Tile Engine"), page);
    chkTiles->setChecked(cfg.readEntry("tiles_41004", false));
    layout->addWidget(chkTiles);
 
    QCheckBox *chkFilters = new QCheckBox(i18nc("Filter as an effect", "Filters"), page);
    chkFilters->setChecked(cfg.readEntry("filters_41005", false));
    layout->addWidget(chkFilters);
 
    QCheckBox *chkPlugins = new QCheckBox(i18n("Plugin Management"), page);
    chkPlugins->setChecked(cfg.readEntry("plugins_41006", false));
    layout->addWidget(chkPlugins);
 
    QCheckBox *chkUi = new QCheckBox(i18n("User Interface"), page);
    chkUi->setChecked(cfg.readEntry("ui_41007", false));
    layout->addWidget(chkUi);
 
    QCheckBox *chkFile = new QCheckBox(i18n("File loading and saving"), page);
    chkFile->setChecked(cfg.readEntry("file_41008", false));
    layout->addWidget(chkFile);
 
    QCheckBox *chkMath = new QCheckBox(i18n("Mathematics and calculations"), page);
    chkMath->setChecked(cfg.readEntry("math_41009", false));
    layout->addWidget(chkMath);
 
    QCheckBox *chkRender = new QCheckBox(i18n("Image Rendering"), page);
    chkRender->setChecked(cfg.readEntry("render_41010", false));
    layout->addWidget(chkRender);
 
    QCheckBox *chkScript = new QCheckBox(i18n("Scripting"), page);
    chkScript->setChecked(cfg.readEntry("script_41011", false));
    layout->addWidget(chkScript);
 
    QCheckBox *chkInput = new QCheckBox(i18n("Input handling"), page);
    chkInput->setChecked(cfg.readEntry("input_41012", false));
    layout->addWidget(chkInput);
 
    QCheckBox *chkAction = new QCheckBox(i18n("Actions"), page);
    chkAction->setChecked(cfg.readEntry("action_41013", false));
    layout->addWidget(chkAction);
 
    QCheckBox *chkTablet = new QCheckBox(i18n("Tablet Handling"), page);
    chkTablet->setChecked(cfg.readEntry("tablet_41014", false));
    layout->addWidget(chkTablet);
 
    QCheckBox *chkOpenGL = new QCheckBox(i18n("GPU Canvas"), page);
    chkOpenGL->setChecked(cfg.readEntry("opengl_41015", false));
    layout->addWidget(chkOpenGL);
 
    QCheckBox *chkMetaData = new QCheckBox(i18n("Metadata"), page);
    chkMetaData->setChecked(cfg.readEntry("metadata_41016", false));
    layout->addWidget(chkMetaData);
 
    QCheckBox *chkPigment = new QCheckBox(i18n("Color Management"), page);
    chkPigment->setChecked(cfg.readEntry("pigment", false));
    layout->addWidget(chkPigment);
 
 
    if (dlg.exec()) {
        // Apply the new settings
        cfg.writeEntry("resources_30009", chkResources->isChecked());
        cfg.writeEntry("krita_41000", chkKrita->isChecked());
        cfg.writeEntry("image_41001", chkImage->isChecked());
        cfg.writeEntry("registry_41002", chkRegistry->isChecked());
        cfg.writeEntry("tools_41003", chkTools->isChecked());
        cfg.writeEntry("tiles_41004", chkTiles->isChecked());
        cfg.writeEntry("filters_41005", chkFilters->isChecked());
        cfg.writeEntry("plugins_41006", chkPlugins->isChecked());
        cfg.writeEntry("ui_41007", chkUi->isChecked());
        cfg.writeEntry("file_41008", chkFile->isChecked());
        cfg.writeEntry("math_41009", chkMath->isChecked());
        cfg.writeEntry("render_41010", chkRender->isChecked());
        cfg.writeEntry("script_41011", chkScript->isChecked());
        cfg.writeEntry("input_41012", chkInput->isChecked());
        cfg.writeEntry("action_41013", chkAction->isChecked());
        cfg.writeEntry("tablet_41014", chkTablet->isChecked());
        cfg.writeEntry("opengl_41015", chkOpenGL->isChecked());
        cfg.writeEntry("metadata_41016", chkMetaData->isChecked());
        cfg.writeEntry("pigment", chkPigment->isChecked());
 
        if (bnToggle->isChecked()) {
            applyCategories();
        }
    }
 
}

References applyCategories(), KoDialog::Cancel, KoDialog::Ok, KoDialog::setButtons(), KoDialog::setCaption(), and KoDialog::setMainWidget().

setViewManager()

void LogDockerDock::setViewManager ( KisViewManager * kisview )

overridevirtual

Implements KisMainwindowObserver.

Definition at line 72 of file LogDockerDock.cpp.

{
    connect(kisview->mainWindow(), SIGNAL(themeChanged()), SLOT(changeTheme()));
}

References changeTheme(), connect(), and KisViewManager::mainWindow().

toggleLogging

void LogDockerDock::toggleLogging ( bool toggle )

privateslot

Definition at line 77 of file LogDockerDock.cpp.

{
    KisConfig(false).writeEntry<bool>("logviewer_enabled", toggle);
    if (toggle) {
        const QtMessageHandler oldHandler = qInstallMessageHandler(messageHandler);
        if (!s_originalMessageHandler) {
            s_originalMessageHandler = oldHandler;
        }
        applyCategories();
    }
    else {
        qInstallMessageHandler(nullptr);
        QLoggingCategory::setFilterRules(QString());
    }
 
}

References applyCategories(), messageHandler(), s_originalMessageHandler, and KisConfig::writeEntry().

unsetCanvas()

void LogDockerDock::unsetCanvas ( )

inlineoverridevirtual

Re-implement to notify the observer that its canvas is no longer among the living. The daisies, it is pushing up. This means you don't have to disconnect, it's dead.

The old canvas should be deleted already, so if you stored a pointer to it, don't touch!

Note that currently there is a bug where in certain specific circumstances unsetCanvas can be called when it shouldn't, see for example KWStatisticsDocker for a workaround for this problem.

Implements KoCanvasObserverBase.

Definition at line 37 of file LogDockerDock.h.

{}

Member Data Documentation

s_critical

QTextCharFormat LogDockerDock::s_critical

staticprivate

Definition at line 57 of file LogDockerDock.h.

s_debug

QTextCharFormat LogDockerDock::s_debug

staticprivate

Definition at line 54 of file LogDockerDock.h.

s_fatal

QTextCharFormat LogDockerDock::s_fatal

staticprivate

Definition at line 58 of file LogDockerDock.h.

s_info

QTextCharFormat LogDockerDock::s_info

staticprivate

Definition at line 55 of file LogDockerDock.h.

s_messageSender

MessageSender * LogDockerDock::s_messageSender {new MessageSender()}

staticprivate

Definition at line 31 of file LogDockerDock.h.

: public QDockWidget, public KisMainwindowObserver, public Ui_WdgLogDocker {

s_warning

QTextCharFormat LogDockerDock::s_warning

staticprivate

Definition at line 56 of file LogDockerDock.h.

---

The documentation for this class was generated from the following files:

• plugins/dockers/logdocker/LogDockerDock.h
• plugins/dockers/logdocker/LogDockerDock.cpp