WindowItem QML Type

An Item that renders a given WindowObject. More...

Import Statement: import QtApplicationManager.SystemUI 2.0



Detailed Description

To render a WindowObject inside the System UI, you must specify where and how it should be done using a WindowItem. A WindowItem is a regular QML Item, that you place in the scene and assign the desired WindowObject to it.

The WindowObject is then rendered in the System UI scene according to the WindowItem's geometry, opacity, visibility, transformations, and so on.

The relationship between WindowObjects and WindowItems is similar to the one between image files and Image items. The former is the content; the latter defines how it's rendered in a QML scene.

It's possible to assign the same WindowObject to multiple WindowItems, so it can be rendered multiple times.

The implicit size of a WindowItem is the size of the WindowObject it displays.

See also WindowObject.

Property Documentation

objectFollowsItemSize : bool

If true, WindowItem resizes the WindowObject it's displaying to match its own size. If false, resizing the WindowItem has no effect on the size of the WindowObject being displayed. By default, this property is true.

Set this property to false when you want the WindowItem size to be determined by the WindowObject's size. Additionally, don't specify a width and height to maintain the item's implicit size as its WindowObject's size, or explicitly set it to match the WindowObject's size.

See also WindowObject::resize.

[read-only] primary : bool

Returns whether this is the primary view of the WindowObject set.

The primary WindowItem is the one sending input events and defining the size of the WindowObject. A WindowObject can have only one primary WindowItem. If multiple WindowItems are rendering the same WindowObject, making one primary automatically sets the primary property of all other WindowItems to false.

By default, the first WindowItem that gets a particular WindowObject assigned will be the primary WindowItem for that WindowObject.

See also makePrimary.

window : WindowObject

The window surface to display.

Method Documentation

void makePrimary()

Make the currently displayed window the primary WindowItem.

See also primary.

© 2023 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.