QMainWindow 类

成员函数文档

[明确] QMainWindow::QMainWindow(QWidget *parent = nullptr, Qt::WindowFlags flags = Qt::WindowFlags())

构造一个具有指定的 parent 和指定的窗口小部件 flags 的 QMainWindow。

QMainWindow 会设置自己的Qt::Window 标志，因此始终作为顶级小部件创建。

[虚拟 noexcept] QMainWindow::~QMainWindow()

销毁主窗口。

void QMainWindow::addDockWidget(Qt::DockWidgetArea area, QDockWidget *dockwidget)

将指定的 dockwidget 添加到指定的 area。

void QMainWindow::addDockWidget(Qt::DockWidgetArea area, QDockWidget *dockwidget, Qt::Orientation orientation)

将 dockwidget 添加到给定的 area，并按指定的 orientation 方向进行添加。

void QMainWindow::addToolBar(Qt::ToolBarArea area, QToolBar *toolbar)

将 toolbar 添加到本主窗口指定的 area。该工具栏将被放置在当前工具栏块（即行）的末尾。如果主窗口已管理 toolbar，则只会将工具栏移动到 area。

另请参阅insertToolBar、addToolBarBreak 和 insertToolBarBreak。

void QMainWindow::addToolBar(QToolBar *toolbar)

这是一个重载的函数。

相当于调用 addToolBar(Qt::TopToolBarArea, toolbar)

QToolBar *QMainWindow::addToolBar(const QString &title)

这是一个重载的函数。

创建一个 QToolBar 对象，设置其窗口标题为 title，并将其插入到顶部工具栏区域。

另请参阅setWindowTitle。

void QMainWindow::addToolBarBreak(Qt::ToolBarArea area = Qt::TopToolBarArea)

在所有其他现有对象之后，在给定的 area 中添加一个工具栏断点。

QWidget *QMainWindow::centralWidget() const

返回主窗口的中央窗口小部件。如果未设置中央窗口小部件，此函数返回 nullptr。

另请参阅setCentralWidget。

[覆盖虚保护] void QMainWindow::contextMenuEvent(QContextMenuEvent *event)

重实现了： QWidget::contextMenuEvent(QContextMenuEvent *event).

Qt::DockWidgetArea QMainWindow::corner(Qt::Corner corner) const

返回占用指定 corner 的停靠窗口区域。

另请参阅setCorner。

[虚拟] QMenu *QMainWindow::createPopupMenu()

返回一个包含可用于主窗口中现有工具栏和停靠小部件的可选条目弹出菜单。如果没有工具栏和停靠小部件，则此函数返回 nullptr。

默认情况下，该函数在用户激活上下文菜单时由主窗口调用，通常是通过在工具栏或停靠小部件上右击。

如果您想创建一个自定义弹出菜单，则重写此函数并返回一个新创建的弹出菜单。弹出菜单的所有权将传递给调用者。

另请参阅addDockWidget，addToolBar 和 menuBar。

Qt::DockWidgetArea QMainWindow::dockWidgetArea(QDockWidget *dockwidget) const

返回 dockwidget 的 Qt::DockWidgetArea。如果 dockwidget 未添加到主窗口，则此函数返回 Qt::NoDockWidgetArea。

另请参阅addDockWidget，splitDockWidget 和 Qt::DockWidgetArea。

[覆盖虚保护] bool QMainWindow::event(QEvent *event)

重实现了：QWidget::event(QEvent *event).

[信号] void QMainWindow::iconSizeChanged(const QSize &iconSize)

当窗口中使用的图标大小发生变化时会触发此信号。新图标大小通过 iconSize 传入。

您可以将此信号连接到其他组件，以帮助保持应用程序的一致外观。

另请参阅setIconSize()。

void QMainWindow::insertToolBar(QToolBar *before, QToolBar *toolbar)

将 toolbar 插入由 before 工具栏占据的区域，使其出现在其之前。例如，在正常的从左到右布局操作中，这意味着 toolbar 将在水平工具栏区域中出现在由 before 指定的工具栏左侧。

另请参阅insertToolBarBreak()、addToolBar() 和 addToolBarBreak()。

void QMainWindow::insertToolBarBreak(QToolBar *before)

在指定的 before 工具栏之前插入一个工具栏断点。

QMenuBar *QMainWindow::menuBar() const

返回主窗口的菜单栏。如果菜单栏不存在，此函数创建并返回一个空菜单栏。

如果您想在一个Mac应用程序的所有窗口中共享一个菜单栏，请勿使用此函数创建它，因为此处创建的菜单栏将以此 QMainWindow 为其父项。相反，您必须创建一个没有父项的菜单栏，然后可以将其在所有Mac窗口之间共享。以下是这样创建无父项菜单栏的方法

QMenuBar *menuBar = new QMenuBar(nullptr);

另请参阅setMenuBar()。

QWidget *QMainWindow::menuWidget() const

返回主窗口的菜单栏。如果尚未构造菜单栏，则此函数返回 null。

另请参阅setMenuWidget()。

void QMainWindow::removeDockWidget(QDockWidget *dockwidget)

从主窗口布局中移除 dockwidget 并隐藏它。请注意，dockwidget 不会 被删除。

void QMainWindow::removeToolBar(QToolBar *toolbar)

从主窗口布局中移除 toolbar 并隐藏它。请注意，toolbar 不会 被删除。

void QMainWindow::removeToolBarBreak(QToolBar *before)

移除之前在指定的 before 工具栏之前插入的工具栏断点。

void QMainWindow::resizeDocks(const QList<QDockWidget *> &docks, const QList<int> &sizes, Qt::Orientation orientation)

根据列表 sizes 中每个项的像素值调整列表 docks 中对应浮动窗口的大小。如果 orientation 是 Qt::Horizontal，则调整宽度，否则调整高度。大小调整将尊重最大和最小尺寸，并确保 QMainWindow 本身不会调整大小。多余的/缺少的空间将根据大小的相对权重分配给小部件。

示例

    resizeDocks({blueWidget, yellowWidget}, {20 , 40}, Qt::Horizontal);

如果蓝色和黄色小部件在相同级别嵌套，则它们的调整大小将使 yellowWidget 是 blueWidget 的大小两倍。

如果某些小部件被分组到标签中，则每个组应指定一个小部件。不在列表中的小部件可能需要更改以遵守约束。

bool QMainWindow::restoreDockWidget(QDockWidget *dockwidget)

如果 dockwidget 在调用 restoreState() 之后创建，则还原其状态。如果状态已还原，则返回 true；否则返回 false。

anche restoreState() 和 saveState()。

bool QMainWindow::restoreState(const QByteArray &state, int version = 0)

还原此主窗口的工具栏和浮动窗口的状态。还还原了角落设置。将 version 号码与存储在 state 中的号码进行比较。如果不匹配，主窗口的状态将保持不变，并且此函数返回 false；否则，状态将还原，并且此函数返回 true。

要使用 QSettings 保存的几何数据恢复，可以使用以下代码

void MainWindow::readSettings()
{
    QSettings settings("MyCompany", "MyApp");
    restoreGeometry(settings.value("myWidget/geometry").toByteArray());
    restoreState(settings.value("myWidget/windowState").toByteArray());
}

anche saveState()，QWidget::saveGeometry()，QWidget::restoreGeometry() 和 restoreDockWidget()。

QByteArray QMainWindow::saveState(int version = 0) const

保存此主窗口的工具栏和浮动窗口的当前状态。这包括可以通过 setCorner() 设置的角落设置。将 version 号码存储为数据的一部分。

objectName 属性用于标识每个 QToolBar 和 QDockWidget。您应该确保为添加到 QMainWindow 的每个 QToolBar 和 QDockWidget 设置此属性是唯一的。

要恢复已保存的状态，将返回值和 version 号码传递给 restoreState()。

要保存关闭窗口时的几何形状，可以像这样实现关闭事件

void MyMainWindow::closeEvent(QCloseEvent *event)
{
    QSettings settings("MyCompany", "MyApp");
    settings.setValue("geometry", saveGeometry());
    settings.setValue("windowState", saveState());
    QMainWindow::closeEvent(event);
}

anche restoreState()，QWidget::saveGeometry() 和 QWidget::restoreGeometry()。

void QMainWindow::setCentralWidget(QWidget *widget)

将指定的widget设置为主窗口的中心部件。

注意：QMainWindow会取得widget指针的所有权，并在适当的时候删除它。

另请参阅centralWidget()。

void QMainWindow::setCorner(Qt::Corner corner, Qt::DockWidgetArea area)

将指定的浮动窗口area设置为占据指定的corner。

另请参阅corner()。

void QMainWindow::setMenuBar(QMenuBar *menuBar)

将主窗口的菜单栏设置为menuBar。

注意：QMainWindow会取得menuBar指针的所有权，并在适当的时候删除它。

另请参阅menuBar()。

void QMainWindow::setMenuWidget(QWidget *menuBar)

将主窗口的菜单栏设置为menuBar。

QMainWindow会取得menuBar指针的所有权，并在适当的时候删除它。

另请参阅menuWidget()。

void QMainWindow::setStatusBar(QStatusBar *statusbar)

将主窗口的状态栏设置为statusbar。

将状态栏设置为nullptr将从主窗口中移除它。注意，QMainWindow会取得statusbar指针的所有权，并在适当的时候删除它。

另请参阅statusBar()。

void QMainWindow::setTabPosition(Qt::DockWidgetAreas areas, QTabWidget::TabPosition tabPosition)

将给定浮动窗口的areas设置指定的tabPosition。默认情况下，所有浮动区域显示其标签在底部。

另请参阅QMainWindow::tabPosition()和QMainWindow::setTabShape()。

void QMainWindow::splitDockWidget(QDockWidget *first, QDockWidget *second, Qt::Orientation orientation)

将第一个浮动窗口first覆盖的空间分为两部分，将第一个浮动窗口first移动到第一部分，并将第二个浮动窗口second移动到第二部分。

方向orientation指定了空间是如何划分的：一个Qt::Horizontal的分割将第二个停靠部件放置在第一个停靠部件的右侧；一个Qt::Vertical的分割将第二个停靠部件放置在第一个停靠部件下方。

注意：如果第一个当前在选项卡停靠区域中，第二个将作为新的选项卡添加，而不是作为第一个的邻居。这是因为一个选项卡只能包含一个停靠部件。

注意：Qt::LayoutDirection影响了分割区域两部分的停靠部件的顺序。当启用从右到左的布局方向时，停靠部件的放置将倒置。

另请参阅 tabifyDockWidget()，addDockWidget()和removeDockWidget()。

QStatusBar *QMainWindow::statusBar() const

返回主窗口的状态栏。如果状态栏不存在，此函数创建并返回一个空的状态栏。

另请参阅 setStatusBar()。

QTabWidget::TabPosition QMainWindow::tabPosition(Qt::DockWidgetArea area) const

返回area的选项卡位置。

另请参阅 setTabPosition()和tabShape。

[信号] void QMainWindow::tabifiedDockWidgetActivated(QDockWidget *dockWidget)

当通过选择选项卡激活选项卡化的停靠部件时，会发出此信号。激活的停靠部件通过dockWidget传入。

另请参阅 tabifyDockWidget()和tabifiedDockWidgets()。

QList<QDockWidget *> QMainWindow::tabifiedDockWidgets(QDockWidget *dockwidget) const

返回与dockwidget一起选项卡化的停靠部件。

另请参阅 tabifyDockWidget()。

void QMainWindow::tabifyDockWidget(QDockWidget *first, QDockWidget *second)

将停靠部件second移动到停靠部件first的上方，在主窗口中创建一个选项卡化的停靠区域。

另请参阅 tabifiedDockWidgets()。

QWidget *QMainWindow::takeCentralWidget()

从本主窗口移除中心部件。

移除控件的所属权传递给调用者。

Qt::ToolBarArea QMainWindow::toolBarArea(const QToolBar *toolbar) const

返回工具栏的Qt::ToolBarArea。如果工具栏没有添加到主窗口中，则此函数返回Qt::NoToolBarArea。

另请参阅addToolBar()、addToolBarBreak和Qt::ToolBarArea。

bool QMainWindow::toolBarBreak(QToolBar *toolbar) const

返回是否存在在工具栏之前的工具栏断点。

另请参阅addToolBarBreak()和insertToolBarBreak。

[信号] void QMainWindow::toolButtonStyleChanged(Qt::ToolButtonStyle toolButtonStyle)

当窗口中工具按钮的样式改变时，发出此信号。新样式通过toolButtonStyle传入。

您可以将此信号连接到其他组件，以帮助保持应用程序的一致外观。

另请参阅setToolButtonStyle。