KisNewsWidget Class Reference

The KisNewsWidget class shows the latest news from Krita.org. More...

#include <KisNewsWidget.h>

Inheritance diagram for KisNewsWidget:

Signals
void	newsDataChanged ()

Public Member Functions
	KisNewsWidget (QWidget *parent=nullptr)
void	setAnalyticsTracking (QString text)
void	toggleNewsLanguage (QString langCode, bool enabled)

Protected Member Functions
bool	eventFilter (QObject *watched, QEvent *event) override

Private Slots
void	itemSelected (const QModelIndex &idx)
void	rssDataChanged ()
void	slotScrollerStateChanged (QScroller::State state)
void	toggleNews (bool toggle)

Private Attributes
QString	m_analyticsTrackingParameters
QSet< QString >	m_enabledFeeds
bool	m_getNews {false}
MultiFeedRssModel *	m_rssModel {0}

Detailed Description

The KisNewsWidget class shows the latest news from Krita.org.

Definition at line 31 of file KisNewsWidget.h.

Constructor & Destructor Documentation

KisNewsWidget()

KisNewsWidget::KisNewsWidget ( QWidget * parent = nullptr )

explicit

Definition at line 77 of file KisNewsWidget.cpp.

    : QWidget(parent)
    , m_getNews(false)
    , m_rssModel(0)
{
    setupUi(this);
    listNews->viewport()->setAutoFillBackground(false);
    listNews->installEventFilter(this);
    listNews->setVerticalScrollMode(QListView::ScrollPerPixel);
    listNews->verticalScrollBar()->setSingleStep(50);
    {
        QScroller* scroller = KisKineticScroller::createPreconfiguredScroller(listNews);
        if (scroller) {
            connect(scroller, SIGNAL(stateChanged(QScroller::State)), this, SLOT(slotScrollerStateChanged(QScroller::State)));
        }
    }
 
    m_rssModel = new MultiFeedRssModel(this);
    connect(m_rssModel, SIGNAL(feedDataChanged()), this, SLOT(rssDataChanged()), Qt::UniqueConnection);
 
    listNews->setModel(m_rssModel);
    listNews->setItemDelegate(new KisNewsDelegate(listNews));
    connect(listNews, SIGNAL(clicked(QModelIndex)), this, SLOT(itemSelected(QModelIndex)));
}

References connect(), KisKineticScroller::createPreconfiguredScroller(), itemSelected(), m_rssModel, rssDataChanged(), and slotScrollerStateChanged().

Member Function Documentation

eventFilter()

bool KisNewsWidget::eventFilter ( QObject * watched, QEvent * event )

overrideprotected

Definition at line 107 of file KisNewsWidget.cpp.

{
    if (watched == listNews && event->type() == QEvent::Leave) {
        listNews->clearSelection();
        listNews->setCurrentIndex(QModelIndex());
    }
    return QWidget::eventFilter(watched, event);
}

itemSelected

void KisNewsWidget::itemSelected ( const QModelIndex & idx )

privateslot

Definition at line 158 of file KisNewsWidget.cpp.

{
    if (idx.isValid()) {
        QString link = idx.data(KisRssReader::RssRoles::LinkRole).toString();
 
        // append query string for analytics tracking if we set it
        if (m_analyticsTrackingParameters != "") {
 
            // use title in analytics query string
            QString linkTitle = idx.data(KisRssReader::RssRoles::TitleRole).toString();
            linkTitle = linkTitle.simplified(); // trims and makes 1 white space
            linkTitle = linkTitle.replace(" ", "");
 
            m_analyticsTrackingParameters = m_analyticsTrackingParameters.append(linkTitle);
            QDesktopServices::openUrl(QUrl(link.append(m_analyticsTrackingParameters)));
 
        } else {
            QDesktopServices::openUrl(QUrl(link));
        }
 
 
    }
}

References KisRssReader::LinkRole, m_analyticsTrackingParameters, and KisRssReader::TitleRole.

newsDataChanged

void KisNewsWidget::newsDataChanged ( )

signal

rssDataChanged

void KisNewsWidget::rssDataChanged ( )

privateslot

Definition at line 182 of file KisNewsWidget.cpp.

{
    Q_EMIT newsDataChanged();
}

References newsDataChanged().

setAnalyticsTracking()

void KisNewsWidget::setAnalyticsTracking

(

QString

text

)

Definition at line 102 of file KisNewsWidget.cpp.

{
    m_analyticsTrackingParameters = text;
}

References m_analyticsTrackingParameters.

slotScrollerStateChanged

void KisNewsWidget::slotScrollerStateChanged ( QScroller::State state )

inlineprivateslot

Definition at line 50 of file KisNewsWidget.h.

{ KisKineticScroller::updateCursor(this, state); }

References KisKineticScroller::updateCursor().

toggleNews

void KisNewsWidget::toggleNews ( bool toggle )

privateslot

Definition at line 142 of file KisNewsWidget.cpp.

{
    m_getNews = toggle;
 
    KisConfig cfg(false);
    cfg.writeEntry<bool>("FetchNews", toggle);
 
    Q_FOREACH(const QString &feed, m_enabledFeeds) {
        if (toggle) {
            m_rssModel->addFeed(feed);
        } else {
            m_rssModel->removeFeed(feed);
        }
    }
}

References MultiFeedRssModel::addFeed(), m_enabledFeeds, m_getNews, m_rssModel, MultiFeedRssModel::removeFeed(), and KisConfig::writeEntry().

toggleNewsLanguage()

void KisNewsWidget::toggleNewsLanguage	(	QString	langCode,
		bool	enabled )

Definition at line 116 of file KisNewsWidget.cpp.

{
    // Sanity check: Since the code is adding the language code directly into
    // the URL, this prevents any nasty surprises with malformed URLs.
    Q_FOREACH(const char &ch, langCode.toLatin1()) {
        bool isValidChar = ((ch >= 'a' && ch <= 'z') || ch == '-' || ch == '@');
        if (!isValidChar) {
            warnUI << "Ignoring attempt to toggle malformed news lang:" << langCode;
            return;
        }
    }
 
    QString feed = QStringLiteral("https://krita.org/%1/index.xml").arg(langCode);
    if (enabled) {
        m_enabledFeeds.insert(feed);
        if (m_getNews) {
            m_rssModel->addFeed(feed);
        }
    } else {
        m_enabledFeeds.remove(feed);
        if (m_getNews) {
            m_rssModel->removeFeed(feed);
        }
    }
}

References MultiFeedRssModel::addFeed(), m_enabledFeeds, m_getNews, m_rssModel, MultiFeedRssModel::removeFeed(), and warnUI.

Member Data Documentation

m_analyticsTrackingParameters

QString KisNewsWidget::m_analyticsTrackingParameters

private

Definition at line 55 of file KisNewsWidget.h.

m_enabledFeeds

QSet<QString> KisNewsWidget::m_enabledFeeds

private

Definition at line 56 of file KisNewsWidget.h.

m_getNews

bool KisNewsWidget::m_getNews {false}

private

Definition at line 53 of file KisNewsWidget.h.

{false};

m_rssModel

MultiFeedRssModel* KisNewsWidget::m_rssModel {0}

private

Definition at line 54 of file KisNewsWidget.h.

{0};

---

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

• libs/ui/widgets/KisNewsWidget.h
• libs/ui/widgets/KisNewsWidget.cpp