/usr/include/kabc/addresseelist.h is in kdepimlibs5-dev 4:4.8.5-0ubuntu0.3.
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 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 | /*
This file is part of libkabc.
Copyright (c) 2002 Jost Schenck <jost@schenck.de>
2003 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 KABC_ADDRESSEELIST_H
#define KABC_ADDRESSEELIST_H
#include "kabc_export.h"
#include <QtCore/QSharedDataPointer>
#include <QtCore/QList>
namespace KABC {
class Field;
class SortMode;
class Addressee;
/**
* Each trait must implement one static function for equality, one for "less
* than". Class name should be the field name. A trait does not necessarily
* have to stick to just one field: a trait sorting by family name can e.g.
* sort addressees with equal family name by given name.
*
* If you want to implement reverse sorting, you do not have to write another
* trait, as AddresseeList takes care of that.
*/
namespace SortingTraits
{
class KABC_EXPORT Uid
{
public:
/**
* Creates an instance.
*/
Uid();
/**
* Destroys the instance.
*/
~Uid();
/**
* "Equal" compare method
*
* @return @c true if the first parameter is equal to the second
* when comparing the uid attribute.
*
* @see Addressee::uid()
* @see QString::compare()
*/
static bool eq( const Addressee &, const Addressee & );
/**
* "Less-Than" compare method
*
* @return @c true if the first parameter is "less-than" the second
* when comparing the uid attribute.
*
* @see Addressee::uid()
* @see QString::compare()
*/
static bool lt( const Addressee &, const Addressee & );
private:
class Private;
Private *const d;
};
class KABC_EXPORT Name
{
public:
/**
* Creates an instance.
*/
Name();
/**
* Destroys the instance.
*/
~Name();
/**
* "Equal" compare method
*
* @return @c true if the first parameter is equal to the second
* when comparing the name attribute.
*
* @see Addressee::name()
* @see QString::localeAwareCompare()
*/
static bool eq( const Addressee &, const Addressee & );
/**
* "Less-Than" compare method
*
* @return @c true if the first parameter is "less-than" the second
* when comparing the name attribute.
*
* @see Addressee::name()
* @see QString::localeAwareCompare()
*/
static bool lt( const Addressee &, const Addressee & );
private:
class Private;
Private *const d;
};
class KABC_EXPORT FormattedName
{
public:
/**
* Creates an instance.
*/
FormattedName();
/**
* Destroys the instance.
*/
~FormattedName();
/**
* "Equal" compare method
*
* @return @c true if the first parameter is equal to the second
* when comparing the formatted name attribute.
*
* @see Addressee::formattedName()
* @see QString::localeAwareCompare()
*/
static bool eq( const Addressee &, const Addressee & );
/**
* "Less-Than" compare method
*
* @return @c true if the first parameter is "less-than" the second
* when comparing the formatted name attribute.
*
* @see Addressee::formattedName()
* @see QString::localeAwareCompare()
*/
static bool lt( const Addressee &, const Addressee & );
private:
class Private;
Private *const d;
};
class KABC_EXPORT FamilyName // fallback to given name
{
public:
/**
* Creates an instance.
*/
FamilyName();
/**
* Destroys the instance.
*/
~FamilyName();
/**
* "Equal" compare method
*
* @return @c true if the first parameter is equal to the second
* when comparing the family name and given name attributes.
*
* @see Addressee::familyName()
* @see Addressee::givenName()
* @see QString::localeAwareCompare()
*/
static bool eq( const Addressee &, const Addressee & );
/**
* "Less-Than" compare method
*
* Falls back to comparing given name if equal
*
* @return @c true if the first parameter is "less-than" the second
* when comparing the family name attribute.
*
* @see Addressee::familyName()
* @see QString::localeAwareCompare()
*/
static bool lt( const Addressee &, const Addressee & );
private:
class Private;
Private *const d;
};
class KABC_EXPORT GivenName // fallback to family name
{
public:
/**
* Creates an instance.
*/
GivenName();
/**
* Destroys the instance.
*/
~GivenName();
/**
* "Equal" compare method
*
* @return @c true if the first parameter is equal to the second
* when comparing the given name and family name attributes.
*
* @see Addressee::givenName()
* @see Addressee::familyName()
* @see QString::localeAwareCompare()
*/
static bool eq( const Addressee &, const Addressee & );
/**
* "Less-Than" compare method
*
* Falls back to comparing family name if equal
*
* @return @c true if the first parameter is "less-than" the second
* when comparing the given name attribute.
*
* @see Addressee::givenName()
* @see QString::localeAwareCompare()
*/
static bool lt( const Addressee &, const Addressee & );
private:
class Private;
Private *const d;
};
}
/**
* Addressee attribute used for sorting.
*/
typedef enum {
Uid,
Name,
FormattedName,
FamilyName,
GivenName
} SortingCriterion;
/**
* @short a QValueList of Addressee, with sorting functionality
*
* This class extends the functionality of QValueList with
* sorting methods specific to the Addressee class. It can be used
* just like any other QValueList but is no template class.
*
* An AddresseeList does not automatically keep sorted when addressees
* are added or removed or the sorting order is changed, as this would
* slow down larger operations by sorting after every step. So after
* such operations you have to call {@link #sort} or {@link #sortBy} to
* create a defined order again.
*
* Iterator usage is inherited from QList and extensively documented
* there. Please remember that the state of an iterator is undefined
* after any sorting operation.
*
* For the enumeration Type SortingCriterion, which specifies the
* field by the collection will be sorted, the following values exist:
* Uid, Name, FormattedName, FamilyName, GivenName.
*
* @author Jost Schenck jost@schenck.de
*/
class KABC_EXPORT AddresseeList : public QList<Addressee>
{
public:
/**
* Creates a new addressee list.
*/
AddresseeList();
/**
* Creates a new addressee list.
*/
AddresseeList( const AddresseeList & );
/**
* Creates a new addressee list.
*/
AddresseeList( const QList<Addressee> & );
/**
* Destroys the addressee list.
*/
~AddresseeList();
/**
* Assignment operator.
*
* @param other the list to assign from
* @return a reference to @c this
*/
AddresseeList &operator=( const AddresseeList &other );
/**
* Determines the direction of sorting. On change, the list
* will <em>not</em> automatically be resorted.
* @param reverseSorting <tt>true</tt> if sorting should be done reverse,
* <tt>false</tt> otherwise
*/
void setReverseSorting( bool reverseSorting = true );
/**
* Returns the direction of sorting.
* @return <tt>true</tt> if sorting is done reverse, <tt>false</tt> otherwise
*/
bool reverseSorting() const;
/**
* Sorts this list by a specific criterion.
* @param c the criterion by which should be sorted
*/
void sortBy( SortingCriterion c );
/**
* Sorts this list by a specific field. If no parameter is given, the
* last used Field object will be used.
* @param field pointer to the Field object to be sorted by
*/
void sortByField( Field *field = 0 );
/**
* Sorts this list by a specific sorting mode.
* @param mode pointer to the sorting mode object to be sorted by
*/
void sortByMode( SortMode *mode = 0 );
/**
* Sorts this list by its active sorting criterion. This normally is the
* criterion of the last sortBy operation or <tt>FormattedName</tt> if up
* to now there has been no sortBy operation.
*
* Please note that the sorting trait of the last {@link #sortByTrait}
* method call is not remembered and thus the action can not be repeated
* by this method.
*/
void sort();
/**
* Templated sort function. You normally will not want to use this but
* {@link #sortBy} and {@link #sort} instead as the existing sorting
* criteria completely suffice for most cases.
*
* However, if you do want to use some special sorting criterion, you can
* write a trait class that will be provided to this templated method.
* This trait class has to have a class declaration like the following:
* \code
* class MySortingTrait {
* public:
* // eq returns true if a1 and a2 are equal
* static bool eq(KABC::Addressee a1, KABC::Addressee a2);
* // lt returns true is a1 is "less than" a2
* static bool lt(KABC::Addressee a1, KABC::Addressee a2);
* };
* \endcode
* You can then pass this class to the sortByTrait method like this:
* \code
* myAddresseelist.sortByTrait<MySortingTrait>();
* \endcode
* Please note that the {@link #sort} method can not be used to repeat the
* sorting of the last <tt>sortByTrait</tt> action.
*
* Right now this method uses the bubble sort algorithm. This should be
* replaced for a better one when I have time.
*/
template<class Trait> void sortByTrait();
/**
* Returns the active sorting criterion, ie the sorting criterion that
* will be used by a {@link #sort} call.
*/
SortingCriterion sortingCriterion() const;
/**
* Returns the active sorting field, ie a pointer to the Field object
* which was used for the last {@link #sortByField} operation.
* This function returns the last GLOBAL sorting field, not
* the class specific one.
* You're a lot better off by keeping track of this locally.
*/
Field *sortingField() const;
/**
* Returns a string representation of the addressee list.
*/
QString toString() const;
private:
class Private;
QSharedDataPointer<Private> d;
};
}
#endif
|