diff options
author | Timothy Pearson <[email protected]> | 2011-11-06 15:57:02 -0600 |
---|---|---|
committer | Timothy Pearson <[email protected]> | 2011-11-06 15:57:02 -0600 |
commit | 2c2fbd828ca474671bb9e03681b30b115d8d6035 (patch) | |
tree | 526a9da418f8d3d7ccf515c37048d3dfc80f2843 /libtdepim/diffalgo.h | |
parent | f0610eece3676b6fe99f42cf4ef2b19a39a5c4e8 (diff) | |
download | tdepim-2c2fbd828ca474671bb9e03681b30b115d8d6035.tar.gz tdepim-2c2fbd828ca474671bb9e03681b30b115d8d6035.zip |
Actually move the kde files that were renamed in the last commit
Diffstat (limited to 'libtdepim/diffalgo.h')
-rw-r--r-- | libtdepim/diffalgo.h | 138 |
1 files changed, 138 insertions, 0 deletions
diff --git a/libtdepim/diffalgo.h b/libtdepim/diffalgo.h new file mode 100644 index 000000000..513db7e33 --- /dev/null +++ b/libtdepim/diffalgo.h @@ -0,0 +1,138 @@ +/* + This file is part of libtdepim. + + Copyright (c) 2004 Tobias Koenig <[email protected]> + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Library General Public + License as published by the Free Software Foundation; either + version 2 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Library General Public License for more details. + + You should have received a copy of the GNU Library General Public License + along with this library; see the file COPYING.LIB. If not, write to + the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, + Boston, MA 02110-1301, USA. +*/ + +#ifndef DIFFALGO_H +#define DIFFALGO_H + +#include <tqvaluelist.h> +#include <tdepimmacros.h> + +namespace KPIM { + +/** + DiffAlgo and DiffAlgoDisplay work together for displaying differences between + two PIM objects like contacts, events or todos. + DiffAlgo is the bas class for the diffing algorithm and DiffAlgoDisplay is + responsible for representation. The separation makes it possible to use one + display for all diffing algorithm and vice versa. + */ +class DiffAlgoDisplay +{ + public: + + /** + Is called on the start of the diff. + */ + virtual void begin() = 0; + + /** + Is called on the end of the diff. + */ + virtual void end() = 0; + + /** + Sets the title of the left data source. + */ + virtual void setLeftSourceTitle( const TQString &title ) = 0; + + /** + Sets the title of the right data source. + */ + virtual void setRightSourceTitle( const TQString &title ) = 0; + + /** + Adds a field which is only available in the left data source. + */ + virtual void additionalLeftField( const TQString &id, const TQString &value ) = 0; + + /** + Adds a field which is only available in the right data source. + */ + virtual void additionalRightField( const TQString &id, const TQString &value ) = 0; + + /** + Adds a conflict between two fields. + */ + virtual void conflictField( const TQString &id, const TQString &leftValue, + const TQString &rightValue ) = 0; +}; + + +class KDE_EXPORT DiffAlgo +{ + public: + /** + Destructor. + */ + virtual ~DiffAlgo() {} + + /** + Starts the diffing algorithm. + */ + virtual void run() = 0; + + /** + Must be called on the start of the diff. + */ + void begin(); + + /** + Must be called on the end of the diff. + */ + void end(); + + /** + Sets the title of the left data source. + */ + void setLeftSourceTitle( const TQString &title ); + + /** + Sets the title of the right data source. + */ + void setRightSourceTitle( const TQString &title ); + + /** + Adds a field which is only available in the left data source. + */ + void additionalLeftField( const TQString &id, const TQString &value ); + + /** + Adds a field which is only available in the right data source. + */ + void additionalRightField( const TQString &id, const TQString &value ); + + /** + Adds a conflict between two fields. + */ + void conflictField( const TQString &id, const TQString &leftValue, + const TQString &rightValue ); + + void addDisplay( DiffAlgoDisplay *display ); + void removeDisplay( DiffAlgoDisplay *display ); + + + private: + TQValueList<DiffAlgoDisplay*> mDisplays; +}; + +} + +#endif |