74 lines
1.8 KiB
C++
74 lines
1.8 KiB
C++
// SPDX-FileCopyrightText: 2019 Black Hat <bhat@encom.eu.org>
|
|
// SPDX-License-Identifier: GPL-3.0-only
|
|
|
|
#pragma once
|
|
|
|
#include <QObject>
|
|
|
|
class QClipboard;
|
|
class QImage;
|
|
|
|
/**
|
|
* @class Clipboard
|
|
*
|
|
* Clipboard proxy
|
|
*
|
|
* Used to set and retrieve content from the clipboard.
|
|
*/
|
|
class Clipboard : public QObject
|
|
{
|
|
Q_OBJECT
|
|
|
|
/**
|
|
* @brief Whether the current clipboard content is an image.
|
|
*/
|
|
Q_PROPERTY(bool hasImage READ hasImage NOTIFY imageChanged)
|
|
|
|
/**
|
|
* @brief Return the current clipboard content image.
|
|
*
|
|
* Returns a null image if the clipboard does not contain an image or if it
|
|
* contains an image in an unsupported image format.
|
|
*/
|
|
Q_PROPERTY(QImage image READ image NOTIFY imageChanged)
|
|
|
|
public:
|
|
explicit Clipboard(QObject *parent = nullptr);
|
|
|
|
[[nodiscard]] bool hasImage() const;
|
|
|
|
[[nodiscard]] QImage image() const;
|
|
|
|
/**
|
|
* @brief Save the current clipboard image to file.
|
|
*
|
|
* If the clipboard does not contain an image or if it contains an image in an
|
|
* unsupported image format nothing happens.
|
|
*
|
|
* The given file path must be both valid and local or nothing happens.
|
|
*
|
|
* @param localPath the path to save the image. A default path for the app cache
|
|
* will be used if available and this is empty.
|
|
*
|
|
* @return A QString with the path that the image was saved to. The string will
|
|
* be empty if nothing was saved.
|
|
*/
|
|
Q_INVOKABLE QString saveImage(QString localPath = {}) const;
|
|
|
|
/**
|
|
* @brief Set the clipboard content to the input message.
|
|
*/
|
|
Q_INVOKABLE void saveText(QString message);
|
|
|
|
/**
|
|
* @brief Set the clipboard content to the input image.
|
|
*/
|
|
Q_INVOKABLE void setImage(const QUrl &image);
|
|
|
|
private:
|
|
QClipboard *m_clipboard;
|
|
|
|
Q_SIGNALS:
|
|
void imageChanged();
|
|
};
|