Тип QML Popup

Базовый тип элементов управления пользовательским интерфейсом, похожих на всплывающие окна. Подробнее...

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

Свойства

• activeFocus : bool
• anchors.centerIn : Объект
• availableHeight : real
• availableWidth : real
• background : Элемент
• bottomInset : real
• bottomMargin : real
• bottomPadding : real
• clip : bool
• closePolicy : перечисление
• contentChildren : список<Элемент>
• contentData : список<Объект>
• contentHeight : real
• contentItem : Элемент
• contentWidth : real
• dim : bool
• enabled : bool
• enter : Переход
• exit : Переход
• focus : bool
• font : шрифт
• height : real
• horizontalPadding : real
• implicitBackgroundHeight : real
• implicitBackgroundWidth : real
• implicitContentHeight : real
• implicitContentWidth : real
• implicitHeight : real
• implicitWidth : real
• leftInset : real
• leftMargin : real
• leftPadding : real
• locale : Локаль
• margins : real
• mirrored : bool
• modal : bool
• opacity : real
• opened : bool
• padding : real
• palette : палитра
• parent : Элемент
• rightInset : real
• rightMargin : real
• rightPadding : real
• scale : real
• spacing : real
• topInset : real
• topMargin : real
• topPadding : real
• transformOrigin : перечисление
• verticalPadding : real
• visible : bool
• width : real
• x : real
• y : real
• z : real

Сигналы

• void aboutToHide()
• void aboutToShow()
• void closed()
• void opened()

Методы

• void close()
• forceActiveFocus(перечисление reason)
• void open()

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

Popup — это базовый тип элементов управления пользовательским интерфейсом, похожих на всплывающие окна. Он может использоваться с Window или ApplicationWindow.

import QtQuick.Window 2.2
import QtQuick.Controls 2.12

ApplicationWindow {
    id: window
    width: 400
    height: 400
    visible: true

    Button {
        text: "Open"
        onClicked: popup.open()
    }

    Popup {
        id: popup
        x: 100
        y: 100
        width: 200
        height: 300
        modal: true
        focus: true
        closePolicy: Popup.CloseOnEscape | Popup.CloseOnPressOutsideParent
    }
}

Для обеспечения отображения всплывающего окна над другими элементами в сцене рекомендуется использовать ApplicationWindow. ApplicationWindow также обеспечивает эффекты затемнения фона.

Popup не предоставляет собственной компоновки, но требует от вас размещения его содержимого, например, путем создания RowLayout или ColumnLayout.

Элементы, объявленные как дочерние элементы Popup, автоматически становятся дочерними элементами contentItem Popup. Динамически созданные элементы необходимо явным образом присоединять к contentItem.

Компоновка Popup

На следующем рисунке показана компоновка всплывающего окна в окне:

Значения implicitWidth и implicitHeight всплывающего окна обычно основаны на неявных размерах элемента фона и элемента содержимого, а также отступах и отступах. Эти свойства определяют размер всплывающего окна, когда не указаны явные значения width или height.

Геометрия contentItem определяется отступами. В следующем примере резервируется 10 пикселей отступа между границами всплывающего окна и его содержимым:

Popup {
    padding: 10

    contentItem: Text {
        text: "Content"
    }
}

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

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

Popup {
    topInset: -2
    leftInset: -2
    rightInset: -6
    bottomInset: -6

    background: BorderImage {
        source: ":/images/shadowed-background.png"
    }
}

Изменение размеров Popup

Если используется только один элемент внутри Popup, он изменит размер, чтобы соответствовать неявным размерам содержащегося элемента. Это делает его особенно подходящим для использования вместе с компоновками.

Popup {
    ColumnLayout {
        anchors.fill: parent
        CheckBox { text: qsTr("E-mail") }
        CheckBox { text: qsTr("Calendar") }
        CheckBox { text: qsTr("Contacts") }
    }
}

Иногда может быть два элемента внутри всплывающего окна:

Popup {
    SwipeView {
        // ...
    }
    PageIndicator {
        anchors.horizontalCenter: parent.horizontalCenter
        anchors.bottom: parent.bottom
    }
}

В этом случае Popup не может вычислить разумный неявный размер. Поскольку мы закрепляем PageIndicator над SwipeView, мы можем просто установить размер содержимого на неявный размер представления:

Popup {
    contentWidth: view.implicitWidth
    contentHeight: view.implicitHeight

    SwipeView {
        id: view
        // ...
    }
    PageIndicator {
        anchors.horizontalCenter: parent.horizontalCenter
        anchors.bottom: parent.bottom
    }
 }

Размещение Popup

Подобно элементам в Qt Quick, координаты x и y Popup относительны к его родительскому элементу. Это означает, что при открытии всплывающего окна, являющегося дочерним элементом Button, например, всплывающее окно будет размещено относительно кнопки.

В следующем примере используется присоединенное свойство Overlay.overlay, чтобы разместить всплывающее окно по центру окна, несмотря на положение кнопки, открывающей это всплывающее окно:

Button {
    onClicked: popup.open()

    Popup {
        id: popup

        parent: Overlay.overlay

        x: Math.round((parent.width - width) / 2)
        y: Math.round((parent.height - height) / 2)
        width: 100
        height: 100
    }
}

Другой способ центрировать всплывающее окно в окне независимо от родительского элемента — использовать anchors.centerIn:

ApplicationWindow {
    id: window
    // ...

    Pane {
        // ...

        Popup {
            anchors.centerIn: Overlay.overlay
        }
    }
}

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

Переходы Popup

С версии Qt 5.15.3 следующие свойства восстанавливаются до их исходных значений, существовавших до перехода в состояние входа, после завершения перехода в состояние выхода.

• прозрачность
• масштаб

Это позволяет встроенным стилям анимировать эти свойства без потери явных значений.

См. также Контролы всплывающих окон, Настройка всплывающего окна и Окно приложения.

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

[только для чтения] activeFocus : bool

Это свойство указывает, имеет ли всплывающее окно активный фокус.

См. также фокус и Фокус клавиатуры в Qt Quick.

[с версии QtQuick.Controls 2.5 (Qt 5.12)] anchors.centerIn : Object

Якоря предоставляют способ позиционирования элемента, определяя его отношение к другим элементам.

Распространённый случай использования — центрирование всплывающего окна внутри его родительского элемента. Один из способов сделать это — с помощью свойств x и y. Якоря предлагают более удобный подход:

Pane {
    // ...

    Popup {
        anchors.centerIn: parent
    }
}

Также возможно центрировать всплывающее окно в окне, используя Overlay:

ApplicationWindow {
    id: window
    // ...

    Pane {
        // ...

        Popup {
            anchors.centerIn: Overlay.overlay
        }
    }
}

Это упрощает центрирование всплывающего окна в окне из любого компонента.

Это свойство было добавлено в QtQuick.Controls 2.5 (Qt 5.12).

См. также Позиционирование всплывающего окна, anchors и Использование типов Qt Quick Controls в объявлениях свойств.

[только для чтения] availableHeight : real

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

См. также padding, topPadding и bottomPadding.

[только для чтения] availableWidth : real

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

См. также padding, leftPadding и rightPadding.

background : Item

Это свойство содержит элемент фона.

См. также Настройка всплывающего окна.

[с версии QtQuick.Controls 2.5 (Qt 5.12)] bottomInset : real

Это свойство содержит нижний отступ для фона.

Это свойство было добавлено в QtQuick.Controls 2.5 (Qt 5.12).

См. также Макет всплывающего окна и topInset.

bottomMargin : real

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

Всплывающее окно с отрицательным нижним отступом не перемещается внутри нижнего края содержащего окна. Значение по умолчанию — -1.

См. также отступы, topMargin и Макет всплывающего окна.

bottomPadding : real

Это свойство содержит нижний отступ. Если не задано явное значение, оно равно verticalPadding.

Свойства отступа используются для управления геометрией элемента содержимого.

Всплывающее окно использует тот же подход к отступам, что и Control. Визуальное объяснение системы отступов см. в разделе Макет элемента управления документации.

См. также padding, topPadding, verticalPadding и availableHeight.

clip : bool

Это свойство указывает, включено ли обрезание. Значение по умолчанию — false.

closePolicy : перечисление

Это свойство определяет условия закрытия всплывающего окна. Флаги могут быть объединены для нескольких способов закрытия.

Доступные значения:

Значение по умолчанию — Popup.CloseOnEscape | Popup.CloseOnPressOutside. Это значение по умолчанию может конфликтовать с существующими ярлыками в приложении, использующими клавишу Escape.

contentChildren : список<Item>

Это свойство содержит список дочерних элементов содержимого.

Список содержит все элементы, объявленные в QML в качестве дочерних элементов всплывающего окна.

См. также Item::children и contentData.

[значение по умолчанию] contentData : список<Объект>

Это свойство содержит список данных содержимого.

Список содержит все объекты, объявленные в QML в качестве дочерних элементов всплывающего окна.

См. также Item::data и contentChildren.

contentHeight : real

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

Дополнительную информацию см. в разделе Размер всплывающего окна.

См. также contentWidth.

contentItem : Item

Это свойство содержит элемент содержимого всплывающего окна.

Элемент содержимого — визуальное представление всплывающего окна. Когда всплывающее окно становится видимым, элемент содержимого автоматически становится дочерним элементом элемента overlay item.

См. также Настройка всплывающего окна.

contentWidth : real

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

Для получения дополнительной информации см. Размещение всплывающего окна.

См. также contentHeight.

dim : bool

Это свойство указывает, затемняет ли всплывающее окно фон.

Если явно не задано, это свойство следует за значением modal. Чтобы вернуться к значению по умолчанию, установите это свойство в undefined.

См. также modal и Overlay.modeless.

[since QtQuick.Controls 2.3 (Qt 5.10)] enabled : bool

Это свойство указывает, включено ли всплывающее окно. Значение по умолчанию — true.

Это свойство было добавлено в QtQuick.Controls 2.3 (Qt 5.10).

См. также visible и Item::enabled.

enter : Transition

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

Следующий пример анимирует непрозрачность всплывающего окна при его появлении на экране:

Popup {
    enter: Transition {
        NumberAnimation { property: "opacity"; from: 0.0; to: 1.0 }
    }
}

См. также exit.

exit : Transition

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

Следующий пример анимирует непрозрачность всплывающего окна при его скрытии с экрана:

Popup {
    exit: Transition {
        NumberAnimation { property: "opacity"; from: 1.0; to: 0.0 }
    }
}

См. также enter.

focus : bool

Это свойство указывает, хочет ли всплывающее окно получить фокус.

Когда всплывающее окно фактически получает фокус, activeFocus будет true. Для получения дополнительной информации см. Фокус клавиатуры в Qt Quick.

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

См. также activeFocus.

font : font

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

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

Popup {
    font.family: "Courier"

    Column {
        Label {
            text: qsTr("This will use Courier...")
        }

        Switch {
            text: qsTr("... and so will this")
        }
    }
}

См. также Control::font и ApplicationWindow::font.

height : real

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

[since QtQuick.Controls 2.5 (Qt 5.12)] horizontalPadding : real

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

Свойства отступа используются для управления геометрией элемента содержимого.

Всплывающее окно использует тот же подход к отступам, что и Control. Визуальное объяснение системы отступов см. в разделе Макет управления документации.

Это свойство было добавлено в QtQuick.Controls 2.5 (Qt 5.12).

См. также padding, leftPadding, rightPadding и verticalPadding.

[только для чтения, начиная с QtQuick.Controls 2.5 (Qt 5.12)] implicitBackgroundHeight : real

Это свойство содержит неявную высоту фона.

Значение равно background ? background.implicitHeight : 0.

Это свойство было добавлено в QtQuick.Controls 2.5 (Qt 5.12).

См. также implicitBackgroundWidth и implicitContentHeight.

[только для чтения, начиная с QtQuick.Controls 2.5 (Qt 5.12)] implicitBackgroundWidth : real

Это свойство содержит неявную ширину фона.

Значение равно background ? background.implicitWidth : 0.

Это свойство было добавлено в QtQuick.Controls 2.5 (Qt 5.12).

См. также implicitBackgroundHeight и implicitContentWidth.

[только для чтения, начиная с QtQuick.Controls 2.5 (Qt 5.12)] implicitContentHeight : real

Это свойство содержит неявную высоту содержимого.

Значение вычисляется на основе дочерних элементов содержимого.

Это свойство было добавлено в QtQuick.Controls 2.5 (Qt 5.12).

См. также implicitContentWidth и implicitBackgroundHeight.

[только для чтения, начиная с QtQuick.Controls 2.5 (Qt 5.12)] implicitContentWidth : real

Это свойство содержит неявную ширину содержимого.

Значение вычисляется на основе дочерних элементов содержимого.

Это свойство было добавлено в QtQuick.Controls 2.5 (Qt 5.12).

См. также implicitContentHeight и implicitBackgroundWidth.

implicitHeight : real

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

implicitWidth : real

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

[since QtQuick.Controls 2.5 (Qt 5.12)] leftInset : real

Это свойство содержит левый отступ фона.

Это свойство было добавлено в QtQuick.Controls 2.5 (Qt 5.12).

См. также Макет всплывающего окна и rightInset.

leftMargin : real

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

Всплывающее окно с отрицательным левым отступом не выводится внутри левого края содержащего окна. Значение по умолчанию — -1.

См. также отступы, rightMargin и Макет всплывающего окна.

leftPadding : real

Это свойство содержит левый отступ. Если явно не задано, значение равно horizontalPadding.

Свойства отступа используются для управления геометрией элемента содержимого.

Всплывающее окно использует тот же подход к отступам, что и Control. Визуальное объяснение системы отступов см. в разделе Макет управления документации.

См. также padding, rightPadding, horizontalPadding и availableWidth.

locale : Locale

Это свойство содержит локаль всплывающего окна.

См. также mirrored и LayoutMirroring.

margins : real

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

Всплывающее окно с отрицательными отступами не выводится внутри границ содержащего окна. Значение по умолчанию — -1.

См. также topMargin, leftMargin, rightMargin, bottomMargin и Макет всплывающего окна.

[только для чтения, начиная с QtQuick.Controls 2.3 (Qt 5.10)] mirrored : bool

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

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

Это свойство было добавлено в QtQuick.Controls 2.3 (Qt 5.10).

См. также locale и Интерфейсы пользователей справа налево.

modal : bool

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

Модальные всплывающие окна часто имеют отличительный эффект затемнения фона, определенный в Overlay.modal, и не позволяют пропускать события нажатия или отпускания на элементы под ними. Например, если пользователь случайно нажмёт за пределами всплывающего окна, любой элемент под этим всплывающим окном в месте щелчка не получит этого события.

На настольных платформах обычно модальные всплывающие окна закрываются только при нажатии клавиши Escape. Для достижения этого поведения установите closePolicy в Popup.CloseOnEscape. По умолчанию, closePolicy установлено в Popup.CloseOnEscape | Popup.CloseOnPressOutside, что означает, что щелчок за пределами модального всплывающего окна закроет его.

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

См. также dim.

opacity : real

Это свойство определяет непрозрачность всплывающего окна. Непрозрачность задаётся числом от 0.0 (полностью прозрачное) до 1.0 (полностью непрозрачное). Значение по умолчанию — 1.0.

См. также visible.

[с QtQuick.Controls 2.3 (Qt 5.10)] opened : bool

Это свойство определяет, полностью ли открыто всплывающее окно. Всплывающее окно считается открытым, когда оно видно и ни одна из анимаций входа (enter) или выхода (exit) не выполняется.

Это свойство было добавлено в QtQuick.Controls 2.3 (Qt 5.10).

См. также open(), close(), и visible.

padding : real

Это свойство определяет значение по умолчанию для отступов.

Свойства отступов используются для управления геометрией элемента содержимого.

Всплывающее окно использует тот же подход к отступам, что и Control. Визуальное объяснение системы отступов можно найти в разделе Макет элементов управления документации.

См. также availableWidth, availableHeight, topPadding, leftPadding, rightPadding и bottomPadding.

[с QtQuick.Controls 2.3 (Qt 5.10)] palette : palette

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

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

Popup {
    palette.text: "red"

    Column {
        Label {
            text: qsTr("This will use red color...")
        }

        Switch {
            text: qsTr("... and so will this")
        }
    }
}

Это свойство было добавлено в QtQuick.Controls 2.3 (Qt 5.10).

См. также Item::palette, Window::palette, ColorGroup и Palette.

parent : Item

Это свойство содержит родительский элемент.

[с QtQuick.Controls 2.5 (Qt 5.12)] rightInset : real

Это свойство определяет правый отступ для фона.

Это свойство было добавлено в QtQuick.Controls 2.5 (Qt 5.12).

См. также Макет всплывающего окна и leftInset.

rightMargin : real

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

Всплывающее окно с отрицательным правым отступом не смещается внутри правого края окружающего окна. Значение по умолчанию — -1.

См. также отступы, leftMargin и Макет всплывающего окна.

rightPadding : real

Это свойство определяет правый отступ. Если не задано явно, значение равно horizontalPadding.

Свойства отступов используются для управления геометрией элемента содержимого.

Всплывающее окно использует тот же подход к отступам, что и Control. Визуальное объяснение системы отступов можно найти в разделе Макет элементов управления документации.

См. также padding, leftPadding, horizontalPadding и availableWidth.

scale : real

Это свойство определяет коэффициент масштабирования всплывающего окна. Значение по умолчанию — 1.0.

Масштаб меньше 1.0 приводит к отображению всплывающего окна в меньшем размере, а масштаб больше 1.0 отображает всплывающее окно в большем размере. Отрицательные масштабы не поддерживаются.

[с QtQuick.Controls 2.1 (Qt 5.8)] spacing : real

Это свойство определяет интервал.

Интервал полезен для всплывающих окон, имеющих несколько или повторяющихся строительных блоков. Например, некоторые стили используют интервал для определения расстояния между заголовком, содержимым и подвалом Диалога. Интервал не навязывается всплывающим окном, поэтому каждый стиль может интерпретировать его по-разному, а некоторые могут его игнорировать.

Это свойство было добавлено в QtQuick.Controls 2.1 (Qt 5.8).

[с QtQuick.Controls 2.5 (Qt 5.12)] topInset : real

Это свойство определяет верхний отступ для фона.

Это свойство было добавлено в QtQuick.Controls 2.5 (Qt 5.12).

См. также Макет всплывающего окна и bottomInset.

topMargin : real

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

Всплывающее окно с отрицательным верхним отступом не смещается внутри верхней грани окружающего окна. Значение по умолчанию — -1.

См. также отступы, bottomMargin и Макет всплывающего окна.

topPadding : real

Это свойство определяет верхний отступ. Если не задано явно, значение равно verticalPadding.

Свойства отступов используются для управления геометрией элемента содержимого.

Всплывающее окно использует тот же подход к отступам, что и Control. Визуальное объяснение системы отступов можно найти в разделе Макет элементов управления документации.

См. также padding, bottomPadding, verticalPadding и availableHeight.

transformOrigin : enumeration

Это свойство определяет точку начала преобразований в анимациях входа и выхода.

Доступно девять точек начала преобразований, как показано на изображении ниже. По умолчанию используется точка Popup.Center.

См. также enter, exit и Item::transformOrigin.

[с QtQuick.Controls 2.5 (Qt 5.12)] verticalPadding : real

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

Свойства отступов используются для управления геометрией элемента содержимого.

Всплывающее окно использует тот же подход к отступам, что и Control. Визуальное объяснение системы отступов можно найти в разделе Макет элементов управления документации.

Это свойство было добавлено в QtQuick.Controls 2.5 (Qt 5.12).

См. также padding, topPadding, bottomPadding и horizontalPadding.

visible : bool

Это свойство указывает, отображается ли всплывающее окно. Значение по умолчанию — false.

См. также open(), close() и opened.

width : real

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

x : real

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

См. также y и z.

y : real

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

См. также x и z.

z : real

Это свойство содержит значение z всплывающего окна. Значение z определяет порядок отображения всплывающих окон.

Если у двух видимых всплывающих окон одинаковое значение z, последнему открытому будет присвоен верхний порядок отображения.

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

См. также x и y.

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

void aboutToHide()

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

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

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

void aboutToShow()

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

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

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

void closed()

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

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

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

void opened()

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

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

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

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

void close()

Закрывает всплывающее окно.

См. также visible.

forceActiveFocus(enumeration reason = Qt.OtherFocusReason)

Принудительно устанавливает активный фокус на всплывающее окно с указанным reason.

Этот метод устанавливает фокус на всплывающее окно и гарантирует, что все родительские объекты FocusScope в иерархии объектов также получают фокус.

См. также activeFocus и Qt::FocusReason.

void open()

Открывает всплывающее окно.

См. также visible.