Spec-Zone.ru › Qt 5.13

Класс QWindow

Класс QWindow представляет окно в базовой системе окон. Подробнее...

Заголовок: #include <QWindow>
qmake: QT += gui
С момента: Qt 5.0
Наследуется от: QObject и QSurface
Наследуется у:

QPaintDeviceWindow и QVulkanWindow

Этот класс был представлен в Qt 5.0.

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

Публичные типы

Перечисление AncestorMode { ExcludeTransients, IncludeTransients }
Перечисление Visibility { Windowed, Minimized, Maximized, FullScreen, AutomaticVisibility, Hidden }

Свойства

  • active : const bool
  • contentOrientation : Qt::ScreenOrientation
  • flags : Qt::WindowFlags
  • height : int
  • maximumHeight : int
  • maximumWidth : int
  • minimumHeight : int
  • minimumWidth : int
  • modality : Qt::WindowModality
  • opacity : qreal
  • title : QString
  • visibility : Visibility
  • visible : bool
  • width : int
  • x : int
  • y : int

Публичные функции

QWindow(QWindow *parent)
QWindow(QScreen *targetScreen = nullptr)
virtual ~QWindow()
QSize baseSize() const
Qt::ScreenOrientation contentOrientation() const
void create()
QCursor cursor() const
void destroy()
qreal devicePixelRatio() const
QString filePath() const
Qt::WindowFlags flags() const
virtual QObject * focusObject() const
QRect frameGeometry() const
QMargins frameMargins() const
QPoint framePosition() const
QRect geometry() const
int height() const
QIcon icon() const
bool isActive() const
bool isAncestorOf(const QWindow *child, QWindow::AncestorMode mode = IncludeTransients) const
bool isExposed() const
bool isModal() const
bool isTopLevel() const
bool isVisible() const
QPoint mapFromGlobal(const QPoint &pos) const
QPoint mapToGlobal(const QPoint &pos) const
QRegion mask() const
int maximumHeight() const
QSize maximumSize() const
int maximumWidth() const
int minimumHeight() const
QSize minimumSize() const
int minimumWidth() const
Qt::WindowModality modality() const
qreal opacity() const
QWindow * parent(QWindow::AncestorMode mode) const
QWindow * parent() const
QPoint position() const
void reportContentOrientationChange(Qt::ScreenOrientation orientation)
QSurfaceFormat requestedFormat() const
void resize(const QSize &newSize)
void resize(int w, int h)
QScreen * screen() const
void setBaseSize(const QSize &size)
void setCursor(const QCursor &cursor)
void setFilePath(const QString &filePath)
void setFlag(Qt::WindowType flag, bool on = true)
void setFlags(Qt::WindowFlags flags)
void setFormat(const QSurfaceFormat &format)
void setFramePosition(const QPoint &point)
void setIcon(const QIcon &icon)
bool setKeyboardGrabEnabled(bool grab)
void setMask(const QRegion &region)
void setMaximumSize(const QSize &size)
void setMinimumSize(const QSize &size)
void setModality(Qt::WindowModality modality)
bool setMouseGrabEnabled(bool grab)
void setOpacity(qreal level)
void setParent(QWindow *parent)
void setPosition(const QPoint &pt)
void setPosition(int posx, int posy)
void setScreen(QScreen *newScreen)
void setSizeIncrement(const QSize &size)
void setSurfaceType(QSurface::SurfaceType surfaceType)
void setVisibility(QWindow::Visibility v)
void setVulkanInstance(QVulkanInstance *instance)
void setWindowState(Qt::WindowState state)
void setWindowStates(Qt::WindowStates state)
QSize sizeIncrement() const
QString title() const
Qt::WindowType type() const
void unsetCursor()
QWindow::Visibility visibility() const
QVulkanInstance * vulkanInstance() const
int width() const
WId winId() const
Qt::WindowState windowState() const
Qt::WindowStates windowStates() const
int x() const
int y() const

Реализованные публичные функции

virtual QSurfaceFormat format() const override
virtual QSize size() const override
virtual QSurface::SurfaceType surfaceType() const override

Публичные слоты

void alert(int msec)
bool close()
void hide()
void lower()
void raise()
void requestActivate()
void requestUpdate()
void setGeometry(const QRect &rect)
void setGeometry(int posx, int posy, int w, int h)
void setHeight(int arg)
void setMaximumHeight(int h)
void setMaximumWidth(int w)
void setMinimumHeight(int h)
void setMinimumWidth(int w)
void setTitle(const QString &)
void setVisible(bool visible)
void setWidth(int arg)
void setX(int arg)
void setY(int arg)
void show()
void showFullScreen()
void showMaximized()
void showMinimized()
void showNormal()

Сигналы

void activeChanged()
void contentOrientationChanged(Qt::ScreenOrientation orientation)
void focusObjectChanged(QObject *object)
void heightChanged(int arg)
void maximumHeightChanged(int arg)
void maximumWidthChanged(int arg)
void minimumHeightChanged(int arg)
void minimumWidthChanged(int arg)
void modalityChanged(Qt::WindowModality modality)
void opacityChanged(qreal opacity)
void screenChanged(QScreen *screen)
void visibilityChanged(QWindow::Visibility visibility)
void visibleChanged(bool arg)
void widthChanged(int arg)
void windowStateChanged(Qt::WindowState windowState)
void windowTitleChanged(const QString &title)
void xChanged(int arg)
void yChanged(int arg)

Статические публичные члены

QWindow * fromWinId(WId id)

Защищённые функции

виртуальный void exposeEvent(QExposeEvent *ev)
виртуальный void focusInEvent(QFocusEvent *ev)
виртуальный void focusOutEvent(QFocusEvent *ev)
виртуальный void hideEvent(QHideEvent *ev)
виртуальный void keyPressEvent(QKeyEvent *ev)
виртуальный void keyReleaseEvent(QKeyEvent *ev)
виртуальный void mouseDoubleClickEvent(QMouseEvent *ev)
виртуальный void mouseMoveEvent(QMouseEvent *ev)
виртуальный void mousePressEvent(QMouseEvent *ev)
виртуальный void mouseReleaseEvent(QMouseEvent *ev)
виртуальный void moveEvent(QMoveEvent *ev)
виртуальный bool nativeEvent(const QByteArray &eventType, void *message, long *result)
виртуальный void resizeEvent(QResizeEvent *ev)
виртуальный void showEvent(QShowEvent *ev)
виртуальный void tabletEvent(QTabletEvent *ev)
виртуальный void touchEvent(QTouchEvent *ev)
виртуальный void wheelEvent(QWheelEvent *ev)

Реализованные защищённые функции

виртуальный bool event(QEvent *ev) override

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

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

Приложение, как правило, использует QWidget или QQuickView для своего пользовательского интерфейса, а не QWindow напрямую. Тем не менее, можно отображать изображения непосредственно в QWindow с помощью QBackingStore или QOpenGLContext, когда требуется минимизировать зависимости или когда нужно использовать OpenGL напрямую. Примеры Raster Window Example и OpenGL Window Example являются полезными примерами для отображения в QWindow с помощью обоих подходов.

Управление ресурсами

Окна могут потенциально использовать много памяти. Обычным показателем является ширина умноженная на высоту умноженная на глубину цвета. Окно может также включать несколько буферов для поддержки двойного и тройного буферизации, а также буферов глубины и трафарета. Чтобы освободить ресурсы памяти окна, вызовите функцию destroy()

Ориентация содержимого

QWindow имеет reportContentOrientationChange(), который можно использовать для указания расположения содержимого окна относительно экрана. Ориентация содержимого — это просто подсказка для системы окон о том, в какой ориентации находится содержимое окна. Это полезно, когда вы хотите сохранить тот же размер окна, но повернуть содержимое вместо этого, особенно при выполнении анимаций поворота между различными ориентациями. Система окон может использовать это значение для определения расположения всплывающих окон или диалоговых окон.

Видимость и экспонирование системой окон

По умолчанию окно невидимо, и вы должны вызвать setVisible(true) или show() или аналогичную функцию, чтобы сделать его видимым. Чтобы снова скрыть окно, вызовите setVisible(false) или hide(). Свойство visible описывает состояние, в котором приложение хочет видеть окно. В зависимости от базовой системы, видимое окно всё равно может не отображаться на экране. Например, оно может быть скрыто другими непрозрачными окнами или перемещено за пределы физической области экрана. В системах окон, которые имеют уведомления об экспонировании, свойство isExposed() описывает, следует ли рассматривать окно как непосредственно видимое на экране. Функция exposeEvent() вызывается всякий раз, когда область окна становится недействительной, например, из-за изменения экспонирования в системе окон. В системах окон, которые не предоставляют эту информацию приложению, isExposed() просто возвращает то же значение, что и isVisible().

QWindow::Visibility запрошен через visibility() — это удобный API, объединяющий функции visible() и windowStates().

Отображение

Есть два API Qt, которые могут использоваться для отображения содержимого в окне: QBackingStore для отображения с помощью QPainter и вывода содержимого в окно с типом QSurface::RasterSurface, и QOpenGLContext для отображения с помощью OpenGL в окно с типом QSurface::OpenGLSurface.

Приложение может начать отображение, как только isExposed() вернёт true, и может продолжать отображение, пока isExposed() не вернёт false. Чтобы узнать, когда isExposed() изменяется, переопределите exposeEvent(). Окно всегда получит событие изменения размера перед первым событием expose.

Начальная геометрия

Если ширина и высота окна не инициализированы, окно получит разумную геометрию по умолчанию от платформы. Если позиция не инициализирована, то платформа позволит системе окон расположить окно. Например, в X11 менеджер окон обычно выполняет некоторое интеллектуальное позиционирование, чтобы избежать полного перекрытия новых окон существующими. Однако setGeometry() инициализирует как позицию, так и размер, поэтому, если вы хотите фиксированный размер, но автоматическую позицию, следует вызвать resize() или setWidth() и setHeight() вместо этого.

Документация по типам членов

перечисление QWindow::AncestorMode

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

Постоянная Значение Описание
QWindow::ExcludeTransients 0 Временные родители не считаются предками.
QWindow::IncludeTransients 1 Временные родители считаются предками.

перечисление QWindow::Visibility

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

Постоянная Значение Описание
QWindow::Windowed 2 Окно занимает часть экрана, но не обязательно весь экран. Это состояние будет появляться только на системах с поддержкой одновременного отображения нескольких окон. В этом состоянии пользователь может перемещать и изменять размер окна вручную, если это разрешено параметрами WindowFlags и поддерживается системой окон.
QWindow::Minimized 3 Окно сворачивается в значок или запись на панели задач, панели задач, списке задач или рабочем столе, в зависимости от того, как система окон обрабатывает сворачиваемые окна.
QWindow::Maximized 4 Окно занимает весь экран, и строка заголовка всё ещё видна. На большинстве систем окон это состояние достигается щелчком по кнопке максимизации на панели инструментов.
QWindow::FullScreen 5 Окно занимает весь экран, не изменяет размер и не имеет строки заголовка. На некоторых платформах, которые не поддерживают одновременное отображение нескольких окон, это может быть обычное состояние видимости, когда окно не скрыто.
QWindow::AutomaticVisibility 1 Это означает присвоение окну состояния видимости по умолчанию, которое может быть полноэкранным или оконным в зависимости от платформы. Его можно задать параметром функции setVisibility, но он никогда не будет считываться из доступа к видимости.
QWindow::Hidden 0 Окно не отображается, но может запоминать скрытую видимость, которую можно восстановить, установив значение AutomaticVisibility.

Этот перечисление был добавлен или изменён в Qt 5.1.

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

active : const bool

Это свойство хранит статус активности окна

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

Функции доступа:

bool isActive() const

Сигнал уведомления:

void activeChanged()

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

contentOrientation : Qt::ScreenOrientation

Это свойство хранит ориентацию содержимого окна

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

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

Разница между ориентацией окна и ориентацией содержимого определяет, на сколько градусов нужно повернуть содержимое. QScreen::angleBetween(), QScreen::transformBetween() и QScreen::mapBetween() могут использоваться для вычисления необходимого преобразования.

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

Функции доступа:

Qt::ScreenOrientation contentOrientation() const
void reportContentOrientationChange(Qt::ScreenOrientation orientation)

Сигнал уведомления:

void contentOrientationChanged(Qt::ScreenOrientation orientation)

flags : Qt::WindowFlags

Это свойство хранит флаги окна

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

Фактические флаги окна могут отличаться от флагов, установленных с помощью setFlags(), если запрошенные флаги не могут быть выполнены.

Функции доступа:

Qt::WindowFlags flags() const
void setFlags(Qt::WindowFlags flags)

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

height : int

Это свойство хранит высоту геометрии окна

Функции доступа:

int height() const
void setHeight(int arg)

Сигнал уведомления:

void heightChanged(int arg)

maximumHeight : int

Это свойство хранит максимальную высоту геометрии окна

Функции доступа:

int maximumHeight() const
void setMaximumHeight(int h)

Сигнал уведомления:

void maximumHeightChanged(int arg)

maximumWidth : int

Это свойство хранит максимальную ширину геометрии окна

Функции доступа:

int maximumWidth() const
void setMaximumWidth(int w)

Сигнал уведомления:

void maximumWidthChanged(int arg)

minimumHeight : int

Это свойство хранит минимальную высоту геометрии окна

Функции доступа:

int minimumHeight() const
void setMinimumHeight(int h)

Сигнал уведомления:

void minimumHeightChanged(int arg)

minimumWidth : int

Это свойство хранит минимальную ширину геометрии окна

Функции доступа:

int minimumWidth() const
void setMinimumWidth(int w)

Сигнал уведомления:

void minimumWidthChanged(int arg)

modality : Qt::WindowModality

Это свойство хранит модальность окна

Модальное окно предотвращает получение событий ввода другими окнами. Qt поддерживает два типа модальности: Qt::WindowModal и Qt::ApplicationModal.

По умолчанию это свойство имеет значение Qt::NonModal

Функции доступа:

Qt::WindowModality modality() const
void setModality(Qt::WindowModality modality)

Сигнал уведомления:

void modalityChanged(Qt::WindowModality modality)

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

opacity : qreal

Это свойство хранит непрозрачность окна в оконной системе.

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

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

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

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

Функции доступа:

qreal opacity() const
void setOpacity(qreal level)

Сигнал уведомления:

void opacityChanged(qreal opacity)

title : QString

Это свойство хранит заголовок окна в оконной системе

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

Функции доступа:

QString title() const
void setTitle(const QString &)

Сигнал уведомления:

void windowTitleChanged(const QString &title)

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

visibility : Visibility

Это свойство хранит состояние занятости экрана окном

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

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

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

Функции доступа:

QWindow::Visibility visibility() const
void setVisibility(QWindow::Visibility v)

Сигнал уведомления:

void visibilityChanged(QWindow::Visibility visibility)

visible : bool

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

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

По умолчанию окно не отображается, необходимо вызвать setVisible(true), или show() или аналогичную функцию, чтобы сделать его видимым.

Функции доступа:

bool isVisible() const
void setVisible(bool visible)

Сигнал уведомления:

void visibleChanged(bool arg)

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

width : int

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

Функции доступа:

int width() const
void setWidth(int arg)

Сигнал уведомления:

void widthChanged(int arg)

x : int

Это свойство содержит позицию x геометрии окна.

Функции доступа:

int x() const
void setX(int arg)

Сигнал уведомления:

void xChanged(int arg)

y : int

Это свойство содержит позицию y геометрии окна.

Функции доступа:

int y() const
void setY(int arg)

Сигнал уведомления:

void yChanged(int arg)

Документация по членам функции

QWindow::QWindow(QWindow *parent)

Создаёт окно как дочернее окно указанного окна parent.

Окно будет вложено внутрь родительского окна, его координаты относительны к родителю.

Экран наследуется от родительского.

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

QWindow::QWindow(QScreen *targetScreen = nullptr)

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

Окно не отображается до вызова setVisible(true), show() или аналогичных функций.

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

[slot] void QWindow::alert(int msec)

Приводит к отображению уведомления на msec миллисекунд. Если msec равно 0 (значение по умолчанию), то уведомление отображается бесконечно до тех пор, пока окно снова не станет активным. Эта функция не действует на активном окне.

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

Эта функция была добавлена в Qt 5.1.

[slot] bool QWindow::close()

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

Закрывает окно, фактически вызывая destroy(), и потенциально завершая приложение. Возвращает true при успехе, false, если у окна есть родительское окно (в этом случае должно быть закрыто окно верхнего уровня).

См. также destroy() и QGuiApplication::quitOnLastWindowClosed().

[signal] void QWindow::focusObjectChanged(QObject *object)

Этот сигнал излучается, когда конечный получатель событий, связанных с фокусом, изменяется на object.

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

[slot] void QWindow::hide()

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

Эквивалентно вызову setVisible(false).

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

[slot] void QWindow::lower()

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

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

[signal] void QWindow::modalityChanged(Qt::WindowModality modality)

Этот сигнал излучается, когда свойство Qwindow::modality изменяется на modality.

Примечание: Сигнал уведомления для свойства modality.

[slot] void QWindow::raise()

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

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

[slot] void QWindow::requestActivate()

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

См. также isActive(), QGuiApplication::focusWindow() и QWindowsWindowFunctions::setWindowActivationBehavior().

[slot] void QWindow::requestUpdate()

Планирует событие QEvent::UpdateRequest для доставки в это окно.

Событие доставляется синхронно с обновлением отображения на платформах, где это возможно. В противном случае событие доставляется после задержки в 5 мс. Дополнительное время необходимо для предоставления циклу событий некоторого времени простоя для сбора системных событий, и может быть переопределено с помощью переменной окружения QT_QPA_UPDATE_IDLE_TIME.

При работе с анимациями эта функция должна вызываться один раз после завершения отрисовки. Многократный вызов этой функции приведёт к доставке в окно только одного события.

Подклассы QWindow должны переопределить event(), перехватить событие и вызвать код отрисовки приложения, а затем вызвать реализацию базового класса.

Примечание: Реализация подкласса event() должна вызывать реализацию базового класса, если он абсолютно уверен, что событие не нужно обрабатывать базовому классу. Например, реализация по умолчанию для этой функции полагается на события QEvent::Timer. Их отфильтровывание, следовательно, нарушит доставку событий обновления.

Эта функция была добавлена в Qt 5.5.

[signal] void QWindow::screenChanged(QScreen *screen)

Этот сигнал излучается, когда экран окна screen изменяется, либо явно с помощью setScreen(), либо автоматически, когда экран окна удаляется.

[slot] void QWindow::setGeometry(const QRect &rect)

Устанавливает геометрию окна, исключая рамку окна, равную rect.

Геометрия относится к virtualGeometry() экрана.

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

[slot] void QWindow::setGeometry(int posx, int posy, int w, int h)

Устанавливает геометрию окна, исключая рамку окна, к прямоугольнику, созданному из posx, posy, w и h.

Геометрия относится к virtualGeometry() экрана.

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

END_OF_DOCUMENT_MARKER

[slot] void QWindow::show()

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

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

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

[slot] void QWindow::showFullScreen()

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

Эквивалентно вызову setWindowStates(Qt::WindowFullScreen) и затем setVisible(true).

См. также setWindowStates() и setVisible().

[slot] void QWindow::showMaximized()

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

Эквивалентно вызову setWindowStates(Qt::WindowMaximized) и затем setVisible(true).

См. также setWindowStates() и setVisible().

[slot] void QWindow::showMinimized()

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

Эквивалентно вызову setWindowStates(Qt::WindowMinimized) и затем setVisible(true).

См. также setWindowStates() и setVisible().

[slot] void QWindow::showNormal()

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

Эквивалентно вызову setWindowStates(Qt::WindowNoState) и затем setVisible(true).

См. также setWindowStates() и setVisible().

[signal] void QWindow::windowStateChanged(Qt::WindowState windowState)

Этот сигнал испускается, когда состояние окна windowState изменяется, либо явно установлено с помощью setWindowStates(), либо автоматически, когда пользователь нажимает одну из кнопок на панели заголовка или другими способами.

[virtual] QWindow::~QWindow()

Уничтожает окно.

QSize QWindow::baseSize() const

Возвращает базовый размер окна.

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

void QWindow::create()

Выделяет ресурсы платформы, связанные с окном.

В этот момент формат поверхности, установленный с помощью setFormat(), преобразуется в фактическую нативную поверхность. Однако окно остается скрытым до вызова setVisible().

Обратите внимание, что обычно не требуется вызывать эту функцию напрямую, так как она будет неявно вызвана show(), setVisible() и другими функциями, требующими доступа к ресурсам платформы.

Вызовите destroy(), чтобы освободить ресурсы платформы, если необходимо.

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

QCursor QWindow::cursor() const

форма курсора для этого окна

См. также setCursor() и unsetCursor().

void QWindow::destroy()

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

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

qreal QWindow::devicePixelRatio() const

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

Общие значения — 1,0 на обычных дисплеях и 2,0 на дисплеях Apple «Retina».

Примечание: Для окон, не поддерживаемых платформенным окном, т.е. для которых не был вызван create(), функция обращается к отношению пикселей устройства связанного QScreen.

См. также QScreen::devicePixelRatio().

[override virtual protected] bool QWindow::event(QEvent *ev)

Переопределяет: QObject::event(QEvent *e).

Переопределите для обработки любого события (ev), отправленного в окно. Верните true, если событие было распознано и обработано.

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

[virtual protected] void QWindow::exposeEvent(QExposeEvent *ev)

Событие отображения (ev) отправляется системой окон, когда область окна становится недействительной, например, из-за изменения отображения в системе окон.

Приложение может начать отрисовку в окно с помощью QBackingStore и QOpenGLContext как только получит exposeEvent(), при условии, что isExposed() равно true.

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

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

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

QString QWindow::filePath() const

имя файла, который представляет это окно.

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

[virtual protected] void QWindow::focusInEvent(QFocusEvent *ev)

Переопределите эту функцию для обработки событий focus in (ev).

События focus in отправляются, когда окно получает фокус клавиатуры.

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

[virtual] QObject *QWindow::focusObject() const

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

[virtual protected] void QWindow::focusOutEvent(QFocusEvent *ev)

Переопределите эту функцию для обработки событий focus out (ev).

События focus out отправляются, когда окно теряет фокус клавиатуры.

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

[override virtual] QSurfaceFormat QWindow::format() const

Переопределяет: QSurface::format() const.

Возвращает фактический формат этого окна.

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

Примечание: В зависимости от платформы некоторые значения в этом формате поверхности могут по-прежнему содержать запрошенные значения, то есть значения, которые были переданы в setFormat(). Типичные примеры — версия OpenGL, профиль и параметры. Они могут не обновляться во время create(), поскольку они специфичны для контекста, и одно окно может использоваться вместе с несколькими контекстами на протяжении всего его жизненного цикла. Используйте формат() QOpenGLContext для запроса таких значений вместо этого.

См. также setFormat(), create(), requestedFormat() и QOpenGLContext::format().

QRect QWindow::frameGeometry() const

Возвращает геометрию окна, включая его рамку.

Геометрия относится к virtualGeometry() соответствующего экрана.

См. также geometry() и frameMargins().

QMargins QWindow::frameMargins() const

Возвращает отступы рамки окна вокруг окна.

См. также geometry() и frameGeometry().

QPoint QWindow::framePosition() const

Возвращает верхнюю левую позицию окна, включая его рамку.

Возвращает то же значение, что и frameGeometry().topLeft().

См. также setFramePosition(), geometry() и frameGeometry().

[static] QWindow *QWindow::fromWinId(WId id)

Создает локальное представление окна, созданного другим процессом или с помощью нативных библиотек ниже Qt.

Учитывая дескриптор id нативное окно, этот метод создает объект QWindow, который может использоваться для представления окна при вызове методов, таких как setParent() и setTransientParent().

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

Если нативные окна не поддерживаются или встраивание нативного окна в плагине платформы потерпело неудачу, эта функция возвращает nullptr.

Примечание: Результирующий QWindow не следует использовать для манипулирования базовым нативным окном (кроме изменения родителя), или для наблюдения за изменениями состояния нативного окна. Любая поддержка таких операций случайная, сильно зависит от платформы и не тестировалась.

См. также setParent() и setTransientParent().

QRect QWindow::geometry() const

Возвращает геометрию окна, исключая его рамку.

Геометрия относится к virtualGeometry() его экрана.

См. также setGeometry(), frameMargins() и frameGeometry().

[virtual protected] void QWindow::hideEvent(QHideEvent *ev)

Переопределите этот метод для обработки событий скрытия (ev).

Функция вызывается, когда окно запросило скрытие в системе окон.

QIcon QWindow::icon() const

Возвращает значок окна в системе окон.

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

bool QWindow::isActive() const

Возвращает true, если окно должно выглядеть активным с точки зрения стиля.

Это относится к окну, у которого есть фокус ввода, а также к окнам, которые находятся в той же цепочке родитель/временный родитель, что и окно с фокусом.

Чтобы получить окно, у которого в данный момент фокус, используйте QGuiApplication::focusWindow().

Примечание: Метод-геттер для свойства active.

bool QWindow::isAncestorOf(const QWindow *child, QWindow::AncestorMode mode = IncludeTransients) const

Возвращает true, если окно является предком указанного child. Если mode равен IncludeTransients, то временные родители также рассматриваются как предки.

bool QWindow::isExposed() const

Возвращает, отображено ли это окно в системе окон.

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

Метод exposeEvent() вызывается каждый раз, когда это значение изменяется.

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

bool QWindow::isModal() const

Возвращает, является ли окно модальным.

Модальное окно предотвращает получение других окон любого ввода.

См. также QWindow::modality.

bool QWindow::isTopLevel() const

Возвращает, является ли окно верхним, т.е. не имеет родительского окна.

[virtual protected] void QWindow::keyPressEvent(QKeyEvent *ev)

Переопределите этот метод для обработки событий нажатия клавиш (ev).

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

[virtual protected] void QWindow::keyReleaseEvent(QKeyEvent *ev)

Переопределите этот метод для обработки событий отпускания клавиш (ev).

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

QPoint QWindow::mapFromGlobal(const QPoint &pos) const

Преобразует глобальные координаты экрана pos в координаты окна.

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

QPoint QWindow::mapToGlobal(const QPoint &pos) const

Преобразует координаты окна pos в глобальные координаты экрана. Например, mapToGlobal(QPoint(0,0)) даст глобальные координаты левого верхнего пикселя окна.

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

QRegion QWindow::mask() const

Возвращает маску, установленную для окна.

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

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

QSize QWindow::maximumSize() const

Возвращает максимальный размер окна.

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

QSize QWindow::minimumSize() const

Возвращает минимальный размер окна.

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

[virtual protected] void QWindow::mouseDoubleClickEvent(QMouseEvent *ev)

Переопределите этот метод для обработки двойных щелчков мышью (ev).

См. также mousePressEvent() и QStyleHints::mouseDoubleClickInterval().

[virtual protected] void QWindow::mouseMoveEvent(QMouseEvent *ev)

Переопределите этот метод для обработки событий перемещения мыши (ev).

[virtual protected] void QWindow::mousePressEvent(QMouseEvent *ev)

Переопределите этот метод для обработки событий нажатия мыши (ev).

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

[virtual protected] void QWindow::mouseReleaseEvent(QMouseEvent *ev)

Переопределите этот метод для обработки событий отпускания мыши (ev).

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

[virtual protected] void QWindow::moveEvent(QMoveEvent *ev)

Переопределите этот метод для обработки событий перемещения окна (ev).

[virtual protected] bool QWindow::nativeEvent(const QByteArray &eventType, void *message, long *result)

Переопределите этот метод для обработки событий, зависящих от платформы. Получите eventType, message и result.

Это может сделать ваше приложение непереносимым.

Должно возвращать true только в том случае, если событие было обработано.

QWindow *QWindow::parent(QWindow::AncestorMode mode) const

Возвращает родительское окно, если оно есть.

Если mode равен IncludeTransients, то возвращается временный родитель, если родительского окна нет.

Окно без родителя известно как верхнее окно.

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

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

QWindow *QWindow::parent() const

Возвращает родительское окно, если оно есть.

Окно без родителя известно как верхнее окно.

QPoint QWindow::position() const

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

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

QSurfaceFormat QWindow::requestedFormat() const

Возвращает запрошенный формат поверхности этого окна.

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

Это значение устанавливается с помощью setFormat().

См. также setFormat() и format().

void QWindow::resize(const QSize &newSize)

Устанавливает размер окна, исключая рамку, на newSize.

См. также size() и geometry().

void QWindow::resize(int w, int h)

Устанавливает размер окна, исключая рамку, на QSize, созданный из ширины w и высоты h.

См. также size() и geometry().

[virtual protected] void QWindow::resizeEvent(QResizeEvent *ev)

Переопределите этот метод для обработки событий изменения размера (ev).

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

QScreen *QWindow::screen() const

Возвращает экран, на котором отображается окно, или null, если такового нет.

Для дочерних окон возвращает экран соответствующего верхнего уровня окна.

См. также setScreen() и QScreen::virtualSiblings().

void QWindow::setBaseSize(const QSize &size)

Устанавливает базовый размер size окна.

Базовый размер используется для расчета правильного размера окна, если окно определяет sizeIncrement().

См. также setMinimumSize(), setMaximumSize(), setSizeIncrement() и baseSize().

void QWindow::setCursor(const QCursor &cursor)

Устанавливает форму курсора для данного окна

Курсор мыши cursor примет эту форму, когда он находится над этим окном, если не установлен курсор переопределения. Список предопределенных объектов курсора см. в списке предопределенных объектов курсора.

Если курсор не установлен или после вызова unsetCursor(), используется курсор родительского окна.

По умолчанию курсор имеет форму Qt::ArrowCursor.

Некоторые реализации оконных систем могут сбросить курсор, если он покидает окно, даже если мышь захвачена. Если вы хотите установить курсор для всех окон, даже при нахождении вне окна, рассмотрите QGuiApplication::setOverrideCursor().

См. также cursor() и QGuiApplication::setOverrideCursor().

void QWindow::setFilePath(const QString &filePath)

Устанавливает имя файла, которое представляет это окно.

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

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

void QWindow::setFlag(Qt::WindowType flag, bool on = true)

Устанавливает флаг окна flag в этом окне, если on равно true; в противном случае сбрасывает флаг.

Эта функция была добавлена в Qt 5.9.

См. также setFlags(), flags() и type().

void QWindow::setFormat(const QSurfaceFormat &format)

Устанавливает формат поверхности окна format.

Формат определяет такие свойства, как глубина цвета, альфа, размер буферов глубины и трафарета и т. д. Например, чтобы сделать окно прозрачным (при условии, что система окон поддерживает композитинг и другие содержимое окна не делает его непрозрачным снова):

QSurfaceFormat format;
format.setAlphaBufferSize(8);
window.setFormat(format);

Формат поверхности будет разрешен в функции create(). Вызов этой функции после вызова create() не переразрешит формат поверхности родного объекта.

Если формат не установлен явно через эту функцию, будет использован формат, возвращаемый QSurfaceFormat::defaultFormat(). Это означает, что при наличии нескольких окон отдельные вызовы этой функции могут быть заменены одним вызовом QSurfaceFormat::setDefaultFormat() до создания первого окна.

См. также format(), create(), destroy() и QSurfaceFormat::setDefaultFormat().

void QWindow::setFramePosition(const QPoint &point)

Устанавливает верхнюю левую позицию окна (point), включая рамку окна.

Позиция относительно virtualGeometry() соответствующего экрана.

См. также framePosition(), setGeometry() и frameGeometry().

void QWindow::setIcon(const QIcon &icon)

Устанавливает значок окна icon в системе окон.

Значок окна может использоваться системой окон, например, для оформления окна и/или в переключателе задач.

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

См. также icon() и setFilePath().

bool QWindow::setKeyboardGrabEnabled(bool grab)

Устанавливает, следует ли включать захват клавиатуры (grab).

Если возвращаемое значение true, окно получает все события клавиш до вызова setKeyboardGrabEnabled(false); другие окна не получают вообще никаких событий клавиш. События мыши не затрагиваются. Используйте setMouseGrabEnabled(), если нужно захватить их.

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

void QWindow::setMask(const QRegion &region)

Устанавливает маску окна.

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

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

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

void QWindow::setMaximumSize(const QSize &size)

Устанавливает максимальный размер окна.

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

См. также setMinimumSize() и maximumSize().

void QWindow::setMinimumSize(const QSize &size)

Устанавливает минимальный размер окна.

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

См. также setMaximumSize() и minimumSize().

bool QWindow::setMouseGrabEnabled(bool grab)

Устанавливает, следует ли включать захват мыши (grab).

Если возвращаемое значение true, окно получает все события мыши до вызова setMouseGrabEnabled(false); другие окна не получают вообще никаких событий мыши. События клавиатуры не затрагиваются. Используйте setKeyboardGrabEnabled(), если нужно захватить их.

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

void QWindow::setParent(QWindow *parent)

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

Установка parent в nullptr сделает окно окном верхнего уровня.

Если parent — это окно, созданное с помощью fromWinId(), текущее окно будет вложено в parent, если платформа это поддерживает.

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

void QWindow::setPosition(const QPoint &pt)

Устанавливает позицию окна на рабочем столе в pt

Позиция относительно virtualGeometry() его экрана.

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

void QWindow::setPosition(int posx, int posy)

Устанавливает позицию окна на рабочем столе в posx, posy

Позиция относительно virtualGeometry() его экрана.

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

void QWindow::setScreen(QScreen *newScreen)

Устанавливает экран, на котором должно отображаться окно.

Если окно уже создано, оно будет пересоздано на newScreen.

Примечание: Если экран является частью виртуального рабочего стола с несколькими экранами, окно не переместится автоматически на newScreen. Чтобы разместить окно относительно экрана, используйте позицию topLeft() экрана.

Эта функция работает только для окон верхнего уровня.

См. также screen() и QScreen::virtualSiblings().

void QWindow::setSizeIncrement(const QSize &size)

Устанавливает шаг изменения размера (size) окна.

Когда пользователь изменяет размер окна, размер будет изменяться шагами sizeIncrement(). по горизонтали и sizeIncrement(). по вертикали, с baseSize() в качестве основы.

По умолчанию это свойство содержит размер с нулевой шириной и высотой.

Система окон может не поддерживать приращения размера.

См. также sizeIncrement(), setBaseSize(), setMinimumSize(), и setMaximumSize().

void QWindow::setSurfaceType(QSurface::SurfaceType surfaceType)

Устанавливает surfaceType окна.

Определяет, предназначено ли окно для растрового рендеринга с помощью QBackingStore или для OpenGL-рендеринга с помощью QOpenGLContext.

Тип поверхности surfaceType будет использован при создании нативного интерфейса в функции create(). Вызов этой функции после создания нативного интерфейса требует вызова destroy() и create() для освобождения старого нативного интерфейса и создания нового.

См. также surfaceType(), QBackingStore, QOpenGLContext, create() и destroy().

void QWindow::setVulkanInstance(QVulkanInstance *instance)

Связывает это окно со специфицированным Vulkan instance.

instance должен оставаться валидным до тех пор, пока существует этот экземпляр QWindow.

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

void QWindow::setWindowState(Qt::WindowState state)

Устанавливает состояние окна относительно экрана.

Состояние окна state определяет, отображается ли окно в системе окон как максимализированное, минимизированное, полноэкранное или нормальное.

Значение перечисления Qt::WindowActive не является допустимым параметром.

См. также windowState(), showNormal(), showFullScreen(), showMinimized(), showMaximized() и setWindowStates().

void QWindow::setWindowStates(Qt::WindowStates state)

Устанавливает состояние окна относительно экрана.

Состояние окна state определяет, отображается ли окно в системе окон как максимализированное, минимизированное и/или полноэкранное.

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

Значение перечисления Qt::WindowActive не должно устанавливаться.

Данная функция была добавлена в Qt 5.10.

См. также windowStates(), showNormal(), showFullScreen(), showMinimized() и showMaximized().

[virtual protected] void QWindow::showEvent(QShowEvent *ev)

Переопределите этот метод для обработки событий показа (ev).

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

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

[override virtual] QSize QWindow::size() const

Реализация: QSurface::size() const.

Возвращает размер окна, исключая рамку.

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

QSize QWindow::sizeIncrement() const

Возвращает приращение размера окна.

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

[override virtual] QSurface::SurfaceType QWindow::surfaceType() const

Реализация: QSurface::surfaceType() const.

Возвращает тип поверхности окна.

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

[virtual protected] void QWindow::tabletEvent(QTabletEvent *ev)

Переопределите этот метод для обработки событий касания, перемещения и отпускания планшетом (ev).

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

[virtual protected] void QWindow::touchEvent(QTouchEvent *ev)

Переопределите этот метод для обработки событий касания (ev).

Qt::WindowType QWindow::type() const

Возвращает тип окна.

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

См. также flags() и setFlags().

void QWindow::unsetCursor()

Восстанавливает стандартный курсор стрелки для этого окна.

QVulkanInstance *QWindow::vulkanInstance() const

Возвращает связанный экземпляр Vulkan, если он был задан, в противном случае nullptr.

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

[virtual protected] void QWindow::wheelEvent(QWheelEvent *ev)

Переопределите этот метод для обработки событий колесика мыши или других событий колесика (ev).

WId QWindow::winId() const

Возвращает идентификатор платформы окна.

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

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

Qt::WindowState QWindow::windowState() const

Состояние окна относительно экрана.

См. также setWindowState() и windowStates().

Qt::WindowStates QWindow::windowStates() const

Состояние окна относительно экрана.

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

Данная функция была добавлена в Qt 5.10.

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

© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-5.13/qwindow.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API