Warning, file /frameworks/kconfigwidgets/src/khelpclient.h was not indexed or was modified since last indexation (in which case cross-reference links may be missing, inaccurate or erroneous).

0001 /*
0002     This file is part of the KDE libraries
0003     SPDX-FileCopyrightText: 2012 David Faure <faure@kde.org>
0004 
0005     SPDX-License-Identifier: LGPL-2.0-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
0006 */
0007 
0008 #ifndef KHELPCLIENT_H
0009 #define KHELPCLIENT_H
0010 
0011 #include "kconfigwidgets_export.h"
0012 #include <QString>
0013 
0014 /**
0015  * @namespace KHelpClient
0016  * Provides utility functions for access to help manuals.
0017  */
0018 namespace KHelpClient
0019 {
0020 /**
0021  * Invokes the KHelpCenter HTML help viewer from docbook sources.
0022  *
0023  * The HTML file will be found using the X-DocPath entry in the application's desktop file.
0024  * It can be either a relative path, or a website URL.
0025  *
0026  * @param anchor      This has to be a defined anchor in your
0027  *                    docbook sources or website. If empty the main index
0028  *                    is loaded.
0029  * @param appname     This allows you to specify the .desktop file to get the help path from.
0030  *                    If empty the QCoreApplication::applicationName() is used.
0031  * @since 5.0
0032  */
0033 KCONFIGWIDGETS_EXPORT void invokeHelp(const QString &anchor = QString(), const QString &appname = QString());
0034 }
0035 
0036 #endif /* KHELPCLIENT_H */