item.h

Go to the documentation of this file.

/******************************************************************************
 *
 *  Copyright 2008 Szymon Tomasz Stefanek <pragma@kvirc.net>
 *
 *  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_ITEM_H__
#define __MESSAGELIST_CORE_ITEM_H__

#include <QList>
#include <QString>
#include <QDate>

#include <time.h> // for time_t

#include <kmime/kmime_headers.h>

#include <akonadi/kmime/messagestatus.h>

#include <messagelist/core/model.h>
#include <messagelist/messagelist_export.h>


namespace MessageList
{

namespace Core
{

class ItemPrivate;

class MESSAGELIST_EXPORT Item
{
    friend class Model;
    friend class ModelPrivate;

public:
    enum Type
    {
        GroupHeader,                              
        Message,                                  
        InvisibleRoot                             
    };

    enum InitialExpandStatus
    {
        ExpandNeeded,                             
        NoExpandNeeded,                           
        ExpandExecuted                            
    };

protected:
    Item( Type type );
    Item( Type type, ItemPrivate *dd );

public:
    virtual ~Item();

    Type type() const;

    InitialExpandStatus initialExpandStatus() const;

    void setInitialExpandStatus( InitialExpandStatus initialExpandStatus );

    bool isViewable() const;

    bool hasAncestor( const Item * it ) const;

    void setViewable( Model *model, bool bViewable );

    QList< Item * > * childItems() const;

    Item * childItem( int idx ) const;

    Item * firstChildItem() const;

    Item * itemBelowChild( Item * child );

    Item * itemAboveChild( Item * child );

    Item * deepestItem();

    Item * itemBelow();

    Item * itemAbove();

    void dump( const QString &prefix );

    int childItemCount() const;

    bool hasChildren() const;

    class ChildItemStats
    {
    public:
        unsigned int mTotalChildCount;   // total
        unsigned int mUnreadChildCount;  // unread only
    public:
        ChildItemStats()
            : mTotalChildCount( 0 ), mUnreadChildCount( 0 )
        {}
    };

    void childItemStats( ChildItemStats &stats ) const;

    int indexOfChildItem( Item *item ) const;

    void setIndexGuess( int index );

    Item * parent() const;

    void setParent( Item *pParent );

    Item * topmostNonRoot();

    const Akonadi::MessageStatus & status() const;

    void setStatus( const Akonadi::MessageStatus &status );

    QString statusDescription() const;

    size_t size() const;

    void setSize( size_t size );

    QString formattedSize() const;

    time_t date() const;

    void setDate( time_t date );

    QString formattedDate() const;

    time_t maxDate() const;

    void setMaxDate( time_t date );

    QString formattedMaxDate() const;

    bool recomputeMaxDate();

    const QString & sender() const;

    void setSender( const QString &sender );

    const QString & receiver() const;

    void setReceiver( const QString &receiver );

    const QString & senderOrReceiver() const;

    bool useReceiver() const;

    const QString & subject() const;

    void setSubject( const QString &subject );

    void initialSetup( time_t date, size_t size,
                       const QString &sender,
                       const QString &receiver,
                       bool useReceiver );

    void setItemId(qint64 id);
    qint64 itemId() const;

    void setParentCollectionId(qint64 id);
    qint64 parentCollectionId() const;

    void setSubjectAndStatus( const QString &subject,
                              const Akonadi::MessageStatus &status );

    int appendChildItem( Model *model, Item *child );

    void rawAppendChildItem( Item * child );

    void takeChildItem( Model *model, Item *child );

    void killAllChildItems();

protected:
    ItemPrivate * const d_ptr;
    Q_DECLARE_PRIVATE( Item )
};

} // namespace Core

} // namespace MessageList

#endif