Source code for spinetoolbox.logger_interface

######################################################################################################################
# Copyright (C) 2017-2021 Spine project consortium
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
# any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
# without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
# Public License for more details. You should have received a copy of the GNU Lesser General Public License along with
# this program. If not, see <http://www.gnu.org/licenses/>.
######################################################################################################################

"""
A logger interface.

:authors: A. Soininen (VTT)
:date:   16.1.2020
"""

from PySide2.QtCore import QObject, Signal


[docs]class LoggerInterface(QObject):
    """
    Placeholder for signals that can be emitted to send messages to an output device.

    The signals should be connected to a concrete logging system.

    Currently, this is just a 'model interface'. ToolboxUI contains the same signals so it can be used
    as a drop-in replacement for this class.
    """

[docs]    msg = Signal(str)
    """Emits a notification message."""
[docs]    msg_success = Signal(str)
    """Emits a message on success"""
[docs]    msg_warning = Signal(str)
    """Emits a warning message."""
[docs]    msg_error = Signal(str)
    """Emits an error message."""
[docs]    msg_proc = Signal(str)
    """Emits a message originating from a subprocess (usually something printed to stdout)."""
[docs]    msg_proc_error = Signal(str)
    """Emits an error message originating from a subprocess (usually something printed to stderr)."""
[docs]    information_box = Signal(str, str)
    """Requests an 'information message box' (e.g. a message window) to be opened with a given title and message."""
[docs]    error_box = Signal(str, str)
    """Requests an 'error message box' to be opened with a given title and message."""