KHelpClient Namespace Reference

Functions
KRITAWIDGETUTILS_EXPORT void	invokeHelp (const QString &anchor=QString(), const QString &appname=QString())

Function Documentation

invokeHelp()

void KHelpClient::invokeHelp	(	const QString &	anchor = QString(),
		const QString &	appname = QString() )

Invokes the KHelpCenter HTML help viewer from docbook sources.

The HTML file will be found using the X-DocPath entry in the application's desktop file. It can be either a relative path, or a website URL.

Parameters

anchor	This has to be a defined anchor in your docbook sources or website. If empty the main index is loaded.
appname	This allows you to specify the .desktop file to get the help path from. If empty the QCoreApplication::applicationName() is used.

Since

5.0

Definition at line 18 of file khelpclient.cpp.

{
    QString appname;
    if (_appname.isEmpty()) {
        appname = QCoreApplication::instance()->applicationName();
    } else {
        appname = _appname;
    }
 
    // Look for the .desktop file of the application
 
    // was:
    //KService::Ptr service(KService::serviceByDesktopName(appname));
    //if (service)
    //    docPath = service->docPath();
    // but we don't want to depend on KService here.
 
    QString docPath;
    const QStringList desktopDirs = QStandardPaths::standardLocations(QStandardPaths::ApplicationsLocation);
    Q_FOREACH (const QString &dir, desktopDirs) {
        QDirIterator it(dir, QStringList() << appname + QLatin1String(".desktop"), QDir::NoFilter, QDirIterator::Subdirectories);
        while (it.hasNext()) {
            const QString desktopPath(it.next());
            KDesktopFile desktopFile(desktopPath);
            docPath = desktopFile.readDocPath();
 
            // TODO: why explicit break in a loop?
            break;
        }
    }
 
    // docPath could be a path or a full URL, I think.
 
    QUrl url;
    if (!docPath.isEmpty()) {
        url = QUrl(QLatin1String("help:/")).resolved(QUrl(docPath));
    } else {
        url = QUrl(QString::fromLatin1("help:/%1/index.html").arg(appname));
    }
 
    if (!anchor.isEmpty()) {
        QUrlQuery query(url);
        query.addQueryItem(QString::fromLatin1("anchor"), anchor);
        url.setQuery(query);
    }
 
    // launch khelpcenter, or a browser for URIs not handled by khelpcenter
    QDesktopServices::openUrl(url);
}