成员函数文档

LiveDocument::LiveDocument(const QString &relativeFilePath)

为给定的 relativeFilePath 构造实例。

relativeFilePath 不能是空字符串，它必须是相对路径，并且当相对于目录解析时，它不能解析为目录之外的路劲。

LiveDocument::LiveDocument()

构造空实例。

另见 isNull() 和 errorString。

QString LiveDocument::absoluteFilePathIn(const QDir &workspace) const

返回在workspace内部的绝对文件路径，包括文件名。

QString LiveDocument::errorString() const

在调用resolve()、existsIn()、isFileIn()或mapsToResource()失败后立即调用，返回一个适合在用户界面中显示的描述性信息。在其他上下文中调用时，结果是不确定的。

bool LiveDocument::existsIn(const QDir &workspace) const

如果该文档在给定的workspace目录中存在，则返回true。

另请参阅errorString。

bool LiveDocument::isFileIn(const QDir &workspace) const

如果该文档在给定的workspace目录中作为常规文件（或常规文件的符号链接）存在，则返回true。

符号链接解析适用。

另请参阅errorString。

bool LiveDocument::isNull() const

如果这是一个空实例，则返回true。

一个空实例可能是用默认构造函数构造的，或者resolve()调用失败。

另请参阅errorString。

bool LiveDocument::mapsToResource(const ResourceMap &resourceMap) const

如果文档的运行时位置在Qt资源中，则返回true。这是使用给定的resourceMap确定的。

另请参阅runtimeLocation()、LiveNodeEngine::resourceMap()和errorString。

QString LiveDocument::relativeFilePath() const

返回包括文件名的相对文件路径。

[静态]LiveDocument LiveDocument::resolve(const QDir &workspace, const QString &filePath)

除非filePath在workspace目录之外解析，否则构造一个非空实例。

filePath可以是绝对或相对文件路径，指向一个不需要存在的文件。

另见 isNull() 和 errorString。

[静态]LiveDocument LiveDocument::resolve(const QDir &workspace, const ResourceMap &resourceMap, const QString &filePath)

为filePath构造一个非空实例，该实例要么解析为workspace目录下的路径，要么确定一个在给定的resourceMap中存在的Qt资源。

filePath可以是文件或Qt资源路径（以":/"开头）。在两种情况下，该文件都不是必须存在的。

另见 isNull() 和 errorString。

[静态] LiveDocument LiveDocument::resolve(const QDir &workspace, const ResourceMap &resourceMap, const QUrl &fileUrl)

为fileUrl构造一个非空实例，该实例解析为workspace目录下的路径，或者在给定的resourceMap中确定为Qt资源的一个映射。

fileUrl可能是一个代表本地文件或Qt资源路径（例如"qrc:/example/icon.png"）的URL。在两种情况下，文件都不需要存在。

另见 isNull() 和 errorString。

QUrl LiveDocument::runtimeLocation(const QDir &workspace, const ResourceMap &resourceMap) const

确定文档的运行时位置。在LiveNodeEngine方面，文档可能存在于文件系统（给定workspace下）或在Qt资源中（使用给定的resourceMap确定）。

示例

LiveDocument document = ...;
LiveNodeEngine *engine = ...;
QFile file(document.runtimeLocation(engine->workspace(), *engine->resourceMap()));

另请参阅mapsToResource()和LiveNodeEngine::resourceMap。

[静态] QString LiveDocument::toFilePath(const QUrl &url)

将本地/Qt资源url转换为文件路径

[静态] QUrl LiveDocument::toUrl(const QString &filePath)

将本地/Qt资源filePath转换为URL