Parser for published QGIS news feeds. More...

#include <qgsnewsfeedparser.h>

Inheritance diagram for QgsNewsFeedParser:

Classes
class	Entry
	Represents a single entry from a news feed. More...

Public Slots
void	fetch ()
	Fetches new entries from the feed's URL.

Signals
void	enabledChanged ()
	Emitted when the enabled/disabled state of the feed URL associated to the news parser changes.
void	entryAdded (const QgsNewsFeedParser::Entry &entry)
	Emitted whenever a new entry is available from the feed (as a result of a call to fetch()).
void	entryDismissed (const QgsNewsFeedParser::Entry &entry)
	Emitted whenever an entry is dismissed (as a result of a call to dismissEntry()).
void	entryUpdated (const QgsNewsFeedParser::Entry &entry)
	Emitted whenever an existing entry is available from the feed (as a result of a call to fetch()).
void	fetched (const QList< QgsNewsFeedParser::Entry > &entries)
	Emitted when entries have been fetched from the feed.
void	imageFetched (int key, const QPixmap &pixmap)
	Emitted when the image attached to the entry with the specified key has been fetched and is now available.
void	isFetchingChanged ()
	Emitted when the news parser's fetching state changes.

Public Member Functions
	QgsNewsFeedParser (const QUrl &feedUrl, const QString &authcfg=QString(), QObject *parent=nullptr)
	Constructor for QgsNewsFeedParser, parsing the specified feedUrl.
QString	authcfg () const
	Returns the authentication configuration for the parser.
Q_INVOKABLE void	dismissAll ()
	Dismisses all current news items.
Q_INVOKABLE void	dismissEntry (int key)
	Dismisses an entry with matching key.
bool	enabled () const
	Returns `true` if the feed URL associated with the news parser is enabled.
QList< QgsNewsFeedParser::Entry >	entries () const
	Returns a list of existing entries in the feed.
bool	isFetching () const
	Returns `true` if the news parser is fetching items.
void	setEnabled (bool enabled)
	Sets whether the feed URL associated with the news parser is enabled.

Static Public Member Functions
static QString	keyForFeed (const QString &baseUrl)
	Returns the settings key used for a feed with the given baseUrl.

Static Public Attributes
static const QgsSettingsEntryBool *	settingsFeedDisabled = new QgsSettingsEntryBool( u"disabled"_s, sTreeNewsFeed, false, u"Whether the news feed is disabled"_s )
static const QgsSettingsEntryString *	settingsFeedEntryContent = new QgsSettingsEntryString( u"content"_s, sTreeNewsFeedEntries, QString(), u"Entry content"_s )
static const QgsSettingsEntryVariant *	settingsFeedEntryExpiry = new QgsSettingsEntryVariant( u"expiry"_s, sTreeNewsFeedEntries, QVariant(), u"Expiry date"_s )
static const QgsSettingsEntryString *	settingsFeedEntryImageUrl = new QgsSettingsEntryString( u"image-url"_s, sTreeNewsFeedEntries, QString(), u"Entry image URL"_s )
static const QgsSettingsEntryString *	settingsFeedEntryLink = new QgsSettingsEntryString( u"link"_s, sTreeNewsFeedEntries, QString(), u"Entry link"_s )
static const QgsSettingsEntryVariant *	settingsFeedEntryPublished = new QgsSettingsEntryVariant( u"published"_s, sTreeNewsFeedEntries, QVariant(), u"Publication date"_s )
static const QgsSettingsEntryBool *	settingsFeedEntrySticky = new QgsSettingsEntryBool( u"sticky"_s, sTreeNewsFeedEntries, false )
static const QgsSettingsEntryString *	settingsFeedEntryTitle = new QgsSettingsEntryString( u"title"_s, sTreeNewsFeedEntries, QString(), u"Entry title"_s )
static const QgsSettingsEntryString *	settingsFeedLanguage = new QgsSettingsEntryString( u"lang"_s, sTreeNewsFeed, QString(), u"Feed language"_s )
static const QgsSettingsEntryInteger64 *	settingsFeedLastFetchTime = new QgsSettingsEntryInteger64( u"last-fetch-time"_s, sTreeNewsFeed, 0, u"Feed last fetch time"_s, Qgis::SettingsOptions(), 0 )
static const QgsSettingsEntryDouble *	settingsFeedLatitude = new QgsSettingsEntryDouble( u"latitude"_s, sTreeNewsFeed, 0.0, u"Feed latitude"_s )
static const QgsSettingsEntryDouble *	settingsFeedLongitude = new QgsSettingsEntryDouble( u"longitude"_s, sTreeNewsFeed, 0.0, u"Feed longitude"_s )
static QgsSettingsTreeNamedListNode *	sTreeNewsFeed = QgsSettingsTree::sTreeApp->createNamedListNode( u"news-feed"_s )
static QgsSettingsTreeNamedListNode *	sTreeNewsFeedEntries = sTreeNewsFeed->createNamedListNode( u"entries"_s )

Properties
bool	enabled
bool	isFetching

Friends
class	TestQgsNewsFeedParser

Detailed Description

Parser for published QGIS news feeds.

This class is designed to work with the specialized QGIS news feed API. See https://github.com/elpaso/qgis-feed.

Since: QGIS 3.10

Definition at line 46 of file qgsnewsfeedparser.h.

Constructor & Destructor Documentation

◆ QgsNewsFeedParser()

QgsNewsFeedParser::QgsNewsFeedParser	(	const QUrl &	feedUrl,
		const QString &	authcfg = QString(),
		QObject *	parent = nullptr )

Constructor for QgsNewsFeedParser, parsing the specified feedUrl.

The optional authcfg argument can be used to specify an authentication configuration to use when connecting to the feed.

Definition at line 56 of file qgsnewsfeedparser.cpp.

Member Function Documentation

◆ authcfg()

QString QgsNewsFeedParser::authcfg ( ) const

Returns the authentication configuration for the parser.

Definition at line 186 of file qgsnewsfeedparser.cpp.

◆ dismissAll()

void QgsNewsFeedParser::dismissAll ( )

Dismisses all current news items.

See also: dismissEntry()

Definition at line 177 of file qgsnewsfeedparser.cpp.

◆ dismissEntry()

void QgsNewsFeedParser::dismissEntry ( int key )

Dismisses an entry with matching key.

This removes the entry from the local store, ensuring it will never be present again.

See also: dismissAll()

Definition at line 131 of file qgsnewsfeedparser.cpp.

◆ enabled()

bool QgsNewsFeedParser::enabled ( ) const

inline

Returns true if the feed URL associated with the news parser is enabled.

Since: QGIS 4.0

Definition at line 121 of file qgsnewsfeedparser.h.

◆ enabledChanged

void QgsNewsFeedParser::enabledChanged ( )

signal

Emitted when the enabled/disabled state of the feed URL associated to the news parser changes.

Since: QGIS 4.0

◆ entries()

QList< QgsNewsFeedParser::Entry > QgsNewsFeedParser::entries ( ) const

Returns a list of existing entries in the feed.

Definition at line 126 of file qgsnewsfeedparser.cpp.

◆ entryAdded

void QgsNewsFeedParser::entryAdded ( const QgsNewsFeedParser::Entry & entry )

signal

Emitted whenever a new entry is available from the feed (as a result of a call to fetch()).

See also: fetch()

◆ entryDismissed

void QgsNewsFeedParser::entryDismissed ( const QgsNewsFeedParser::Entry & entry )

signal

Emitted whenever an entry is dismissed (as a result of a call to dismissEntry()).

See also: dismissEntry()

◆ entryUpdated

void QgsNewsFeedParser::entryUpdated ( const QgsNewsFeedParser::Entry & entry )

signal

Emitted whenever an existing entry is available from the feed (as a result of a call to fetch()).

See also: fetch()

Since: QGIS 3.36

◆ fetch

void QgsNewsFeedParser::fetch ( )

slot

Fetches new entries from the feed's URL.

See also: fetched()

Definition at line 191 of file qgsnewsfeedparser.cpp.

◆ fetched

void QgsNewsFeedParser::fetched ( const QList< QgsNewsFeedParser::Entry > & entries )

signal

Emitted when entries have been fetched from the feed.

See also: fetch()

◆ imageFetched

void QgsNewsFeedParser::imageFetched	(	int	key,
		const QPixmap &	pixmap )

signal

Emitted when the image attached to the entry with the specified key has been fetched and is now available.

◆ isFetching()

bool QgsNewsFeedParser::isFetching ( ) const

inline

Returns true if the news parser is fetching items.

Since: QGIS 4.0

Definition at line 135 of file qgsnewsfeedparser.h.

◆ isFetchingChanged

void QgsNewsFeedParser::isFetchingChanged ( )

signal

Emitted when the news parser's fetching state changes.

Since: QGIS 4.0

◆ keyForFeed()

QString QgsNewsFeedParser::keyForFeed ( const QString & baseUrl )

static

Returns the settings key used for a feed with the given baseUrl.

Definition at line 431 of file qgsnewsfeedparser.cpp.

◆ setEnabled()

void QgsNewsFeedParser::setEnabled ( bool enabled )

Sets whether the feed URL associated with the news parser is enabled.

Since: QGIS 4.0

Definition at line 113 of file qgsnewsfeedparser.cpp.

◆ TestQgsNewsFeedParser

friend class TestQgsNewsFeedParser

friend

Definition at line 250 of file qgsnewsfeedparser.h.

Member Data Documentation

◆ settingsFeedDisabled

const QgsSettingsEntryBool * QgsNewsFeedParser::settingsFeedDisabled = new QgsSettingsEntryBool( u"disabled"_s, sTreeNewsFeed, false, u"Whether the news feed is disabled"_s )

static

Definition at line 56 of file qgsnewsfeedparser.h.

◆ settingsFeedEntryContent

const QgsSettingsEntryString * QgsNewsFeedParser::settingsFeedEntryContent = new QgsSettingsEntryString( u"content"_s, sTreeNewsFeedEntries, QString(), u"Entry content"_s )

static

Definition at line 65 of file qgsnewsfeedparser.h.

◆ settingsFeedEntryExpiry

const QgsSettingsEntryVariant * QgsNewsFeedParser::settingsFeedEntryExpiry = new QgsSettingsEntryVariant( u"expiry"_s, sTreeNewsFeedEntries, QVariant(), u"Expiry date"_s )

static

Definition at line 69 of file qgsnewsfeedparser.h.

◆ settingsFeedEntryImageUrl

const QgsSettingsEntryString * QgsNewsFeedParser::settingsFeedEntryImageUrl = new QgsSettingsEntryString( u"image-url"_s, sTreeNewsFeedEntries, QString(), u"Entry image URL"_s )

static

Definition at line 64 of file qgsnewsfeedparser.h.

◆ settingsFeedEntryLink

const QgsSettingsEntryString * QgsNewsFeedParser::settingsFeedEntryLink = new QgsSettingsEntryString( u"link"_s, sTreeNewsFeedEntries, QString(), u"Entry link"_s )

static

Definition at line 66 of file qgsnewsfeedparser.h.

◆ settingsFeedEntryPublished

const QgsSettingsEntryVariant * QgsNewsFeedParser::settingsFeedEntryPublished = new QgsSettingsEntryVariant( u"published"_s, sTreeNewsFeedEntries, QVariant(), u"Publication date"_s )

static

Definition at line 68 of file qgsnewsfeedparser.h.

◆ settingsFeedEntrySticky

const QgsSettingsEntryBool * QgsNewsFeedParser::settingsFeedEntrySticky = new QgsSettingsEntryBool( u"sticky"_s, sTreeNewsFeedEntries, false )

static

Definition at line 67 of file qgsnewsfeedparser.h.

◆ settingsFeedEntryTitle

const QgsSettingsEntryString * QgsNewsFeedParser::settingsFeedEntryTitle = new QgsSettingsEntryString( u"title"_s, sTreeNewsFeedEntries, QString(), u"Entry title"_s )

static

Definition at line 63 of file qgsnewsfeedparser.h.

◆ settingsFeedLanguage

const QgsSettingsEntryString * QgsNewsFeedParser::settingsFeedLanguage = new QgsSettingsEntryString( u"lang"_s, sTreeNewsFeed, QString(), u"Feed language"_s )

static

Definition at line 58 of file qgsnewsfeedparser.h.

◆ settingsFeedLastFetchTime

const QgsSettingsEntryInteger64 * QgsNewsFeedParser::settingsFeedLastFetchTime = new QgsSettingsEntryInteger64( u"last-fetch-time"_s, sTreeNewsFeed, 0, u"Feed last fetch time"_s, Qgis::SettingsOptions(), 0 )

static

Definition at line 57 of file qgsnewsfeedparser.h.

◆ settingsFeedLatitude

const QgsSettingsEntryDouble * QgsNewsFeedParser::settingsFeedLatitude = new QgsSettingsEntryDouble( u"latitude"_s, sTreeNewsFeed, 0.0, u"Feed latitude"_s )

static

Definition at line 59 of file qgsnewsfeedparser.h.

◆ settingsFeedLongitude

const QgsSettingsEntryDouble * QgsNewsFeedParser::settingsFeedLongitude = new QgsSettingsEntryDouble( u"longitude"_s, sTreeNewsFeed, 0.0, u"Feed longitude"_s )

static

Definition at line 60 of file qgsnewsfeedparser.h.

◆ sTreeNewsFeed

QgsSettingsTreeNamedListNode* QgsNewsFeedParser::sTreeNewsFeed = QgsSettingsTree::sTreeApp->createNamedListNode( u"news-feed"_s )

inlinestatic

Definition at line 55 of file qgsnewsfeedparser.h.

◆ sTreeNewsFeedEntries

QgsSettingsTreeNamedListNode* QgsNewsFeedParser::sTreeNewsFeedEntries = sTreeNewsFeed->createNamedListNode( u"entries"_s )

inlinestatic

Definition at line 62 of file qgsnewsfeedparser.h.

Property Documentation

◆ enabled

bool QgsNewsFeedParser::enabled

readwrite

Definition at line 50 of file qgsnewsfeedparser.h.

◆ isFetching

bool QgsNewsFeedParser::isFetching

read

Definition at line 51 of file qgsnewsfeedparser.h.

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

/build/qgis-4.3.0+git20261026+16eddb2670e+99sid/src/core/network/qgsnewsfeedparser.h
/build/qgis-4.3.0+git20261026+16eddb2670e+99sid/src/core/network/qgsnewsfeedparser.cpp

Classes

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Static Public Attributes

Properties

Friends

Detailed Description

Constructor & Destructor Documentation

◆ QgsNewsFeedParser()

Member Function Documentation

◆ authcfg()

◆ dismissAll()

◆ dismissEntry()

◆ enabled()

◆ enabledChanged

◆ entries()

◆ entryAdded

◆ entryDismissed

◆ entryUpdated

◆ fetch

◆ fetched

◆ imageFetched

◆ isFetching()

◆ isFetchingChanged

◆ keyForFeed()

◆ setEnabled()

Friends And Related Symbol Documentation

◆ TestQgsNewsFeedParser

Member Data Documentation

◆ settingsFeedDisabled

◆ settingsFeedEntryContent

◆ settingsFeedEntryExpiry

◆ settingsFeedEntryImageUrl

◆ settingsFeedEntryLink

◆ settingsFeedEntryPublished

◆ settingsFeedEntrySticky

◆ settingsFeedEntryTitle

◆ settingsFeedLanguage

◆ settingsFeedLastFetchTime

◆ settingsFeedLatitude

◆ settingsFeedLongitude

◆ sTreeNewsFeed

◆ sTreeNewsFeedEntries

Property Documentation

◆ enabled

◆ isFetching