sortmode.h

/*
    This file is part of libkabc.
    Copyright (c) 2004 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_SORTMODE_H
#define KABC_SORTMODE_H

#include "kabc_export.h"
#include "addressee.h"

namespace KABC {

class Field;

class KABC_EXPORT SortMode
{
  public:
    virtual ~SortMode();

    virtual bool lesser( const KABC::Addressee &first, const KABC::Addressee &second ) const = 0;
};

class KABC_EXPORT NameSortMode : public SortMode
{
  public:
    enum NameType {
      FormattedName,    
      FamilyName,       
      GivenName         
    };

    NameSortMode();

    explicit NameSortMode( NameType type, bool ascending = true );

    virtual ~NameSortMode();

    virtual bool lesser( const KABC::Addressee &first, const KABC::Addressee &second ) const;

  private:
    class Private;
    Private *const d;

    Q_DISABLE_COPY( NameSortMode )
};

class KABC_EXPORT FieldSortMode : public SortMode
{
  public:
    explicit FieldSortMode( KABC::Field *field, bool ascending = true );

    virtual ~FieldSortMode();

    virtual bool lesser( const KABC::Addressee &first, const KABC::Addressee &second ) const;

  private:
    class Private;
    Private *const d;

    Q_DISABLE_COPY( FieldSortMode )
};

}

#endif