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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
|
/* This file is part of the KDE libraries
Copyright (c) 2001 Martin R. Jones <mjones@kde.org>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#ifndef KSCREENSAVER_H
#define KSCREENSAVER_H
#include <qwidget.h>
#include <kdelibs_export.h>
class QTimer;
class KScreenSaverPrivate;
class KBlankEffectPrivate;
/**
* Provides a QWidget for a screensaver to draw into.
*
* You should derive from this widget and implement your screensaver's
* functionality. To use libkss, provide the following constants and
* functions:
*
* extern "C"
* {
* const char *kss_applicationName = "yourappname";
* const char *kss_description = I18N_NOOP( "Your screensaver" );
* const char *kss_version = "1.0";
*
* KScreenSaver *kss_create( WId d )
* {
* // return your KScreenSaver derived screensaver
* }
*
* QDialog *kss_setup()
* {
* // return your modal setup dialog
* }
* }
*
* @short Provides a QWidget for a screensaver to draw into.
* @author Martin R. Jones <mjones@kde.org>
*/
class KDE_EXPORT KScreenSaver : public QWidget
{
Q_OBJECT
public:
/**
* @param id The winId() of the widget to draw the screensaver into.
*/
KScreenSaver( WId id=0 );
~KScreenSaver();
protected:
/**
* You cannot create a new widget with this widget as parent, since this
* widget may not be owned by your application. In order to create
* widgets with a KScreenSaver as parent, create the widget with no parent,
* call embed(), and then show() the widget.
*
* @param widget The widget to embed in the screensaver widget.
*/
void embed( QWidget *widget );
bool eventFilter( QObject *o, QEvent * );
private:
KScreenSaverPrivate *d;
};
/**
*
* Blanks a widget using various effects.
*
* @short Blanks a widget using various effects.
* @author Martin R. Jones <mjones@kde.org>
*/
class KBlankEffect : public QObject
{
Q_OBJECT
public:
KBlankEffect( QObject *parent=0 );
~KBlankEffect();
enum Effect { Random=-1, Blank=0, SweepRight, SweepDown, Blocks,
MaximumEffects };
/**
* Blank a widget using the specified effect.
* Some blanking effects take some time, so you should connect to
* doneBlank() to know when the blanking is complete.
*
* @param w The widget to blank.
* @param effect The type of effect to use.
*/
void blank( QWidget *w, Effect effect=Random );
typedef void (KBlankEffect::*BlankEffect)();
signals:
/**
* emitted when a blanking effect has completed.
*/
void doneBlank();
protected slots:
void timeout();
protected:
void finished();
void blankNormal();
void blankSweepRight();
void blankSweepDown();
void blankBlocks();
protected:
static BlankEffect effects[];
KBlankEffectPrivate *d;
};
#endif
|
