IContext类

class Core::IContext

IContext类关联了一个小部件与上下文列表和上下文帮助。更多信息...

头文件 #include <coreplugin/icontext.h>
继承 QObject
继承自

Core::IEditorCore::IMode

公共类型

公共函数

IContext(QObject *parent = nullptr)
virtual Core::Contextcontext() const
virtual voidcontextHelp(const Core::IContext::HelpCallback &callback) const
virtual voidsetContext(const Core::Context &context)
virtual voidsetContextHelp(const Core::HelpItem &id)
virtual voidsetWidget(QWidget *widget)
virtual QWidget *widget() const

详细描述

IContext的实例必须使用 Core::ICore::addContextObject()注册才能生效。对于像 Core::IEditorCore::IMode 这样的许多IContext的子类,这是自动完成的。但也可以手动创建IContext实例来关联任意小部件的上下文和上下文帮助。删除IContext实例时,实例会自动注销。如果需要手动注销IContext实例,请使用 Core::ICore::removeContextObject()。

只要小部件是应用程序范围焦点小部件的父链的一部分,就激活该上下文列表。这使得为包含的任何上下文ID注册的操作生效。如果用户请求上下文帮助,则会在焦点小部件的父级层次结构中最顶层的IContext实例中寻求提供帮助。

请参阅 动作管理和命令,了解上下文如何用于管理操作的概述。

另请参阅 Core::ICoreCore::ContextCore::ActionManager动作管理和命令

成员类型文档

[alias] IContext::HelpCallback

HelpCallback类定义了用于在用户请求上下文帮助时报告要显示的帮助项的回调函数。

成员函数文档

IContext::IContext(QObject *parent = nullptr)

创建一个具有可选的parent的IContext。

[virtual] Core::Context IContext::context() const

返回与此IContext关联的上下文列表。

另请参阅 setContext

[虚] void IContext::contextHelp(const Core::IContext::HelpCallback &callback) const

当用户请求上下文帮助且此 IContext 为应用焦点窗口的最顶层时,将被调用。实现必须调用传入的 callback 并返回一个帮助项目。默认实现返回设置有 setContextHelp辅助标识的帮助项目。

另请参阅 setContextHelp

[虚] void IContext::setContext(const Core::Context &context)

将此 IContext 的上下文列表设置为context

另请参阅 context

[虚] void IContext::setContextHelp(const Core::HelpItem &id)

将此 IContext 的上下文帮助条目设置为id

另请参阅 contextHelp

[虚] void IContext::setWidget(QWidget *widget)

将与此 IContext 相关的小部件设置为widget

另请参阅 widget

[虚] QWidget *IContext::widget() const

返回与此 IContext 相关的小部件。

另请参阅 setWidget

©2024 Qt公司有限公司。本文件中所包含的文档贡献归各自的拥有者所有。本文件所提供的文档遵照自由软件基金会发布的GNU自由文档许可证1.3版的条款进行许可。Qt及其相关标志是芬兰Qt公司及其它国家的商标。所有其他商标归其各自所有者所有。