QMainWindow Class

成员函数文档

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

根据给定的parent 和指定的控件flags 创建一个QMainWindow。

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

[virtual 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 将放置在当前工具栏块（即一行）的末尾。如果主窗口已经管理了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()。

[override virtual protected] void QMainWindow::contextMenuEvent(QContextMenuEvent *event)

重写了：QWidget::contextMenuEvent(QContextMenuEvent *event)。

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

返回占据指定corner 的Dock小部件区域。

另请参阅 setCorner()。

[virtual] QMenu *QMainWindow::createPopupMenu()

返回一个包含主窗口中现有工具栏和停靠小部件的可选中项的弹出菜单。如果主窗口中不存在工具栏和停靠小部件，则该函数返回nullptr 。

默认情况下，当用户激活上下文菜单时（通常是右键单击工具栏或停靠控件），主窗口会调用此函数。

若要创建自定义弹出菜单，请重写此函数并返回一个新创建的弹出菜单。弹出菜单的所有权将转移给调用方。

另请参阅 addDockWidget()、addToolBar() 和menuBar()。

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

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

另请参阅 addDockWidget()、splitDockWidget() 和Qt::DockWidgetArea 。

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

重写了：QWidget::event(QEvent *event)。

[signal] 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)

将列表docks 中的停靠控件调整为列表sizes 中对应的像素尺寸。如果orientation 为Qt::Horizontal ，则调整宽度；否则调整高度。调整后的尺寸将确保最大和最小尺寸得到保留，且QMainWindow 本身不会被调整大小。 任何多余或缺失的空间将根据各小部件尺寸的相对权重在它们之间进行分配。

示例：

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

如果蓝色和小部件与黄色小部件处于同一层级，则会调整大小，使得黄色小部件的大小是蓝色小部件的两倍

如果某些控件被分组为标签页，则每个组应仅指定一个控件。未列入列表的控件可能会被调整，以满足约束条件。

bool QMainWindow::restoreDockWidget(QDockWidget *dockwidget)

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

另请参阅 restoreState() 和saveState()。

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

恢复此主窗口工具栏和停靠控件的state 。同时恢复角部设置。将version 中的数值与state 中存储的数值进行比较。如果两者不匹配，则主窗口的状态保持不变，且本函数返回false ；否则，状态将被恢复，且本函数返回true 。

要恢复使用QSettings 保存的几何信息，可以使用如下代码：

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

另请参阅 saveState()、QWidget::saveGeometry()、QWidget::restoreGeometry() 和restoreDockWidget()。

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

保存此主窗口工具栏和停靠控件的当前状态。这包括可通过 `setCorner()` 设置的角落设置。version 编号作为数据的一部分被存储。

objectName QToolBar QDockWidget 属性用于标识每个 和 。您应确保此属性对于添加到QToolBar QDockWidget QMainWindow

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

若要在窗口关闭时保存几何图形，可以像这样实现一个关闭事件：

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

另请参阅 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 。默认情况下，所有停靠区域的标签页均显示在底部。

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

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

将first 停靠小部件所占空间分为两部分，将first 停靠小部件移至第一部分，并将second 停靠小部件移至第二部分。

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

注意：如果first 当前位于一个带标签页的停靠区域中，则second 将被添加为一个新标签页，而非与first 并列。这是因为单个标签页只能包含一个停靠控件。

注意：Qt::LayoutDirection 会影响分割区域中两个部分内停靠小部件的顺序。当启用从右到左的布局方向时，停靠小部件的排列顺序将被反转。

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

QStatusBar *QMainWindow::statusBar() const

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

另请参阅 setStatusBar()。

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

返回area 的制表符位置。

另请参阅 setTabPosition() 和tabShape()。

[signal] void QMainWindow::tabifiedDockWidgetActivated(QDockWidget *dockWidget)

当通过选择标签页激活带标签页的停靠控件时，会发出此信号。被激活的停靠控件将作为参数传递给dockWidget 。

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

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

返回与dockwidget 一起被划分为标签页的Dock控件。

另请参阅 tabifyDockWidget()。

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

将second 停靠控件移至first 停靠控件上方，在first 的当前位置创建一个带标签的停靠区域。

在调用此函数之前，这两个停靠控件必须已通过addDockWidget() 添加到主窗口中，且两者均不能已是标签页形式。

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

QWidget *QMainWindow::takeCentralWidget()

从该主窗口中移除中央小部件。

被移除的小部件的所有权将传递给调用方。

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

返回toolbar 的Qt::ToolBarArea 。如果toolbar 尚未被添加到主窗口中，则该函数返回Qt::NoToolBarArea 。

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

bool QMainWindow::toolBarBreak(QToolBar *toolbar) const

返回在toolbar 之前是否存在工具栏分隔符。

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

[signal] void QMainWindow::toolButtonStyleChanged(Qt::ToolButtonStyle toolButtonStyle)

当窗口中工具按钮所用的样式发生变化时，会触发此信号。新样式将通过toolButtonStyle 传递进来。

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

另请参阅 setToolButtonStyle()。