IWizardFactory 类

class Core::IWizardFactory

IWizardFactory 类是所有向导工厂的基类。更多...

头文件	#include <coreplugin/iwizardfactory.h>
继承	QObject
继承自	Core::BaseFileWizardFactory

所有成员的列表，包括继承的成员

公共类型

枚举	WizardFlag { 平台无关，强制文件名首字母大写 }
标志	WizardFlags
枚举	WizardKind { 文件向导，项目向导 }

公共函数

QString	category() const
QString	description() const
QString	displayCategory() const
QString	displayName() const
QIcon	icon() const
Utils::Id	id() const
Core::IWizardFactory::WizardKind	kind() const
Utils::Wizard *	runWizard(const Utils::FilePath &path, QWidget *parent, Utils::Id platform, const QVariantMap &variables, bool showWizard = true)

详细信息

注意：建议您创建基于 JSON 的向导，而不是使用此类，具体操作请参考添加新自定义向导。

向导界面是对文件 > 新建文件和新建项目中向导的非常薄的抽象。基本上，它定义了在向导选择对话框中向用户显示的内容，以及如果用户选择向导则被调用的钩子。

向导可以执行任何他们喜欢的操作，包括显示对话框和创建文件。通常不需要从头创建自己的向导。使用预定义的向导之一，并将其根据需要进行调整。

为了使您的向导为系统所知，请在您插件的初始化函数中将您的 IWizardFactory 实例添加到插件管理器的对象池中

void MyPlugin::initialize()
{
    // ... do setup
    addAutoReleasedObject(new MyWizardFactory);
    // ... do more setup
}

另请参阅Core::BaseFileWizardFactory 和 Core::BaseFileWizard。

成员类型文档

enum IWizardFactory::WizardFlag
flags IWizardFactory::WizardFlags

包含有关创建的项目和文件的信息。

常量	值	描述
`Core::IWizardFactory::PlatformIndependent`	`0x01`	向导创建可在所有平台上运行的项目。
`Core::IWizardFactory::ForceCapitalLetterForFileName`	`0x02`	向导使用新文件名的首字母大写。

WizardFlags 类型是 QFlags<WizardFlag> 的 typedef。它存储 WizardFlag 值的 OR 组合。

enum IWizardFactory::WizardKind

用于指定向导创建的对象类型。此信息用于在选择“新建项目”菜单项时仅显示创建项目的向导。

常量	值	描述
`Core::IWizardFactory::FileWizard`	`0x01`	向导创建一个或多个文件。
`Core::IWizardFactory::ProjectWizard`	`0x02`	向导创建一个新的项目。

成员函数文档

QString IWizardFactory::category() const

返回一个类别ID，用于将向导添加到该类别。

QString IWizardFactory::description() const

返回在对话框中选择此向导时显示的翻译描述。

QString IWizardFactory::displayCategory() const

返回在对话框中显示的类别翻译字符串。

QString IWizardFactory::displayName() const

返回在对话框中显示的向导翻译名称。

QIcon IWizardFactory::icon() const

返回在向导选择对话框中显示的图标。

Utils::Id IWizardFactory::id() const

返回一个任意ID，用于类别内的排序。

Core::IWizardFactory::WizardKind IWizardFactory::kind() const

返回向导创建的对象类型。

Utils::Wizard IWizardFactory::runWizard(const Utils::FilePath &path*, QWidget **parent, Utils::Id platform, const QVariantMap &variables, bool showWizard* = true)

在操作系统platform上使用variables为用户选择的执行向导创建向导。

向导打开的任何对话框都应该使用所给的parent。参数path是对创建文件位置的提示。向导应在路径选择元素中使用此路径作为默认路径。

当showWizard为false时，向导实例被创建并设置，但并未实际显示。

IWizardFactory 类

公共类型

公共函数

详细信息

成员类型文档

enum IWizardFactory::WizardFlagflags IWizardFactory::WizardFlags

enum IWizardFactory::WizardKind

成员函数文档

QString IWizardFactory::category() const

QString IWizardFactory::description() const

QString IWizardFactory::displayCategory() const

QString IWizardFactory::displayName() const

QIcon IWizardFactory::icon() const

Utils::Id IWizardFactory::id() const

Core::IWizardFactory::WizardKind IWizardFactory::kind() const

Utils::Wizard *IWizardFactory::runWizard(const Utils::FilePath &path, QWidget *parent, Utils::Id platform, const QVariantMap &variables, bool showWizard = true)

enum IWizardFactory::WizardFlag
flags IWizardFactory::WizardFlags

Utils::Wizard IWizardFactory::runWizard(const Utils::FilePath &path*, QWidget **parent, Utils::Id platform, const QVariantMap &variables, bool showWizard* = true)