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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
|
/****************************************************************************
**
** Copyright (C) 2018 Pelagicore AG
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Pelagicore Application Manager.
**
** $QT_BEGIN_LICENSE:LGPL-QTAS$
** Commercial License Usage
** Licensees holding valid commercial Qt Automotive Suite licenses may use
** this file in accordance with the commercial license agreement provided
** with the Software or, alternatively, in accordance with the terms
** contained in a written agreement between you and The Qt Company. For
** licensing terms and conditions see https://www.qt.io/terms-conditions.
** For further information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
** SPDX-License-Identifier: LGPL-3.0
**
****************************************************************************/
#include "window.h"
/*!
\qmltype WindowObject
\inqmlmodule QtApplicationManager.SystemUI
\ingroup system-ui-non-instantiable
\brief A client window surface.
A WindowObject represents a window from a client application. Each visible
ApplicationManagerWindow on the application side will be reflected by a
corresponding WindowObject on the server, System-UI, side.
To render a WindowObject inside your System-UI you have to assign it to a WindowItem.
\sa WindowItem
*/
/*!
\qmlmethod bool WindowObject::setWindowProperty(string name, var value)
Sets the application window's shared property identified by \a name to the given \a value.
These properties are shared between the System-UI and the client application: in single-process
mode simply via a QVariantMap; in multi-process mode the sharing is done via Qt's extended
surface Wayland extension. Changes from the client side are notified by the
windowPropertyChanged() signal.
See ApplicationManagerWindow for the client side API.
\sa windowProperty(), windowProperties(), windowPropertyChanged()
*/
/*!
\qmlmethod var WindowObject::windowProperty(string name)
Returns the value of the application window's shared property identified by \a name.
\sa setWindowProperty()
*/
/*!
\qmlmethod var WindowObject::windowProperties()
Returns an object containing all shared properties of the application window.
\sa setWindowProperty()
*/
/*!
\qmlmethod var WindowObject::resize(Size size)
Resizes the WindowObject to the given size, in pixels. Usually you don't have to call
this yourself as WindowItem takes care of it by default.
\sa WindowObject::size, WindowItem::objectFollowsItemSize
*/
/*!
\qmlproperty enumeration WindowObject::contentState
\readonly
This property holds the state of the content of this window.
A window may be backed up by a surface and that surface may have content or not.
\list
\li WindowObject.SurfaceWithContent - The window is backed by a surface and that surface has content.
This is the initial state.
\li WindowObject.SurfaceNoContent - The window is backed by a surface but that surface presently has no content.
It may get content again, in which case the state goes back to
WindowObject::SurfaceWithContent, or it may be followed by a state change to
WindowObject::NoSurface.
\target windowobject-nosurface
\li WindowObject.NoSurface - The window doesn't have a surface anymore. This is an end state. After displaying
the appropriate animations (if any), System UI should ensure that there's no
WindowItem instance left pointing to this Window (by either destroying them or
resetting their WindowItem::window properties) in order to free up resources
associated with it.
\endlist
*/
/*!
\qmlproperty QSize WindowObject::size
\readonly
The size of the window surface, in pixels
\sa WindowObject::resize
*/
/*!
\qmlproperty ApplicationObject WindowObject::application
\readonly
This property holds the \l{ApplicationObject}{application} that created this window.
*/
/*!
\qmlmethod WindowObject::close()
Sends a close event to the WindowObject.
\sa Window::close()
*/
/*!
\qmlproperty WaylandSurface WindowObject::waylandSurface
\readonly
This property exists only when running in multi-process mode. Enables
you to access the underlying WaylandSurface of this window, if any.
It will be null in case WindowObject::contentState is WindowObject.NoSurface.
Naturally you should avoid using this property in code that should work in
both single and multi-process modes.
*/
/*!
\qmlsignal WindowObject::windowPropertyChanged(string name, var value)
Notifies that the window property with \a name has a new \a value.
Window property changes can be caused either by the System-UI (via WindowObject::setWindowProperty)
or by the application that created that window (via ApplicationManagerWindow::setWindowProperty).
\sa setWindowProperty
*/
QT_BEGIN_NAMESPACE_AM
Window::Window(AbstractApplication *app)
: QObject()
, m_application(app)
{
}
Window::~Window()
{
emit _windowDestroyed();
}
AbstractApplication *Window::application() const
{
return m_application;
}
void Window::registerItem(WindowItem *item)
{
m_items.insert(item);
if (m_items.count() == 1)
Q_EMIT isBeingDisplayedChanged();
}
void Window::unregisterItem(WindowItem *item)
{
m_items.remove(item);
if (m_items.count() == 0)
Q_EMIT isBeingDisplayedChanged();
}
void Window::setPrimaryItem(WindowItem *item)
{
m_primaryItem = item;
}
bool Window::isBeingDisplayed() const
{
return m_items.count() > 0;
}
QT_END_NAMESPACE_AM
|