KConfigWidgets

khelpclient.h
1/*
2 This file is part of the KDE libraries
3 SPDX-FileCopyrightText: 2012 David Faure <faure@kde.org>
4
5 SPDX-License-Identifier: LGPL-2.0-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
6*/
7
8#ifndef KHELPCLIENT_H
9#define KHELPCLIENT_H
10
11#include "kconfigwidgets_export.h"
12#include <QString>
13
14/**
15 * @namespace KHelpClient
16 * Provides utility functions for access to help manuals.
17 */
18namespace KHelpClient
19{
20/**
21 * Invokes the KHelpCenter HTML help viewer from docbook sources.
22 *
23 * The HTML file will be found using the X-DocPath entry in the application's desktop file.
24 * It can be either a relative path, or a website URL.
25 *
26 * @param anchor This has to be a defined anchor in your
27 * docbook sources or website. If empty the main index
28 * is loaded.
29 * @param appname This allows you to specify the .desktop file to get the help path from.
30 * If empty the QCoreApplication::applicationName() is used.
31 * @since 5.0
32 */
33KCONFIGWIDGETS_EXPORT void invokeHelp(const QString &anchor = QString(), const QString &appname = QString());
34}
35
36#endif /* KHELPCLIENT_H */
Provides utility functions for access to help manuals.
void invokeHelp(const QString &anchor=QString(), const QString &appname=QString())
Invokes the KHelpCenter HTML help viewer from docbook sources.
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Tue Mar 26 2024 11:13:01 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.