src/quick/items/qquicklistview_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the QtQml module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** GNU Lesser General Public License Usage
  10 ** This file may be used under the terms of the GNU Lesser General Public
  11 ** License version 2.1 as published by the Free Software Foundation and
  12 ** appearing in the file LICENSE.LGPL included in the packaging of this
  13 ** file. Please review the following information to ensure the GNU Lesser
  14 ** General Public License version 2.1 requirements will be met:
  15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  16 **
  17 ** In addition, as a special exception, Nokia gives you certain additional
  18 ** rights. These rights are described in the Nokia Qt LGPL Exception
  19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  20 **
  21 ** GNU General Public License Usage
  22 ** Alternatively, this file may be used under the terms of the GNU General
  23 ** Public License version 3.0 as published by the Free Software Foundation
  24 ** and appearing in the file LICENSE.GPL included in the packaging of this
  25 ** file. Please review the following information to ensure the GNU General
  26 ** Public License version 3.0 requirements will be met:
  27 ** http://www.gnu.org/copyleft/gpl.html.
  28 **
  29 ** Other Usage
  30 ** Alternatively, this file may be used in accordance with the terms and
  31 ** conditions contained in a signed written agreement between you and Nokia.
  32 **
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QQUICKLISTVIEW_P_H
  43 #define QQUICKLISTVIEW_P_H
  44
  45 #include "qquickitemview_p.h"
  46
  47 #include <private/qqmlguard_p.h>
  48
  49 QT_BEGIN_HEADER
  50
  51 QT_BEGIN_NAMESPACE
  52
  53 class QQuickListView;
  54 class QQuickListViewPrivate;
  55 class Q_AUTOTEST_EXPORT QQuickViewSection : public QObject
  56 {
  57     Q_OBJECT
  58     Q_PROPERTY(QString property READ property WRITE setProperty NOTIFY propertyChanged)
  59     Q_PROPERTY(SectionCriteria criteria READ criteria WRITE setCriteria NOTIFY criteriaChanged)
  60     Q_PROPERTY(QQmlComponent *delegate READ delegate WRITE setDelegate NOTIFY delegateChanged)
  61     Q_PROPERTY(int labelPositioning READ labelPositioning WRITE setLabelPositioning NOTIFY labelPositioningChanged)
  62     Q_ENUMS(SectionCriteria)
  63     Q_ENUMS(LabelPositioning)
  64 public:
  65     QQuickViewSection(QQuickListView *parent=0);
  66
  67     QString property() const { return m_property; }
  68     void setProperty(const QString &);
  69
  70     enum SectionCriteria { FullString, FirstCharacter };
  71     SectionCriteria criteria() const { return m_criteria; }
  72     void setCriteria(SectionCriteria);
  73
  74     QQmlComponent *delegate() const { return m_delegate; }
  75     void setDelegate(QQmlComponent *delegate);
  76
  77     QString sectionString(const QString &value);
  78
  79     enum LabelPositioning { InlineLabels = 0x01, CurrentLabelAtStart = 0x02, NextLabelAtEnd = 0x04 };
  80     int labelPositioning() { return m_labelPositioning; }
  81     void setLabelPositioning(int pos);
  82
  83 Q_SIGNALS:
  84     void propertyChanged();
  85     void criteriaChanged();
  86     void delegateChanged();
  87     void labelPositioningChanged();
  88
  89 private:
  90     QString m_property;
  91     SectionCriteria m_criteria;
  92     QQmlComponent *m_delegate;
  93     int m_labelPositioning;
  94     QQuickListViewPrivate *m_view;
  95 };
  96
  97
  98 class QQuickVisualModel;
  99 class QQuickListViewAttached;
 100 class Q_AUTOTEST_EXPORT QQuickListView : public QQuickItemView
 101 {
 102     Q_OBJECT
 103     Q_DECLARE_PRIVATE(QQuickListView)
 104
 105     // XXX deprecate these two properties (only duration should be necessary)
 106     Q_PROPERTY(qreal highlightMoveSpeed READ highlightMoveSpeed WRITE setHighlightMoveSpeed NOTIFY highlightMoveSpeedChanged)
 107     Q_PROPERTY(qreal highlightResizeSpeed READ highlightResizeSpeed WRITE setHighlightResizeSpeed NOTIFY highlightResizeSpeedChanged)
 108
 109     Q_PROPERTY(int highlightResizeDuration READ highlightResizeDuration WRITE setHighlightResizeDuration NOTIFY highlightResizeDurationChanged)
 110
 111     Q_PROPERTY(qreal spacing READ spacing WRITE setSpacing NOTIFY spacingChanged)
 112     Q_PROPERTY(Orientation orientation READ orientation WRITE setOrientation NOTIFY orientationChanged)
 113
 114     Q_PROPERTY(QQuickViewSection *section READ sectionCriteria CONSTANT)
 115     Q_PROPERTY(QString currentSection READ currentSection NOTIFY currentSectionChanged)
 116
 117     Q_PROPERTY(SnapMode snapMode READ snapMode WRITE setSnapMode NOTIFY snapModeChanged)
 118
 119     Q_ENUMS(Orientation)
 120     Q_ENUMS(SnapMode)
 121     Q_CLASSINFO("DefaultProperty", "data")
 122
 123 public:
 124     QQuickListView(QQuickItem *parent=0);
 125     ~QQuickListView();
 126
 127     qreal spacing() const;
 128     void setSpacing(qreal spacing);
 129
 130     enum Orientation { Horizontal = Qt::Horizontal, Vertical = Qt::Vertical };
 131     Orientation orientation() const;
 132     void setOrientation(Orientation);
 133
 134     QQuickViewSection *sectionCriteria();
 135     QString currentSection() const;
 136
 137     virtual void setHighlightFollowsCurrentItem(bool);
 138
 139     qreal highlightMoveSpeed() const;
 140     void setHighlightMoveSpeed(qreal);
 141
 142     qreal highlightResizeSpeed() const;
 143     void setHighlightResizeSpeed(qreal);
 144
 145     int highlightResizeDuration() const;
 146     void setHighlightResizeDuration(int);
 147
 148     virtual void setHighlightMoveDuration(int);
 149
 150     enum SnapMode { NoSnap, SnapToItem, SnapOneItem };
 151     SnapMode snapMode() const;
 152     void setSnapMode(SnapMode mode);
 153
 154     static QQuickListViewAttached *qmlAttachedProperties(QObject *);
 155
 156 public Q_SLOTS:
 157     void incrementCurrentIndex();
 158     void decrementCurrentIndex();
 159
 160 Q_SIGNALS:
 161     void spacingChanged();
 162     void orientationChanged();
 163     void currentSectionChanged();
 164     void highlightMoveSpeedChanged();
 165     void highlightResizeSpeedChanged();
 166     void highlightResizeDurationChanged();
 167     void snapModeChanged();
 168
 169 protected:
 170     virtual void viewportMoved(Qt::Orientations orient);
 171     virtual void keyPressEvent(QKeyEvent *);
 172     virtual void geometryChanged(const QRectF &newGeometry,const QRectF &oldGeometry);
 173     virtual void initItem(int index, QQuickItem *item);
 174
 175 protected Q_SLOTS:
 176     void updateSections();
 177 };
 178
 179 class QQuickListViewAttached : public QQuickItemViewAttached
 180 {
 181     Q_OBJECT
 182
 183 public:
 184     QQuickListViewAttached(QObject *parent)
 185         : QQuickItemViewAttached(parent), m_view(0), m_sectionItem(0) {}
 186     ~QQuickListViewAttached() {}
 187
 188     Q_PROPERTY(QQuickListView *view READ view NOTIFY viewChanged)
 189     QQuickListView *view() { return m_view; }
 190     void setView(QQuickListView *view) {
 191         if (view != m_view) {
 192             m_view = view;
 193             emit viewChanged();
 194         }
 195     }
 196
 197 Q_SIGNALS:
 198     void viewChanged();
 199
 200 public:
 201     QQmlGuard<QQuickListView> m_view;
 202     QQuickItem *m_sectionItem;
 203 };
 204
 205
 206 QT_END_NAMESPACE
 207
 208 QML_DECLARE_TYPEINFO(QQuickListView, QML_HAS_ATTACHED_PROPERTIES)
 209 QML_DECLARE_TYPE(QQuickListView)
 210 QML_DECLARE_TYPE(QQuickViewSection)
 211
 212 QT_END_HEADER
 213
 214 #endif // QQUICKLISTVIEW_P_H