/usr/include/akonadi/abstractdifferencesreporter.h is in kdepimlibs5-dev 4:4.14.10-1ubuntu7.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 | /*
Copyright (c) 2010 KDAB
Author: Tobias Koenig <tokoe@kde.org>
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 ABSTRACTDIFFERENCESREPORTER_P_H
#define ABSTRACTDIFFERENCESREPORTER_P_H
namespace Akonadi {
/**
* @short An interface to report differences between two arbitrary objects.
*
* This interface can be used to report differences between two arbitrary objects
* by describing a virtual table with three columns. The first column contains the name
* of the property that is compared, the second column the property value of the one
* object and the third column the property of the other object.
*
* The rows of this table can have different modes:
* @li NormalMode The left and right columns show the same property values.
* @li ConflictMode The left and right columns show conflicting property values.
* @li AdditionalLeftMode The left column contains a property value that is not available in the right column.
* @li AdditionalRightMode The right column contains a property value that is not available in the left column.
*
* Example:
*
* @code
* // add differences of a contact
* const KABC::Addressee contact1 = ...
* const KABC::Addressee contact2 = ...
*
* AbstractDifferencesReporter *reporter = ...
* reporter->setPropertyNameTitle( i18n( "Contact fields" ) );
* reporter->setLeftPropertyValueTitle( i18n( "Changed Contact" ) );
* reporter->setRightPropertyValueTitle( i18n( "Conflicting Contact" ) );
*
* // check given name
* if ( contact1.givenName() != contact2.givenName() )
* reporter->addProperty( AbstractDifferencesReporter::ConflictMode, i18n( "Given Name" ),
* contact1.givenName(), contact2.givenName() );
* else
* reporter->addProperty( AbstractDifferencesReporter::NormalMode, i18n( "Given Name" ),
* contact1.givenName(), contact2.givenName() );
*
* // check family name
* if ( contact1.familyName() != contact2.familyName() )
* reporter->addProperty( AbstractDifferencesReporter::ConflictMode, i18n( "Family Name" ),
* contact1.givenName(), contact2.givenName() );
* else
* reporter->addProperty( AbstractDifferencesReporter::NormalMode, i18n( "Family Name" ),
* contact1.givenName(), contact2.givenName() );
*
* // check emails
* const QStringList leftEmails = contact1.emails();
* const QStringList rightEmails = contact2.emails();
*
* foreach ( const QString &leftEmail, leftEmails ) {
* if ( rightEmails.contains( leftEmail ) )
* reporter->addProperty( AbstractDifferencesReporter::NormalMode, i18n( "Email" ),
* leftEmail, leftEmail );
* else
* reporter->addProperty( AbstractDifferencesReporter::AdditionalLeftMode, i18n( "Email" ),
* leftEmail, QString() );
* }
*
* foreach ( const QString &rightEmail, rightEmails ) {
* if ( !leftEmails.contains( rightEmail ) )
* reporter->addProperty( AbstractDifferencesReporter::AdditionalRightMode, i18n( "Email" ),
* QString(), rightEmail );
* }
*
* @endcode
*
* @author Tobias Koenig <tokoe@kde.org>
* @since 4.6
*/
class AbstractDifferencesReporter
{
public:
/**
* Describes the property modes.
*/
enum Mode {
NormalMode, ///< The left and right column show the same property values.
ConflictMode, ///< The left and right column show conflicting property values.
AdditionalLeftMode, ///< The left column contains a property value that is not available in the right column.
AdditionalRightMode ///< The right column contains a property value that is not available in the left column.
};
/**
* Destroys the abstract differences reporter.
*/
virtual ~AbstractDifferencesReporter() {}
/**
* Sets the @p title of the property name column.
*/
virtual void setPropertyNameTitle( const QString &title ) = 0;
/**
* Sets the @p title of the column that shows the property values
* of the left object.
*/
virtual void setLeftPropertyValueTitle( const QString &title ) = 0;
/**
* Sets the @p title of the column that shows the property values
* of the right object.
*/
virtual void setRightPropertyValueTitle( const QString &title ) = 0;
/**
* Adds a new property entry to the table.
*
* @param mode Describes the mode of the property. If mode is AdditionalLeftMode or AdditionalRightMode, rightValue resp. leftValue
* should be QString().
* @param name The user visible name of the property.
* @param leftValue The user visible property value of the left object.
* @param rightValue The user visible property value of the right object.
*/
virtual void addProperty( Mode mode, const QString &name, const QString &leftValue, const QString &rightValue ) = 0;
};
}
#endif
|