addresseelist.h

/*
    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;

namespace SortingTraits {

class KABC_EXPORT Uid
{
  public:
    Uid();

    ~Uid();

    static bool eq( const Addressee &, const Addressee & );

    static bool lt( const Addressee &, const Addressee & );

  private:
    class Private;
    Private *const d;
};

class KABC_EXPORT Name
{
  public:
    Name();

    ~Name();

    static bool eq( const Addressee &, const Addressee & );

    static bool lt( const Addressee &, const Addressee & );

  private:
    class Private;
    Private *const d;
};

class KABC_EXPORT FormattedName
{
  public:
    FormattedName();

    ~FormattedName();

    static bool eq( const Addressee &, const Addressee & );

    static bool lt( const Addressee &, const Addressee & );

  private:
    class Private;
    Private *const d;
};

class KABC_EXPORT FamilyName // fallback to given name
{
  public:
    FamilyName();

    ~FamilyName();

    static bool eq( const Addressee &, const Addressee & );

    static bool lt( const Addressee &, const Addressee & );

  private:
    class Private;
    Private *const d;
};

class KABC_EXPORT GivenName  // fallback to family name
{
  public:
    GivenName();

    ~GivenName();

    static bool eq( const Addressee &, const Addressee & );

    static bool lt( const Addressee &, const Addressee & );

  private:
    class Private;
    Private *const d;
};

}

typedef enum {
  Uid,
  Name,
  FormattedName,
  FamilyName,
  GivenName
} SortingCriterion;

class KABC_EXPORT AddresseeList : public QList<Addressee>
{
  public:
    AddresseeList();

    AddresseeList( const AddresseeList & );

    AddresseeList( const QList<Addressee> & );

    ~AddresseeList();

    AddresseeList &operator=( const AddresseeList &other );

    void setReverseSorting( bool reverseSorting = true );

    bool reverseSorting() const;

    void sortBy( SortingCriterion c );

    void sortByField( Field *field = 0 );

    void sortByMode( SortMode *mode = 0 );

    void sort();

    template<class Trait> void sortByTrait();

    SortingCriterion sortingCriterion() const;

    Field *sortingField() const;

    QString toString() const;

  private:
    class Private;
    QSharedDataPointer<Private> d;
};

}

#endif