HelpManager Class
(Debugger::Core::HelpManager)| Inherits: | QObject |
Public Types
| typedef | Filters |
| enum | HelpViewerLocation { SideBySideIfPossible, SideBySideAlways, HelpModeAlways, ExternalHelpAlways } |
Static Public Members
| void | aboutToShutdown() |
| void | addUserDefinedFilter(const Debugger::QString &filter, const Debugger::QStringList &attr) |
| Debugger::QString | collectionFilePath() |
| Debugger::QVariant | customValue(const Debugger::QString &key, const Debugger::QVariant &value = QVariant()) |
| Debugger::QByteArray | fileData(const Debugger::QUrl &url) |
| Debugger::QString | fileFromNamespace(const Debugger::QString &nameSpace) |
| Debugger::Core::HelpManager::Filters | filters() |
| Debugger::QUrl | findFile(const Debugger::QUrl &url) |
| Debugger::Core::HelpManager::Filters | fixedFilters() |
| void | handleHelpRequest(const Debugger::QUrl &url, Core::HelpManager::HelpViewerLocation location = HelpModeAlways) |
| void | handleHelpRequest(const Debugger::QString &url, Core::HelpManager::HelpViewerLocation location = HelpModeAlways) |
| Debugger::Core::HelpManager * | instance() |
| QMap<Debugger::QString, Debugger::QUrl> | linksForIdentifier(const Debugger::QString &id) |
| QMap<Debugger::QString, Debugger::QUrl> | linksForKeyword(const Debugger::QString &key) |
| Debugger::QString | namespaceFromFile(const Debugger::QString &file) |
| void | registerDocumentation(const Debugger::QStringList &fileNames) |
| void | registerUserDocumentation(const Debugger::QStringList &filePaths) |
| Debugger::QStringList | registeredNamespaces() |
| void | removeUserDefinedFilter(const Debugger::QString &filter) |
| void | setCustomValue(const Debugger::QString &key, const Debugger::QVariant &value) |
| void | unregisterDocumentation(const Debugger::QStringList &nameSpaces) |
| Debugger::Core::HelpManager::Filters | userDefinedFilters() |
| QSet<Debugger::QString> | userDocumentationPaths() |
- 10 static public members inherited from QObject
Protected Functions
| void | collectionFileChanged() |
| void | documentationChanged() |
| void | helpRequested(const Debugger::QUrl &url, Core::HelpManager::HelpViewerLocation location) |
| void | setupFinished() |
- 9 protected functions inherited from QObject
Additional Inherited Members
- 1 property inherited from QObject
- 34 public functions inherited from QObject
- 1 public slot inherited from QObject
- 2 signals inherited from QObject
- 1 public variable inherited from QObject
- 2 protected variables inherited from QObject
Member Function Documentation
[static] void HelpManager::aboutToShutdown()
[static] void HelpManager::addUserDefinedFilter(const Debugger::QString &filter, const Debugger::QStringList &attr)
[protected] void HelpManager::collectionFileChanged()
[static] Debugger::QString HelpManager::collectionFilePath()
[static] Debugger::QVariant HelpManager::customValue(const Debugger::QString &key, const Debugger::QVariant &value = QVariant())
See also setCustomValue().
[protected] void HelpManager::documentationChanged()
[static] Debugger::QByteArray HelpManager::fileData(const Debugger::QUrl &url)
[static] Debugger::QString HelpManager::fileFromNamespace(const Debugger::QString &nameSpace)
[static] Debugger::Core::HelpManager::Filters HelpManager::filters()
[static] Debugger::QUrl HelpManager::findFile(const Debugger::QUrl &url)
[static] Debugger::Core::HelpManager::Filters HelpManager::fixedFilters()
[static] void HelpManager::handleHelpRequest(const Debugger::QUrl &url, Core::HelpManager::HelpViewerLocation location = HelpModeAlways)
[static] void HelpManager::handleHelpRequest(const Debugger::QString &url, Core::HelpManager::HelpViewerLocation location = HelpModeAlways)
[protected] void HelpManager::helpRequested(const Debugger::QUrl &url, Core::HelpManager::HelpViewerLocation location)
[static] Debugger::Core::HelpManager *HelpManager::instance()
[static] QMap<Debugger::QString, Debugger::QUrl> HelpManager::linksForIdentifier(const Debugger::QString &id)
[static] QMap<Debugger::QString, Debugger::QUrl> HelpManager::linksForKeyword(const Debugger::QString &key)
[static] Debugger::QString HelpManager::namespaceFromFile(const Debugger::QString &file)
[static] void HelpManager::registerDocumentation(const Debugger::QStringList &fileNames)
[static] void HelpManager::registerUserDocumentation(const Debugger::QStringList &filePaths)
[static] Debugger::QStringList HelpManager::registeredNamespaces()
[static] void HelpManager::removeUserDefinedFilter(const Debugger::QString &filter)
[static] void HelpManager::setCustomValue(const Debugger::QString &key, const Debugger::QVariant &value)
See also customValue().