qgsmessageoutput.h

Go to the documentation of this file.

/***************************************************************************
    qgsmessageoutput.h  -  interface for showing messages
    ----------------------
    begin                : April 2006
    copyright            : (C) 2006 by Martin Dobias
    email                : wonder.sk at gmail dot com
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/


#ifndef QGSMESSAGEOUTPUT_H
#define QGSMESSAGEOUTPUT_H

#include <QString>
#include "qgis_sip.h"
#include <QObject>

#include "qgis_core.h"

class QgsMessageOutput;
typedef QgsMessageOutput *( *MESSAGE_OUTPUT_CREATOR )() SIP_SKIP;


class CORE_EXPORT QgsMessageOutput
{
  public:

    enum MessageType { MessageText, MessageHtml };

    virtual ~QgsMessageOutput() = default;

    virtual void setMessage( const QString &message, MessageType msgType ) = 0;

    virtual void appendMessage( const QString &message ) = 0;

    virtual void setTitle( const QString &title ) = 0;

    virtual void showMessage( bool blocking = true ) = 0;

    static void showMessage( const QString &title, const QString &message, MessageType msgType );

    // TODO: implementation where Python class could be passed
    static void setMessageOutputCreator( MESSAGE_OUTPUT_CREATOR f ) SIP_SKIP;

    static QgsMessageOutput *createMessageOutput();

  private:

    static MESSAGE_OUTPUT_CREATOR mMessageOutputCreator;
};


class CORE_EXPORT QgsMessageOutputConsole : public QObject, public QgsMessageOutput
{
    Q_OBJECT

  public:

    QgsMessageOutputConsole() = default;

    void setMessage( const QString &message, MessageType msgType ) override;

    void appendMessage( const QString &message ) override;

    void setTitle( const QString &title ) override;

    void showMessage( bool blocking = true ) override;

  signals:

    void destroyed();

  private:

    QString mMessage;

    QString mTitle;

    MessageType mMsgType = MessageText;
};

#endif