foldertreewidget.h

Go to the documentation of this file.

#ifndef KDEPIM_FOLDERTREEWIDGET_H
#define KDEPIM_FOLDERTREEWIDGET_H

/******************************************************************************
 *
 * This file is part of libkdepim.
 *
 * Copyright (C) 2008 Szymon Tomasz Stefanek <pragma@kvirc.net>
 *
 * 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.
 *
 *****************************************************************************/

#include "knode_export.h"
#include "treewidget.h"

#include <QHash>
#include <QColor>

namespace KPIM
{

class FolderTreeWidgetItem;

class KNODE_EXPORT FolderTreeWidget : public KPIM::TreeWidget
{
  friend class FolderTreeWidgetItemLabelColumnDelegate;
  Q_OBJECT
public:
  explicit FolderTreeWidget( QWidget *parent , const char *name = 0 );

private:
  void emitRenamed( QTreeWidgetItem *item );
  int mLabelColumnIndex;      
  int mUnreadColumnIndex;     
  int mTotalColumnIndex;      
  int mDataSizeColumnIndex;   

  QColor mUnreadCountColor;
  QColor mCloseToQuotaWarningColor;

public:
  int addLabelColumn( const QString &headerLabel );

  int labelColumnIndex() const
    { return mLabelColumnIndex; };

  bool labelColumnVisible() const;

  int addUnreadColumn( const QString &headerLabel );

  int unreadColumnIndex() const
    { return mUnreadColumnIndex; };

  bool unreadColumnVisible() const;

  int addTotalColumn( const QString &headerLabel );

  int totalColumnIndex() const
    { return mTotalColumnIndex; };

  bool totalColumnVisible() const;

  int addDataSizeColumn( const QString &headerLabel );

  int dataSizeColumnIndex() const
    { return mDataSizeColumnIndex; };

  bool dataSizeColumnVisible() const;

  const QColor & closeToQuotaWarningColor() const
    { return mCloseToQuotaWarningColor; };

  void setCloseToQuotaWarningColor( const QColor &clr );

  const QColor & unreadCountColor() const
    { return mUnreadCountColor; };

  void setUnreadCountColor( const QColor &clr );

  void updateColumnForItem( FolderTreeWidgetItem * item, int columnIndex );

Q_SIGNALS:
  void renamed( QTreeWidgetItem *item );

private Q_SLOTS:

  void updateExpandedState( QTreeWidgetItem *item );
};

class FolderTreeWidgetItemLabelColumnDelegate;

class KNODE_EXPORT FolderTreeWidgetItem : public QTreeWidgetItem
{
  friend class FolderTreeWidgetItemLabelColumnDelegate;
public:
  enum Protocol {
      Local, Imap, CachedImap, News, Search, NONE
  };

  // FIXME: Rename to FolderItemType
  enum FolderType {
      Inbox, Outbox, SentMail, Trash, Drafts, Templates, Root,
      Calendar, Tasks, Journals, Contacts, Notes,  Other
  };

private:
  Protocol mProtocol;                  
  FolderType mFolderType;              
  QString mLabelText;                  
  int mTotalCount;                     
  int mUnreadCount;                    
  qint64 mDataSize;                    
  unsigned int mIsCloseToQuota:1;      
  unsigned int mLabelTextElided:1;     
  int mChildrenTotalCount;             
  int mChildrenUnreadCount;            
  qint64 mChildrenDataSize;            
  bool mAlwaysDisplayCounts;           

public:
  explicit FolderTreeWidgetItem(
      FolderTreeWidget *parent,
      const QString &label,
      Protocol protocol,
      FolderType folderType
    );

  explicit FolderTreeWidgetItem(
      FolderTreeWidgetItem *parent,
      const QString &label,
      Protocol protocol,
      FolderType folderType
   );

public:
  bool isCloseToQuota() const
    { return mIsCloseToQuota; };

  void setIsCloseToQuota( bool closeToQuota );

  const QString & labelText() const
    { return mLabelText; };

  void setLabelText( const QString &label );

  int unreadCount() const
    { return mUnreadCount; };

  void setUnreadCount( int unreadCount );

  int totalCount() const
    { return mTotalCount; };

  void setTotalCount( int totalCount );

  qint64 dataSize() const
    { return mDataSize; };

  void setDataSize( qint64 s );

  int childrenUnreadCount() const
    { return mChildrenUnreadCount; };

  int childrenTotalCount() const
    { return mChildrenTotalCount; };

  qint64 childrenDataSize() const
    { return mChildrenDataSize; };

  bool updateChildrenCounts();

  Protocol protocol() const
    { return mProtocol; };

  void setProtocol( Protocol protocol )
    { mProtocol = protocol; };

  QString protocolDescription() const;

  FolderType folderType() const
    { return mFolderType; };

  void setFolderType( FolderType folderType )
    { mFolderType = folderType; };

  virtual bool operator < ( const QTreeWidgetItem &other ) const;

  void updateColumn( int columnIndex );

  void updateExpandedState();

  bool labelTextElided() const
    { return mLabelTextElided; };

  bool alwaysDisplayCounts() const
    { return mAlwaysDisplayCounts; };

  void setAlwaysDisplayCounts( bool alwaysDisplayCounts )
    { mAlwaysDisplayCounts = alwaysDisplayCounts; };

protected:
  void setLabelTextElided( bool labelTextElided )
    { mLabelTextElided = labelTextElided ? 1 : 0; };

  virtual QString elidedLabelText( const QFontMetrics &metrics, unsigned int width ) const;
};

} // namespace KPIM

#endif