• Skip to content
  • Skip to link menu
KDE 4.3 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • Sitemap
  • Contact Us
 

akonadi

Akonadi::ChangeRecorder

Akonadi::ChangeRecorder Class Reference

Records and replays change notification. More...

#include <changerecorder.h>

Inheritance diagram for Akonadi::ChangeRecorder:

Inheritance graph
[legend]

List of all members.


Public Slots

void replayNext ()

Signals

void changesAdded ()
void nothingToReplay ()

Public Member Functions

void changeProcessed ()
 ChangeRecorder (QObject *parent=0)
bool isEmpty () const
void setChangeRecordingEnabled (bool enable)
void setConfig (QSettings *settings)
 ~ChangeRecorder ()

Detailed Description

Records and replays change notification.

This class is responsible for recording change notification during an agent is not online and replay the notifications when the agent is online again. Therefor the agent doesn't have to care about online/offline mode in its synchronization algorithm.

Author:
Volker Krause <vkrause@kde.org>

Definition at line 41 of file changerecorder.h.


Constructor & Destructor Documentation

ChangeRecorder::ChangeRecorder ( QObject *  parent = 0  )  [explicit]

Creates a new change recorder.

Definition at line 125 of file changerecorder.cpp.

ChangeRecorder::~ChangeRecorder (  ) 

Destroys the change recorder.

All not yet processed changes are written back to the config file.

Definition at line 132 of file changerecorder.cpp.


Member Function Documentation

void ChangeRecorder::changeProcessed (  ) 

Removes the previously emitted change from the records.

Definition at line 178 of file changerecorder.cpp.

void Akonadi::ChangeRecorder::changesAdded (  )  [signal]

Emitted when new changes are recorded.

bool ChangeRecorder::isEmpty (  )  const

Returns whether there are recorded changes.

Definition at line 172 of file changerecorder.cpp.

void Akonadi::ChangeRecorder::nothingToReplay (  )  [signal]

Emitted when replayNext() was called, but there was no valid change to replay.

This can happen when all pending changes have been filtered out for example. You only need to connect to this signal if you rely on one signal being emitted as a result of calling replayNext().

void ChangeRecorder::replayNext (  )  [slot]

Replay the next change notification and erase the previous one from the record.

Definition at line 151 of file changerecorder.cpp.

void ChangeRecorder::setChangeRecordingEnabled ( bool  enable  ) 

Enables change recording.

If change recording is disabled, this class behaves exactly like Akonadi::Monitor. Change recording is enabled by default.

Definition at line 186 of file changerecorder.cpp.

void ChangeRecorder::setConfig ( QSettings *  settings  ) 

Sets the QSettings object used for persisting recorded changes.

Definition at line 138 of file changerecorder.cpp.


The documentation for this class was generated from the following files:
  • changerecorder.h
  • changerecorder.cpp

akonadi

Skip menu "akonadi"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  • kabc
  • kblog
  • kcal
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  • kldap
  • kmime
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.5.8
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal