You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
130 lines
3.2 KiB
130 lines
3.2 KiB
/* This file is part of the KDE project |
|
Copyright (C) 2004 Esben Mose Hansen <kde@mosehansen.dk> |
|
|
|
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 2 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; see the file COPYING. If not, write to |
|
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
|
Boston, MA 02110-1301, USA. |
|
*/ |
|
#ifndef HISTORYITEM_H |
|
#define HISTORYITEM_H |
|
|
|
#include <QPixmap> |
|
|
|
class HistoryModel; |
|
class QString; |
|
class QMimeData; |
|
class QDataStream; |
|
|
|
class HistoryItem; |
|
typedef QSharedPointer<HistoryItem> HistoryItemPtr; |
|
typedef QSharedPointer<const HistoryItem> HistoryItemConstPtr; |
|
/** |
|
* An entry in the clipboard history. |
|
*/ |
|
class HistoryItem |
|
{ |
|
public: |
|
explicit HistoryItem(const QByteArray &uuid); |
|
virtual ~HistoryItem(); |
|
|
|
/** |
|
* Return the current item as text |
|
* An image would be returned as a descriptive |
|
* text, such as 32x43 image. |
|
*/ |
|
virtual QString text() const = 0; |
|
|
|
/** |
|
* @return uuid of current item. |
|
*/ |
|
const QByteArray &uuid() const |
|
{ |
|
return m_uuid; |
|
} |
|
|
|
/** |
|
* Return the current item as pixmap |
|
* A text would be returned as a null pixmap, |
|
* which is also the default implementation |
|
*/ |
|
inline virtual const QPixmap &image() const; |
|
|
|
/** |
|
* Returns a pointer to a QMimeData suitable for QClipboard::setMimeData(). |
|
*/ |
|
virtual QMimeData *mimeData() const = 0; |
|
|
|
/** |
|
* Write object on datastream |
|
*/ |
|
virtual void write(QDataStream &stream) const = 0; |
|
|
|
/** |
|
* Equality. |
|
*/ |
|
virtual bool operator==(const HistoryItem &rhs) const = 0; |
|
|
|
/** |
|
* Create an HistoryItem from MimeSources (i.e., clipboard data) |
|
* returns null if create fails (e.g, unsupported mimetype) |
|
*/ |
|
static HistoryItemPtr create(const QMimeData *data); |
|
|
|
/** |
|
* Create an HistoryItem from data stream (i.e., disk file) |
|
* returns null if creation fails. In this case, the datastream |
|
* is left in an undefined state. |
|
*/ |
|
static HistoryItemPtr create(QDataStream &dataStream); |
|
|
|
/** |
|
* previous item's uuid |
|
* TODO: drop, only used in unit test now |
|
*/ |
|
QByteArray previous_uuid() const; |
|
|
|
/** |
|
* next item's uuid |
|
* TODO: drop, only used in unit test now |
|
*/ |
|
QByteArray next_uuid() const; |
|
|
|
void setModel(HistoryModel *model); |
|
|
|
protected: |
|
HistoryModel *m_model; |
|
|
|
private: |
|
QByteArray m_uuid; |
|
}; |
|
|
|
inline const QPixmap &HistoryItem::image() const |
|
{ |
|
static QPixmap nullPixmap; |
|
return nullPixmap; |
|
} |
|
|
|
inline QDataStream &operator<<(QDataStream &lhs, HistoryItem const *const rhs) |
|
{ |
|
if (rhs) { |
|
rhs->write(lhs); |
|
} |
|
return lhs; |
|
} |
|
|
|
Q_DECLARE_METATYPE(HistoryItem *) |
|
Q_DECLARE_METATYPE(HistoryItemPtr) |
|
Q_DECLARE_METATYPE(HistoryItemConstPtr) |
|
|
|
#endif
|
|
|