ESCA111/neochat
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Document linkpreviewer

Browse Source
This commit is contained in:
James Graham
2023-04-30 20:09:35 +00:00
parent 685b2a68ba
commit 26b2380bb7
1 changed files with 34 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
src/linkpreviewer.h
View File

@@ -6,25 +6,52 @@
#include <QObject>
#include <QUrl>
/**
* @class LinkPreviewer
*
* A class to download the link preview info for a URL and provide a QML interface for it.
*
* To use set the URL property and then access the other parameters which will be
* populated once loaded is true.
*/
class LinkPreviewer : public QObject
{
Q_OBJECT
Q_PROPERTY(bool loaded READ loaded NOTIFY loadedChanged)
Q_PROPERTY(QString title READ title NOTIFY titleChanged)
Q_PROPERTY(QString description READ description NOTIFY descriptionChanged)
Q_PROPERTY(QString imageSource READ imageSource NOTIFY imageSourceChanged)
/**
* @brief The URL to get the preview for.
*/
Q_PROPERTY(QUrl url READ url WRITE setUrl NOTIFY urlChanged)
/**
* @brief Whether the preview information has been loaded.
*/
Q_PROPERTY(bool loaded READ loaded NOTIFY loadedChanged)
/**
* @brief The title of the preview.
*/
Q_PROPERTY(QString title READ title NOTIFY titleChanged)
/**
* @brief The description of the preview.
*/
Q_PROPERTY(QString description READ description NOTIFY descriptionChanged)
/**
* @brief The image source for the preview.
*/
Q_PROPERTY(QString imageSource READ imageSource NOTIFY imageSourceChanged)
public:
explicit LinkPreviewer(QObject *parent = nullptr);
[[nodiscard]] QUrl url() const;
void setUrl(QUrl);
[[nodiscard]] bool loaded() const;
[[nodiscard]] QString title() const;
[[nodiscard]] QString description() const;
[[nodiscard]] QString imageSource() const;
[[nodiscard]] QUrl url() const;
void setUrl(QUrl);
private:
bool m_loaded;