mirror of
https://github.com/qgis/QGIS.git
synced 2025-02-26 00:02:08 -05:00
91 lines
2.3 KiB
Plaintext
91 lines
2.3 KiB
Plaintext
|
/************************************************************************
|
||
|
|
* This file has been generated automatically from *
|
||
|
|
* *
|
||
|
|
* src/core/qgsnewsfeedparser.h *
|
||
|
|
* *
|
||
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
||
|
|
************************************************************************/
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
class QgsNewsFeedParser : QObject
|
||
|
|
{
|
||
|
|
%Docstring
|
||
|
|
Parser for published QGIS news feeds.
|
||
|
|
|
||
|
|
This class is designed to work with the specialised QGIS news feed API. See
|
||
|
|
https://github.com/elpaso/qgis-feed.
|
||
|
|
|
||
|
|
.. versionadded:: 3.10
|
||
|
|
%End
|
||
|
|
|
||
|
|
%TypeHeaderCode
|
||
|
|
#include "qgsnewsfeedparser.h"
|
||
|
|
%End
|
||
|
|
public:
|
||
|
|
|
||
|
|
class Entry
|
||
|
|
{
|
||
|
|
%Docstring
|
||
|
|
Represents a single entry from a news feed.
|
||
|
|
%End
|
||
|
|
|
||
|
|
%TypeHeaderCode
|
||
|
|
#include "qgsnewsfeedparser.h"
|
||
|
|
%End
|
||
|
|
public:
|
||
|
|
|
||
|
|
int key;
|
||
|
|
|
||
|
|
QString title;
|
||
|
|
|
||
|
|
QString imageUrl;
|
||
|
|
|
||
|
|
QString content;
|
||
|
|
|
||
|
|
QUrl link;
|
||
|
|
|
||
|
|
bool sticky;
|
||
|
|
};
|
||
|
|
|
||
|
|
QgsNewsFeedParser( const QUrl &feedUrl, const QString &authcfg = QString() );
|
||
|
|
%Docstring
|
||
|
|
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.
|
||
|
|
%End
|
||
|
|
|
||
|
|
QList< QgsNewsFeedParser::Entry > entries() const;
|
||
|
|
%Docstring
|
||
|
|
Returns a list of existing entries in the feed.
|
||
|
|
%End
|
||
|
|
|
||
|
|
public slots:
|
||
|
|
|
||
|
|
void fetch();
|
||
|
|
%Docstring
|
||
|
|
Fetches new entries from the feed's URL.
|
||
|
|
|
||
|
|
.. seealso:: :py:func:`fetched`
|
||
|
|
%End
|
||
|
|
|
||
|
|
signals:
|
||
|
|
|
||
|
|
void fetched( const QList< QgsNewsFeedParser::Entry > &entries );
|
||
|
|
%Docstring
|
||
|
|
Emitted when ``entries`` have fetched from the feed.
|
||
|
|
|
||
|
|
.. seealso:: :py:func:`fetch`
|
||
|
|
%End
|
||
|
|
|
||
|
|
};
|
||
|
|
|
||
|
|
/************************************************************************
|
||
|
|
* This file has been generated automatically from *
|
||
|
|
* *
|
||
|
|
* src/core/qgsnewsfeedparser.h *
|
||
|
|
* *
|
||
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
||
|
|
************************************************************************/
|