kpassivepopup.h

/*
 *   Copyright            : (C) 2001-2002 by Richard Moore
 *   Copyright            : (C) 2004-2005 by Sascha Cunz
 *   License              : This file is released under the terms of the LGPL, version 2.
 *   Email                : rich@kde.org
 *   Email                : sascha.cunz@tiscali.de
 */
 
#ifndef KPASSIVEPOPUP_H
#define KPASSIVEPOPUP_H
 
#include <tqframe.h>
 
#include <tdelibs_export.h>
 
class TQBoxLayout;
class TQTimer;
class TQLabel;
class TQVBox;

class TDEUI_EXPORT KPassivePopup : public TQFrame
{
    TQ_OBJECT
    TQ_PROPERTY (bool autoDelete READ autoDelete WRITE setAutoDelete )
    TQ_PROPERTY (int timeout READ timeout WRITE setTimeout )
 
public:
    enum PopupStyle
    {
        Boxed,             
        Balloon,           
    CustomStyle=128    
    };

    KPassivePopup( TQWidget *parent=0, const char *name=0, WFlags f=0 );

    KPassivePopup( WId parent, const char *name=0, WFlags f=0 );

    KPassivePopup( int popupStyle, TQWidget *parent=0, const char *name=0, WFlags f=0 );

    KPassivePopup( int popupStyle, WId parent, const char *name=0, WFlags f=0 );

    virtual ~KPassivePopup();

    void setView( TQWidget *child );

    void setView( const TQString &caption, const TQString &text = TQString::null );

    virtual void setView( const TQString &caption, const TQString &text, const TQPixmap &icon );

    TQVBox * standardView( const TQString& caption, const TQString& text,
                          const TQPixmap& icon, TQWidget *parent = 0L );

    TQWidget *view() const { return msgView; }

    int timeout() const { return hideDelay; }

    virtual void setAutoDelete( bool autoDelete );

    bool autoDelete() const { return m_autoDelete; }

    void setAnchor( const TQPoint& anchor );
 
    // TODO KDE4: give all the statics method a const TQPoint p = TQPoint() that in 
    // case the point is not null calls the show(cosnt TQPoint &p) method instead
    // the show() one.
    static KPassivePopup *message( const TQString &text, TQWidget *parent, const char *name=0 );

    static KPassivePopup *message( const TQString &caption, const TQString &text,
                   TQWidget *parent, const char *name=0 );

    static KPassivePopup *message( const TQString &caption, const TQString &text,
                   const TQPixmap &icon,
                   TQWidget *parent, const char *name=0, int timeout = -1 );

    static KPassivePopup *message( const TQString &caption, const TQString &text,
                   const TQPixmap &icon,
                   WId parent, const char *name=0, int timeout = -1 );

    static KPassivePopup *message( int popupStyle, const TQString &text, TQWidget *parent,
                   const char *name=0 );

    static KPassivePopup *message( int popupStyle, const TQString &caption, const TQString &text,
                   TQWidget *parent, const char *name=0 );

    static KPassivePopup *message( int popupStyle, const TQString &caption, const TQString &text,
                   const TQPixmap &icon,
                   TQWidget *parent, const char *name=0, int timeout = -1 );

    static KPassivePopup *message( int popupStyle, const TQString &caption, const TQString &text,
                   const TQPixmap &icon,
                   WId parent, const char *name=0, int timeout = -1 );
 
 
public slots:
    void setTimeout( int delay );

    virtual void show();

    void show(const TQPoint &p);
 
signals:
    void clicked();

    void clicked( TQPoint pos );

    void hidden(KPassivePopup*);
 
protected:
    virtual void positionSelf();

    virtual void hideEvent( TQHideEvent * );

    void moveNear( TQRect target );

    virtual void mouseReleaseEvent( TQMouseEvent *e );

    TQRect defaultArea() const;

    void updateMask();

    virtual void paintEvent( TQPaintEvent* pe );
 
private:
    void init( int popupStyle );
 
    WId window;
    TQWidget *msgView;
    TQBoxLayout *topLayout;
    int hideDelay;
    TQTimer *hideTimer;
 
    TQLabel *ttlIcon;
    TQLabel *ttl;
    TQLabel *msg;
 
    bool m_autoDelete;
 
    /* @internal */
    class Private;
    Private *d;
};
 
#endif // KPASSIVEPOPUP_H