Contains information about a single article/item. More...

#include <Fuoten/Article>

Inheritance diagram for Fuoten::Article:

Properties
QString	author
	The author of the article.
QString	body
	The text body of the article.
QUrl	enclosureLink
	URL of the enclosure.
QString	enclosureMime
	MIME type of an optional enclosure.
qint64	feedId
	ID of the Feed this Article belongs to.
QString	feedTitle
	Title of the feed this article belongs to.
QString	fingerprint
	Hash over title, enclosure, body and url.
qint64	folderId
	ID of the folder this article belongs to.
QString	folderName
	Name of the folder this article belongs to.
QString	guid
	Global unique identifier of the article.
QString	guidHash
	Hash of the global uniquie identifier of the article.
QString	humanPubDate
	Returns a human readable string of the publication date.
QString	humanPubTime
	Return a human readable string of the publication time.
QDateTime	lastModified
	Date and time this articles has been modified the last time.
QString	mediaDescription
	Holds the description of a optional media object.
QUrl	mediaThumbnail
	Holds the url to a optional media thumbnail.
QDateTime	pubDate
	Date and time the article was published.
bool	rtl
	Returns `true` if the text is right to left.
bool	starred
	True if the user has starred this article.
QString	title
	Title of the article.
bool	unread
	True if the article has not been read.
QUrl	url
	URL of the article.
Properties inherited from Fuoten::BaseItem
Fuoten::Error *	error
	Pointer to an Error object, if an error occurred, otherwise returns a `nullptr`.
qint64	id
	Database ID of the Article, Feed or Folder.
bool	inOperation
	Returns true while there is an operation running on the item.

Public Member Functions
	Article (Article other, QObject parent=nullptr)
	Constructs a new Article object with the given parent by copying the properties of other to the new object.
	Article (qint64 id, qint64 feedId, const QString &feedTitle, const QString &guid, const QString &guidHash, const QUrl &url, const QString &title, const QString &author, const QDateTime &pubDate, const QString &body, const QString &enclosureMime, const QUrl &enclosureLink, bool unread, bool starred, const QDateTime &lastModified, const QString &fingerprint, qint64 folderId, const QString &folderName, FuotenEnums::QueueActions queue, bool rtl, const QUrl &mediaThumbnail, const QString &mediaDescription, QObject *parent=nullptr)
	Constructs a new Article object with the given arguments and parent.
	Article (QObject *parent=nullptr)
	Constructs a new Article object with default values and the given parent.
	~Article () override
	Deconstructs the Article object.
QString	author () const
	Getter function for the author property.
QString	body () const
	Getter function for the body property.
void	copy (BaseItem *other) override
	Makes a deep copy of other.
QUrl	enclosureLink () const
	Getter function for the enclosureLink property.
QString	enclosureMime () const
	Getter function for the enclosureMime property.
qint64	feedId () const
	Getter function for the feedId property.
QString	feedTitle () const
	Getter function for the feedTitle property.
QString	fingerprint () const
	Getter function for the fingerprint property.
qint64	folderId () const
	Getter function for the folderId property.
QString	folderName () const
	Getter function for the folderName property.
QString	guid () const
	Getter function for the guid property.
QString	guidHash () const
	Getter function for the guidHash property.
QString	humanPubDate () const
	Getter function for the humanPubDate property.
QString	humanPubTime () const
	Getter function for the humanPubTime property.
QDateTime	lastModified () const
	Getter function for the lastModified property.
Q_INVOKABLE void	mark (bool unread, bool enqueue=false)
	Marks this article as read or unread on the server. This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This uses Component::defaultConfiguration() and Component::defaultStorage().
Q_INVOKABLE void	mark (bool unread, Fuoten::AbstractConfiguration config, Fuoten::AbstractStorage storage=nullptr, bool enqueue=false)
	Marks this article as read or unread on the server.
QString	mediaDescription () const
	Getter function for the mediaDescription property.
QUrl	mediaThumbnail () const
	Getter function for the mediaThumbnail property.
QDateTime	pubDate () const
	Getter function for the pubDate property.
bool	rtl () const
	Getter function for the rtl property.
void	setAuthor (const QString &nAuthor)
	Setter function for the author property. Emits the authorChanged() signal if nAuthor is not equal to the stored value.
void	setBody (const QString &nBody)
	Setter function for the body property. Emits the bodyChanged() signal if nBody is not equal to the stored value.
void	setEnclosureLink (const QUrl &nEnclosureLink)
	Setter function for the enclosureLink property. Emits the enclosureLinkChanged() signal if nEnclosureLink is not equal to the stored value.
void	setEnclosureMime (const QString &nEnclosureMime)
	Setter function for the enclosureMime property. Emits the enclosureMimeChanged() signal if nEnclosureMime is not equal to the stored value.
void	setFeedId (qint64 nFeedId)
	Setter function for the feedId property. Emits the feedIdChanged() signal if nFeedId is not equal to the stored value.
void	setFeedTitle (const QString &nFeedTitle)
	Setter function for the feedTitle property. Emits the feedTitleChanged() signal if nFeedTitle is not equal to the stored value.
void	setFingerprint (const QString &nFingerprint)
	Setter function for the fingerprint property. Emits the fingerprintChanged() signal if nFingerprint is not equal to the stored value.
void	setFolderId (qint64 nFolderId)
	Setter function for the folderId property. Emits the folderIdChanged() signal if nFolderId is not equal to the stored value.
void	setFolderName (const QString &nFolderName)
	Setter function for the folderName property. Emits the folderNameChanged() signal if nFolderName is not equal to the stored value.
void	setGuid (const QString &nGuid)
	Setter function for the guid property. Emits the guidChanged() signal if nGuid is not equal to the stored value.
void	setGuidHash (const QString &nGuidHash)
	Setter function for the guidHash property. Emits the guidHashChanged() signal if nGuidHash is not equal to the stored value.
void	setLastModified (const QDateTime &nLastModified)
	Setter function for the lastModified property. Emits the lastModifiedChanged() signal if nLastModified is not equal to the stored value.
void	setMediaDescription (const QString &nMediaDescription)
	Setter function for the mediaDescription property. Emits the mediaDescriptionChanged() signal if nMediaDescription is not equal to the stored value.
void	setMediaThumbnail (const QUrl &nMediaThumbnail)
	Setter function for the mediaThumbnail property. Emits the mediaThumbnailChanged() signal if nMediaThumbnail is not equal to the stored value.
void	setPubDate (const QDateTime &nPubDate)
	Setter function for the pubDate property. Emits the pubDateChanged() signal if nPubDate is not equal to the stored value.
void	setRtl (bool nRtl)
	Setter function for the rtl property. Emits the rtlChanged() signal if nRtl is not equal to the stored value.
void	setStarred (bool nStarred)
	Setter function for the starred property. Emits the starredChanged() signal if nStarred is not equal to the stored value.
void	setTitle (const QString &nTitle)
	Setter function for the title property. Emits the titleChanged() signal if nTitle is not equal to the stored value.
void	setUnread (bool nUnread)
	Setter function for the unread property. Emits the unreadChanged() signal if nUnread is not equal to the stored value.
void	setUrl (const QUrl &nUrl)
	Setter function for the url property. Emits the urlChanged() signal if nUrl is not equal to the stored value.
Q_INVOKABLE void	star (bool starred, bool enqueue=false)
	Marks this article as starred or unstarred on the remote server. This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This uses Component::defaultConfiguration() and Component::defaultStorage().
Q_INVOKABLE void	star (bool starred, Fuoten::AbstractConfiguration config, Fuoten::AbstractStorage storage=nullptr, bool enqueue=false)
	Marks this article as starred or unstarred on the remote server.
bool	starred () const
	Getter function for the starred property.
QString	title () const
	Getter function for the title property.
bool	unread () const
	Getter function for the unread property.
QUrl	url () const
	Getter function for the url property.
Public Member Functions inherited from Fuoten::BaseItem
	BaseItem (QObject *parent=nullptr)
	Constructs an empty base item with the given parent.
	~BaseItem () override
	Deconstructs the base item.
Q_INVOKABLE void	clearError ()
	Removes the current Error object and sets a `nullptr`.
Error *	error () const
	Returns a pointer to an Error object, if any error occurred, otherwise a `nullptr`.
qint64	id () const
	Returns the ID of the item.
bool	inOperation () const
	Returns true while there is some operation ongoing directly on the item.
void	setId (qint64 nId)
	Sets the database ID of the item/feed/folder.

Signals
void	authorChanged (const QString &author)
	This is emitted if the value of the author property changes.
void	bodyChanged (const QString &body)
	This is emitted if the value of the body property changes.
void	enclosureLinkChanged (const QUrl &enclosureLink)
	This is emitted if the value of the enclosureLink property changes.
void	enclosureMimeChanged (const QString &enclosureMime)
	This is emitted if the value of the enclosureMime property changes.
void	feedIdChanged (qint64 feedId)
	This is emitted if the value of the feedId property changes.
void	feedTitleChanged (const QString &feedTitle)
	This is emitted if the value of the feedTitle property changes.
void	fingerprintChanged (const QString &fingerprint)
	This is emitted if the value of the fingerprint property changes.
void	folderIdChanged (qint64 folderId)
	This is emitted if the value of the folderId property changes.
void	folderNameChanged (const QString &folderName)
	This is emitted if the value of the folderName property changes.
void	guidChanged (const QString &guid)
	This is emitted if the value of the guid property changes.
void	guidHashChanged (const QString &guidHash)
	This is emitted if the value of the guidHash property changes.
void	humanPubDateChanged (const QString &humanPubDate)
	This is emitted if the value of the humanPubDate property changes.
void	humanPubTimeChanged (const QString &humanPubTime)
	This is emitted if the value of the humanPubTime property changes.
void	lastModifiedChanged (const QDateTime &lastModified)
	This is emitted if the value of the lastModified property changes.
void	mediaDescriptionChanged (const QString &mediaDescription)
	This is emitted if the value of the mediaDescription property changes.
void	mediaThumbnailChanged (const QUrl &mediaThumbnail)
	This is emitted if the value of the mediaThumbnail property changes.
void	pubDateChanged (const QDateTime &pubDate)
	This is emitted if the value of the pubDate property changes.
void	rtlChanged (bool rtl)
	This is emitted if the value of the rtl property changes.
void	starredChanged (bool starred)
	This is emitted if the value of the starred property changes.
void	titleChanged (const QString &title)
	This is emitted if the value of the title property changes.
void	unreadChanged (bool unread)
	This is emitted if the value of the unread property changes.
void	urlChanged (const QUrl &url)
	This is emitted if the value of the url property changes.
Signals inherited from Fuoten::BaseItem
void	errorChanged (Fuoten::Error *error)
	This signal will be emitted whenever the error property changes. May return a nullptr.
void	idChanged (qint64 id)
	This signal will be emitted whenever the id property changes.
void	inOperationChanged (bool inOperation)
	This signal will be emitted whenever the inOperation property changes.

Additional Inherited Members
Protected Member Functions inherited from Fuoten::BaseItem
Component *	component () const
	Returns the pointer to the currently active Component.
void	setComponent (Component *nComp)
	Sets the API component to perform an internal API request.
void	setError (Error *nError)
	Sets the Error object of the error property.

Detailed Description

Contains information about a single article/item.

Property Documentation

◆ author

QString Fuoten::Article::author

readwrite

The author of the article.

Access functions:

QString	author() const
void	setAuthor(const QString &nAuthor)

Notifier signal:

void	authorChanged(const QString &author)

◆ body

QString Fuoten::Article::body

readwrite

The text body of the article.

Access functions:

QString	body() const
void	setBody(const QString &nBody)

Notifier signal:

void	bodyChanged(const QString &body)

◆ enclosureLink

QUrl Fuoten::Article::enclosureLink

readwrite

URL of the enclosure.

Access functions:

QUrl	enclosureLink() const
void	setEnclosureLink(const QUrl &nEnclosureLink)

Notifier signal:

void	enclosureLinkChanged(const QUrl &enclosureLink)

◆ enclosureMime

QString Fuoten::Article::enclosureMime

readwrite

MIME type of an optional enclosure.

Access functions:

QString	enclosureMime() const
void	setEnclosureMime(const QString &nEnclosureMime)

Notifier signal:

void	enclosureMimeChanged(const QString &enclosureMime)

◆ feedId

qint64 Fuoten::Article::feedId

readwrite

ID of the Feed this Article belongs to.

Access functions:

qint64	feedId() const
void	setFeedId(qint64 nFeedId)

Notifier signal:

void	feedIdChanged(qint64 feedId)

◆ feedTitle

QString Fuoten::Article::feedTitle

readwrite

Title of the feed this article belongs to.

Access functions:

QString	feedTitle() const
void	setFeedTitle(const QString &nFeedTitle)

Notifier signal:

void	feedTitleChanged(const QString &feedTitle)

◆ fingerprint

QString Fuoten::Article::fingerprint

readwrite

Hash over title, enclosure, body and url.

Access functions:

QString	fingerprint() const
void	setFingerprint(const QString &nFingerprint)

Notifier signal:

void	fingerprintChanged(const QString &fingerprint)

◆ folderId

qint64 Fuoten::Article::folderId

readwrite

ID of the folder this article belongs to.

Access functions:

qint64	folderId() const
void	setFolderId(qint64 nFolderId)

Notifier signal:

void	folderIdChanged(qint64 folderId)

◆ folderName

QString Fuoten::Article::folderName

readwrite

Name of the folder this article belongs to.

Access functions:

QString	folderName() const
void	setFolderName(const QString &nFolderName)

Notifier signal:

void	folderNameChanged(const QString &folderName)

◆ guid

QString Fuoten::Article::guid

readwrite

Global unique identifier of the article.

Access functions:

QString	guid() const
void	setGuid(const QString &nGuid)

Notifier signal:

void	guidChanged(const QString &guid)

◆ guidHash

QString Fuoten::Article::guidHash

readwrite

Hash of the global uniquie identifier of the article.

Access functions:

QString	guidHash() const
void	setGuidHash(const QString &nGuidHash)

Notifier signal:

void	guidHashChanged(const QString &guidHash)

◆ humanPubDate

QString Fuoten::Article::humanPubDate

read

Returns a human readable string of the publication date.

Will be automatically created from pubDate.

Access functions:

QString

getHumanPubDate() const

Notifier signal:

void	humanPubDateChanged(const QString &humanPubDate)

◆ humanPubTime

QString Fuoten::Article::humanPubTime

read

Return a human readable string of the publication time.

Access functions:

QString

humanPubTime() const

Notifier signal:

void	humanPubTimeChanged(const QString &humanPubTime)

◆ lastModified

QDateTime Fuoten::Article::lastModified

readwrite

Date and time this articles has been modified the last time.

Access functions:

QDateTime	lastModified() const
void	setLastModified(const QDateTime &nLastModified)

Notifier signal:

void	lastModifiedChanged(const QDateTime &lastModified)

◆ mediaDescription

QString Fuoten::Article::mediaDescription

readwrite

Holds the description of a optional media object.

Since: 0.8.0

Access functions:

QString	mediaDescription() const
void	setMediaDescription(const QString &nMediaDescription)

Notifier signal:

void	mediaDescriptionChanged(const QString &mediaDescription)

◆ mediaThumbnail

QUrl Fuoten::Article::mediaThumbnail

readwrite

Holds the url to a optional media thumbnail.

Since: 0.8.0

Access functions:

QUrl	mediaThumbnail() const
void	setMediaThumbnail(const QUrl &nMediaThumbnail)

Notifier signal:

void	mediaThumbnailChanged(const QUrl &mediaThumbnail)

◆ pubDate

QDateTime Fuoten::Article::pubDate

readwrite

Date and time the article was published.

Access functions:

QDateTime	pubDate() const
void	setPubDate(const QDateTime &nPubDate)

Notifier signal:

void	pubDateChanged(const QDateTime &pubDate)

◆ rtl

bool Fuoten::Article::rtl

readwrite

Returns true if the text is right to left.

Since: 0.8.0

Access functions:

bool	rtl() const
void	setRtl(bool nRtl)

Notifier signal:

void	rtlChanged(bool rtl)

◆ starred

bool Fuoten::Article::starred

readwrite

True if the user has starred this article.

Access functions:

bool	starred() const
void	setStarred(bool nStarred)

Notifier signal:

void	starredChanged(bool starred)

◆ title

QString Fuoten::Article::title

readwrite

Title of the article.

Access functions:

QString	title() const
void	setTitle(const QString &nTitle)

Notifier signal:

void	titleChanged(const QString &title)

◆ unread

bool Fuoten::Article::unread

readwrite

True if the article has not been read.

Access functions:

bool	unread() const
void	setUnread(bool nUnread)

Notifier signal:

void	unreadChanged(bool unread)

◆ url

QUrl Fuoten::Article::url

readwrite

URL of the article.

Access functions:

QUrl	url() const
void	setUrl(const QUrl &nUrl)

Notifier signal:

void	urlChanged(const QUrl &url)

Constructor & Destructor Documentation

◆ Article() [1/3]

Article::Article ( QObject * parent = nullptr )

explicit

Constructs a new Article object with default values and the given parent.

◆ Article() [2/3]

Article::Article	(	qint64	id,
		qint64	feedId,
		const QString &	feedTitle,
		const QString &	guid,
		const QString &	guidHash,
		const QUrl &	url,
		const QString &	title,
		const QString &	author,
		const QDateTime &	pubDate,
		const QString &	body,
		const QString &	enclosureMime,
		const QUrl &	enclosureLink,
		bool	unread,
		bool	starred,
		const QDateTime &	lastModified,
		const QString &	fingerprint,
		qint64	folderId,
		const QString &	folderName,
		FuotenEnums::QueueActions	queue,
		bool	rtl,
		const QUrl &	mediaThumbnail,
		const QString &	mediaDescription,
		QObject *	parent = nullptr )

Constructs a new Article object with the given arguments and parent.

◆ Article() [3/3]

Article::Article	(	Article *	other,
		QObject *	parent = nullptr )

explicit

Constructs a new Article object with the given parent by copying the properties of other to the new object.

◆ ~Article()

Article::~Article ( )

override

Deconstructs the Article object.

Member Function Documentation

◆ author()

QString Article::author ( ) const

Getter function for the author property.

See also: Article::setAuthor(), Article::authorChanged()

◆ authorChanged

void Fuoten::Article::authorChanged ( const QString & author )

signal

This is emitted if the value of the author property changes.

See also: Article::author(), Article::setAuthor()

◆ body()

QString Article::body ( ) const

Getter function for the body property.

See also: Article::setBody(), Article::bodyChanged()

◆ bodyChanged

void Fuoten::Article::bodyChanged ( const QString & body )

signal

This is emitted if the value of the body property changes.

See also: Article::body(), Article::setBody()

◆ copy()

void Article::copy ( BaseItem * other )

overridevirtual

Makes a deep copy of other.

other has to be an Article object.

Reimplemented from Fuoten::BaseItem.

◆ enclosureLink()

QUrl Article::enclosureLink ( ) const

Getter function for the enclosureLink property.

See also: Article::setEnclosureLink(), Article::enclosureLinkChanged()

◆ enclosureLinkChanged

void Fuoten::Article::enclosureLinkChanged ( const QUrl & enclosureLink )

signal

This is emitted if the value of the enclosureLink property changes.

See also: Article::enclosureLink(), Article::setEnclosureLink()

◆ enclosureMime()

QString Article::enclosureMime ( ) const

Getter function for the enclosureMime property.

See also: Article::setEnclosureMime(), Article::enclosureMimeChanged()

◆ enclosureMimeChanged

void Fuoten::Article::enclosureMimeChanged ( const QString & enclosureMime )

signal

This is emitted if the value of the enclosureMime property changes.

See also: Article::enclosureMime(), Article::setEnclosureMime()

◆ feedId()

qint64 Article::feedId ( ) const

Getter function for the feedId property.

See also: Article::setFeedId(), Article::feedIdChanged()

◆ feedIdChanged

void Fuoten::Article::feedIdChanged ( qint64 feedId )

signal

This is emitted if the value of the feedId property changes.

See also: Article::feedId(), Article::setFeedId()

◆ feedTitle()

QString Article::feedTitle ( ) const

Getter function for the feedTitle property.

See also: Article::setFeedTitle(), Article::feedTitleChanged()

◆ feedTitleChanged

void Fuoten::Article::feedTitleChanged ( const QString & feedTitle )

signal

This is emitted if the value of the feedTitle property changes.

See also: Article::feedTitle(), Article::setFeedTitle()

◆ fingerprint()

QString Article::fingerprint ( ) const

Getter function for the fingerprint property.

See also: Article::setFingerprint(), Article::fingerprintChanged()

◆ fingerprintChanged

void Fuoten::Article::fingerprintChanged ( const QString & fingerprint )

signal

This is emitted if the value of the fingerprint property changes.

See also: Article::fingerprint(), Article::setFingerprint()

◆ folderId()

qint64 Article::folderId ( ) const

Getter function for the folderId property.

See also: Article::setFolderId(), Article::folderIdChanged()

◆ folderIdChanged

void Fuoten::Article::folderIdChanged ( qint64 folderId )

signal

This is emitted if the value of the folderId property changes.

See also: Article::folderId(), Article::setFolderId()

◆ folderName()

QString Article::folderName ( ) const

Getter function for the folderName property.

See also: Article::setFolderName(), Article::folderNameChanged()

◆ folderNameChanged

void Fuoten::Article::folderNameChanged ( const QString & folderName )

signal

This is emitted if the value of the folderName property changes.

See also: Article::folderName(), Article::setFolderName()

◆ guid()

QString Article::guid ( ) const

Getter function for the guid property.

See also: Article::setGuid(), Article::guidChanged()

◆ guidChanged

void Fuoten::Article::guidChanged ( const QString & guid )

signal

This is emitted if the value of the guid property changes.

See also: Article::guid(), Article::setGuid()

◆ guidHash()

QString Article::guidHash ( ) const

Getter function for the guidHash property.

See also: Article::setGuidHash(), Article::guidHashChanged()

◆ guidHashChanged

void Fuoten::Article::guidHashChanged ( const QString & guidHash )

signal

This is emitted if the value of the guidHash property changes.

See also: Article::guidHash(), Article::setGuidHash()

◆ humanPubDate()

QString Article::humanPubDate ( ) const

Getter function for the humanPubDate property.

See also: Article::humanPubDateChanged()

◆ humanPubDateChanged

void Fuoten::Article::humanPubDateChanged ( const QString & humanPubDate )

signal

This is emitted if the value of the humanPubDate property changes.

See also: Article::getHumanPubDate()

◆ humanPubTime()

QString Article::humanPubTime ( ) const

Getter function for the humanPubTime property.

See also: Article::humanPubTimeChanged()

◆ humanPubTimeChanged

void Fuoten::Article::humanPubTimeChanged ( const QString & humanPubTime )

signal

This is emitted if the value of the humanPubTime property changes.

See also: Article::humanPubTime()

◆ lastModified()

QDateTime Article::lastModified ( ) const

Getter function for the lastModified property.

See also: Article::setLastModified(), Article::lastModifiedChanged()

◆ lastModifiedChanged

void Fuoten::Article::lastModifiedChanged ( const QDateTime & lastModified )

signal

This is emitted if the value of the lastModified property changes.

See also: Article::lastModified(), Article::setLastModified()

◆ mark() [1/2]

void Article::mark	(	bool	unread,
		bool	enqueue = false )

Marks this article as read or unread on the server. This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This uses Component::defaultConfiguration() and Component::defaultStorage().

◆ mark() [2/2]

void Article::mark	(	bool	unread,
		Fuoten::AbstractConfiguration *	config,
		Fuoten::AbstractStorage *	storage = nullptr,
		bool	enqueue = false )

Marks this article as read or unread on the server.

Will also mark the article as read or unread in the local storage, if a valid AbstractStorage object is available.

Parameters

unread	set to `true` to mark the item as unread, set to `false` to mark it as read
config	pointer to an AbstractConfiguration object that containts the authentication credentials
storage	pointer to an AbstractStorage object to update the local storage after successful request
enqueue	`true` to enqueue the marking local up to the next sync, valid `storage` has to be available

◆ mediaDescription()

QString Article::mediaDescription ( ) const

Getter function for the mediaDescription property.

See also: setMediaDescription(), mediaDescriptionChanged()

◆ mediaDescriptionChanged

void Fuoten::Article::mediaDescriptionChanged ( const QString & mediaDescription )

signal

This is emitted if the value of the mediaDescription property changes.

See also: mediaDescription(), setMediaDescription()

◆ mediaThumbnail()

QUrl Article::mediaThumbnail ( ) const

Getter function for the mediaThumbnail property.

See also: setMediaThumbnail(), mediaThumbnailChanged()

◆ mediaThumbnailChanged

void Fuoten::Article::mediaThumbnailChanged ( const QUrl & mediaThumbnail )

signal

This is emitted if the value of the mediaThumbnail property changes.

See also: mediaThumbnail(), setMediaThumbnail()

◆ pubDate()

QDateTime Article::pubDate ( ) const

Getter function for the pubDate property.

See also: Article::setPubDate(), Article::pubDateChanged()

◆ pubDateChanged

void Fuoten::Article::pubDateChanged ( const QDateTime & pubDate )

signal

This is emitted if the value of the pubDate property changes.

See also: Article::pubDate(), Article::setPubDate()

◆ rtl()

bool Article::rtl ( ) const

Getter function for the rtl property.

See also: setRtl(), rtlChanged()

◆ rtlChanged

void Fuoten::Article::rtlChanged ( bool rtl )

signal

This is emitted if the value of the rtl property changes.

See also: rtl(), setRtl()

◆ setAuthor()

void Article::setAuthor ( const QString & nAuthor )

Setter function for the author property. Emits the authorChanged() signal if nAuthor is not equal to the stored value.

See also: Article::author(), Article::authorChanged()

◆ setBody()

void Article::setBody ( const QString & nBody )

Setter function for the body property. Emits the bodyChanged() signal if nBody is not equal to the stored value.

See also: Article::body(), Article::bodyChanged()

◆ setEnclosureLink()

void Article::setEnclosureLink ( const QUrl & nEnclosureLink )

Setter function for the enclosureLink property. Emits the enclosureLinkChanged() signal if nEnclosureLink is not equal to the stored value.

See also: Article::enclosureLink(), Article::enclosureLinkChanged()

◆ setEnclosureMime()

void Article::setEnclosureMime ( const QString & nEnclosureMime )

Setter function for the enclosureMime property. Emits the enclosureMimeChanged() signal if nEnclosureMime is not equal to the stored value.

See also: Article::enclosureMime(), Article::enclosureMimeChanged()

◆ setFeedId()

void Article::setFeedId ( qint64 nFeedId )

Setter function for the feedId property. Emits the feedIdChanged() signal if nFeedId is not equal to the stored value.

See also: Article::feedId(), Article::feedIdChanged()

◆ setFeedTitle()

void Article::setFeedTitle ( const QString & nFeedTitle )

Setter function for the feedTitle property. Emits the feedTitleChanged() signal if nFeedTitle is not equal to the stored value.

See also: Article::feedTitle(), Article::feedTitleChanged()

◆ setFingerprint()

void Article::setFingerprint ( const QString & nFingerprint )

Setter function for the fingerprint property. Emits the fingerprintChanged() signal if nFingerprint is not equal to the stored value.

See also: Article::fingerprint(), Article::fingerprintChanged()

◆ setFolderId()

void Article::setFolderId ( qint64 nFolderId )

Setter function for the folderId property. Emits the folderIdChanged() signal if nFolderId is not equal to the stored value.

See also: Article::folderId(), Article::folderIdChanged()

◆ setFolderName()

void Article::setFolderName ( const QString & nFolderName )

Setter function for the folderName property. Emits the folderNameChanged() signal if nFolderName is not equal to the stored value.

See also: Article::folderName(), Article::folderNameChanged()

◆ setGuid()

void Article::setGuid ( const QString & nGuid )

Setter function for the guid property. Emits the guidChanged() signal if nGuid is not equal to the stored value.

See also: Article::guid(), Article::guidChanged()

◆ setGuidHash()

void Article::setGuidHash ( const QString & nGuidHash )

Setter function for the guidHash property. Emits the guidHashChanged() signal if nGuidHash is not equal to the stored value.

See also: Article::guidHash(), Article::guidHashChanged()

◆ setLastModified()

void Article::setLastModified ( const QDateTime & nLastModified )

Setter function for the lastModified property. Emits the lastModifiedChanged() signal if nLastModified is not equal to the stored value.

See also: Article::lastModified(), Article::lastModifiedChanged()

◆ setMediaDescription()

void Article::setMediaDescription ( const QString & nMediaDescription )

Setter function for the mediaDescription property. Emits the mediaDescriptionChanged() signal if nMediaDescription is not equal to the stored value.

See also: mediaDescription(), mediaDescriptionChanged()

◆ setMediaThumbnail()

void Article::setMediaThumbnail ( const QUrl & nMediaThumbnail )

Setter function for the mediaThumbnail property. Emits the mediaThumbnailChanged() signal if nMediaThumbnail is not equal to the stored value.

See also: mediaThumbnail(), mediaThumbnailChanged()

◆ setPubDate()

void Article::setPubDate ( const QDateTime & nPubDate )

Setter function for the pubDate property. Emits the pubDateChanged() signal if nPubDate is not equal to the stored value.

See also: Article::pubDate(), Article::pubDateChanged()

◆ setRtl()

void Article::setRtl ( bool nRtl )

Setter function for the rtl property. Emits the rtlChanged() signal if nRtl is not equal to the stored value.

See also: ŗtl(), rtlChanged()

◆ setStarred()

void Article::setStarred ( bool nStarred )

Setter function for the starred property. Emits the starredChanged() signal if nStarred is not equal to the stored value.

See also: Article::starred(), Article::starredChanged()

◆ setTitle()

void Article::setTitle ( const QString & nTitle )

Setter function for the title property. Emits the titleChanged() signal if nTitle is not equal to the stored value.

See also: Article::title(), Article::titleChanged()

◆ setUnread()

void Article::setUnread ( bool nUnread )

Setter function for the unread property. Emits the unreadChanged() signal if nUnread is not equal to the stored value.

See also: Article::unread(), Article::unreadChanged()

◆ setUrl()

void Article::setUrl ( const QUrl & nUrl )

Setter function for the url property. Emits the urlChanged() signal if nUrl is not equal to the stored value.

See also: Article::url(), Article::urlChanged()

◆ star() [1/2]

void Article::star	(	bool	starred,
		bool	enqueue = false )

Marks this article as starred or unstarred on the remote server. This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This uses Component::defaultConfiguration() and Component::defaultStorage().

◆ star() [2/2]

void Article::star	(	bool	starred,
		Fuoten::AbstractConfiguration *	config,
		Fuoten::AbstractStorage *	storage = nullptr,
		bool	enqueue = false )

Marks this article as starred or unstarred on the remote server.

Will also mark the article as starred/unstarred in the local storage if a valid AbstractStorage object is available.

Parameters

starred	ste to `true` to mark the item as starred, set to `false` to mark it as unstarred
config	pointer to an AbstractConfiguration object that containts the authentication credentials
storage	pointer to an AbstractStorage object to update the local storage after successful request
enqueue	`true` to enqueue the un/starring local up to the next sync, valid `storage` has to be available

◆ starred()

bool Article::starred ( ) const

Getter function for the starred property.

See also: Article::setStarred(), Article::starredChanged()

◆ starredChanged

void Fuoten::Article::starredChanged ( bool starred )

signal

This is emitted if the value of the starred property changes.

See also: Article::starred(), Article::setStarred()

◆ title()

QString Article::title ( ) const

Getter function for the title property.

See also: Article::setTitle(), Article::titleChanged()

◆ titleChanged

void Fuoten::Article::titleChanged ( const QString & title )

signal

This is emitted if the value of the title property changes.

See also: Article::title(), Article::setTitle()

◆ unread()

bool Article::unread ( ) const

Getter function for the unread property.

See also: Article::setUnread(), Article::unreadChanged()

◆ unreadChanged

void Fuoten::Article::unreadChanged ( bool unread )

signal

This is emitted if the value of the unread property changes.

See also: Article::unread(), Article::setUnread()

◆ url()

QUrl Article::url ( ) const

Getter function for the url property.

See also: Article::setUrl(), Article::urlChanged()

◆ urlChanged

void Fuoten::Article::urlChanged ( const QUrl & url )

signal

This is emitted if the value of the url property changes.

See also: Article::url(), Article::setUrl()

The documentation for this class was generated from the following files:

Fuoten/article.h
build/Fuoten/FuotenQt5_autogen/include/moc_article.cpp
Fuoten/article.cpp

Properties

Public Member Functions

Signals

Additional Inherited Members

Detailed Description

Property Documentation

◆ author

◆ body

◆ enclosureLink

◆ enclosureMime

◆ feedId

◆ feedTitle

◆ fingerprint

◆ folderId

◆ folderName

◆ guid

◆ guidHash

◆ humanPubDate

◆ humanPubTime

◆ lastModified

◆ mediaDescription

◆ mediaThumbnail

◆ pubDate

◆ rtl

◆ starred

◆ title

◆ unread

◆ url

Constructor & Destructor Documentation

◆ Article() [1/3]

◆ Article() [2/3]

◆ Article() [3/3]

◆ ~Article()

Member Function Documentation

◆ author()

◆ authorChanged

◆ body()

◆ bodyChanged

◆ copy()

◆ enclosureLink()

◆ enclosureLinkChanged

◆ enclosureMime()

◆ enclosureMimeChanged

◆ feedId()

◆ feedIdChanged

◆ feedTitle()

◆ feedTitleChanged

◆ fingerprint()

◆ fingerprintChanged

◆ folderId()

◆ folderIdChanged

◆ folderName()

◆ folderNameChanged

◆ guid()

◆ guidChanged

◆ guidHash()

◆ guidHashChanged

◆ humanPubDate()

◆ humanPubDateChanged

◆ humanPubTime()

◆ humanPubTimeChanged

◆ lastModified()

◆ lastModifiedChanged

◆ mark() [1/2]

◆ mark() [2/2]

◆ mediaDescription()

◆ mediaDescriptionChanged

◆ mediaThumbnail()

◆ mediaThumbnailChanged

◆ pubDate()

◆ pubDateChanged

◆ rtl()

◆ rtlChanged

◆ setAuthor()

◆ setBody()

◆ setEnclosureLink()

◆ setEnclosureMime()

◆ setFeedId()

◆ setFeedTitle()

◆ setFingerprint()