dde-dock/interfaces/pluginproxyinterface.h
石博文 82b26d9109 add documents
Change-Id: I94eb2be8d6d977ed01357465079a25e4c81c681f
2016-09-07 16:45:57 +08:00

48 lines
1.4 KiB
C++

#ifndef PLUGINPROXYINTERFACE_H
#define PLUGINPROXYINTERFACE_H
#include "constants.h"
#include <QtCore>
class PluginsItemInterface;
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 requestRefershWindowVisible
/// tell dock refersh window visible state,
/// its useful because sometimes you could force disable auto-hide.
///
virtual void requestRefershWindowVisible() = 0;
};
#endif // PLUGINPROXYINTERFACE_H