kmoretools.h

/*
    SPDX-FileCopyrightText: 2015 Gregor Mi <[email protected]>

    SPDX-License-Identifier: LGPL-2.1-or-later
*/

#ifndef KMORETOOLS_H
#define KMORETOOLS_H

#include <QString>
#include <QUrl>
#include <QMenu>

#include <KService>

#include "knewstuff_export.h"

class KMoreToolsService;
class KMoreToolsMenuBuilder;
class KMoreToolsPrivate;

class KNEWSTUFF_EXPORT KMoreTools
{
    friend class KMoreToolsService;
    friend class KMoreToolsServicePrivate;

public:
    enum ServiceLocatingMode
    {
        ServiceLocatingMode_Default,

        ServiceLocatingMode_ByProvidedExecLine
    };

    enum MenuSection
    {
        MenuSection_Main,

        MenuSection_More
    };

//     /* *
//      * todo/later: introduce when needed
//      */
//     enum NotInstalledSectionOption
//     {
//         /* *
//          * default
//          */
//         NotInstalledSection_Show,
//
//         /* *
//          * Even if there are non-installed apps the Not-Installed section will
//          * not be shown
//          */
//         NotInstalledSection_Hide
//     };

    enum ConfigureDialogAccessibleSetting
    {
        ConfigureDialogAccessible_Always,

        ConfigureDialogAccessible_Defensive
    };

public:
    explicit KMoreTools(const QString& uniqueId);

    ~KMoreTools();

    KMoreTools(const KMoreTools &) = delete;
    KMoreTools& operator=(const KMoreTools &) = delete;

    KMoreToolsService* registerServiceByDesktopEntryName(
        const QString& desktopEntryName,
        const QString& kmtDesktopfileSubdir = QString(),
        ServiceLocatingMode serviceLocatingMode = ServiceLocatingMode_Default);

    KMoreToolsMenuBuilder* menuBuilder(const QString& userConfigPostfix = QString()) const;

private:
    KMoreToolsPrivate* d;
};

// --------------------------------------------------------------------------------------
// --------------------------------------------------------------------------------------

class KMoreToolsServicePrivate;

class KNEWSTUFF_EXPORT KMoreToolsService
{
    friend class KMoreTools;
    friend class KMoreToolsPrivate;

public:
    ~KMoreToolsService();

    KMoreToolsService(const KMoreToolsService &) = delete;
    KMoreToolsService& operator=(const KMoreToolsService &) = delete;

    QString desktopEntryName() const;

    bool isInstalled() const;

    KService::Ptr installedService() const;

    KService::Ptr kmtProvidedService() const;

    QIcon kmtProvidedIcon() const;

    QUrl homepageUrl() const;

    void setHomepageUrl(const QUrl& url);

    int maxUrlArgCount() const;

    void setMaxUrlArgCount(int maxUrlArgCount);

    QString formatString(const QString& formatString) const;

    QIcon icon() const;

    void setExec(const QString& exec);

    QString appstreamId() const;

    void setAppstreamId(const QString&);

private:
    KMoreToolsService(const QString& kmtDesktopfileSubdir,
                      const QString& desktopEntryName,
                      bool isInstalled, KService::Ptr installedService,
                      KService::Ptr kmtDesktopfile);

    KMoreToolsService(const KMoreTools&);

    KMoreToolsServicePrivate* d;
};

// --------------------------------------------------------------------------------------
// --------------------------------------------------------------------------------------

class KMoreToolsMenuItem;
class KMoreToolsMenuBuilderPrivate;

class KNEWSTUFF_EXPORT KMoreToolsMenuBuilder
{
    friend class KMoreToolsPrivate;
    friend class KMoreTools;
    friend class KMoreToolsTest;
    friend class KMoreToolsTest2;
    friend class KMoreToolsTestInteractive;

public:
    ~KMoreToolsMenuBuilder();

    KMoreToolsMenuBuilder(const KMoreToolsMenuBuilder &) = delete;
    KMoreToolsMenuBuilder& operator=(const KMoreToolsMenuBuilder &) = delete;

    void setInitialItemTextTemplate(const QString& templateText);

    KMoreToolsMenuItem* addMenuItem(KMoreToolsService* registeredService,
                                    KMoreTools::MenuSection defaultLocation = KMoreTools::MenuSection_Main);

    KMoreToolsMenuItem* addMenuItem(QAction* action, const QString& itemId,
                                    KMoreTools::MenuSection defaultLocation = KMoreTools::MenuSection_Main);

    void clear();

    void buildByAppendingToMenu(
        QMenu* menu,
        KMoreTools::ConfigureDialogAccessibleSetting configureDialogAccessibleSetting
        = KMoreTools::ConfigureDialogAccessible_Always,
        QMenu** outMoreMenu = nullptr);

private:
    QString menuStructureAsString(bool mergeWithUserConfig) const;

    void showConfigDialog(const QString& title);

    KMoreToolsMenuBuilder();

    KMoreToolsMenuBuilder(const QString& uniqueId, const QString& userConfigPostfix);

    KMoreToolsMenuBuilder(const KMoreTools&);

    KMoreToolsMenuBuilderPrivate* d;
};

// --------------------------------------------------------------------------------------
// --------------------------------------------------------------------------------------

class KMoreToolsMenuItemPrivate;

class KNEWSTUFF_EXPORT KMoreToolsMenuItem
{
    friend class KMoreToolsMenuBuilderPrivate;
    friend class KMoreToolsMenuBuilder;

public:
    KMoreToolsMenuItem(const KMoreToolsMenuItem &) = delete;
    KMoreToolsMenuItem& operator=(const KMoreToolsMenuItem &) = delete;

    QString id() const;

    void setId(const QString& id);

    KMoreToolsService* registeredService() const;

    KMoreTools::MenuSection defaultLocation() const;

    QString initialItemText() const;

    void setInitialItemText(const QString& itemText);

    QAction* action() const;

private: // internal usage
    KMoreToolsMenuItem(KMoreToolsService* registeredService, KMoreTools::MenuSection defaultLocation, const QString& initialItemTextTemplate);

    KMoreToolsMenuItem(QAction* action, const QString& itemId, KMoreTools::MenuSection defaultLocation);

    ~KMoreToolsMenuItem();

private:
    KMoreToolsMenuItemPrivate* d;
};

#endif // KMORETOOLS_H