qeventloop.h Include File

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

# qeventloop.h

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

    /****************************************************************************
    ** $Id: qt/qeventloop.h   3.3.5   edited Aug 31 12:17 $
    **
    ** Declaration of QEventLoop class
    **
    ** Copyright (C) 1992-2005 Trolltech AS.  All rights reserved.
    **
    ** This file is part of the kernel module of the Qt GUI Toolkit.
    **
    ** This file may be distributed under the terms of the Q Public License
    ** as defined by Trolltech AS 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 QEVENTLOOP_H
    #define QEVENTLOOP_H

    #ifndef QT_H
    #include "qobject.h"
    #include "qsocketnotifier.h"
    #endif // QT_H

    class QEventLoopPrivate;
    class QSocketNotifier;
    class QTimer;
    #ifdef Q_WS_MAC
    struct timeval; //stdc struct
    struct TimerInfo; //internal structure (qeventloop_mac.cpp)
    #endif

    #if defined(QT_THREAD_SUPPORT)
    class QMutex;
    #endif // QT_THREAD_SUPPORT

    class Q_EXPORT QEventLoop : public QObject
    {
        Q_OBJECT

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

        enum ProcessEvents {
    	AllEvents		= 0x00,
    	ExcludeUserInput	= 0x01,
    	ExcludeSocketNotifiers	= 0x02,
    	WaitForMore		= 0x04
        };
        typedef uint ProcessEventsFlags;

        void processEvents( ProcessEventsFlags flags, int maxtime );
        virtual bool processEvents( ProcessEventsFlags flags );

        virtual bool hasPendingEvents() const;

        virtual void registerSocketNotifier( QSocketNotifier * );
        virtual void unregisterSocketNotifier( QSocketNotifier * );
        void setSocketNotifierPending( QSocketNotifier * );
        int activateSocketNotifiers();

        int activateTimers();
        int timeToWait() const;

        virtual int exec();
        virtual void exit( int retcode = 0 );

        virtual int enterLoop();
        virtual void exitLoop();
        virtual int loopLevel() const;

        virtual void wakeUp();

    signals:
        void awake();
        void aboutToBlock();

    private:
    #if defined(Q_WS_MAC)
        friend QMAC_PASCAL void qt_mac_select_timer_callbk(EventLoopTimerRef, void *);
        int macHandleSelect(timeval *);
        void macHandleTimer(TimerInfo *);
    #endif // Q_WS_MAC

        // internal initialization/cleanup - implemented in various platform specific files
        void init();
        void cleanup();
        virtual void appStartingUp();
        virtual void appClosingDown();

        // data for the default implementation - other implementations should not
        // use/need this data
        QEventLoopPrivate *d;

        friend class QApplication;
    };

    #endif // QEVENTLOOP_H