qtoolbutton.h Include File

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

# qtoolbutton.h

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

    /****************************************************************************
    ** $Id: qt/qtoolbutton.h   3.3.8   edited Jan 11 14:39 $
    **
    ** Definition of QToolButton class
    **
    ** Created : 979899
    **
    ** 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 used under the terms of the GNU General Public
    ** License versions 2.0 or 3.0 as published by the Free Software
    ** Foundation and appearing in the file LICENSE.GPL included in the
    ** packaging of this file. Alternatively you may (at your option) use any
    ** later version of the GNU General Public License if such license has
    ** been publicly approved by Trolltech ASA (or its successors, if any)
    ** and the KDE Free Qt Foundation.
    **
    ** Please review the following information to ensure GNU General
    ** Public Licensing requirements will be met:
    ** http://trolltech.com/products/qt/licenses/licensing/opensource/.
    ** If you are unsure which license is appropriate for your use, please
    ** review the following information:
    ** http://trolltech.com/products/qt/licenses/licensing/licensingoverview
    ** or contact the sales department at sales@trolltech.com.
    **
    ** This file may be used under the terms of the Q Public License as
    ** defined by Trolltech ASA and appearing in the file LICENSE.QPL
    ** included in the packaging of this file.  Licensees holding valid Qt
    ** Commercial 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 WARRANTIES OF DESIGN, MERCHANTABILITY AND FITNESS FOR
    ** A PARTICULAR PURPOSE. Trolltech reserves all rights not granted
    ** herein.
    **
    **********************************************************************/

    #ifndef QTOOLBUTTON_H
    #define QTOOLBUTTON_H

    #ifndef QT_H
    #include "qbutton.h"
    #include "qstring.h"
    #include "qpixmap.h"
    #include "qiconset.h"
    #endif // QT_H

    #ifndef QT_NO_TOOLBUTTON

    class QToolButtonPrivate;
    class QToolBar;
    class QPopupMenu;

    class Q_EXPORT QToolButton : public QButton
    {
        Q_OBJECT
        Q_ENUMS( TextPosition )

        Q_PROPERTY( QIconSet iconSet READ iconSet WRITE setIconSet )
        Q_PROPERTY( QIconSet onIconSet READ onIconSet WRITE setOnIconSet DESIGNABLE false STORED false )
        Q_PROPERTY( QIconSet offIconSet READ offIconSet WRITE setOffIconSet DESIGNABLE false STORED false )
        Q_PROPERTY( bool usesBigPixmap READ usesBigPixmap WRITE setUsesBigPixmap )
        Q_PROPERTY( bool usesTextLabel READ usesTextLabel WRITE setUsesTextLabel )
        Q_PROPERTY( QString textLabel READ textLabel WRITE setTextLabel )
        Q_PROPERTY( int popupDelay READ popupDelay WRITE setPopupDelay )
        Q_PROPERTY( bool autoRaise READ autoRaise WRITE setAutoRaise )
        Q_PROPERTY( TextPosition textPosition READ textPosition WRITE setTextPosition )

        Q_OVERRIDE( bool toggleButton WRITE setToggleButton )
        Q_OVERRIDE( bool on WRITE setOn )
        Q_OVERRIDE( QPixmap pixmap DESIGNABLE false STORED false )
        Q_OVERRIDE( BackgroundMode backgroundMode DESIGNABLE true)

    public:
        enum TextPosition {
    	BesideIcon,
    	BelowIcon,
    	Right = BesideIcon, // obsolete
    	Under = BelowIcon // obsolete
        };
        QToolButton( QWidget * parent, const char* name=0 );
    #ifndef QT_NO_TOOLBAR
        QToolButton( const QIconSet& s, const QString &textLabel,
    		 const QString& grouptext,
    		 QObject * receiver, const char* slot,
    		 QToolBar * parent, const char* name=0 );
    #endif
        QToolButton( ArrowType type, QWidget *parent, const char* name=0 );
        ~QToolButton();

        QSize sizeHint() const;
        QSize minimumSizeHint() const;

    #ifndef QT_NO_COMPAT
        void setOnIconSet( const QIconSet& );
        void setOffIconSet( const QIconSet& );
        void setIconSet( const QIconSet &, bool on );
        QIconSet onIconSet() const;
        QIconSet offIconSet( ) const;
        QIconSet iconSet( bool on ) const;
    #endif
        virtual void setIconSet( const QIconSet & );
        QIconSet iconSet() const;

        bool usesBigPixmap() const { return ubp; }
        bool usesTextLabel() const { return utl; }
        QString textLabel() const { return tl; }

    #ifndef QT_NO_POPUPMENU
        void setPopup( QPopupMenu* popup );
        QPopupMenu* popup() const;

        void setPopupDelay( int delay );
        int popupDelay() const;

        void openPopup();
    #endif

        void setAutoRaise( bool enable );
        bool autoRaise() const;
        TextPosition textPosition() const;

        void setText( const QString &txt );

    public slots:
        virtual void setUsesBigPixmap( bool enable );
        virtual void setUsesTextLabel( bool enable );
        virtual void setTextLabel( const QString &, bool );

        virtual void setToggleButton( bool enable );

        virtual void setOn( bool enable );
        void toggle();
        void setTextLabel( const QString & );
        void setTextPosition( TextPosition pos );

    protected:
        void mousePressEvent( QMouseEvent * );
        void drawButton( QPainter * );
        void drawButtonLabel(QPainter *);

        void enterEvent( QEvent * );
        void leaveEvent( QEvent * );
        void moveEvent( QMoveEvent * );

        // ### Make virtual in 4.0, maybe act like QPushButton with
        // regards to setFlat() instead?  Andy
        bool uses3D() const;
    #if (QT_VERSION >= 0x040000)
    #error "Some functions need to be changed to virtual for Qt 4.0"
    #endif

        bool eventFilter( QObject *o, QEvent *e );

    #ifndef QT_NO_PALETTE
        void paletteChange( const QPalette & );
    #endif

    private slots:
        void popupTimerDone();
        void popupPressed();

    private:
        void init();

        QPixmap bp;
        int bpID;
        QPixmap sp;
        int spID;

        QString tl;

        QToolButtonPrivate *d;
        QIconSet *s;

        uint utl : 1;
        uint ubp : 1;
        uint hasArrow : 1;

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

    #endif // QT_NO_TOOLBUTTON

    #endif // QTOOLBUTTON_H