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