Тип QML окна

Создаёт новое окно верхнего уровня. Подробнее...

• Список всех членов, включая унаследованные

Свойства

• active : bool
• activeFocusItem : Item
• цвет : цвет
• contentItem : Item
• contentOrientation : Qt::ScreenOrientation
• данные : list<Object>
• флаги : Qt::WindowFlags
• высота : int
• максимальная высота : int
• максимальная ширина : int
• минимальная высота : int
• минимальная ширина : int
• модальность : Qt::WindowModality
• прозрачность : real
• палитра : QQuickPalette
• экран : variant
• заголовок : string
• transientParent : QWindow
• видимость : QWindow::Visibility
• видимый : bool
• ширина : int
• x : int
• y : int

Присоединённые свойства

• active : bool
• activeFocusItem : Item
• contentItem : Item
• высота : int
• видимость : QWindow::Visibility
• ширина : int
• окно : Window

Сигналы

• послеАнимации()
• закрытие(CloseEvent закрыть)
• кадрЗаменён()
• ошибкаГрафаСцены(SceneGraphError ошибка, QString сообщение)

Методы

• alert(int msec)
• закрыть()
• скрыть()
• опустить()
• поднять()
• запросАктивации()
• показать()
• показатьНаВесьЭкран()
• показатьМаксимизированным()
• показатьМинимизированным()
• показатьНормально()

Подробное описание

Объект Window создаёт новое окно верхнего уровня для сцены Qt Quick. Он автоматически настраивает окно для использования с QtQuick 2.x графическими типами.

Чтобы использовать этот тип, вам необходимо импортировать модуль следующей строкой:

import QtQuick.Window 2.2

Пропуск этого импорта позволит вам иметь QML-среду без доступа к функциям системы окон.

Окно может быть объявлено внутри Item или внутри другого окна; в этом случае внутреннее окно автоматически станет «вспомогательным» для внешнего окна: большинство платформ по умолчанию отобразят его по центру внешнего окна, и могут быть другие платформенно-зависимые особенности, также зависящие от флагов. Если вложенное окно предназначено для диалогового окна вашего приложения, вы также должны установить флаги на Qt.Dialog, потому что некоторые менеджеры окон не обеспечат центрирование без этого флага. Вы также можете объявить несколько окон внутри верхнего уровня QtObject, в этом случае окна не будут иметь транзитивных отношений.

В качестве альтернативы вы можете установить или связать x и y, чтобы явно расположить окно на экране.

Когда пользователь пытается закрыть окно, будет испущен сигнал закрытие. Вы можете заставить окно остаться открытым (например, чтобы попросить пользователя сохранить изменения) написав обработчик onClosing и установив close.accepted = false.

Документация свойств

Определяет максимальный размер окна.

Это подсказка для менеджера окон, чтобы предотвратить изменение размера сверх заданной ширины и высоты.

Это свойство QML было введено в Qt 5.1.

Определяет минимальный размер окна.

Это подсказка для менеджера окон, чтобы предотвратить изменение размера ниже заданной ширины и высоты.

Это свойство QML было введено в Qt 5.1.

Определяет положение и размер окна.

Положение (x,y) относительно экрана, если он один, или виртуального рабочего стола (макета нескольких экранов).

Window { x: 100; y: 100; width: 100; height: 100 }

[с 5.1] активный : bool

Статус активности окна.

Это свойство было введено в Qt 5.1.

См. также requestActivate().

[с 5.1] активныйЭлементФокуса : Item

Элемент, который в данный момент имеет активный фокус, или null если нет элемента с активным фокусом.

Это свойство было введено в Qt 5.1.

цвет : цвет

Цвет фона окна.

Установка этого свойства более эффективна, чем использование отдельного Rectangle.

[только для чтения] contentItem : Item

Невидимый корневой элемент сцены.

[с 5.1] contentOrientation : Qt::ScreenOrientation

Это подсказка для менеджера окон в случае, если ему нужно отображать дополнительный контент, такой как всплывающие окна, диалоговые окна, панели состояния или аналогичное, в отношении окна.

Рекомендуемая ориентация — Screen.orientation, но приложение не должно поддерживать все возможные ориентации, и поэтому может выбрать игнорирование текущей ориентации экрана.

Разница между ориентацией окна и ориентацией контента определяет, на сколько нужно повернуть контент.

Значение по умолчанию — Qt::PrimaryOrientation.

Это свойство было введено в Qt 5.1.

См. также Экран.

[по умолчанию] данные : list<Object>

Свойство данных позволяет свободно смешивать визуальные дочерние элементы, ресурсы и другие окна в окне.

Если вы присвойте другому окну список данных, вложенное окно станет «вспомогательным» для внешнего окна.

Если вы присвойте Item в список данных, он станет дочерним элементом contentItem окна, поэтому он будет отображаться внутри окна. Родительским элементом этого элемента будет contentItem окна, который является корнем дерева владения Item внутри этого окна.

Если вы присвойте любой другой тип объекта, он добавится как ресурс.

Обычно не нужно ссылаться на свойство data так как это свойство по умолчанию для Window и, следовательно, все дочерние элементы автоматически назначаются этому свойству.

См. также QWindow::transientParent().

флаги : Qt::WindowFlags

Флаги окна.

Флаги окна управляют внешним видом окна в системе окон, является ли это диалоговым окном, всплывающим окном или обычным окном и есть ли у него панель заголовка и т. д.

Флаги, которые вы считываете из этого свойства, могут отличаться от тех, которые вы установили, если запрошенные флаги не могут быть выполнены.

См. также Qt::WindowFlags.

модальность : Qt::WindowModality

Модальность окна.

Модальное окно предотвращает получение других окон событий ввода. Возможные значения — Qt.NonModal (по умолчанию), Qt.WindowModal и Qt.ApplicationModal.

[since 5.1] opacity : real

Непрозрачность окна.

Если система окон поддерживает непрозрачность окон, это свойство можно использовать для плавного появления и исчезновения окна или для придания ему полупрозрачности.

Значение 1.0 или больше интерпретируется как полностью непрозрачное, а значение 0.0 или меньше — как полностью прозрачное. Промежуточные значения представляют различные уровни полупрозрачности между этими двумя крайностями.

Значение по умолчанию — 1.0.

Это свойство было добавлено в Qt 5.1.

[since 6.0] palette : QQuickPalette

Это свойство содержит палитру, текущую для окна.

Палитра по умолчанию зависит от системной среды. QGuiApplication поддерживает системную/темовую палитру, которая используется как палитра по умолчанию для всех окон приложения. Также можно установить палитру по умолчанию для окон, передав пользовательскую палитру в QGuiApplication::setPalette() до загрузки QML.

ApplicationWindow распространяет явные свойства палитры на дочерние элементы управления. Если вы измените определённое свойство палитры окна, это свойство распространится на все дочерние элементы управления в окне, переопределяя любые системные значения по умолчанию для этого свойства.

Это свойство было добавлено в Qt 6.0.

См. также Item::palette, Popup::palette и QQuickColorGroup.

[since 5.9] screen : variant

Экран, с которым связано окно.

Если указано до показа окна, приведет к отображению окна на этом экране, если не задано явное положение окна. Значение должно быть элементом из массива Qt.application.screens.

Примечание: Чтобы гарантировать, что окно связано с нужным экраном при создании базового системного окна, убедитесь, что это свойство установлено как можно раньше и что установка его значения не отложена. Это особенно важно на встраиваемых платформах без системы окон, где разрешено только одно окно на экран в каждый момент времени. Установка экрана после создания окна не перемещает окно, если новый экран является частью того же виртуального рабочего стола, что и старый экран.

Это свойство было добавлено в Qt 5.9.

См. также QWindow::setScreen(), QWindow::screen(), QScreen и Qt.application.

title : string

Заголовок окна в системе окон.

Заголовок окна может отображаться в области заголовка декораций окна, в зависимости от системы окон и флагов окна. Также он может использоваться системой окон для идентификации окна в других контекстах, например, в переключателе задач.

[since 5.13] transientParent : QWindow

Окно, для которого это окно является всплывающим окном-диалогом.

Это подсказка для менеджера окон о том, что это окно является диалоговым окном или всплывающим окном от имени transient parent. Обычно это означает, что всплывающее окно будет центрировано над своим transient parent при его первоначальном отображении, что минимизация родительского окна также минимизирует всплывающее окно, и так далее; однако результаты несколько отличаются в зависимости от платформы.

Обычно, если вы объявляете Window внутри Item или внутри другого Window, эта связь выводится автоматически. В этом случае, если вы объявляете свойство visible этого окна true, оно фактически не будет отображаться до тех пор, пока transientParent окно не будет отображено.

Однако, если вы задаёте это свойство, Qt Quick больше не будет ждать, пока transientParent окно будет отображено, прежде чем отображать это окно. Если вы хотите иметь возможность отображать всплывающее окно независимо от "родительского" Item или Window, внутри которого оно было объявлено, вы можете удалить эту связь, установив transientParent в null.

import QtQuick.Window 2.13

Window {
    // visible is false by default
    Window {
        transientParent: null
        visible: true
    }
}

Для того чтобы окно по умолчанию центрировалось над своим transient parent, в зависимости от менеджера окон, может потребоваться также установить свойство Window::flags с подходящим значением Qt::WindowType (например, Qt::Dialog).

Это свойство было добавлено в Qt 5.13.

[since 5.1] visibility : QWindow::Visibility

Состояние отображения окна на экране.

Видимость — это то, должно ли окно отображаться в системе окон как нормальное, свёрнутое, развернутое, полноэкранное или скрытое.

Установка видимости в AutomaticVisibility означает, что окну будет задано состояние видимости по умолчанию, которое может быть FullScreen или Windowed в зависимости от платформы. Однако при чтении свойства visibility вы всегда получите фактическое состояние, а не AutomaticVisibility.

Когда окно невидимо, его видимость — Hidden, и установка видимости в Hidden эквивалентна установке visible в false.

Это свойство было добавлено в Qt 5.1.

См. также visible.

visible : bool

Является ли окно видимым на экране.

Установка visible в false эквивалентна установке visibility в Hidden.

См. также visibility.

Документация присоединённого свойства

Эти присоединённые свойства содержат размеры окна элемента. Присоединённое свойство Window может быть прикреплено к любому Item.

Это свойство QML было добавлено в Qt 5.5.

[since 5.4] Window.active : bool

Это присоединённое свойство указывает, является ли окно активным. Присоединённое свойство Window может быть прикреплено к любому Item.

Вот пример, который изменяет метку, чтобы отобразить активное состояние окна, в котором она отображается:

import QtQuick 2.4
import QtQuick.Window 2.2

Text {
    text: Window.active ? "active" : "inactive"
}

Это свойство было добавлено в Qt 5.4.

[since 5.4] Window.activeFocusItem : Item

Это присоединённое свойство содержит элемент, который в настоящее время имеет фокус, или null , если нет элемента с активным фокусом. Присоединённое свойство Window может быть прикреплено к любому Item.

Это свойство было добавлено в Qt 5.4.

[since 5.4] Window.contentItem : Item

Это присоединённое свойство содержит невидимый корневой элемент сцены или null , если элемент не находится в окне. Присоединённое свойство Window может быть прикреплено к любому Item.

Это свойство было добавлено в Qt 5.4.

[since 5.4] Window.visibility : QWindow::Visibility

Это присоединённое свойство содержит информацию о том, отображается ли окно в системе окон в данный момент как обычное, свёрнутое, развернутое, полноэкранное или скрытое. Window присоединённое свойство может быть прикреплено к любому Item. Если элемент не отображается ни в одном окне, значение будет Hidden.

Это свойство было добавлено в Qt 5.4.

См. также visible и visibility.

[since 5.7] Window.window : Window

Это присоединённое свойство содержит окно элемента. Присоединённое свойство Window может быть прикреплено к любому Item.

Это свойство было добавлено в Qt 5.7.

Документация сигналов

[since 5.3] afterAnimating()

Этот сигнал излучается в потоке GUI перед запросом к потоку рендеринга выполнить синхронизацию графа сцены.

Вы можете реализовать onAfterAnimating для выполнения дополнительных операций после каждого шага анимации.

Примечание: Соответствующий обработчик — onAfterAnimating.

Этот сигнал был добавлен в Qt 5.3.

[since 5.1] closing(CloseEvent close)

Этот сигнал излучается, когда пользователь пытается закрыть окно.

Этот сигнал включает параметр close. Свойство close.accepted по умолчанию имеет значение true, позволяя окну закрыться; но вы можете реализовать обработчик onClosing и установить close.accepted = false , если вам нужно выполнить другие действия перед закрытием окна.

Примечание: Соответствующий обработчик — onClosing.

Этот сигнал был добавлен в Qt 5.1.

frameSwapped()

Этот сигнал излучается, когда кадр был помещен в очередь для отображения. При включённой вертикальной синхронизации сигнал излучается не более одного раза за интервал vsync в непрерывно анимируемой сцене.

Примечание: Соответствующий обработчик — onFrameSwapped.

[since 5.3] sceneGraphError(SceneGraphError error, QString message)

Этот сигнал излучается при возникновении ошибки error во время инициализации графа сцены.

Вы можете реализовать onSceneGraphError(error, message) для обработки ошибок, таких как сбои в создании контекста графики, в своём собственном стиле. Если обработчик не подключён к этому сигналу, Quick выведет сообщение message или отобразит окно с сообщением и завершит приложение.

Примечание: Соответствующий обработчик — onSceneGraphError.

Этот сигнал был введён в Qt 5.3.

Документация по методам

[since 5.1] alert(int msec)

Вызывает отображение предупреждения на msec миллисекунд. Если msec равно 0 (по умолчанию), то предупреждение отображается неопределённо долго, до тех пор, пока окно не станет активным снова.

В состоянии предупреждения окно указывает, что требует внимания, например, мигая или подпрыгивая в области задач.

Этот метод был введён в Qt 5.1.

close()

Закрывает окно.

При вызове этого метода или при попытке пользователя закрыть окно кнопкой на панели заголовка, будет испущен сигнал closing. Если обработчика нет или он не отзывает разрешение на закрытие, окно будет закрыто. Если свойство QGuiApplication::quitOnLastWindowClosed равно true, и других открытых окон нет, приложение завершит работу.

hide()

Скрывает окно.

Эквивалентно установке visible в false или visibility в Hidden.

См. также show().

lower()

Опускает окно в системе окон.

Запрашивает опускание окна, чтобы оно отображалось под другими окнами.

raise()

Приподнимает окно в системе окон.

Запрашивает поднятие окна, чтобы оно отображалось над другими окнами.

[since 5.1] requestActivate()

Запрашивает активацию окна, т.е. получение фокуса клавиатуры.

Этот метод был введён в Qt 5.1.

show()

Отображает окно.

Это эквивалентно вызову showFullScreen(), showMaximized() или showNormal(), в зависимости от поведения платформы по умолчанию для типа окна и флагов.

См. также showFullScreen(), showMaximized(), showNormal(), hide() и QQuickItem::flags().

showFullScreen()

Отображает окно в полноэкранном режиме.

Эквивалентно установке visibility в FullScreen.

showMaximized()

Отображает окно в максимальном режиме.

Эквивалентно установке visibility в Maximized.

showMinimized()

Отображает окно в свёрнутом виде.

Эквивалентно установке visibility в Minimized.

showNormal()

Отображает окно в нормальном режиме, то есть ни максимизированным, ни свёрнутым, ни полноэкранным.

Эквивалентно установке visibility в Windowed.