QHelpFilterEngine Class
QHelpFilterEngine 클래스는 도움말 콘텐츠의 필터링된 보기를 제공합니다. 더 보기...
| 헤더: | #include <QHelpFilterEngine> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS Help)target_link_libraries(mytarget PRIVATE Qt6::Help) |
| qmake: | QT += help |
| 상속합니다: | QObject |
공용 함수
| QString | activeFilter() const |
| QStringList | availableComponents() const |
| QList<QVersionNumber> | availableVersions() const |
| QHelpFilterData | filterData(const QString &filterName) const |
| QStringList | filters() const |
| QStringList | indices() const |
| QStringList | indices(const QString &filterName) const |
| QMap<QString, QString> | namespaceToComponent() const |
| QMap<QString, QVersionNumber> | namespaceToVersion() const |
| QStringList | namespacesForFilter(const QString &filterName) const |
| bool | removeFilter(const QString &filterName) |
| bool | setActiveFilter(const QString &filterName) |
| bool | setFilterData(const QString &filterName, const QHelpFilterData &filterData) |
시그널
| void | filterActivated(const QString &newFilter) |
상세 설명
필터 엔진을 사용하면 QHelpEngineCore 인스턴스와 연결된 필터를 관리할 수 있습니다. 헬프 엔진은 내부적으로 필터 엔진의 인스턴스를 생성하며, QHelpEngineCore::filterEngine()를 호출하여 액세스할 수 있습니다. 따라서 이 클래스의 공개 생성자는 비활성화되어 있습니다.
필터는 필터 이름 문자열로 식별됩니다. 필터 세부 사항은 QHelpFilterData 클래스에 설명되어 있습니다.
필터 엔진은 setFilterData() 메서드를 통해 새 필터를 추가하고 기존 필터의 데이터를 변경할 수 있습니다. 기존 필터는 removeFilter() 메서드를 통해 제거할 수 있습니다.
등록된 필터 중 하나를 활성 필터로 표시할 수 있습니다. 활성 필터는 관련 도움말 엔진에서 콘텐츠, 색인 또는 검색 결과 등 다양한 기능의 필터링된 결과를 반환하는 데 사용됩니다. 활성으로 표시된 필터가 없으면 도움말 엔진은 사용 가능한 전체 결과 목록을 반환합니다.
활성 필터는 activeFilter()에서 반환되며 setActiveFilter()에서 변경할 수 있습니다.
QHelpEngineCore 를참조하세요 .
멤버 기능 문서
QString QHelpFilterEngine::activeFilter() const
현재 활성화된 필터의 이름을 반환합니다.
setActiveFilter()도 참조하세요 .
QStringList QHelpFilterEngine::availableComponents() const
등록된 모든 문서 파일에 정의된 사용 가능한 모든 구성 요소의 목록을 반환합니다.
QList<QVersionNumber> QHelpFilterEngine::availableVersions() const
등록된 모든 문서 파일에 정의된 사용 가능한 모든 버전 목록을 반환합니다.
[signal] void QHelpFilterEngine::filterActivated(const QString &newFilter)
이 신호는 활성 필터가 설정되어 있을 때 전송됩니다. newFilter 필터의 이름을 지정합니다.
setActiveFilter()도 참조하세요 .
QHelpFilterData QHelpFilterEngine::filterData(const QString &filterName) const
filterName 와 관련된 필터 세부 정보를 반환합니다.
setFilterData()도 참조하세요 .
QStringList QHelpFilterEngine::filters() const
필터 엔진 내부에 정의된 모든 필터 이름 목록을 반환합니다.
QStringList QHelpFilterEngine::indices() const
사용 가능한 인덱스의 정렬된 목록을 반환합니다. 반환되는 목록 내용은 활성 필터에 따라 달라지므로 활성 필터에 등록된 인덱스만 반환됩니다.
QStringList QHelpFilterEngine::indices(const QString &filterName) const
filterName 에 의해 필터링된 사용 가능한 인덱스의 정렬된 목록을 반환합니다. 반환되는 목록 내용은 전달된 필터에 따라 달라지므로 이 필터에 등록된 인덱스만 반환됩니다. 사용 가능한 모든 인덱스를 필터링하지 않고 가져오려면 빈 문자열을 filterName 으로 전달하세요.
QMap<QString, QString> QHelpFilterEngine::namespaceToComponent() const
사용 가능한 모든 네임스페이스의 맵을 키로, 관련 컴포넌트를 값으로 반환합니다.
QMap<QString, QVersionNumber> QHelpFilterEngine::namespaceToVersion() const
사용 가능한 모든 네임스페이스의 맵을 키로, 관련 버전과 함께 값으로 반환합니다.
QStringList QHelpFilterEngine::namespacesForFilter(const QString &filterName) const
filterName 으로 식별된 필터와 일치하는 등록된 모든 문서 네임스페이스의 목록을 반환합니다.
bool QHelpFilterEngine::removeFilter(const QString &filterName)
filterName 으로 식별된 필터를 제거합니다.
필터 제거에 성공하면 true 을 반환하고, 그렇지 않으면 false 을 반환합니다.
bool QHelpFilterEngine::setActiveFilter(const QString &filterName)
현재 활성 필터를 filterName 로 변경합니다.
필터 변경에 성공하면 true 을 반환하고, 그렇지 않으면 false 을 반환합니다.
activeFilter()도 참조하세요 .
bool QHelpFilterEngine::setFilterData(const QString &filterName, const QHelpFilterData &filterData)
filterName 으로 식별된 필터의 기존 필터 세부 정보를 filterData 으로 변경합니다. 필터가 존재하지 않으면 새 필터가 생성됩니다.
필터 설정에 성공하면 true 을 반환하고, 그렇지 않으면 false 을 반환합니다.
filterData()도 참조하세요 .
© 2025 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.
