view.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_VIEW_H__
#define __MESSAGELIST_CORE_VIEW_H__

#include <QTreeView>
#include <QList>
#include <QPoint>

#include <messagelist/core/enums.h>
#include <messagelist/messagelist_export.h>
#include <messagelist/core/widgets/quicksearchline.h>

class KMenu;

class QTimer;

namespace Akonadi
{
class MessageStatus;
}

namespace MessageList
{

namespace Core
{

typedef long int MessageItemSetReference;

class Aggregation;
class Delegate;
class Item;
class MessageItem;
class GroupHeaderItem;
class Model;
class Theme;
class SortOrder;
class StorageModel;
class Widget;

class MESSAGELIST_EXPORT View : public QTreeView
{
    friend class Model;
    friend class ModelPrivate;
    Q_OBJECT
public:
    explicit View( Widget *parent );
    ~View();

    Model * model() const;

    Delegate * delegate() const;

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

    StorageModel * storageModel() const;

    void setAggregation( const Aggregation * aggregation );

    void setTheme( Theme * theme );

    void setSortOrder( const SortOrder * sortOrder );

    void reload();

    MessageItem * currentMessageItem( bool selectIfNeeded = true ) const;

    Item * currentItem() const;

    void setCurrentMessageItem( MessageItem * it, bool center = false );

    bool isDisplayedWithParentsExpanded( Item * it ) const;

    void ensureDisplayedWithParentsExpanded( Item * it );

    QList< MessageItem * > selectionAsMessageItemList( bool includeCollapsedChildren = true ) const;

    QList< MessageItem * > currentThreadAsMessageItemList() const;

    bool selectionEmpty() const;

    void selectMessageItems( const QList< MessageItem * > &list );

    MessageItemSetReference createPersistentSet( const QList< MessageItem * > &items );

    QList< MessageItem * > persistentSetCurrentMessageItemList( MessageItemSetReference ref );

    void deletePersistentSet( MessageItemSetReference ref );

    void markMessageItemsAsAboutToBeRemoved( QList< MessageItem * > &items, bool bMark );

    bool isThreaded() const;

    void setCurrentThreadExpanded( bool expand );

    void setAllThreadsExpanded( bool expand );

    void setAllGroupsExpanded( bool expand );

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

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

    bool focusNextMessageItem( MessageTypeFilter messageTypeFilter, bool centerItem, bool loop );

    bool focusPreviousMessageItem( MessageTypeFilter messageTypeFilter, bool centerItem, bool loop );

    void selectFocusedMessageItem( bool centerItem );

    bool selectFirstMessageItem( MessageTypeFilter messageTypeFilter, bool centerItem );

    bool selectLastMessageItem( MessageTypeFilter messageTypeFilter, bool centerItem );

    void focusQuickSearch(const QString &selectedText);

    QList<Akonadi::MessageStatus> currentFilterStatus() const;

    QString currentFilterSearchString() const;

    virtual void setRowHidden( int row, const QModelIndex & parent, bool hide );

    void sortOrderMenuAboutToShow(KMenu *menu);

    void aggregationMenuAboutToShow(KMenu *menu);

    void themeMenuAboutToShow(KMenu *menu);

    void setCollapseItem(const QModelIndex& index);
    void setExpandItem(const QModelIndex& index);

    void setQuickSearchClickMessage(const QString &msg);

    MessageList::Core::QuickSearchLine::SearchOptions currentOptions() const;
protected:
    virtual bool event( QEvent *e );

    virtual void changeEvent( QEvent *e );

    virtual void showEvent( QShowEvent *e );

    virtual void mousePressEvent( QMouseEvent * e );

    virtual void mouseDoubleClickEvent( QMouseEvent * e );

    virtual void mouseMoveEvent( QMouseEvent * e );

    virtual void contextMenuEvent( QContextMenuEvent* e );

    virtual void dragEnterEvent( QDragEnterEvent * e );

    virtual void dragMoveEvent( QDragMoveEvent * e );

    virtual void dropEvent( QDropEvent * e );

    virtual void resizeEvent( QResizeEvent * e );

    virtual int sizeHintForColumn( int logicalColumnIndex ) const;

    virtual void updateGeometries();

    bool isScrollingLocked() const;

    void ignoreUpdateGeometries( bool ignore );

    void modelHasBeenReset();

    void modelAboutToEmitLayoutChanged();
    void modelEmittedLayoutChanged();

    void appendMessageItemChildren( MessageItem * par, QList< MessageItem * > &list );

    void ignoreCurrentChanges( bool ignore );

    void setChildrenExpanded( const Item * parent, bool expand );

    Item * nextMessageItem( MessageTypeFilter messageTypeFilter, bool loop );

    Item * messageItemAfter( Item * referenceItem, MessageTypeFilter messageTypeFilter, bool loop );

    Item * firstMessageItem( MessageTypeFilter messageTypeFilter )
    { return messageItemAfter( 0, messageTypeFilter, false ); }

    Item * previousMessageItem( MessageTypeFilter messageTypeFilter, bool loop );

    Item * deepestExpandedChild( Item * referenceItem ) const;

    Item * messageItemBefore( Item * referenceItem, MessageTypeFilter messageTypeFilter, bool loop );

    Item * lastMessageItem( MessageTypeFilter messageTypeFilter )
    { return messageItemBefore( 0, messageTypeFilter, false ); }

    void modelJobBatchStarted();

    void modelJobBatchTerminated();

    void modelFinishedLoading();

    void changeMessageStatus( MessageItem * it, const Akonadi::MessageStatus &set, const Akonadi::MessageStatus &unset );
    void changeMessageStatusRead( MessageItem *it, bool read );

    void triggerDelayedSaveThemeColumnState();

    void triggerDelayedApplyThemeColumns();

    void growOrShrinkExistingSelection( const QModelIndex &newSelectedIndex, bool movingUp );

public slots:
    void slotCollapseAllGroups();

    void slotExpandAllGroups();

    void slotExpandCurrentItem();

    void slotCollapseCurrentItem();

protected slots:

    void slotHeaderContextMenuRequested( const QPoint &pnt );

    void slotShowHideColumn( int columnIndex );

    void slotAdjustColumnSizes();

    void slotShowDefaultColumns();

    void slotDisplayTooltips( bool showTooltips );

    void slotHeaderSectionResized( int logicalIndex, int oldWidth, int newWidth );

    void slotSelectionChanged( const QItemSelection &current, const QItemSelection & );

    void saveThemeColumnState();

    void applyThemeColumns();

private:
    Q_PRIVATE_SLOT(d, void expandFullThread( const QModelIndex& ))

    class Private;
    Private * d;
}; // class View

} // namespace Core

} // namespace MessageList


#endif