src/corelib/kernel/qeventloop.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: Nokia Corporation (qt-info@nokia.com)
   6 **
   7 ** This file is part of the QtCore module of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** GNU Lesser General Public License Usage
  11 ** This file may be used under the terms of the GNU Lesser General Public
  12 ** License version 2.1 as published by the Free Software Foundation and
  13 ** appearing in the file LICENSE.LGPL included in the packaging of this
  14 ** file. Please review the following information to ensure the GNU Lesser
  15 ** General Public License version 2.1 requirements will be met:
  16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  17 **
  18 ** In addition, as a special exception, Nokia gives you certain additional
  19 ** rights. These rights are described in the Nokia Qt LGPL Exception
  20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  21 **
  22 ** GNU General Public License Usage
  23 ** Alternatively, this file may be used under the terms of the GNU General
  24 ** Public License version 3.0 as published by the Free Software Foundation
  25 ** and appearing in the file LICENSE.GPL included in the packaging of this
  26 ** file. Please review the following information to ensure the GNU General
  27 ** Public License version 3.0 requirements will be met:
  28 ** http://www.gnu.org/copyleft/gpl.html.
  29 **
  30 ** Other Usage
  31 ** Alternatively, this file may be used in accordance with the terms and
  32 ** conditions contained in a signed written agreement between you and Nokia.
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QEVENTLOOP_H
  43 #define QEVENTLOOP_H
  44
  45 #include <QtCore/qobject.h>
  46
  47 QT_BEGIN_HEADER
  48
  49 QT_BEGIN_NAMESPACE
  50
  51 QT_MODULE(Core)
  52
  53 class QEventLoopPrivate;
  54
  55 class Q_CORE_EXPORT QEventLoop : public QObject
  56 {
  57     Q_OBJECT
  58     Q_DECLARE_PRIVATE(QEventLoop)
  59
  60 public:
  61     explicit QEventLoop(QObject *parent = 0);
  62     ~QEventLoop();
  63
  64     enum ProcessEventsFlag {
  65         AllEvents = 0x00,
  66         ExcludeUserInputEvents = 0x01,
  67         ExcludeSocketNotifiers = 0x02,
  68         WaitForMoreEvents = 0x04,
  69 #ifdef QT3_SUPPORT
  70         ExcludeUserInput = ExcludeUserInputEvents,
  71         WaitForMore = WaitForMoreEvents,
  72 #endif
  73         X11ExcludeTimers = 0x08
  74 #ifdef QT_DEPRECATED
  75         , DeferredDeletion = 0x10
  76 #endif
  77         , EventLoopExec = 0x20
  78         , DialogExec = 0x40
  79     };
  80     Q_DECLARE_FLAGS(ProcessEventsFlags, ProcessEventsFlag)
  81
  82     bool processEvents(ProcessEventsFlags flags = AllEvents);
  83     void processEvents(ProcessEventsFlags flags, int maximumTime);
  84
  85     int exec(ProcessEventsFlags flags = AllEvents);
  86     void exit(int returnCode = 0);
  87     bool isRunning() const;
  88
  89     void wakeUp();
  90
  91 public Q_SLOTS:
  92     void quit();
  93 };
  94
  95 Q_DECLARE_OPERATORS_FOR_FLAGS(QEventLoop::ProcessEventsFlags)
  96
  97 QT_END_NAMESPACE
  98
  99 QT_END_HEADER
 100
 101 #endif // QEVENTLOOP_H