RSS::Item Class Reference

#include <rss_item.h>

Inheritance diagram for RSS::Item:

Collaboration diagram for RSS::Item:

Signals
void	pathChanged (Item *item=nullptr)
void	unreadCountChanged (Item *item=nullptr)
void	aboutToBeDestroyed (Item *item=nullptr)
void	newArticle (Article *article)
void	articleRead (Article *article)
void	articleAboutToBeRemoved (Article *article)

Public Member Functions
virtual QList< Article * >	articles () const =0
virtual int	unreadCount () const =0
virtual void	markAsRead ()=0
virtual void	refresh ()=0
QString	path () const
QString	name () const
virtual QJsonValue	toJsonValue (bool withData=false) const =0

Static Public Member Functions
static bool	isValidPath (const QString &path)
static QString	joinPath (const QString &path1, const QString &path2)
static QStringList	expandPath (const QString &path)
static QString	parentPath (const QString &path)
static QString	relativeName (const QString &path)

Static Public Attributes
static const QChar	PathSeparator

Protected Member Functions
	Item (const QString &path)
	~Item () override
virtual void	cleanup ()=0

Private Member Functions
void	setPath (const QString &path)

Private Attributes
QString	m_path

Friends
class	Folder
class	Session

Detailed Description

Definition at line 42 of file rss_item.h.

Constructor & Destructor Documentation

Item()

Item::Item ( const QString &  path )

explicitprotected

Definition at line 41 of file rss_item.cpp.

    : m_path(path)
{
}

~Item()

Item::~Item ( )

overrideprotected

Definition at line 46 of file rss_item.cpp.

{}

Member Function Documentation

aboutToBeDestroyed

void RSS::Item::aboutToBeDestroyed ( Item *  item = nullptr )

signal

Referenced by RSS::Session::addItem(), RSS::Feed::~Feed(), and RSS::Folder::~Folder().

Here is the caller graph for this function:

articleAboutToBeRemoved

void RSS::Item::articleAboutToBeRemoved ( Article *  article )

signal

Referenced by RSS::Folder::addItem(), RSS::Folder::removeItem(), RSS::Feed::removeOldestArticle(), and ArticleListWidget::setRSSItem().

Here is the caller graph for this function:

articleRead

void RSS::Item::articleRead ( Article *  article )

signal

Referenced by RSS::Folder::addItem(), RSS::Feed::handleArticleRead(), RSS::Feed::markAsRead(), and ArticleListWidget::setRSSItem().

Here is the caller graph for this function:

articles()

virtual QList<Article *> RSS::Item::articles ( ) const

pure virtual

Implemented in RSS::Folder, and RSS::Feed.

Referenced by RSS::Folder::addItem(), RSS::Folder::removeItem(), and ArticleListWidget::setRSSItem().

Here is the caller graph for this function:

cleanup()

virtual void RSS::Item::cleanup ( )

protectedpure virtual

Implemented in RSS::Folder, and RSS::Feed.

expandPath()

QStringList Item::expandPath ( const QString &  path )

static

Definition at line 90 of file rss_item.cpp.

{
    QStringList result;
    if (path.isEmpty()) return result;
    //    if (!isValidRSSFolderName(folder))
    //        return result;
 
    int index = 0;
    while ((index = path.indexOf(Item::PathSeparator, index)) >= 0)
    {
        result << path.left(index);
        ++index;
    }
    result << path;
 
    return result;
}

References path(), and PathSeparator.

Referenced by RSS::Session::loadLegacy().

Here is the call graph for this function:

Here is the caller graph for this function:

isValidPath()

bool Item::isValidPath ( const QString &  path )

static

Definition at line 67 of file rss_item.cpp.

{
    static const QRegularExpression re(
                QString(R"(\A[^\%1]+(\%1[^\%1]+)*\z)").arg(Item::PathSeparator)
                , QRegularExpression::DontCaptureOption);
 
    if (path.isEmpty() || !re.match(path).hasMatch())
    {
        qDebug() << "Incorrect RSS Item path:" << path;
        return false;
    }
 
    return true;
}

References path(), and PathSeparator.

Referenced by RSS::Session::prepareItemDest().

Here is the call graph for this function:

Here is the caller graph for this function:

joinPath()

QString Item::joinPath ( const QString &  path1, const QString &  path2  )

static

Definition at line 82 of file rss_item.cpp.

{
    if (path1.isEmpty())
        return path2;
 
    return (path1 + Item::PathSeparator + path2);
}

References PathSeparator.

Referenced by RSS::Session::addFeedToFolder(), RSS::Session::addSubfolder(), RSSWidget::askNewFolder(), FeedListWidget::dropEvent(), RSS::Session::handleFeedTitleChanged(), RSS::Session::loadLegacy(), RSSWidget::on_newFeedButton_clicked(), and RSSWidget::renameSelectedRSSItem().

Here is the caller graph for this function:

markAsRead()

virtual void RSS::Item::markAsRead ( )

pure virtual

Implemented in RSS::Folder, and RSS::Feed.

Referenced by RSSController::markAsReadAction(), and RSSWidget::on_markReadButton_clicked().

Here is the caller graph for this function:

name()

QString Item::name

(

)

const

Definition at line 62 of file rss_item.cpp.

{
    return relativeName(path());
}

References path(), and relativeName().

Referenced by AutomatedRssDownloader::addFeedArticlesToTree(), FeedListWidget::createItem(), RSS::Session::handleFeedTitleChanged(), FeedListWidget::handleItemPathChanged(), FeedListWidget::handleItemUnreadCountChanged(), RSSWidget::loadFoldersOpenState(), RSSController::matchingArticlesAction(), and RSSWidget::renameSelectedRSSItem().

Here is the call graph for this function:

Here is the caller graph for this function:

newArticle

void RSS::Item::newArticle ( Article *  article )

signal

Referenced by RSS::Feed::addArticle(), RSS::Folder::addItem(), RSS::AutoDownloader::setProcessingEnabled(), ArticleListWidget::setRSSItem(), and RSS::AutoDownloader::startProcessing().

Here is the caller graph for this function:

parentPath()

QString Item::parentPath ( const QString &  path )

static

Definition at line 108 of file rss_item.cpp.

{
    int pos;
    return ((pos = path.lastIndexOf(Item::PathSeparator)) >= 0 ? path.left(pos) : "");
}

References path(), and PathSeparator.

Referenced by RSS::Session::handleFeedTitleChanged(), FeedListWidget::handleItemAdded(), FeedListWidget::handleItemPathChanged(), RSS::Session::loadLegacy(), RSS::Session::moveItem(), RSS::Session::prepareItemDest(), RSS::Session::removeItem(), and RSSWidget::renameSelectedRSSItem().

Here is the call graph for this function:

Here is the caller graph for this function:

path()

QString Item::path

(

)

const

Definition at line 57 of file rss_item.cpp.

{
    return m_path;
}

References m_path.

Referenced by RSS::Session::addFeedToFolder(), RSS::Session::addItem(), RSS::Session::addSubfolder(), RSSWidget::askNewFolder(), FeedListWidget::dropEvent(), expandPath(), RSS::Session::handleFeedTitleChanged(), RSS::Session::handleItemAboutToBeDestroyed(), FeedListWidget::handleItemAdded(), FeedListWidget::handleItemPathChanged(), isValidPath(), FeedListWidget::itemPath(), RSS::Session::loadFolder(), RSS::Session::moveItem(), name(), RSSWidget::on_newFeedButton_clicked(), parentPath(), relativeName(), RSSWidget::renameSelectedRSSItem(), and setPath().

Here is the caller graph for this function:

pathChanged

void RSS::Item::pathChanged ( Item *  item = nullptr )

signal

Referenced by RSS::Session::addItem(), and setPath().

Here is the caller graph for this function:

refresh()

virtual void RSS::Item::refresh ( )

pure virtual

Implemented in RSS::Folder, and RSS::Feed.

Referenced by RSSController::refreshItemAction(), and RSSWidget::refreshSelectedItems().

Here is the caller graph for this function:

relativeName()

QString Item::relativeName ( const QString &  path )

static

Definition at line 114 of file rss_item.cpp.

{
    int pos;
    return ((pos = path.lastIndexOf(Item::PathSeparator)) >= 0 ? path.right(path.size() - (pos + 1)) : path);
}

References path(), and PathSeparator.

Referenced by RSS::Session::loadLegacy(), and name().

Here is the call graph for this function:

Here is the caller graph for this function:

setPath()

void Item::setPath ( const QString &  path )

private

Definition at line 48 of file rss_item.cpp.

{
    if (path != m_path)
    {
        m_path = path;
        emit pathChanged(this);
    }
}

References m_path, path(), and pathChanged().

Referenced by RSS::Session::moveItem().

Here is the call graph for this function:

Here is the caller graph for this function:

toJsonValue()

virtual QJsonValue RSS::Item::toJsonValue ( bool  withData = false ) const

pure virtual

Implemented in RSS::Folder, and RSS::Feed.

unreadCount()

virtual int RSS::Item::unreadCount ( ) const

pure virtual

Implemented in RSS::Folder, and RSS::Feed.

Referenced by RSS::Folder::addItem(), FeedListWidget::createItem(), FeedListWidget::handleItemPathChanged(), FeedListWidget::handleItemUnreadCountChanged(), and RSS::Folder::removeItem().

Here is the caller graph for this function:

unreadCountChanged

void RSS::Item::unreadCountChanged ( Item *  item = nullptr )

signal

Referenced by RSS::Folder::addItem(), FeedListWidget::createItem(), RSS::Feed::decreaseUnreadCount(), FeedListWidget::FeedListWidget(), RSS::Folder::handleItemUnreadCountChanged(), RSS::Feed::increaseUnreadCount(), RSS::Feed::markAsRead(), RSS::Folder::removeItem(), and RSSWidget::RSSWidget().

Here is the caller graph for this function:

Friends And Related Function Documentation

Folder

friend class Folder

friend

Definition at line 47 of file rss_item.h.

Session

friend class Session

friend

Definition at line 48 of file rss_item.h.

Member Data Documentation

m_path

QString RSS::Item::m_path

private

Definition at line 86 of file rss_item.h.

Referenced by path(), and setPath().

PathSeparator

const QChar Item::PathSeparator

static

Definition at line 61 of file rss_item.h.

Referenced by expandPath(), isValidPath(), joinPath(), RSS::Session::loadLegacy(), parentPath(), and relativeName().

---

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

• src/base/rss/rss_item.h
• src/base/rss/rss_item.cpp