kitchensync Library API Documentation

syncer.h

00001 /*
00002     This file is part of KitchenSync.
00003 
00004     Copyright (c) 2002 Cornelius Schumacher <schumacher@kde.org>
00005     Copyright (c) 2002 Holger Freyther <zecke@handhelds.org>
00006 
00007     This library is free software; you can redistribute it and/or
00008     modify it under the terms of the GNU Library General Public
00009     License as published by the Free Software Foundation; either
00010     version 2 of the License, or (at your option) any later version.
00011 
00012     This library is distributed in the hope that it will be useful,
00013     but WITHOUT ANY WARRANTY; without even the implied warranty of
00014     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00015     Library General Public License for more details.
00016 
00017     You should have received a copy of the GNU Library General Public License
00018     along with this library; see the file COPYING.LIB.  If not, write to
00019     the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
00020     Boston, MA 02111-1307, USA.
00021 */
00022 #ifndef KSYNC_SYNCER_H
00023 #define KSYNC_SYNCER_H
00024 
00025 #include <qstring.h>
00026 #include <qptrlist.h>
00027 
00028 namespace KSync {
00029 
00030 class SyncAlgorithm;
00031 class SyncUi;
00032 class Syncee;
00033 
00054 class Syncer
00055 {
00056   public:
00063     Syncer( SyncUi *ui = 0, SyncAlgorithm *algorithm = 0 );
00064     virtual ~Syncer();
00065 
00069     void setSyncAlgorithm( SyncAlgorithm * );
00070 
00074     void setSyncUi( SyncUi * );
00075 
00079     void addSyncee( Syncee * );
00080 
00084     void clear();
00085 
00093     void sync();
00094 
00103     void syncAllToTarget( Syncee *target, bool writeback = false);
00104 
00113     void syncToTarget( Syncee *syncee, Syncee *target, bool override = false );
00114 
00115   private:
00116     QPtrList<Syncee> mSyncees;
00117 
00118     SyncUi *mUi;
00119     SyncAlgorithm *mAlgorithm;
00120 
00121     bool mOwnUi;
00122     bool mOwnAlgorithm;
00123 
00124     class SyncerPrivate;
00125     SyncerPrivate *d;
00126 };
00127 
00128 }
00129 
00130 #endif
KDE Logo
This file is part of the documentation for kitchensync Library Version 3.3.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Thu May 3 20:20:52 2007 by doxygen 1.4.2 written by Dimitri van Heesch, © 1997-2003