kpassivepopup.h

Go to the documentation of this file.

// -*- c++ -*-

/*
 *   Copyright (C) 2001-2006 by Richard Moore <rich@kde.org>
 *   Copyright (C) 2004-2005 by Sascha Cunz <sascha.cunz@tiscali.de>
 *
 *   This library 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 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
 *   Lesser General Public License for more details.
 *
 *   You should have received a copy of the GNU Lesser General Public
 *   License along with this library; if not, write to the Free Software
 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */

#ifndef KPASSIVEPOPUP_H
#define KPASSIVEPOPUP_H

#include <kdeui_export.h>

#include <QtGui/QFrame>

class KVBox;
class QSystemTrayIcon;

class KDEUI_EXPORT KPassivePopup : public QFrame
{
    Q_OBJECT
    Q_PROPERTY (bool autoDelete READ autoDelete WRITE setAutoDelete )
    Q_PROPERTY (int timeout READ timeout WRITE setTimeout )
    Q_PROPERTY (QRect defaultArea READ defaultArea )

public:
    enum PopupStyle
    {
        Boxed,             
        Balloon,           
    CustomStyle=128    
    };

    explicit KPassivePopup( QWidget *parent=0, Qt::WFlags f = 0 );

    explicit KPassivePopup( WId parent );

#if 0 // These break macos and win32 where the definition of WId makes them ambiguous

    explicit KPassivePopup( int popupStyle, QWidget *parent=0, Qt::WFlags f=0 ) KDE_DEPRECATED;

    KPassivePopup( int popupStyle, WId parent, Qt::WFlags f=0 ) KDE_DEPRECATED;
#endif

    virtual ~KPassivePopup();

    void setView( QWidget *child );

    void setView( const QString &caption, const QString &text = QString() );

    virtual void setView( const QString &caption, const QString &text, const QPixmap &icon );

    KVBox * standardView( const QString& caption, const QString& text,
                          const QPixmap& icon, QWidget *parent = 0L );

    QWidget *view() const;

    int timeout() const;

    virtual void setAutoDelete( bool autoDelete );

    bool autoDelete() const;

    QRect defaultArea() const;

    QPoint anchor() const;

    void setAnchor( const QPoint& anchor );

    // TODO KDE4: give all the static methods a const QPoint p = QPoint() that in
    // case the point is not null calls the show(const QPoint &p) method instead
    // of the show() one.
    static KPassivePopup *message( const QString &text, QWidget *parent );

    static KPassivePopup *message( const QString &text, QSystemTrayIcon *parent );

    static KPassivePopup *message( const QString &caption, const QString &text,
                   QWidget *parent );

    static KPassivePopup *message( const QString &caption, const QString &text,
                   QSystemTrayIcon *parent );

    static KPassivePopup *message( const QString &caption, const QString &text,
                   const QPixmap &icon,
                   QWidget *parent, int timeout = -1 );

    static KPassivePopup *message( const QString &caption, const QString &text,
                   const QPixmap &icon,
                   QSystemTrayIcon *parent, int timeout = -1 );

    static KPassivePopup *message( const QString &caption, const QString &text,
                   const QPixmap &icon,
                   WId parent, int timeout = -1 );

    static KPassivePopup *message( int popupStyle, const QString &text, QWidget *parent );

    static KPassivePopup *message( int popupStyle, const QString &text, QSystemTrayIcon *parent );

    static KPassivePopup *message( int popupStyle, const QString &caption, const QString &text,
                   QSystemTrayIcon *parent );

    static KPassivePopup *message( int popupStyle, const QString &caption, const QString &text,
                   QWidget *parent );

    static KPassivePopup *message( int popupStyle, const QString &caption, const QString &text,
                   const QPixmap &icon,
                   QWidget *parent, int timeout = -1 );

    static KPassivePopup *message( int popupStyle, const QString &caption, const QString &text,
                   const QPixmap &icon,
                   QSystemTrayIcon *parent, int timeout = -1 );

    static KPassivePopup *message( int popupStyle, const QString &caption, const QString &text,
                   const QPixmap &icon,
                   WId parent, int timeout = -1 );


public Q_SLOTS:
    void setTimeout( int delay );

    void setPopupStyle( int popupstyle );

    void show();

    void show(const QPoint &p);

    virtual void setVisible(bool visible);

Q_SIGNALS:
    void clicked();

    void clicked( const QPoint &pos );

protected:
    virtual void positionSelf();

    virtual void hideEvent( QHideEvent * );

    void moveNear( const QRect &target );

    QPoint calculateNearbyPoint( const QRect &target);

    virtual void mouseReleaseEvent( QMouseEvent *e );

    void updateMask();

    virtual void paintEvent( QPaintEvent* pe );

private:
    void init( WId window );

    /* @internal */
    class Private;
    Private *const d;
};

#endif // KPASSIVEPOPUP_H

// Local Variables:
// c-basic-offset: 4
// End: