kde-workspace/libs/oxygen/oxygenitemmodel.h

#ifndef ITEMMODEL_H
#define ITEMMODEL_H

//////////////////////////////////////////////////////////////////////////////
// itemmodel.h
// -------------------
//
// Copyright (c) 2009-2010 Hugo Pereira Da Costa <hugo.pereira@free.fr>
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to
// deal in the Software without restriction, including without limitation the
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
// sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
// IN THE SOFTWARE.
//////////////////////////////////////////////////////////////////////////////

#include "oxygen_export.h"

#include <QtCore/QAbstractItemModel>

namespace Oxygen
{

    //! Job model. Stores job information for display in lists
    class OXYGEN_EXPORT ItemModel : public QAbstractItemModel
    {
        
        public:
        
        //! constructor
        explicit ItemModel(QObject *parent = 0);
        
        //! destructor
        virtual ~ItemModel()
        {}
        
        //! return all indexes in model starting from parent [recursive]
        QModelIndexList indexes( int column = 0, const QModelIndex& parent = QModelIndex() ) const;
        
        //!@name sorting
        //@{
        
        //! sort
        virtual void sort( void )
        { sort( sortColumn(), sortOrder() ); }
        
        //! sort
        virtual void sort( int column, Qt::SortOrder order = Qt::AscendingOrder );
        
        //! current sorting column
        const int& sortColumn( void ) const
        { return _sortColumn; }
        
        //! current sort order
        const Qt::SortOrder& sortOrder( void ) const
        { return _sortOrder; }
        
        //@}
        
        protected:
        
        //! this sort columns without calling the layout changed callbacks
        void privateSort( void )
        { privateSort( sortColumn(), sortOrder() ); }
        
        //! private sort, with no signals emmitted
        virtual void privateSort( int column, Qt::SortOrder order ) = 0;
        
        //! used to sort items in list
        class SortFTor
        {
            
            public:
            
            //! constructor
            explicit SortFTor( const int& type, Qt::SortOrder order = Qt::AscendingOrder ):
                _type( type ),
                _order( order )
            {}
            
            protected:
            
            //! column
            int _type;
            
            //! order
            Qt::SortOrder _order;
            
        };
        
        private:
        
        //! sorting column
        int _sortColumn;
        
        //! sorting order
        Qt::SortOrder _sortOrder;
        
    };
    
}

#endif