qtooltip.h Include File

Home | All Classes | Main Classes | Annotated | Grouped Classes | Functions |

# qtooltip.h

This is the verbatim text of the qtooltip.h include file. It is provided only for illustration; the copyright remains with Trolltech.

    /****************************************************************************
    ** $Id: qt/qtooltip.h   3.3.8   edited Jan 11 14:39 $
    **
    ** Definition of Tool Tips (or Balloon Help) for any widget or rectangle
    **
    ** Copyright (C) 1992-2007 Trolltech ASA.  All rights reserved.
    **
    ** This file is part of the widgets module of the Qt GUI Toolkit.
    **
    ** This file may be distributed under the terms of the Q Public License
    ** as defined by Trolltech ASA of Norway and appearing in the file
    ** LICENSE.QPL included in the packaging of this file.
    **
    ** This file may be distributed and/or modified under the terms of the
    ** GNU General Public License version 2 as published by the Free Software
    ** Foundation and appearing in the file LICENSE.GPL included in the
    ** packaging of this file.
    **
    ** Licensees holding valid Qt Enterprise Edition or Qt Professional Edition
    ** licenses may use this file in accordance with the Qt Commercial License
    ** Agreement provided with the Software.
    **
    ** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
    ** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
    **
    ** See http://www.trolltech.com/pricing.html or email sales@trolltech.com for
    **   information about Qt Commercial License Agreements.
    ** See http://www.trolltech.com/qpl/ for QPL licensing information.
    ** See http://www.trolltech.com/gpl/ for GPL licensing information.
    **
    ** Contact info@trolltech.com if any conditions of this licensing are
    ** not clear to you.
    **
    **********************************************************************/

    #ifndef QTOOLTIP_H
    #define QTOOLTIP_H

    #ifndef QT_H
    #include "qwidget.h"
    #endif // QT_H

    #ifndef QT_NO_TOOLTIP

    #if __GNUC__  - 0 > 3
    #pragma GCC system_header
    #endif

    class QTipManager;
    class QIconViewToolTip;
    class QListViewToolTip;

    class Q_EXPORT QToolTipGroup: public QObject
    {
        Q_OBJECT
        Q_PROPERTY( bool delay READ delay WRITE setDelay )
        Q_PROPERTY( bool enabled READ enabled WRITE setEnabled )

    public:
        QToolTipGroup( QObject *parent, const char *name = 0 );
       ~QToolTipGroup();

        bool delay() const;
        bool enabled() const;

    public slots:
        void setDelay( bool );
        void setEnabled( bool );

    signals:
        void showTip( const QString &);
        void removeTip();

    private:
        uint del:1;
        uint ena:1;

        friend class QTipManager;

    private:	// Disabled copy constructor and operator=
    #if defined(Q_DISABLE_COPY)
        QToolTipGroup( const QToolTipGroup & );
        QToolTipGroup& operator=( const QToolTipGroup & );
    #endif
    };

    class Q_EXPORT QToolTip: public Qt
    {
    public:
        QToolTip( QWidget *, QToolTipGroup * = 0 );
        //### add virtual d'tor for 4.0

        static void add( QWidget *, const QString &);
        static void add( QWidget *, const QString &,
    		     QToolTipGroup *, const QString& );
        static void remove( QWidget * );

        static void add( QWidget *, const QRect &, const QString &);
        static void add( QWidget *, const QRect &, const QString &,
    		     QToolTipGroup *, const QString& );
        static void remove( QWidget *, const QRect & );

        static QString textFor( QWidget *, const QPoint & pos = QPoint() );

        static void hide();

        static QFont    font();
        static void	    setFont( const QFont & );
        static QPalette palette();
        static void	    setPalette( const QPalette & );

    #ifndef QT_NO_COMPAT
        static void	    setEnabled( bool enable ) { setGloballyEnabled( enable ); }
        static bool	    enabled() { return isGloballyEnabled(); }
    #endif
        static void	    setGloballyEnabled( bool );
        static bool	    isGloballyEnabled();
        static void	    setWakeUpDelay(int);

    protected:
        virtual void maybeTip( const QPoint & ) = 0;
        void    tip( const QRect &, const QString &);
        void    tip( const QRect &, const QString& , const QString &);
        void    tip( const QRect &, const QString &, const QRect & );
        void    tip( const QRect &, const QString&, const QString &, const QRect &);

        void    clear();

    public:
        QWidget	  *parentWidget() const { return p; }
        QToolTipGroup *group()	  const { return g; }

    private:
        QWidget	    *p;
        QToolTipGroup   *g;
        static QFont    *ttFont;
        static QPalette *ttPalette;

        friend class QTipManager;
    };

    #endif // QT_NO_TOOLTIP

    #endif // QTOOLTIP_H