pane.h

Go to the documentation of this file.

/*
    Copyright (c) 2009 Kevin Ottens <ervin@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_PANE_H__
#define __MESSAGELIST_PANE_H__

#include <messagelist/core/enums.h>
#include <messagelist/core/view.h>
#include <QtCore/QHash>
#include <KTabWidget>

#include <kmime/kmime_message.h>
#include <akonadi/collection.h>
#include <akonadi/item.h>
#include <messagelist/messagelist_export.h>

class KXMLGUIClient;
class QAbstractItemModel;
class QAbstractProxyModel;
class QItemSelectionModel;
class QItemSelection;
class QToolButton;

namespace KPIM
{
  class MessageStatus;
}

namespace Akonadi
{
  class Item;
}

namespace MessageList
{

class Widget;
class StorageModel;

class MESSAGELIST_EXPORT Pane : public KTabWidget
{
  Q_OBJECT

public:
  explicit Pane(bool restoreSession, QAbstractItemModel *model, QItemSelectionModel *selectionModel, QWidget *parent = 0 );
  ~Pane();


  virtual MessageList::StorageModel *createStorageModel( QAbstractItemModel *model, QItemSelectionModel *selectionModel, QObject *parent );

  virtual void writeConfig(bool restoreSession);

  void setXmlGuiClient( KXMLGUIClient *xmlGuiClient );

  Akonadi::Item currentItem() const;

  KMime::Message::Ptr currentMessage() const;


  QList<KMime::Message::Ptr > selectionAsMessageList( bool includeCollapsedChildren = true ) const;

  QList<Akonadi::Item> selectionAsMessageItemList( bool includeCollapsedChildren = true ) const;

  QVector<qlonglong> selectionAsMessageItemListId( bool includeCollapsedChildren = true ) const;

  QList<Akonadi::Item::Id> selectionAsListMessageId( bool includeCollapsedChildren = true) const;

  QList<Akonadi::Item> currentThreadAsMessageList() const;


  bool selectNextMessageItem( MessageList::Core::MessageTypeFilter messageTypeFilter,
                              MessageList::Core::ExistingSelectionBehaviour existingSelectionBehaviour,
                              bool centerItem,
                              bool loop );

  bool selectPreviousMessageItem( MessageList::Core::MessageTypeFilter messageTypeFilter,
                                  MessageList::Core::ExistingSelectionBehaviour existingSelectionBehaviour,
                                  bool centerItem,
                                  bool loop );

  bool focusNextMessageItem( MessageList::Core::MessageTypeFilter messageTypeFilter, bool centerItem, bool loop );

  bool focusPreviousMessageItem( MessageList::Core::MessageTypeFilter messageTypeFilter, bool centerItem, bool loop );

  void selectFocusedMessageItem( bool centerItem );

  bool selectFirstMessageItem( MessageList::Core::MessageTypeFilter messageTypeFilter, bool centerItem );

  bool selectLastMessageItem( MessageList::Core::MessageTypeFilter messageTypeFilter, bool centerItem );

  void setCurrentThreadExpanded( bool expand );

  void setAllThreadsExpanded( bool expand );

  void setAllGroupsExpanded( bool expand );

  void focusQuickSearch();

  Akonadi::MessageStatus currentFilterStatus() const;

  QString currentFilterSearchString() const;


  bool isThreaded() const;

  bool selectionEmpty() const;
  bool getSelectionStats( Akonadi::Item::List &selectedItems,
                          Akonadi::Item::List &selectedVisibleItems,
                          bool * allSelectedBelongToSameThread,
                          bool includeCollapsedChildren = true) const;
  void deletePersistentSet( MessageList::Core::MessageItemSetReference ref );


  void markMessageItemsAsAboutToBeRemoved( MessageList::Core::MessageItemSetReference ref, bool bMark );

  QList<Akonadi::Item> itemListFromPersistentSet( MessageList::Core::MessageItemSetReference ref );


  MessageList::Core::MessageItemSetReference selectionAsPersistentSet( bool includeCollapsedChildren = true ) const;

  MessageList::Core::MessageItemSetReference currentThreadAsPersistentSet() const;
  void focusView();

  void reloadGlobalConfiguration();

  QItemSelectionModel* currentItemSelectionModel();

  void setCurrentFolder(
    const Akonadi::Collection &fld,
    bool preferEmptyTab = false,
    MessageList::Core::PreSelectionMode preSelectionMode = MessageList::Core::PreSelectLastSelected,
    const QString &overrideLabel = QString()
    );

  void resetModelStorage();

  void setPreferEmptyTab( bool emptyTab );

  void updateTabIconText( const Akonadi::Collection &collection, const QString&label, const QIcon& icon );

  void saveCurrentSelection();

  void updateTagComboBox();


  bool searchEditHasFocus() const;

public slots:
  void selectAll();

  QItemSelectionModel *createNewTab();

  void sortOrderMenuAboutToShow();

  void aggregationMenuAboutToShow();

  void themeMenuAboutToShow();


signals:
  void messageSelected( const Akonadi::Item &item );

  void messageActivated( const Akonadi::Item &item );

  void selectionChanged();

  void messageStatusChangeRequest( const Akonadi::Item &item, const Akonadi::MessageStatus &set, const Akonadi::MessageStatus &clear );

  void fullSearchRequest();

  void statusMessage( const QString &message );

  void currentTabChanged();



private:


  void readConfig(bool restoreSession);

  Q_PRIVATE_SLOT(d, void onSelectionChanged( const QItemSelection&, const QItemSelection& ))
  Q_PRIVATE_SLOT(d, void onNewTabClicked())
  Q_PRIVATE_SLOT(d, void onCloseTabClicked())
  Q_PRIVATE_SLOT(d, void activateTab())
  Q_PRIVATE_SLOT(d, void moveTabLeft())
  Q_PRIVATE_SLOT(d, void moveTabRight())
  Q_PRIVATE_SLOT(d, void activateNextTab())
  Q_PRIVATE_SLOT(d, void activatePreviousTab())
  Q_PRIVATE_SLOT(d, void closeTab( QWidget * ))
  Q_PRIVATE_SLOT(d, void onCurrentTabChanged())
  Q_PRIVATE_SLOT(d, void onTabContextMenuRequest( const QPoint& ))
  Q_PRIVATE_SLOT(d, void updateTabControls())
  Q_PRIVATE_SLOT(d, void changeQuicksearchVisibility(bool))

  bool eventFilter( QObject *obj, QEvent *event );

  class Private;
  Private * const d;
};

} // namespace MessageList

#endif