libfuoten 0.8.2
Qt based library to access the Nextcloud News App API.
Loading...
Searching...
No Matches
Fuoten::FeedListModel Class Reference

List model containing Feed objects. More...

#include <Fuoten/Models/FeedListModel>

Inheritance diagram for Fuoten::FeedListModel:
Fuoten::AbstractFeedModel Fuoten::BaseModel QAbstractItemModel QObject

Public Member Functions

 FeedListModel (QObject *parent=nullptr)
 Constructs a new empty feed list model with the given parent.
 ~FeedListModel () override
 Deconstructs the FeedListModel object.
Public Member Functions inherited from Fuoten::AbstractFeedModel
 AbstractFeedModel (QObject *parent=nullptr)
 Constructs a new empty abstract Feed model with the given parent.
 ~AbstractFeedModel () override
 Destroys the AbstractFeedModel object.
QModelIndex findByID (qint64 id) const override
 Returns the model index of the Feed identified by id.
QHash< qint64, QModelIndexfindByIDs (const IdList &ids) const override
 Returns IDs and model indices of the Feed objects in the model defined by their ID in ids.
Public Member Functions inherited from Fuoten::BaseModel
 BaseModel (QObject *parent=nullptr)
 Constructs a new BaseModel object.
 ~BaseModel () override
 Deconstructs the BaseModel object.
double doubleParentId () const
 Returns the currently set parent ID as double. This function is for use in QML, that does not support 64bit integers. It performs a static cast from the saved qint64 parent ID to double.
bool inOperation () const
 Returns true while the model is loading data.
int limit () const
 Getter function for the limit property.
bool loaded () const
 Getter function for the loaded property. *.
qint64 parentId () const
 Returns the currently set parent ID.
void setDoubleParentId (double nDoubleParentId)
 Sets the parent ID via a double. This function is for use in QML, that does not support 64bit integers. It performs a static cast from the double to a qint64 to save it.
void setLimit (int nLimit)
 Setter function for the limit property. Emits the limitChanged() signal if nLimit is not equal to the stored value.
void setParentId (qint64 nParentId)
 Set the parent ID.
void setSortingRole (FuotenEnums::SortingRole nSortingRole)
 Setter function for the sortingRole property. Emits the sortingRoleChanged() signal if nSortingRole is not equal to the stored value.
void setSortOrder (Qt::SortOrder nSortOrder)
 Setter function for the sortOrder property. Emits the sortOrderChanged() signal if nSortOrder is not equal to the stored value.
void setStorage (AbstractStorage *nStorage)
 Sets the pointer to the local storage handler.
void setUnreadOnly (bool nUnreadOnly)
 Setter function for the unreadOnly property. Emits the unreadOnlyChanged() signal if nUnreadOnly is not equal to the stored value.
FuotenEnums::SortingRole sortingRole () const
 Getter function for the sortingRole property.
Qt::SortOrder sortOrder () const
 Getter function for the sortOrder property.
AbstractStoragestorage () const
 Returns the pointer to the currently set local storage.
bool unreadOnly () const
 Getter function for the unreadOnly property.

Additional Inherited Members

Properties inherited from Fuoten::BaseModel
double doubleParentId
 Stores the parent ID as double to make it accesseable from QML.
bool inOperation
 Returns true while the model is loading data.
int limit
 Limits the result to the specified number of objects.
bool loaded
 This property holds true if the model has initially loaded the data.
qint64 parentId
 Sets the parent database ID to load feeds/items for.
Fuoten::FuotenEnums::SortingRole sortingRole
 The role/value used to sort the result.
Qt::SortOrder sortOrder
 The sorting order.
Fuoten::AbstractStoragestorage
 Pointer to a class derived from AbstractStorage.
bool unreadOnly
 If true, only unread articles, feeds or folders are returned.
Public Slots inherited from Fuoten::AbstractFeedModel
void load () override
 Populates the model with data from the local storage.
Public Slots inherited from Fuoten::BaseModel
virtual void load ()=0
 Loads the model data.
virtual void reload ()
 Reloads the complete model.
Signals inherited from Fuoten::BaseModel
void doubleParentIdChanged (double doubleParentId)
 This signal is emitted if the parent ID changes.
void inOperationChanged (bool inOperation)
 This signal is emitted if the operational state of the model changes.
void limitChanged (int limit)
 This is emitted if the value of the limit property changes.
void loadedChanged (bool loaded)
 This is emitted if the value of the loaded property changes.
void parentIdChanged (qint64 parentId)
 This signal is emitted if the parent ID changes.
void sortingRoleChanged (FuotenEnums::SortingRole sortingRole)
 This is emitted if the value of the sortingRole property changes.
void sortOrderChanged (Qt::SortOrder sortOrder)
 This is emitted if the value of the sortOrder property changes.
void storageChanged (Fuoten::AbstractStorage *storage)
 This signal is emitted if the poiner to the local storage changes.
void unreadOnlyChanged (bool unreadOnly)
 This is emitted if the value of the unreadOnly property changes.
Protected Slots inherited from Fuoten::AbstractFeedModel
void feedCreated (qint64 id, qint64 folderId)
 Takes and processes data after a feed has been created.
void feedDeleted (qint64 id)
 Takes and processes data after a feed has been deleted.
void feedMarkedRead (qint64 id, qint64 newestItemId)
 Takes and processes data after a complete feed has been marked as read.
void feedMoved (qint64 id, qint64 targetFolderId)
 Takes and processes data after a feed has been moved to a different folder.
void feedRenamed (qint64 id, const QString &newName)
 Takes and processes data after a feed has been renamed.
void feedsRequested (const Fuoten::IdList &updatedFeeds, const Fuoten::IdList &newFeeds, const Fuoten::IdList &deletedFeeds)
 Takes and processes data after feeds have been requested.
void folderDeleted (qint64 folderId)
 Takes and processes data after a folder has been deleted.
void folderMarkedRead (qint64 folderId, qint64 newestItemId)
 Takes and processes data after a complete folder has been marked as read.
void itemMarked (qint64 itemId, bool unread)
 Takes and processes data after an item/article has been marked as read/unread.
void itemsMarked ()
 Should be called after a set of items has been marked as read or unread.
void itemsRquested (const Fuoten::IdList &updatedItems, const Fuoten::IdList &newItems, const Fuoten::IdList &deletedItems)
 Takes and processes data after items/articles have been requested/updated.
Protected Member Functions inherited from Fuoten::AbstractFeedModel
void clear () override
 Clears the complete model and will destroy all Feed object.
QList< Feed * > feeds () const
 Returns the list of Feed objects in the model.
void handleStorageChanged (AbstractStorage *old) override
 Connects the feed realted signals of AbstractStorage to the model's slots.
Protected Member Functions inherited from Fuoten::BaseModel
void setInOperation (bool nInOperation)
 Sets the inOperation property.
void setLoaded (bool loaded)
 Set this to true if the model has initially loaded its data.

Detailed Description

List model containing Feed objects.

List model with one column that contains a pointer to a Feed object. The Qt::DisplayRole (display in QML) returns the pointer. To use this model, you need an AbstractStorage derived class that has to be set to the BaseModel::storage property.

Constructor & Destructor Documentation

◆ FeedListModel()

FeedListModel::FeedListModel ( QObject * parent = nullptr)
explicit

Constructs a new empty feed list model with the given parent.

◆ ~FeedListModel()

FeedListModel::~FeedListModel ( )
override

Deconstructs the FeedListModel object.


The documentation for this class was generated from the following files:
  • Fuoten/Models/feedlistmodel.h
  • Fuoten/Models/feedlistmodel.cpp