ksync Library API Documentation

BookmarkSyncee Class Reference

This class provides an implementation of the interface for KSync. More...

#include <bookmarksyncee.h>

Inheritance diagram for BookmarkSyncee:

KSyncee List of all members.

Public Member Functions

BookmarkSyncEntry * firstEntry ()
 Return the first KSyncEntry object of the data set.

BookmarkSyncEntry * nextEntry ()
 Return the next KSyncEntry object of the data set.

void addEntry (KSyncEntry *)
 Add a KSyncEntry object to this data set.

void removeEntry (KSyncEntry *)
 Remove a KSyncEntry.

bool read ()
 Read the data set from disk from the file with the name filename().

bool write ()
 Write the data set to disk to the file with the name filename().


Detailed Description

This class provides an implementation of the interface for KSync.

It provides syncing of bookmark files as used by Konqueror.

Definition at line 34 of file bookmarksyncee.h.


Member Function Documentation

BookmarkSyncEntry * BookmarkSyncee::firstEntry  )  [virtual]
 

Return the first KSyncEntry object of the data set.

This function together with nextEntry() is used to iterate through all entries of a KSyncee data set.

Implements KSyncee.

Definition at line 99 of file bookmarksyncee.cpp.

References QValueList< QDomElement >::begin().

BookmarkSyncEntry * BookmarkSyncee::nextEntry  )  [virtual]
 

Return the next KSyncEntry object of the data set.

This function together with firstEntry() is used to iterate through all entries of a KSyncee data set.

Implements KSyncee.

Definition at line 105 of file bookmarksyncee.cpp.

void BookmarkSyncee::addEntry KSyncEntry  )  [virtual]
 

Add a KSyncEntry object to this data set.

Ownership of the object remains with the caller.

Implements KSyncee.

Definition at line 125 of file bookmarksyncee.cpp.

References QValueList< QDomElement >::append().

void BookmarkSyncee::removeEntry KSyncEntry  )  [virtual]
 

Remove a KSyncEntry.

The entry is removed from the data set, but the object is not deleted.

Implements KSyncee.

Definition at line 139 of file bookmarksyncee.cpp.

bool BookmarkSyncee::read  )  [virtual]
 

Read the data set from disk from the file with the name filename().

This function has to be reimplemented by concrete subclasses to provide the actual reading from disk.

Returns:
true, if reading is successfull, otherwise false.

Implements KSyncee.

Definition at line 62 of file bookmarksyncee.cpp.

References QValueList< QDomElement >::begin(), QValueList< QDomElement >::clear(), and KSyncee::filename().

bool BookmarkSyncee::write  )  [virtual]
 

Write the data set to disk to the file with the name filename().

This function has to be reimplemented by concrete subclasses to provide the actual writing to disk.

Returns:
true, if writing is successfull, otherwise false.

Implements KSyncee.

Definition at line 91 of file bookmarksyncee.cpp.


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kdelibs Version 3.1.4.
Documentation copyright © 1996-2002 the KDE developers.
Generated on Sat Oct 18 02:47:17 2003 by doxygen 1.3.4 written by Dimitri van Heesch, © 1997-2001