summaryrefslogtreecommitdiffstats
path: root/src/core/idledelegate.cpp
blob: a28441a599f4a8b729bd95216798be18b01a3957 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
/****************************************************************************
**
** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** $QT_BEGIN_LICENSE:LGPL$
** GNU Lesser General Public License Usage
** This file may be used under the terms of the GNU Lesser General Public
** License version 2.1 as published by the Free Software Foundation and
** appearing in the file LICENSE.LGPL included in the packaging of this
** file. Please review the following information to ensure the GNU Lesser
** General Public License version 2.1 requirements will be met:
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU General
** Public License version 3.0 as published by the Free Software Foundation
** and appearing in the file LICENSE.GPL included in the packaging of this
** file. Please review the following information to ensure the GNU General
** Public License version 3.0 requirements will be met:
** http://www.gnu.org/copyleft/gpl.html.
**
** Other Usage
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

#include "idledelegate.h"

QT_BEGIN_NAMESPACE_PROCESSMANAGER

/*!
  \class IdleDelegate
  \brief The IdleDelegate class is a virtual class for gathering idle CPU cycles

  You must subclass this class to do anything useful.

  The IdleDelegate is turned on and off by the \l{requestIdleCpu()} function.
  The IdleDelegate should emit the \l{idleCpuAvailable()} signal approximately
  once per second when it is turned on.
*/

/*!
    Construct a IdleDelegate with an optional \a parent.
*/

IdleDelegate::IdleDelegate(QObject *parent)
    : QObject(parent)
{
}

/*!
    \fn void IdleDelegate::requestIdleCpu(bool request)

    Turn on or off idle requests based on \a request
    You must override this function in a subclass.
*/

/*!
    \fn void IdleDelegate::idleCpuAvailable()

    Signal emitted periodically when idle CPU resources are available.
*/

#include "moc_idledelegate.cpp"

QT_END_NAMESPACE_PROCESSMANAGER