sortorder.h

Go to the documentation of this file.

/******************************************************************************
 *
 *  Copyright 2009 Thomas McGuire <mcguire@kde.org>
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program 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 General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 *******************************************************************************/
#ifndef __MESSAGELIST_CORE_SORTORDER_H__
#define __MESSAGELIST_CORE_SORTORDER_H__

#include <messagelist/core/aggregation.h>

#include <KConfigGroup>

namespace MessageList
{

namespace Core
{

class SortOrder
{
  Q_GADGET
  Q_ENUMS( GroupSorting )
  Q_ENUMS( SortDirection )
  Q_ENUMS( MessageSorting )

  public:

    enum GroupSorting
    {
      NoGroupSorting,                      
      SortGroupsByDateTime,                
      SortGroupsByDateTimeOfMostRecent,    
      SortGroupsBySenderOrReceiver,        
      SortGroupsBySender,                  
      SortGroupsByReceiver                 
      // Never add enum entries in the middle: always add them at the end (numeric values are stored in configuration)
    };

    enum SortDirection
    {
      Ascending,
      Descending
    };

    enum MessageSorting
    {
      NoMessageSorting,                    
      SortMessagesByDateTime,              
      SortMessagesByDateTimeOfMostRecent,  
      SortMessagesBySenderOrReceiver,      
      SortMessagesBySender,                
      SortMessagesByReceiver,              
      SortMessagesBySubject,               
      SortMessagesBySize,                  
      SortMessagesByActionItemStatus,      
      SortMessagesByUnreadStatus,        
      SortMessagesByImportantStatus        
      // Warning: Never add enum entries in the middle: always add them at the end (numeric values are stored in configuration)
    };

    explicit SortOrder();

    GroupSorting groupSorting() const
      { return mGroupSorting; }

    void setGroupSorting( GroupSorting gs )
      { mGroupSorting = gs; }

    SortDirection groupSortDirection() const
      { return mGroupSortDirection; }

    void setGroupSortDirection( SortDirection groupSortDirection )
      { mGroupSortDirection = groupSortDirection; }

    MessageSorting messageSorting() const
      { return mMessageSorting; }

    void setMessageSorting( MessageSorting ms )
      { mMessageSorting = ms; }

    SortDirection messageSortDirection() const
      { return mMessageSortDirection; }

    void setMessageSortDirection( SortDirection messageSortDirection )
      { mMessageSortDirection = messageSortDirection; }

    static QList< QPair< QString, int > > enumerateMessageSortingOptions( Aggregation::Threading t );

    static QList< QPair< QString, int > > enumerateMessageSortDirectionOptions( MessageSorting ms );

    static QList< QPair< QString, int > > enumerateGroupSortingOptions( Aggregation::Grouping g );

    static QList< QPair< QString, int > > enumerateGroupSortDirectionOptions( Aggregation::Grouping g,
                                                                              GroupSorting groupSorting );

    bool validForAggregation( const Aggregation *aggregation ) const;

    static SortOrder defaultForAggregation( const Aggregation *aggregation,
                                            const SortOrder &oldSortOrder );

    static bool isValidMessageSorting( SortOrder::MessageSorting ms );

    void readConfig( KConfigGroup &conf, const QString &storageId,
                     bool *storageUsesPrivateSortOrder );

    void writeConfig( KConfigGroup &conf, const QString &storageId,
                      bool storageUsesPrivateSortOrder ) const;

  private:

    // Helper function to convert an enum value to a string and back
    static const QString nameForSortDirection( SortDirection sortDirection );
    static const QString nameForMessageSorting( MessageSorting messageSorting );
    static const QString nameForGroupSorting( GroupSorting groupSorting );
    static SortDirection sortDirectionForName( const QString& name );
    static MessageSorting messageSortingForName( const QString& name );
    static GroupSorting groupSortingForName( const QString& name );

    bool readConfigHelper( KConfigGroup &conf, const QString &id );

    MessageSorting mMessageSorting;
    SortDirection mMessageSortDirection;
    GroupSorting mGroupSorting;
    SortDirection mGroupSortDirection;
};

} // namespace Core

} // namespace MessageList

#endif // __MESSAGELIST_CORE_SORTORDER_H__