mirror of
https://github.com/linuxdeepin/dde-dock.git
synced 2025-06-03 00:15:21 +00:00
e714c7e44e
所有插件的api版本都改成2.0.0，PluginProxyInterface新增的接口放到最后的位置，保证老插件在加载的时候能调用到正确的函数 Log: 修改老插件的兼容性问题 Influence: 任务栏加载老插件 Bug: https://pms.uniontech.com/bug-view-132961.html Change-Id: I0c2714db6a21f2d246126ce2d9cec96e8c706d80
108 lines
3.7 KiB
C++
108 lines
3.7 KiB
C++
/*
|
|
* Copyright (C) 2011 ~ 2018 Deepin Technology Co., Ltd.
|
|
*
|
|
* Author: sbw <sbw@sbw.so>
|
|
*
|
|
* Maintainer: sbw <sbw@sbw.so>
|
|
*
|
|
* 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
|
|
* 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 <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#ifndef PLUGINPROXYINTERFACE_H
|
|
#define PLUGINPROXYINTERFACE_H
|
|
|
|
#include "constants.h"
|
|
|
|
#include <QtCore>
|
|
|
|
class PluginsItemInterface;
|
|
enum class DockPart;
|
|
|
|
class PluginProxyInterface
|
|
{
|
|
public:
|
|
///
|
|
/// \brief itemAdded
|
|
/// add a new dock item
|
|
/// if itemkey of this plugin inter already exist, the new item
|
|
/// will be ignored, so if you need to add multiple item, you need
|
|
/// to ensure all itemKey is different.
|
|
/// \param itemInter
|
|
/// your plugin interface
|
|
/// \param itemKey
|
|
/// your item unique key
|
|
///
|
|
virtual void itemAdded(PluginsItemInterface * const itemInter, const QString &itemKey) = 0;
|
|
///
|
|
/// \brief itemUpdate
|
|
/// update(repaint) spec item
|
|
/// \param itemInter
|
|
/// \param itemKey
|
|
///
|
|
virtual void itemUpdate(PluginsItemInterface * const itemInter, const QString &itemKey) = 0;
|
|
///
|
|
/// \brief itemRemoved
|
|
/// remove spec item, if spec item is not exist, dock will to nothing.
|
|
/// dock will NOT delete your object, you should manage memory by your self.
|
|
/// \param itemInter
|
|
/// \param itemKey
|
|
///
|
|
virtual void itemRemoved(PluginsItemInterface * const itemInter, const QString &itemKey) = 0;
|
|
|
|
///
|
|
/// \brief requestContextMenu
|
|
/// request show context menu
|
|
///
|
|
//virtual void requestContextMenu(PluginsItemInterface * const itemInter, const QString &itemKey) = 0;
|
|
|
|
virtual void requestWindowAutoHide(PluginsItemInterface * const itemInter, const QString &itemKey, const bool autoHide) = 0;
|
|
virtual void requestRefreshWindowVisible(PluginsItemInterface * const itemInter, const QString &itemKey) = 0;
|
|
|
|
virtual void requestSetAppletVisible(PluginsItemInterface * const itemInter, const QString &itemKey, const bool visible) = 0;
|
|
|
|
///
|
|
/// \brief saveValue
|
|
/// save module config to .config/deepin/dde-dock.conf
|
|
/// all key-values of all plugins will be save to that file
|
|
/// and grouped by the returned value of pluginName() function which is defined in PluginsItemInterface
|
|
/// \param itemInter the plugin object
|
|
/// \param key the key of data
|
|
/// \param value the data
|
|
///
|
|
virtual void saveValue(PluginsItemInterface * const itemInter, const QString &key, const QVariant &value) = 0;
|
|
|
|
///
|
|
/// \brief getValue
|
|
/// SeeAlse: saveValue
|
|
/// return value from .config/deepin/dde-dock.conf
|
|
///
|
|
virtual const QVariant getValue(PluginsItemInterface *const itemInter, const QString &key, const QVariant& fallback = QVariant()) = 0;
|
|
|
|
///
|
|
/// \brief removeValue
|
|
/// remove the values specified by keyList
|
|
/// remove all values of itemInter if keyList is empty
|
|
/// SeeAlse: saveValue
|
|
///
|
|
virtual void removeValue(PluginsItemInterface *const itemInter, const QStringList &keyList) = 0;
|
|
|
|
///
|
|
/// update display or information
|
|
///
|
|
///
|
|
virtual void updateDockInfo(const DockPart &) = 0;
|
|
};
|
|
|
|
#endif // PLUGINPROXYINTERFACE_H
|