Класс QMdiArea

Виджет QMdiArea предоставляет область для отображения окон в режиме MDI. Подробнее...

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

Типы

Свойства

Открытые функции

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

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

Сигналы

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

Защищенные слоты

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

Функции QMdiArea, по сути, работают как менеджер окон для окон MDI. Например, он рисует управляемые им окна на себе и организует их в каскадном или мозаичном порядке. QMdiArea обычно используется в качестве центрального виджета в QMainWindow для создания MDI-приложений, но также может быть размещен в любом макете. Следующий код добавляет область в главное окно:

    QMainWindow *mainWindow = new QMainWindow;
    mainWindow->setCentralWidget(mdiArea);

В отличие от менеджеров окон для окон верхнего уровня, все флаги окна (Qt::WindowFlags) поддерживаются QMdiArea, если только флаги поддерживаются текущей стилизованной частью. Если конкретный флаг не поддерживается стилем (например, WindowShadeButtonHint), вы все равно можете затемнить окно с помощью showShaded().

Подокна в QMdiArea являются экземплярами QMdiSubWindow. Они добавляются в область MDI с помощью addSubWindow(). Обычно в эту функцию передается QWidget, который устанавливается как внутренний виджет, но также можно передать QMdiSubWindow напрямую. Класс наследует QWidget, и при программировании вы можете использовать тот же API, что и с обычным окном верхнего уровня. QMdiSubWindow также имеет поведение, специфичное для окон MDI. Подробнее см. описание класса QMdiSubWindow.

Под­окно становится активным, когда получает фокус клавиатуры или когда вызывается setFocus(). Пользователь активирует окно обычным способом. Область MDI излучает сигнал subWindowActivated() при изменении активного окна, а функция activeSubWindow() возвращает активное под окно.

Функция subWindowList() возвращает список всех под­окон. Например, эта информация может использоваться в всплывающем меню, содержащем список окон.

Под­окна сортируются по текущему WindowOrder. Это используется для subWindowList(), а также для activateNextSubWindow() и activatePreviousSubWindow(). Кроме того, используется при каскадном или мозаичном размещении окон с помощью cascadeSubWindows() и tileSubWindows().

QMdiArea предоставляет две встроенные стратегии макета для под­окон: cascadeSubWindows() и tileSubWindows(). Обе являются слотами и легко подключаются к пунктам меню.

См. также QMdiSubWindow.

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

перечисление QMdiArea::AreaOptionфлаги QMdiArea::AreaOptions

Это перечисление описывает параметры, которые настраивают поведение QMdiArea.

Тип AreaOptions — это псевдоним для QFlags<AreaOption>. Он хранит результат объединения по оператору ИЛИ значений AreaOption.

перечисление QMdiArea::ViewMode

Это перечисление описывает режим отображения области; т. е. как будут отображаться под­окна.

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

перечисление QMdiArea::WindowOrder

Определяет критерии, используемые для упорядочивания списка дочерних окон, возвращаемых функцией subWindowList(). Функции cascadeSubWindows() и tileSubWindows() следуют этому порядку при расположении окон.

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

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

QMdiArea::QMdiArea(QWidget *parent = nullptr)

Создаёт пустую область MDI. parent передаётся в конструктор QWidget.

void QMdiArea::activateNextSubWindow()

Передає фокус клавиатуры другому окну в списке дочерних окон. Активированным окном будет следующее, определяемое текущим порядком активации.

См. также activatePreviousSubWindow() и QMdiArea::WindowOrder.

void QMdiArea::activatePreviousSubWindow()

Передає фокус клавиатуры другому окну в списку дочерних окон. Активированным окном будет попереднє, определяемое текущим порядком активації.

См. также activateNextSubWindow() и QMdiArea::WindowOrder.

void QMdiArea::cascadeSubWindows()

Располагает все дочерние окна в виде каскада.

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

void QMdiArea::closeActiveSubWindow()

Закрывает активное дочернее окно.

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

void QMdiArea::closeAllSubWindows()

Закрывает все дочерние окна, отправив QCloseEvent в каждое окно. Вы можете получить сигналы subWindowActivated() от дочерних окон перед их закрытием (если область MDI активирует дочернее окно при закрытии другого).

Дочерние окна, которые игнорируют событие закрытия, останутся открытыми.

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

void QMdiArea::setActiveSubWindow(QMdiSubWindow *window)

Активирует дочернее окно window. Если window равен nullptr, любое текущее активное окно деактивируется.

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

void QMdiArea::setupViewport(QWidget *viewport)

Переопределяет: QAbstractScrollArea::setupViewport(QWidget *viewport).

Этот слот вызывается QAbstractScrollArea после вызова setViewport(). Переопределите эту функцию в подклассе QMdiArea, чтобы инициализировать новый viewport перед его использованием.

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

void QMdiArea::subWindowActivated(QMdiSubWindow *window)

QMdiArea излучает этот сигнал после активации window. Когда window равно nullptr, QMdiArea только что деактивировал последнее активное окно, и на рабочем пространстве нет активных окон.

См. также QMdiArea::activeSubWindow().

void QMdiArea::tileSubWindows()

Располагает все дочерние окна в виде плитки.

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

QMdiArea::~QMdiArea()

Уничтожает область MDI.

QMdiSubWindow *QMdiArea::activeSubWindow() const

Возвращает указатель на текущее активное подокно. Если активного окна нет, возвращается nullptr.

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

См. также setActiveSubWindow() и Qt::WindowState.

QMdiSubWindow *QMdiArea::addSubWindow(QWidget *widget, Qt::WindowFlags windowFlags = Qt::WindowFlags())

Добавляет widget в качестве нового подокна в область MDI. Если windowFlags отличны от нуля, они переопределят флаги, установленные для виджета.

widget может быть либо QMdiSubWindow, либо другим QWidget (в этом случае область MDI создаст подокно и установит widget как внутренний виджет).

    QMdiArea mdiArea;
    QMdiSubWindow *subWindow1 = new QMdiSubWindow;
    subWindow1->setWidget(internalWidget1);
    subWindow1->setAttribute(Qt::WA_DeleteOnClose);
    mdiArea.addSubWindow(subWindow1);

    QMdiSubWindow *subWindow2 =
        mdiArea.addSubWindow(internalWidget2);

При создании собственного подокна необходимо установить атрибут виджета Qt::WA_DeleteOnClose, если вы хотите, чтобы окно удалялось при закрытии в области MDI. В противном случае окно будет скрыто, а область MDI не активирует следующее подокно.

Возвращает QMdiSubWindow, добавленный в область MDI.

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

[override virtual protected] void QMdiArea::childEvent(QChildEvent *childEvent)

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

QMdiSubWindow *QMdiArea::currentSubWindow() const

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

Эта функция вернет то же значение, что и activeSubWindow(), если QApplication, содержащая QMdiArea, активна.

См. также activeSubWindow() и QApplication::activeWindow().

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

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

[override virtual protected] bool QMdiArea::eventFilter(QObject *object, QEvent *event)

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

[override virtual] QSize QMdiArea::minimumSizeHint() const

Переопределяет: QAbstractScrollArea::minimumSizeHint() const.

[override virtual protected] void QMdiArea::paintEvent(QPaintEvent *paintEvent)

Переопределяет: QAbstractScrollArea::paintEvent(QPaintEvent *event).

void QMdiArea::removeSubWindow(QWidget *widget)

Удаляет widget из области MDI. widget должен быть либо QMdiSubWindow, либо виджетом, являющимся внутренним виджетом подокна. Обратите внимание, что QMdiArea никогда не удаляет widget напрямую. Если передаётся QMdiSubWindow, его родителем устанавливается nullptr, и он удаляется; но если передаётся внутренний виджет, виджет-потомок устанавливается в nullptr, и QMdiSubWindow не удаляется.

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

[override virtual protected] void QMdiArea::resizeEvent(QResizeEvent *resizeEvent)

Переопределяет: QAbstractScrollArea::resizeEvent(QResizeEvent *event).

[override virtual protected] void QMdiArea::scrollContentsBy(int dx, int dy)

Переопределяет: QAbstractScrollArea::scrollContentsBy(int dx, int dy).

void QMdiArea::setOption(QMdiArea::AreaOption option, bool on = true)

Если on равно true, option включён в области MDI; в противном случае он выключен. См. AreaOption для эффекта каждого параметра.

См. также AreaOption и testOption().

[override virtual protected] void QMdiArea::showEvent(QShowEvent *showEvent)

Переопределяет: QWidget::showEvent(QShowEvent *event).

[override virtual] QSize QMdiArea::sizeHint() const

Переопределяет: QAbstractScrollArea::sizeHint() const.

QList<QMdiSubWindow *> QMdiArea::subWindowList(QMdiArea::WindowOrder order = CreationOrder) const

Возвращает список всех поддокументов в области MDI. Если order равен CreationOrder (по умолчанию), окна упорядочены в порядке их вставки в рабочее пространство. Если order равен StackingOrder, окна перечислены в порядке их расположения в стеке, при этом верхнее окно является последним элементом списка. Если order равен ActivationHistoryOrder, окна перечислены в соответствии с их недавней историей активации.

См. также WindowOrder.

bool QMdiArea::testOption(QMdiArea::AreaOption option) const

Возвращает true, если option включён; в противном случае возвращает false.

См. также AreaOption и setOption().

[override virtual protected] void QMdiArea::timerEvent(QTimerEvent *timerEvent)

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

[override virtual protected] bool QMdiArea::viewportEvent(QEvent *event)

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