Update copyright headers
[qt:qt.git] / demos / browser / modelmenu.h
1 /****************************************************************************
2 **
3 ** Copyright (C) 2015 The Qt Company Ltd.
4 ** Contact: http://www.qt.io/licensing/
5 **
6 ** This file is part of the demonstration applications of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and The Qt Company. For licensing terms
14 ** and conditions see http://www.qt.io/terms-conditions. For further
15 ** information use the contact form at http://www.qt.io/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 2.1 or version 3 as published by the Free
20 ** Software Foundation and appearing in the file LICENSE.LGPLv21 and
21 ** LICENSE.LGPLv3 included in the packaging of this file. Please review the
22 ** following information to ensure the GNU Lesser General Public License
23 ** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
24 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
25 **
26 ** As a special exception, The Qt Company gives you certain additional
27 ** rights. These rights are described in The Qt Company LGPL Exception
28 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
29 **
30 ** GNU General Public License Usage
31 ** Alternatively, this file may be used under the terms of the GNU
32 ** General Public License version 3.0 as published by the Free Software
33 ** Foundation and appearing in the file LICENSE.GPL included in the
34 ** packaging of this file.  Please review the following information to
35 ** ensure the GNU General Public License version 3.0 requirements will be
36 ** met: http://www.gnu.org/copyleft/gpl.html.
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41
42 #ifndef MODELMENU_H
43 #define MODELMENU_H
44
45 #include <QtGui/QMenu>
46 #include <QtCore/QAbstractItemModel>
47
48 // A QMenu that is dynamically populated from a QAbstractItemModel
49 class ModelMenu : public QMenu
50 {
51     Q_OBJECT
52
53 signals:
54     void activated(const QModelIndex &index);
55     void hovered(const QString &text);
56
57 public:
58     ModelMenu(QWidget *parent = 0);
59
60     void setModel(QAbstractItemModel *model);
61     QAbstractItemModel *model() const;
62
63     void setMaxRows(int max);
64     int maxRows() const;
65
66     void setFirstSeparator(int offset);
67     int firstSeparator() const;
68
69     void setRootIndex(const QModelIndex &index);
70     QModelIndex rootIndex() const;
71
72     void setHoverRole(int role);
73     int hoverRole() const;
74
75     void setSeparatorRole(int role);
76     int separatorRole() const;
77
78     QAction *makeAction(const QIcon &icon, const QString &text, QObject *parent);
79
80 protected:
81     // add any actions before the tree, return true if any actions are added.
82     virtual bool prePopulated();
83     // add any actions after the tree
84     virtual void postPopulated();
85     // put all of the children of parent into menu up to max
86     void createMenu(const QModelIndex &parent, int max, QMenu *parentMenu = 0, QMenu *menu = 0);
87
88 private slots:
89     void aboutToShow();
90     void triggered(QAction *action);
91     void hovered(QAction *action);
92
93 private:
94     QAction *makeAction(const QModelIndex &index);
95     int m_maxRows;
96     int m_firstSeparator;
97     int m_maxWidth;
98     int m_hoverRole;
99     int m_separatorRole;
100     QAbstractItemModel *m_model;
101     QPersistentModelIndex m_root;
102 };
103
104 #endif // MODELMENU_H
105