Cocoa implementation of QPA menu interface.
[profile/ivi/qtbase.git] / src / plugins / platforms / cocoa / qcocoamenuitem.h
1 /****************************************************************************
2 **
3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
4 ** Copyright (C) 2012 Klarälvdalens Datakonsult AB, a KDAB Group company, info@kdab.com, author James Turner <james.turner@kdab.com>
5 ** Contact: http://www.qt-project.org/
6 **
7 ** This file is part of the plugins of the Qt Toolkit.
8 **
9 ** $QT_BEGIN_LICENSE:LGPL$
10 ** GNU Lesser General Public License Usage
11 ** This file may be used under the terms of the GNU Lesser General Public
12 ** License version 2.1 as published by the Free Software Foundation and
13 ** appearing in the file LICENSE.LGPL included in the packaging of this
14 ** file. Please review the following information to ensure the GNU Lesser
15 ** General Public License version 2.1 requirements will be met:
16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
17 **
18 ** In addition, as a special exception, Nokia gives you certain additional
19 ** rights. These rights are described in the Nokia Qt LGPL Exception
20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
21 **
22 ** GNU General Public License Usage
23 ** Alternatively, this file may be used under the terms of the GNU General
24 ** Public License version 3.0 as published by the Free Software Foundation
25 ** and appearing in the file LICENSE.GPL included in the packaging of this
26 ** file. Please review the following information to ensure the GNU General
27 ** Public License version 3.0 requirements will be met:
28 ** http://www.gnu.org/copyleft/gpl.html.
29 **
30 ** Other Usage
31 ** Alternatively, this file may be used in accordance with the terms and
32 ** conditions contained in a signed written agreement between you and Nokia.
33 **
34 **
35 **
36 **
37 **
38 **
39 ** $QT_END_LICENSE$
40 **
41 ****************************************************************************/
42
43 #ifndef QCOCOAMENUITEM_H
44 #define QCOCOAMENUITEM_H
45
46 #include <qpa/qplatformmenu.h>
47 #include <QtGui/QImage>
48
49 //#define QT_COCOA_ENABLE_MENU_DEBUG
50
51 @class NSMenuItem;
52 @class NSMenu;
53
54 QT_BEGIN_HEADER
55
56 QT_BEGIN_NAMESPACE
57
58 class QCocoaMenu;
59
60 class QCocoaMenuItem : public QPlatformMenuItem
61 {
62 public:
63     QCocoaMenuItem();
64     virtual ~QCocoaMenuItem();
65
66     inline virtual void setTag(quintptr tag)
67         { m_tag = tag; }
68     inline virtual quintptr tag() const
69         { return m_tag; }
70
71     void setText(const QString &text);
72     void setIcon(const QImage &icon);
73     void setMenu(QPlatformMenu *menu);
74     void setVisible(bool isVisible);
75     void setIsSeparator(bool isSeparator);
76     void setFont(const QFont &font);
77     void setRole(MenuRole role);
78     void setShortcut(const QKeySequence& shortcut);
79     void setChecked(bool isChecked);
80     void setEnabled(bool isEnabled);
81
82     inline QString text() const { return m_text; }
83     inline NSMenuItem * nsItem() { return m_native; }
84     NSMenuItem *sync();
85
86     void syncMerged();
87     void syncModalState(bool modal);
88
89     inline bool isMerged() const { return m_merged; }
90     inline bool isEnabled() const { return m_enabled; }
91     inline bool isSeparator() const { return m_isSeparator; }
92
93     QCocoaMenu *menu() const { return m_menu; }
94 private:
95     QString mergeText();
96     QKeySequence mergeAccel();
97
98     NSMenuItem *m_native;
99     QString m_text;
100     QImage m_icon;
101     QCocoaMenu *m_menu;
102     bool m_isVisible;
103     bool m_enabled;
104     bool m_isSeparator;
105     QFont m_font;
106     MenuRole m_role;
107     QKeySequence m_shortcut;
108     bool m_checked;
109     bool m_merged;
110     quintptr m_tag;
111 };
112
113 QT_END_HEADER
114
115 QT_END_NAMESPACE
116
117 #endif