blob: 8dd1ecc06628708a23287ab0b0eb2de44ee27321 (
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
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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
|
/***************************************************************************
**
** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (directui@nokia.com)
**
** This file is part of libdui.
**
** If you have questions regarding the use of this file, please contact
** Nokia at directui@nokia.com.
**
** This library is free software; you can redistribute it and/or
** modify it 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.
**
****************************************************************************/
#ifndef DUIEXTENSIONRUNNER_H_
#define DUIEXTENSIONRUNNER_H_
#include <QObject>
#include <QRectF>
#include <QPixmap>
#include <duinamespace.h>
#include <duiexport.h>
class DuiWidget;
class DuiScene;
class DuiWindow;
class QGraphicsWidget;
class DuiAppletClient;
class DuiAppletMessage;
class DuiAppletMouseMessage;
class DuiAppletCancelMessage;
class DuiAppletMetaData;
class DuiAppletInterface;
class DuiAppletSharedMutex;
class QAction;
#ifdef QT_OPENGL_LIB
class QGLContext;
#endif
//! \internal
/**
* DuiExtensionRunner is a class that is used to start and run oop (out of process)
* extension widgets.
*
* W A R N I N G
* -------------
* This file is not part of the libdui API. It should only be used by applet runner developers.
*/
class DUI_EXPORT DuiExtensionRunner : public QObject
{
Q_OBJECT
public:
/*!
* DuiExtensionRunner constructor
*/
DuiExtensionRunner();
//! DuiExtensionRunner destructor
virtual ~DuiExtensionRunner();
/*!
* Initialize the extension and establish an IPC connection between the runner and
* the host application.
*
* \param serverName the name of the host process's server.
* \return \c true if the extension and IPC connection were initialized correctly,
* \c false if something went wrong.
*/
virtual bool init(const QString &serverName);
/*!
* Sends a message of type DuiAppletUpdateGeometryMessage to the host.
*/
virtual void sendUpdateGeometryMessage();
Q_SIGNALS:
/*!
* \brief A signal that is emitted when item is shown/hidden
*/
void visibilityChanged(bool visibility);
protected slots:
/*!
* \brief A slot for receiving messages from the host application
*/
virtual void messageReceived(const DuiAppletMessage &message);
/*!
* \brief A slot for notifying that the scene has changed and needs to be painted
*/
virtual void sceneChanged(const QList<QRectF> ®ion);
/*!
* \brief Slot to be called when the host process has not sent any messages in ALIVE_TIMER_TIMEOUT milliseconds
*/
virtual void hostProcessNotAlive();
protected:
//! AppletClient for communicating between the runner and the host processes.
DuiAppletClient *communicator;
//! A parent widget for the actual extension widget
QGraphicsWidget *parentWidget;
//! The extension widget instantiated from shared library
DuiWidget *widget;
//! Scene where the widget is inserted.
DuiScene *scene;
//! View into the scene.
DuiWindow *view;
/*! Pixmap in which the extension is painted. The underlying X pixmap is
shared between the host and runner processes. */
QPixmap pixmap;
//! List to hold object menu actions received from widget.
QList<QAction *> widgetObjectMenuActions;
#ifdef QT_OPENGL_LIB
//! OpenGL context
QGLContext *context;
#endif
//! Timer for checking that the host process is alive
QTimer *aliveTimer;
//! Shared mutex for locking the pixmap
DuiAppletSharedMutex *pixmapMutex;
//! Combined changed rect for the scene
QRectF changedRect;
//! Visibility status of the extension
bool visible;
/*!
* Frees all resources that have been reserved by this object currently.
*/
virtual void teardown();
/*!
* Handles an AppletMouseMessage.
*
* \param message the AppletMouseMessage to handle
*/
virtual void handleMouseEvent(const DuiAppletMouseMessage *message);
/*!
* Handles an AppletCancelMessage.
*
* \param message to be handled
*/
virtual void handleCancelEvent(const DuiAppletCancelMessage *message);
/*!
* Sets pixmap to use the received X pixmap handle
*
* \param handle the X pixmap handle to use
*/
virtual void createAppletPixmap(Qt::HANDLE handle);
#ifdef UNIT_TEST
friend class Ut_DuiExtensionRunner;
#endif
};
//! \internal_end
#endif /* DUIEXTENSIONRUNNER_H_ */
|
