widget.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_WIDGET_H__
#define __MESSAGELIST_WIDGET_H__

#include <messagelist/core/widgetbase.h>
#include <messagelist/core/view.h>
#include <akonadi/item.h>

#include <kmime/kmime_message.h>

#include <messagelist/messagelist_export.h>

class KXMLGUIClient;
class QWidget;

namespace MessageList
{

class MESSAGELIST_EXPORT Widget : public MessageList::Core::Widget
{
  Q_OBJECT

public:
  explicit Widget( QWidget *parent );
  ~Widget();

  void setXmlGuiClient( KXMLGUIClient *xmlGuiClient );

  Akonadi::Item currentItem() const;

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


  bool canAcceptDrag( const QDropEvent *e );

  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 selectAll();
  void setCurrentThreadExpanded( bool expand );

  void setAllThreadsExpanded( bool expand );

  void setAllGroupsExpanded( bool expand );

  void focusQuickSearch();

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

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

  QVector<qlonglong> selectionAsMessageItemListId( bool includeCollapsedChildren ) const;
  QList<Akonadi::Item::Id> selectionAsListMessageId( bool includeCollapsedChildren ) const;

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

  Akonadi::MessageStatus currentFilterStatus() const;

  QString currentFilterSearchString() const;

  bool isThreaded() const;

  bool selectionEmpty() const;

  bool getSelectionStats( Akonadi::Item::List &selectedSernums,
                          Akonadi::Item::List &selectedVisibleSernums,
                          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;
  Akonadi::Collection currentCollection() const;

protected:

  virtual void fillMessageTagCombo( KComboBox * combo );

  virtual void viewMessageSelected( MessageList::Core::MessageItem *msg );

  virtual void viewMessageActivated( MessageList::Core::MessageItem *msg );

  virtual void viewSelectionChanged();

  virtual void viewMessageListContextPopupRequest( const QList< MessageList::Core::MessageItem * > &selectedItems, const QPoint &globalPos );

  virtual void viewGroupHeaderContextPopupRequest( MessageList::Core::GroupHeaderItem *group, const QPoint &globalPos );

  virtual void viewDragEnterEvent( QDragEnterEvent * e );

  virtual void viewDragMoveEvent( QDragMoveEvent * e );

  virtual void viewDropEvent( QDropEvent * e );

  virtual void viewStartDragRequest();

  virtual void viewMessageStatusChangeRequest( MessageList::Core::MessageItem *msg, const Akonadi::MessageStatus &set, const Akonadi::MessageStatus &clear );

private Q_SLOTS:
  void slotCollapseItem();
  void slotExpandItem();


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 );

private:
  class Private;
  Private * const d;
};

} // namespace MessageList

#endif