mlist.h

Go to the documentation of this file.

/***************************************************************************
**
** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (directui@nokia.com)
**
** This file is part of libmeegotouch.
**
** If you have questions regarding the use of this file, please contact
** Nokia at directui@nokia.com.
**
** This library is free software; you can redistribute it and/or
** modify it under the terms of the GNU Lesser General Public
** License version 2.1 as published by the Free Software Foundation
** and appearing in the file LICENSE.LGPL included in the packaging
** of this file.
**
****************************************************************************/

#ifndef MLIST_H
#define MLIST_H

#include <QRectF>

#include "mwidgetcontroller.h"
#include <mlistmodel.h>

class QGraphicsSceneResizeEvent;
class MListPrivate;
class QItemSelectionModel;
class QAbstractItemModel;
class QModelIndex;
class MCellCreator;
class MListFilter;

class M_CORE_EXPORT MList : public MWidgetController
{
    Q_OBJECT
    M_CONTROLLER(MList)

    
    Q_PROPERTY(bool showGroups READ showGroups WRITE setShowGroups)

    Q_PROPERTY(int columns READ columns WRITE setColumns)

    Q_PROPERTY(SelectionMode selectionMode READ selectionMode WRITE setSelectionMode)

    friend class Ut_MList;
    friend class Pt_MList;

public:
    enum SelectionMode {
        NoSelection,
        SingleSelection,
        MultiSelection
    };

    enum ScrollHint {
        EnsureVisibleHint,
        PositionAtTopHint,
        PositionAtBottomHint,
        PositionAtCenterHint
    };

    enum DisplayMode {
        Hide = 0,
        Show,
        Auto,
        Floating
    };

    enum ListOptimizationFlag {
        DontCallCreateCellDuringUpdate = 0x1
    };
    Q_DECLARE_FLAGS(ListOptimizationFlags, ListOptimizationFlag)

    
    MList(QGraphicsItem *parent = 0);

    virtual ~MList();

    void setItemModel(QAbstractItemModel *itemModel);

    QAbstractItemModel *itemModel() const;

    void setCellCreator(MCellCreator *cellCreator);

    const MCellCreator *cellCreator() const;

    void setHeaderCreator(MCellCreator *cellCreator);

    const MCellCreator *headerCreator() const;

    void setColumns(int columns);
    int columns() const;

    QItemSelectionModel *selectionModel() const;

    void setSelectionModel(QItemSelectionModel *selectionModel);

    void setSelectionMode(MList::SelectionMode mode);

    MList::SelectionMode selectionMode() const;

    const QModelIndex firstVisibleItem() const;

    const QModelIndex lastVisibleItem() const;

    bool showGroups() const;

    void setShowGroups(bool showGroups);

    bool indexVisible();

    MListFilter *filtering() const;

    ListOptimizationFlags optimizationFlags() const;

    void setOptimizationFlag(ListOptimizationFlag optimizationFlag, bool enabled = true);

    void setOptimizationFlags(ListOptimizationFlags optimizationFlags);

public Q_SLOTS:
    void selectItem(const QModelIndex &index);

    void longTapItem(const QModelIndex &index);

    void longTapItem(const QModelIndex &index, const QPointF &position);

    void scrollTo(const QModelIndex &index);

    void scrollTo(const QModelIndex &index, ScrollHint hint);

    void setIndexVisible(bool visible);

    void setIndexDisplayMode(DisplayMode displayMode);

    DisplayMode indexDisplayMode() const;

Q_SIGNALS:
    void scrollToIndex(const QModelIndex &index);

    void selectionModelChanged(QItemSelectionModel *selectionModel);

    void itemClicked(const QModelIndex &index);

    void itemLongTapped(const QModelIndex &index);

    void itemLongTapped(const QModelIndex &index, const QPointF &position);

    void panningStarted();

    void panningStopped();

protected:
    MList(MListPrivate *dd, MListModel *model, QGraphicsItem *parent);

    virtual void updateData(const QList<const char *>& modifications);

    virtual void contextMenuEvent(QGraphicsSceneContextMenuEvent *event);

    virtual void keyPressEvent(QKeyEvent *event);

    virtual void connectNotify(const char *signal);

    virtual void disconnectNotify(const char *signal);

private:
    Q_DECLARE_PRIVATE(MList)
    Q_DISABLE_COPY(MList)
    friend class MListView;
};

Q_DECLARE_OPERATORS_FOR_FLAGS(MList::ListOptimizationFlags)

#endif