ILogger.h

Go to the documentation of this file.

// SPDX-License-Identifier: LGPL-2.1-or-later OR GPL-2.0-or-later OR GPL-3.0-or-later OR LicenseRef-ACF-Commercial
#pragma once
 
 
// Qt includes
#include <QtCore/QString>
 
// ACF includes
#include <istd/IInformationProvider.h>
 
 
namespace istd
{
 
 
class ILogger: virtual public IPolymorphic
{
public:
       virtual bool IsLogConsumed(
                            const IInformationProvider::InformationCategory* categoryPtr = NULL,
                            const int* flagsPtr = NULL) const;
 
       virtual bool SendLogMessage(
                            IInformationProvider::InformationCategory category,
                            int id,
                            const QString& message,
                            const QString& messageSource,
                            int flags = 0) const;
 
protected:
       virtual void DecorateMessage(
                            IInformationProvider::InformationCategory category,
                            int id,
                            int flags,
                            QString& message,
                            QString& messageSource) const;
};
 
 
// inline methods
 
inline bool ILogger::IsLogConsumed(
                     const IInformationProvider::InformationCategory* /*categoryPtr*/,
                     const int* /*flagsPtr*/) const
{
       return false;
}
 
 
inline bool ILogger::SendLogMessage(
                     IInformationProvider::InformationCategory /*category*/,
                     int /*id*/,
                     const QString& /*message*/,
                     const QString& /*messageSource*/,
                     int /*flags*/) const
{
       return false;
}
 
 
// protected methods
 
inline void ILogger::DecorateMessage(
                     IInformationProvider::InformationCategory /*category*/,
                     int /*id*/,
                     int /*flags*/,
                     QString& /*message*/,
                     QString& /*messageSource*/) const
{
}
 
 
} // namespace istd