message.h

/*  SPDX-License-Identifier: LGPL-2.0-or-later

    Copyright (C) 2012-2013 Dominik Haumann <[email protected]>

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library 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
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/

#ifndef KTEXTEDITOR_MESSAGE_H
#define KTEXTEDITOR_MESSAGE_H

#include <QAction>
#include <QIcon>
#include <QList>
#include <QObject>

#include <ktexteditor_export.h>

namespace KTextEditor
{
class View;
class Document;

class KTEXTEDITOR_EXPORT Message : public QObject
{
    Q_OBJECT

    //
    // public data types
    //
public:
    enum MessageType {
        Positive = 0, 
        Information,  
        Warning,      
        Error         
    };

    enum MessagePosition {
        AboveView = 0,
        BelowView,
        TopInView,
        BottomInView,
        CenterInView
    };

    enum AutoHideMode {
        Immediate = 0,       
        AfterUserInteraction 
    };

public:
    Message(const QString &richtext, MessageType type = Message::Information);

    virtual ~Message();

    QString text() const;

    QIcon icon() const;

    MessageType messageType() const;

    void addAction(QAction *action, bool closeOnTrigger = true);

    QList<QAction *> actions() const;

    void setAutoHide(int delay = 0);

    int autoHide() const;

    void setAutoHideMode(KTextEditor::Message::AutoHideMode mode);

    KTextEditor::Message::AutoHideMode autoHideMode() const;

    void setWordWrap(bool wordWrap);

    bool wordWrap() const;

    void setPriority(int priority);

    int priority() const;

    void setView(KTextEditor::View *view);

    KTextEditor::View *view() const;

    void setDocument(KTextEditor::Document *document);

    KTextEditor::Document *document() const;

    void setPosition(MessagePosition position);

    MessagePosition position() const;

public Q_SLOTS:
    void setText(const QString &richtext);

    void setIcon(const QIcon &icon);

Q_SIGNALS:
    void closed(KTextEditor::Message *message);

    void textChanged(const QString &text);

    void iconChanged(const QIcon &icon);

private:
    class MessagePrivate *const d;
};

}

#endif