MultiMC5/api/logic/news/NewsChecker.h

106 lines
2.6 KiB
C
Raw Normal View History

2018-02-10 23:40:01 +00:00
/* Copyright 2013-2018 MultiMC Contributors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#pragma once
#include <QObject>
#include <QString>
#include <QList>
2015-02-09 00:51:14 +00:00
#include <net/NetJob.h>
#include "NewsEntry.h"
#include "multimc_logic_export.h"
class MULTIMC_LOGIC_EXPORT NewsChecker : public QObject
{
2018-07-15 12:51:05 +00:00
Q_OBJECT
public:
2018-07-15 12:51:05 +00:00
/*!
* Constructs a news reader to read from the given RSS feed URL.
*/
NewsChecker(const QString& feedUrl);
/*!
* Returns the error message for the last time the news was loaded.
* Empty string if the last load was successful.
*/
QString getLastLoadErrorMsg() const;
/*!
* Returns true if the news has been loaded successfully.
*/
bool isNewsLoaded() const;
//! True if the news is currently loading. If true, reloadNews() will do nothing.
bool isLoadingNews() const;
/*!
* Returns a list of news entries.
*/
QList<NewsEntryPtr> getNewsEntries() const;
/*!
* Reloads the news from the website's RSS feed.
* If the news is already loading, this does nothing.
*/
void Q_SLOT reloadNews();
signals:
2018-07-15 12:51:05 +00:00
/*!
* Signal fired after the news has finished loading.
*/
void newsLoaded();
2018-07-15 12:51:05 +00:00
/*!
* Signal fired after the news fails to load.
*/
void newsLoadingFailed(QString errorMsg);
protected slots:
2018-07-15 12:51:05 +00:00
void rssDownloadFinished();
void rssDownloadFailed(QString reason);
protected: /* data */
2018-07-15 12:51:05 +00:00
//! The URL for the RSS feed to fetch.
QString m_feedUrl;
2018-07-15 12:51:05 +00:00
//! List of news entries.
QList<NewsEntryPtr> m_newsEntries;
2018-07-15 12:51:05 +00:00
//! The network job to use to load the news.
NetJobPtr m_newsNetJob;
2018-07-15 12:51:05 +00:00
//! True if news has been loaded.
bool m_loadedNews;
2018-07-15 12:51:05 +00:00
QByteArray newsData;
2018-07-15 12:51:05 +00:00
/*!
* Gets the error message that was given last time the news was loaded.
* If the last news load succeeded, this will be an empty string.
*/
QString m_lastLoadError;
protected slots:
2018-07-15 12:51:05 +00:00
/// Emits newsLoaded() and sets m_lastLoadError to empty string.
void succeed();
2015-04-26 21:04:50 +00:00
2018-07-15 12:51:05 +00:00
/// Emits newsLoadingFailed() and sets m_lastLoadError to the given message.
void fail(const QString& errorMsg);
};