• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdepim API Reference
  • KDE Home
  • Contact Us
 

akregator

  • sources
  • kde-4.14
  • kdepim
  • akregator
  • interfaces
storage.h
Go to the documentation of this file.
1 /*
2  This file is part of Akregator.
3 
4  Copyright (C) 2005 Stanislav Karchebny <Stanislav.Karchebny@kdemail.net>
5 
6  This program is free software; you can redistribute it and/or modify
7  it under the terms of the GNU General Public License as published by
8  the Free Software Foundation; either version 2 of the License, or
9  (at your option) any later version.
10 
11  This program is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  GNU General Public License for more details.
15 
16  You should have received a copy of the GNU General Public License
17  along with this program; if not, write to the Free Software
18  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19 
20  As a special exception, permission is given to link this program
21  with any edition of Qt, and distribute the resulting executable,
22  without including the source code for Qt in the source distribution.
23 */
24 
25 #ifndef AKREGATOR_BACKEND_STORAGE_H
26 #define AKREGATOR_BACKEND_STORAGE_H
27 
28 #include "akregator_export.h"
29 #include <QtCore/QObject>
30 
31 class QString;
32 class QStringList;
33 
34 namespace Akregator {
35 namespace Backend {
36 
37 class FeedStorage;
38 
43 class Storage : public QObject //krazy:exclude=qobject
44 {
45  public:
46 
47  virtual ~Storage() {}
48 
51  virtual void initialize(const QStringList& params) = 0;
52 
57  virtual bool open(bool autoCommit = false) = 0;
58 
63  virtual bool commit() = 0;
64 
69  virtual bool rollback() = 0;
70 
75  virtual bool close() = 0;
76 
80  virtual FeedStorage* archiveFor(const QString &url) = 0;
81  virtual const FeedStorage* archiveFor(const QString &url) const = 0;
82  virtual bool autoCommit() const = 0;
83  virtual int unreadFor(const QString &url) const = 0;
84  virtual void setUnreadFor(const QString &url, int unread) = 0;
85  virtual int totalCountFor(const QString &url) const = 0;
86  virtual void setTotalCountFor(const QString &url, int total) = 0;
87  virtual int lastFetchFor(const QString& url) const = 0;
88  virtual void setLastFetchFor(const QString& url, int lastFetch) = 0;
89 
94  virtual void storeFeedList(const QString& opmlStr) = 0;
95  virtual QString restoreFeedList() const = 0;
96 
97  virtual void storeTagSet(const QString& xmlStr) = 0;
98  virtual QString restoreTagSet() const = 0;
99 
102  virtual QStringList feeds() const = 0;
103 
107  virtual void add(Storage* source) = 0;
108 
110  virtual void clear() = 0;
111 };
112 
113 } // namespace Backend
114 } // namespace Akregator
115 
116 #endif // AKREGATOR_BACKEND_STORAGE_H
Akregator::Backend::Storage::lastFetchFor
virtual int lastFetchFor(const QString &url) const =0
Akregator::Backend::Storage::restoreTagSet
virtual QString restoreTagSet() const =0
Akregator::Backend::Storage::setTotalCountFor
virtual void setTotalCountFor(const QString &url, int total)=0
Akregator::Backend::Storage
Storage is the main interface to the article archive.
Definition: storage.h:43
Akregator::Backend::Storage::add
virtual void add(Storage *source)=0
adds all feed storages from a source to this storage existing articles are replaced ...
Akregator::Backend::Storage::totalCountFor
virtual int totalCountFor(const QString &url) const =0
Akregator::Backend::Storage::commit
virtual bool commit()=0
Commit changes made in feeds and articles, making them persistent.
Akregator::Backend::Storage::autoCommit
virtual bool autoCommit() const =0
Akregator::Backend::Storage::initialize
virtual void initialize(const QStringList &params)=0
initializes the storage object with given parameters
Akregator::Backend::Storage::clear
virtual void clear()=0
deletes all feed storages in this archive
QObject
Akregator::Backend::Storage::feeds
virtual QStringList feeds() const =0
returns a list of all feeds (URLs) stored in this archive
Akregator::Backend::Storage::setUnreadFor
virtual void setUnreadFor(const QString &url, int unread)=0
Akregator::Backend::FeedStorage
Definition: feedstorage.h:66
Akregator::Backend::Storage::storeTagSet
virtual void storeTagSet(const QString &xmlStr)=0
Akregator::Backend::Storage::storeFeedList
virtual void storeFeedList(const QString &opmlStr)=0
stores the feed list in the storage backend.
QString
Akregator::Backend::Storage::rollback
virtual bool rollback()=0
Rollback changes made in feeds and articles, reverting to last committed values.
Akregator::Backend::Storage::unreadFor
virtual int unreadFor(const QString &url) const =0
Akregator::Backend::Storage::open
virtual bool open(bool autoCommit=false)=0
Open storage and prepare it for work.
QStringList
Akregator::Backend::Storage::restoreFeedList
virtual QString restoreFeedList() const =0
Akregator::Backend::Storage::~Storage
virtual ~Storage()
Definition: storage.h:47
akregator_export.h
Akregator::Backend::Storage::setLastFetchFor
virtual void setLastFetchFor(const QString &url, int lastFetch)=0
Akregator::Backend::Storage::archiveFor
virtual FeedStorage * archiveFor(const QString &url)=0
Akregator::Backend::Storage::close
virtual bool close()=0
Closes storage, freeing all allocated resources.
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:34:00 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

akregator

Skip menu "akregator"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members

kdepim API Reference

Skip menu "kdepim API Reference"
  • akonadi_next
  • akregator
  • blogilo
  • calendarsupport
  • console
  •   kabcclient
  •   konsolekalendar
  • kaddressbook
  • kalarm
  •   lib
  • kdgantt2
  • kjots
  • kleopatra
  • kmail
  • knode
  • knotes
  • kontact
  • korgac
  • korganizer
  • ktimetracker
  • libkdepim
  • libkleo
  • libkpgp
  • mailcommon
  • messagelist
  • messageviewer
  • pimprint

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal