widgetbase.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_WIDGETBASE_H__
#define __MESSAGELIST_CORE_WIDGETBASE_H__

#include <QWidget>
#include <QString>
#include <QList>

#include <messagelist/core/enums.h>
#include <messagelist/core/sortorder.h>

#include <messagelist/messagelist_export.h>

class KLineEdit;
class QTimer;
class QActionGroup;
class KComboBox;
class KMenu;

namespace Akonadi
{
  class Collection;
  class MessageStatus;
}

namespace MessageList
{

namespace Core
{

class GroupHeaderItem;
class MessageItem;
class StorageModel;
class View;

class MESSAGELIST_EXPORT Widget : public QWidget
{
  friend class View;

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

  void setStorageModel( StorageModel * storageModel, PreSelectionMode preSelectionMode = PreSelectLastSelected );

  StorageModel *storageModel() const;

  KLineEdit *quickSearch() const;

  View *view() const;

  Core::MessageItem * currentMessageItem() const;

  Akonadi::MessageStatus currentFilterStatus() const;

  QString currentFilterSearchString() const;

  QString currentFilterTagId() const;

  void focusQuickSearch();

  bool isThreaded() const;
  bool selectionEmpty() const;

  void setCurrentFolder( const Akonadi::Collection &collection );

  void saveCurrentSelection();

  bool searchEditHasFocus() const;


  void sortOrderMenuAboutToShow(KMenu *menu);
  void themeMenuAboutToShow(KMenu *menu);
  void aggregationMenuAboutToShow(KMenu *menu);

public slots:

  void populateStatusFilterCombo();

  void changeQuicksearchVisibility(bool);

protected:
  virtual void fillMessageTagCombo( KComboBox * combo );

  virtual void viewMessageSelected( MessageItem *msg );

  virtual void viewMessageActivated( MessageItem *msg );

  virtual void viewSelectionChanged();

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

  virtual void viewGroupHeaderContextPopupRequest( 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( MessageItem *msg, const Akonadi::MessageStatus &set, const Akonadi::MessageStatus &clear );

  virtual void viewJobBatchStarted();

  virtual void viewJobBatchTerminated();

  void tagIdSelected(const QVariant &data );

Q_SIGNALS:
  void fullSearchRequest();

  void statusMessage( const QString &message );

protected slots:
  void aggregationsChanged();

  void themesChanged();


  void themeMenuAboutToShow();
  void aggregationMenuAboutToShow();
  void themeSelected( bool );
  void configureThemes();
  void setPrivateSortOrderForStorage();
  void aggregationSelected( bool );
  void statusSelected( int index );
  void searchEditTextEdited( const QString &text );
  void searchTimerFired();
  void searchEditClearButtonClicked();
  void sortOrderMenuAboutToShow();
  void messageSortingSelected( QAction *action );
  void messageSortDirectionSelected( QAction *action );
  void groupSortingSelected( QAction *action );
  void groupSortDirectionSelected( QAction *action );
  void resetFilter();

  void slotViewHeaderSectionClicked( int logicalIndex );

  void slotLockSearchClicked(bool b);

private:
  void defaultFilterStatus();
  class Private;
  Private * const d;
};

} // namespace Core

} // namespace MessageList


#endif