khelpmenu.cpp

/*
    This file is part of the KDE Libraries
    SPDX-FileCopyrightText: 1999-2000 Espen Sand <espen@kde.org>
 
    SPDX-License-Identifier: LGPL-2.0-or-later
*/
 
// I (espen) prefer that header files are included alphabetically
 
#include "khelpmenu.h"
 
#include <QAction>
#include <QApplication>
#include <QDesktopServices>
#include <QDialogButtonBox>
#include <QLabel>
#include <QMenu>
#include <QStandardPaths>
#include <QStyle>
#include <QTimer>
#include <QUrl>
#include <QWhatsThis>
#include <QWidget>
 
#include "kaboutapplicationdialog.h"
#include "kaboutkdedialog_p.h"
#include "kbugreport.h"
#include "kswitchlanguagedialog_p.h"
 
#include <KAboutData>
#include <KAuthorized>
#include <KLocalizedString>
#include <KStandardActions>
 
#include <optional>
 
using namespace KDEPrivate;
 
class KHelpMenuPrivate
{
public:
    KHelpMenuPrivate()
    {
    }
    ~KHelpMenuPrivate()
    {
        delete mMenu;
        delete mAboutApp;
        delete mAboutKDE;
        delete mBugReport;
        delete mSwitchApplicationLanguage;
    }
 
    void createActions(KHelpMenu *q, bool showWhatsThis);
 
    QMenu *mMenu = nullptr;
    QDialog *mAboutApp = nullptr;
    KAboutKdeDialog *mAboutKDE = nullptr;
    KBugReport *mBugReport = nullptr;
    QAction *mDonateAction = nullptr;
    KSwitchLanguageDialog *mSwitchApplicationLanguage = nullptr;
 
    // TODO evaluate if we use static_cast<QWidget*>(parent()) instead of mParent to win that bit of memory
    QWidget *mParent = nullptr;
 
    QAction *mHandBookAction = nullptr;
    QAction *mWhatsThisAction = nullptr;
    QAction *mReportBugAction = nullptr;
    QAction *mSwitchApplicationLanguageAction = nullptr;
    QAction *mAboutAppAction = nullptr;
    QAction *mAboutKDEAction = nullptr;
 
    std::optional<KAboutData> mAboutData;
};
 
#if KXMLGUI_BUILD_DEPRECATED_SINCE(6, 9)
KHelpMenu::KHelpMenu(QWidget *parent, const QString &, bool showWhatsThis)
    : QObject(parent)
    , d(new KHelpMenuPrivate)
{
    d->mParent = parent;
    d->createActions(this, showWhatsThis);
}
#endif
 
KHelpMenu::KHelpMenu(QWidget *parent)
    : QObject(parent)
    , d(new KHelpMenuPrivate)
{
    d->mParent = parent;
    d->createActions(this, true);
}
 
#if KXMLGUI_BUILD_DEPRECATED_SINCE(6, 9)
KHelpMenu::KHelpMenu(QWidget *parent, const KAboutData &aboutData, bool showWhatsThis)
    : QObject(parent)
    , d(new KHelpMenuPrivate)
{
    d->mParent = parent;
    d->mAboutData = aboutData;
    d->createActions(this, showWhatsThis);
}
#endif
 
KHelpMenu::KHelpMenu(QWidget *parent, const KAboutData &aboutData)
    : QObject(parent)
    , d(new KHelpMenuPrivate)
{
    d->mParent = parent;
    d->mAboutData = aboutData;
    d->createActions(this, true);
}
 
KHelpMenu::~KHelpMenu()
{
    delete d;
}
 
void KHelpMenu::setShowWhatsThis(bool showWhatsThis)
{
    if (!showWhatsThis) {
        delete d->mWhatsThisAction;
        d->mWhatsThisAction = nullptr;
    } else if (KAuthorized::authorizeAction(QStringLiteral("help_whats_this"))) {
        d->mWhatsThisAction = KStandardActions::whatsThis(this, &KHelpMenu::contextHelpActivated, this);
    }
}
 
void KHelpMenuPrivate::createActions(KHelpMenu *q, bool showWhatsThis)
{
    if (KAuthorized::authorizeAction(QStringLiteral("help_contents"))) {
        mHandBookAction = KStandardActions::helpContents(q, &KHelpMenu::appHelpActivated, q);
    }
    if (showWhatsThis && KAuthorized::authorizeAction(QStringLiteral("help_whats_this"))) {
        mWhatsThisAction = KStandardActions::whatsThis(q, &KHelpMenu::contextHelpActivated, q);
    }
 
    const auto bugAddress = mAboutData ? mAboutData->bugAddress() : KAboutData::applicationData().bugAddress();
    if (KAuthorized::authorizeAction(QStringLiteral("help_report_bug")) && !bugAddress.isEmpty()) {
        mReportBugAction = KStandardActions::reportBug(q, &KHelpMenu::reportBug, q);
    }
 
    if (KAuthorized::authorizeAction(QStringLiteral("help_donate")) && bugAddress == QLatin1String("submit@bugs.kde.org")) {
        mDonateAction = KStandardActions::donate(q, &KHelpMenu::donate, q);
    }
 
    if (KAuthorized::authorizeAction(QStringLiteral("switch_application_language"))) {
        mSwitchApplicationLanguageAction = KStandardActions::switchApplicationLanguage(q, &KHelpMenu::switchApplicationLanguage, q);
    }
 
    if (KAuthorized::authorizeAction(QStringLiteral("help_about_app"))) {
        mAboutAppAction = KStandardActions::aboutApp(q, &KHelpMenu::aboutApplication, q);
    }
 
    if (KAuthorized::authorizeAction(QStringLiteral("help_about_kde"))) {
        mAboutKDEAction = KStandardActions::aboutKDE(q, &KHelpMenu::aboutKDE, q);
    }
}
 
// Used in the non-xml-gui case, like kfind or ksnapshot's help button.
QMenu *KHelpMenu::menu()
{
    if (!d->mMenu) {
        d->mMenu = new QMenu(d->mParent);
        connect(d->mMenu, &QObject::destroyed, this, &KHelpMenu::menuDestroyed);
 
        d->mMenu->setTitle(i18n("&Help"));
 
        bool need_separator = false;
        if (d->mHandBookAction) {
            d->mMenu->addAction(d->mHandBookAction);
            need_separator = true;
        }
 
        if (d->mWhatsThisAction) {
            d->mMenu->addAction(d->mWhatsThisAction);
            need_separator = true;
        }
 
        if (d->mReportBugAction) {
            if (need_separator) {
                d->mMenu->addSeparator();
            }
            d->mMenu->addAction(d->mReportBugAction);
            need_separator = true;
        }
 
        if (d->mDonateAction) {
            if (need_separator) {
                d->mMenu->addSeparator();
            }
            d->mMenu->addAction(d->mDonateAction);
            need_separator = true;
        }
 
        if (d->mSwitchApplicationLanguageAction) {
            if (need_separator) {
                d->mMenu->addSeparator();
            }
            d->mMenu->addAction(d->mSwitchApplicationLanguageAction);
            need_separator = true;
        }
 
        if (need_separator) {
            d->mMenu->addSeparator();
        }
 
        if (d->mAboutAppAction) {
            d->mMenu->addAction(d->mAboutAppAction);
        }
 
        if (d->mAboutKDEAction) {
            d->mMenu->addAction(d->mAboutKDEAction);
        }
    }
 
    return d->mMenu;
}
 
QAction *KHelpMenu::action(MenuId id) const
{
    switch (id) {
    case menuHelpContents:
        return d->mHandBookAction;
 
    case menuWhatsThis:
        return d->mWhatsThisAction;
 
    case menuReportBug:
        return d->mReportBugAction;
 
    case menuSwitchLanguage:
        return d->mSwitchApplicationLanguageAction;
 
    case menuAboutApp:
        return d->mAboutAppAction;
 
    case menuAboutKDE:
        return d->mAboutKDEAction;
 
    case menuDonate:
        return d->mDonateAction;
    }
 
    return nullptr;
}
 
void KHelpMenu::appHelpActivated()
{
    QDesktopServices::openUrl(QUrl(QStringLiteral("help:/")));
}
 
void KHelpMenu::aboutApplication()
{
    if (receivers(SIGNAL(showAboutApplication())) > 0) {
        Q_EMIT showAboutApplication();
    } else {
        if (!d->mAboutApp) {
            d->mAboutApp = new KAboutApplicationDialog(d->mAboutData ? *d->mAboutData : KAboutData::applicationData(), d->mParent);
            connect(d->mAboutApp, &QDialog::finished, this, &KHelpMenu::dialogFinished);
        }
        d->mAboutApp->show();
    }
}
 
void KHelpMenu::aboutKDE()
{
    if (!d->mAboutKDE) {
        d->mAboutKDE = new KAboutKdeDialog(d->mParent);
        connect(d->mAboutKDE, &QDialog::finished, this, &KHelpMenu::dialogFinished);
    }
    d->mAboutKDE->show();
}
 
void KHelpMenu::reportBug()
{
    if (!d->mBugReport) {
        d->mBugReport = new KBugReport(d->mAboutData ? *d->mAboutData : KAboutData::applicationData(), d->mParent);
        connect(d->mBugReport, &QDialog::finished, this, &KHelpMenu::dialogFinished);
    }
    d->mBugReport->show();
}
 
void KHelpMenu::switchApplicationLanguage()
{
    if (!d->mSwitchApplicationLanguage) {
        d->mSwitchApplicationLanguage = new KSwitchLanguageDialog(d->mParent);
        connect(d->mSwitchApplicationLanguage, &QDialog::finished, this, &KHelpMenu::dialogFinished);
    }
    d->mSwitchApplicationLanguage->show();
}
 
void KHelpMenu::donate()
{
    const auto componentName = d->mAboutData ? d->mAboutData->componentName() : KAboutData::applicationData().componentName();
    QDesktopServices::openUrl(QUrl(QLatin1String("https://www.kde.org/donate?app=") + componentName));
}
 
void KHelpMenu::dialogFinished()
{
    QTimer::singleShot(0, this, &KHelpMenu::timerExpired);
}
 
void KHelpMenu::timerExpired()
{
    if (d->mAboutKDE && !d->mAboutKDE->isVisible()) {
        delete d->mAboutKDE;
        d->mAboutKDE = nullptr;
    }
 
    if (d->mBugReport && !d->mBugReport->isVisible()) {
        delete d->mBugReport;
        d->mBugReport = nullptr;
    }
 
    if (d->mSwitchApplicationLanguage && !d->mSwitchApplicationLanguage->isVisible()) {
        delete d->mSwitchApplicationLanguage;
        d->mSwitchApplicationLanguage = nullptr;
    }
 
    if (d->mAboutApp && !d->mAboutApp->isVisible()) {
        delete d->mAboutApp;
        d->mAboutApp = nullptr;
    }
}
 
void KHelpMenu::menuDestroyed()
{
    d->mMenu = nullptr;
}
 
void KHelpMenu::contextHelpActivated()
{
    QWhatsThis::enterWhatsThisMode();
}
 
#include "moc_khelpmenu.cpp"