QHelpEngineCore Class

멤버 함수 문서

[explicit] QHelpEngineCore::QHelpEngineCore(const QString &collectionFile, QObject *parent = nullptr)

parent 를 사용하여 새로운 핵심 도움말 엔진을 생성합니다. 이 도움말 엔진은 collectionFile 에 저장된 정보를 사용하여 도움말을 제공합니다. 컬렉션 파일이 아직 존재하지 않으면 자동으로 생성됩니다.

[virtual noexcept] QHelpEngineCore::~QHelpEngineCore()

도움말 엔진을 삭제합니다.

bool QHelpEngineCore::copyCollectionFile(const QString &fileName)

fileName 파일을 생성하고, 현재 컬렉션 파일의 모든 내용을 새로 생성된 파일로 복사하며, 성공하면 true를 반환하고, 그렇지 않으면 false를 반환합니다.

이 복사 과정에서는 Qt 컬렉션 파일(.qch)에 대한 파일 참조가 그에 따라 업데이트되도록 보장합니다.

QVariant QHelpEngineCore::customValue(const QString &key, const QVariant &defaultValue = {}) const

key 에 할당된 값을 반환합니다. 요청된 키가 존재하지 않으면, 지정된 defaultValue 가 반환됩니다.

setCustomValue() 및 removeCustomValue()도 참조하십시오 .

QString QHelpEngineCore::documentationFileName(const QString &namespaceName)

namespaceName 로 식별되는 Qt 압축 도움말 파일(.qch)의 절대 파일 이름을 반환합니다. 지정된 네임스페이스를 가진 Qt 압축 도움말 파일이 등록되어 있지 않으면 빈 문자열이 반환됩니다.

namespaceName()도 참조하십시오 .

QList<QHelpLink> QHelpEngineCore::documentsForIdentifier(const QString &id) const

id 에 대해 발견된 모든 문서 링크 목록을 반환합니다. 반환되는 목록의 내용은 현재 필터에 따라 달라지므로, 현재 필터에 등록된 키워드에 대한 항목만 반환됩니다.

QList<QHelpLink> QHelpEngineCore::documentsForIdentifier(const QString &id, const QString &filterName) const

id 에 대해 검색된 문서 링크 목록을 filterName 로 필터링하여 반환합니다. 반환되는 목록의 내용은 전달된 필터에 따라 달라지므로, 해당 필터에 등록된 키워드만 반환됩니다. 필터링되지 않은 모든 결과를 얻으려면 filterName 에 빈 문자열을 전달하십시오.

QList<QHelpLink> QHelpEngineCore::documentsForKeyword(const QString &keyword) const

keyword 에 대해 발견된 모든 문서 링크의 목록을 반환합니다. 반환되는 목록의 내용은 현재 필터에 따라 달라지므로, 현재 필터에 등록된 키워드에 대해서만 결과가 반환됩니다.

QList<QHelpLink> QHelpEngineCore::documentsForKeyword(const QString &keyword, const QString &filterName) const

keyword 에 대해 검색된 문서 링크 목록을 filterName 로 필터링하여 반환합니다. 반환되는 목록의 내용은 전달된 필터에 따라 달라지므로, 해당 필터에 등록된 키워드만 반환됩니다. 필터링 없이 모든 결과를 얻으려면 filterName 로 빈 문자열을 전달하십시오.

QString QHelpEngineCore::error() const

마지막으로 발생한 오류에 대한 설명을 반환합니다.

QByteArray QHelpEngineCore::fileData(const QUrl &url) const

url 로 지정된 파일의 데이터를 반환합니다. 파일이 존재하지 않으면 빈 QByteArray 가 반환됩니다.

findFile()도 참조하십시오 .

QList<QUrl> QHelpEngineCore::files(const QString namespaceName, const QString &filterName, const QString &extensionFilter = {})

namespaceName 의 Qt Help 압축 도움말 파일에 포함된 파일 목록을 반환합니다. 파일은 filterName 을 기준으로 필터링할 수 있을 뿐만 아니라, 확장자 extensionFilter (예: 'html')을 기준으로 필터링할 수도 있습니다.

QHelpFilterEngine *QHelpEngineCore::filterEngine() const

이 도움말 엔진과 연결된 필터 엔진을 반환합니다. 필터 엔진을 사용하면 이 도움말 엔진에 대한 기존 필터를 추가, 변경 및 제거할 수 있습니다. 이 엔진을 사용하려면 ` setUsesFilterEngine()`를 호출하고, ` true`로 설정해야 합니다.

QUrl QHelpEngineCore::findFile(const QUrl &url) const

url 의 일부로 정의된 가상 폴더가 지정한 다른 네임스페이스를 참조할 수 있는 url 에 대한 수정된 URL을 반환합니다. 가상 폴더가 url 의 네임스페이스와 일치하는 경우, 이 메서드는 파일이 존재하는지 확인한 후 동일한 url 을 반환합니다. 가상 폴더가 url 의 네임스페이스와 일치하지 않을 경우, 활성 필터에 따라 가장 잘 일치하는 네임스페이스를 찾으려고 시도합니다. 네임스페이스가 발견되면 파일이 존재할 경우 수정된 URL을 반환하고, 그렇지 않으면 유효하지 않은 URL을 반환합니다.

[static] QVariant QHelpEngineCore::metaData(const QString &documentationFileName, const QString &name)

documentationFileName 에 대한 Qt 압축 도움말 파일의 메타데이터를 반환합니다. name 에 대한 데이터가 없는 경우, 유효하지 않은 QVariant()가 반환됩니다. 메타데이터는 Qt 압축 도움말 파일을 생성할 때 정의되며, 이후에는 수정할 수 없습니다. 일반적인 메타데이터에는 예를 들어 문서의 저자 정보 등이 포함됩니다.

[static] QString QHelpEngineCore::namespaceName(const QString &documentationFileName)

documentationFileName 로 지정된 Qt 압축 도움말 파일(.qch)에 대해 정의된 네임스페이스 이름을 반환합니다. 파일이 유효하지 않은 경우, 빈 문자열이 반환됩니다.

documentationFileName()도 참조하십시오 .

bool QHelpEngineCore::registerDocumentation(const QString &documentationFileName)

documentationFileName 파일에 포함된 Qt 압축 도움말 파일(.qch)을 등록합니다. 네임스페이스로 고유하게 식별되는 하나의 압축 도움말 파일은 한 번만 등록할 수 있습니다. 등록에 성공하면 true를 반환하고, 그렇지 않으면 false를 반환합니다.

unregisterDocumentation() 및 error()도 참조하십시오 .

QStringList QHelpEngineCore::registeredDocumentations() const

현재 컬렉션 파일에 등록된 모든 Qt 압축 도움말 파일의 목록을 반환합니다. 반환된 이름은 등록된 Qt 압축 도움말 파일(.qch)의 네임스페이스입니다.

bool QHelpEngineCore::removeCustomValue(const QString &key)

컬렉션 파일의 설정 섹션에서 ` key `을 제거합니다. 값이 성공적으로 제거되면 `true`를 반환하고, 그렇지 않으면 `false`를 반환합니다.

customValue() 및 setCustomValue()도 참조하십시오 .

bool QHelpEngineCore::setCustomValue(const QString &key, const QVariant &value)

value 를 key 에 저장합니다. 키가 이미 존재하는 경우, 해당 값은 덮어쓰게 됩니다. 값이 성공적으로 저장되면 true를 반환하고, 그렇지 않으면 false를 반환합니다.

customValue() 및 removeCustomValue()도 참조하십시오 .

void QHelpEngineCore::setUsesFilterEngine(bool uses)

전달된 uses 매개변수에 따라 도움말 엔진 내의 새로운 필터 엔진 기능을 활성화하거나 비활성화합니다.

usesFilterEngine() 및 filterEngine()도 참조하십시오 .

bool QHelpEngineCore::setupData()

컬렉션 파일에 포함된 정보를 처리하여 도움말 엔진을 설정하며, 성공하면 true를 반환하고, 그렇지 않으면 false를 반환합니다.

이 함수를 호출하면 도움말 엔진이 즉시 초기화됩니다. 대부분의 경우, 올바르게 설정된 도움말 엔진에 의존하는 게터 함수들이 이를 자동으로 처리하므로 이 함수를 명시적으로 호출할 필요는 없습니다.

[signal] void QHelpEngineCore::setupFinished()

이 신호는 설정이 완료되면 전송됩니다.

[signal] void QHelpEngineCore::setupStarted()

이 신호는 설정 과정이 시작될 때 발생합니다.

bool QHelpEngineCore::unregisterDocumentation(const QString &namespaceName)

namespaceName 로 식별되는 Qt 압축 도움말 파일(.qch)을 도움말 모음에서 등록 해제합니다. 성공하면 true를 반환하고, 그렇지 않으면 false를 반환합니다.

registerDocumentation() 및 error()도 참조하십시오 .

bool QHelpEngineCore::usesFilterEngine() const

도움말 엔진이 새로운 필터 기능을 사용하는지 여부를 반환합니다.

setUsesFilterEngine() 및 filterEngine()도 참조하십시오 .

[signal] void QHelpEngineCore::warning(const QString &msg)

이 신호는 비중대한 오류가 발생했을 때 전송됩니다. 경고 메시지는 ` msg`에 저장됩니다.