forked from openkylin/ukui-search
91 lines
2.8 KiB
C++
91 lines
2.8 KiB
C++
/*
|
|
*
|
|
* Copyright (C) 2023, KylinSoft Co., Ltd.
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
*
|
|
*
|
|
*/
|
|
#ifndef SEARCHPLUGINIFACE_H
|
|
#define SEARCHPLUGINIFACE_H
|
|
#define SearchPluginIface_iid "org.ukui.ukui-search.plugin-iface.SearchPluginInterface"
|
|
#define SEARCH_PLUGIN_IFACE_VERSION "1.1.0"
|
|
|
|
#include <QString>
|
|
#include <QIcon>
|
|
#include <QList>
|
|
#include <QMutex>
|
|
#include <QtPlugin>
|
|
#include "plugin-iface.h"
|
|
#include "data-queue.h"
|
|
|
|
namespace UkuiSearch {
|
|
class SearchPluginIface : public PluginInterface
|
|
{
|
|
public:
|
|
enum InvokableAction
|
|
{
|
|
None = 1u << 0,
|
|
HideUI = 1u << 1
|
|
};
|
|
Q_DECLARE_FLAGS(InvokableActions, InvokableAction)
|
|
|
|
struct DescriptionInfo
|
|
{
|
|
QString key;
|
|
QString value;
|
|
};
|
|
struct Actioninfo
|
|
{
|
|
int actionkey;
|
|
QString displayName;
|
|
};
|
|
/**
|
|
* @brief The ResultInfo struct
|
|
*/
|
|
struct ResultInfo
|
|
{
|
|
QIcon icon;
|
|
QString name;
|
|
QVector<DescriptionInfo> description;
|
|
QString actionKey;
|
|
int type;
|
|
ResultInfo(const QIcon &iconToSet = QIcon(), const QString &nameToSet = QString(),
|
|
const QVector<DescriptionInfo> &descriptionToSet = QVector<DescriptionInfo>(),
|
|
const QString &actionKeyToSet = QString(), const int &typeToSet = 0) {
|
|
icon = iconToSet;
|
|
name = nameToSet;
|
|
description = descriptionToSet;
|
|
actionKey = actionKeyToSet;
|
|
type = typeToSet;
|
|
}
|
|
};
|
|
|
|
virtual ~SearchPluginIface() {}
|
|
virtual QString getPluginName() = 0;
|
|
virtual void KeywordSearch(QString keyword,DataQueue<ResultInfo> *searchResult) = 0;
|
|
virtual void stopSearch() = 0;
|
|
virtual QList<Actioninfo> getActioninfo(int type) = 0;
|
|
virtual void openAction(int actionkey, QString key, int type) = 0;
|
|
// virtual bool isPreviewEnable(QString key, int type) = 0;
|
|
// virtual QWidget *previewPage(QString key, int type, QWidget *parent = nullptr) = 0;
|
|
virtual QWidget *detailPage(const ResultInfo &ri) = 0;
|
|
|
|
void invokeActions(InvokableActions actions);
|
|
};
|
|
}
|
|
Q_DECLARE_INTERFACE(UkuiSearch::SearchPluginIface, SearchPluginIface_iid)
|
|
|
|
#endif // SEARCHPLUGINIFACE_H
|