ktitlewidget.h

Go to the documentation of this file.

/* This file is part of the KDE libraries
   Copyright (C) 2007-2009 Urs Wolfer <uwolfer @ kde.org>

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License version 2 as published by the Free Software Foundation.

   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 KTITLEWIDGET_H
#define KTITLEWIDGET_H

#include <kdeui_export.h>

#include <QtGui/QWidget>

class KDEUI_EXPORT KTitleWidget : public QWidget
{
    Q_OBJECT
    Q_ENUMS(ImageAlignment)
    Q_PROPERTY(QString text READ text WRITE setText)
    Q_PROPERTY(QString comment READ comment WRITE setComment)
    Q_PROPERTY(QPixmap pixmap READ pixmap WRITE setPixmap)
    Q_PROPERTY(int autoHideTimeout READ autoHideTimeout WRITE setAutoHideTimeout)

public:
    enum ImageAlignment {
        ImageLeft, 
        ImageRight 
    };

    enum MessageType {
        PlainMessage, 
        InfoMessage, 
        WarningMessage, 
        ErrorMessage 
    };

    explicit KTitleWidget(QWidget *parent = 0);

    virtual ~KTitleWidget();

    void setWidget(QWidget *widget);

    QString text() const;

    QString comment() const;

    const QPixmap *pixmap() const;

    void setBuddy(QWidget *buddy);

    int autoHideTimeout() const;

public Q_SLOTS:
    void setText(const QString &text, Qt::Alignment alignment = Qt::AlignLeft | Qt::AlignVCenter);
    void setText(const QString &text, MessageType type);

    void setComment(const QString &comment, MessageType type = PlainMessage);

    void setPixmap(const QPixmap &pixmap, ImageAlignment alignment = ImageRight);

    void setPixmap(const QString &icon, ImageAlignment alignment = ImageRight);

    void setPixmap(const QIcon& icon, ImageAlignment alignment = ImageRight);

    void setPixmap(MessageType type, ImageAlignment alignment = ImageRight);

    void setAutoHideTimeout(int msecs);

protected:
    void changeEvent(QEvent *e);
    void showEvent(QShowEvent *event);
    bool eventFilter(QObject *object, QEvent *event);

private:
    class Private;
    Private* const d;

    Q_PRIVATE_SLOT(d, void _k_timeoutFinished())
    Q_DISABLE_COPY(KTitleWidget)
};

#endif