You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
tqtinterface/qtinterface/qt4/Qt/qmenu.h

428 lines
15 KiB

/****************************************************************************
**
** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the QtGui module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial Usage
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Nokia.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used 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. Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
** $QT_END_LICENSE$
**
****************************************************************************/
#ifndef QMENU_H
#define QMENU_H
#include <QtGui/qwidget.h>
#include <QtCore/qstring.h>
#include <QtGui/qicon.h>
#include <QtGui/qaction.h>
#ifdef QT3_SUPPORT
#include <QtGui/qpixmap.h>
#endif
QT_BEGIN_HEADER
QT_BEGIN_NAMESPACE
QT_MODULE(Gui)
#ifndef QT_NO_MENU
class QMenuPrivate;
class QStyleOptionMenuItem;
#ifdef QT3_SUPPORT
class QMenuItem;
#endif
class Q_GUI_EXPORT QMenu : public QWidget
{
private:
Q_OBJECT
Q_DECLARE_PRIVATE(QMenu)
Q_PROPERTY(bool tearOffEnabled READ isTearOffEnabled WRITE setTearOffEnabled)
Q_PROPERTY(QString title READ title WRITE setTitle)
Q_PROPERTY(QIcon icon READ icon WRITE setIcon)
Q_PROPERTY(bool separatorsCollapsible READ separatorsCollapsible WRITE setSeparatorsCollapsible)
public:
explicit QMenu(QWidget *parent = 0);
explicit QMenu(const QString &title, QWidget *parent = 0);
~QMenu();
#ifdef Q_NO_USING_KEYWORD
inline void addAction(QAction *action) { QWidget::addAction(action); }
#else
using QWidget::addAction;
#endif
QAction *addAction(const QString &text);
QAction *addAction(const QIcon &icon, const QString &text);
QAction *addAction(const QString &text, const QObject *receiver, const char* member, const QKeySequence &shortcut = 0);
QAction *addAction(const QIcon &icon, const QString &text, const QObject *receiver, const char* member, const QKeySequence &shortcut = 0);
QAction *addMenu(QMenu *menu);
QMenu *addMenu(const QString &title);
QMenu *addMenu(const QIcon &icon, const QString &title);
QAction *addSeparator();
QAction *insertMenu(QAction *before, QMenu *menu);
QAction *insertSeparator(QAction *before);
bool isEmpty() const;
void clear();
void setTearOffEnabled(bool);
bool isTearOffEnabled() const;
bool isTearOffMenuVisible() const;
void hideTearOffMenu();
void setDefaultAction(QAction *);
QAction *defaultAction() const;
void setActiveAction(QAction *act);
QAction *activeAction() const;
void popup(const QPoint &pos, QAction *at=0);
QAction *exec();
QAction *exec(const QPoint &pos, QAction *at=0);
// ### Qt 5: merge
static QAction *exec(QList<QAction*> actions, const QPoint &pos, QAction *at=0);
static QAction *exec(QList<QAction*> actions, const QPoint &pos, QAction *at, QWidget *parent);
QSize sizeHint() const;
QRect actionGeometry(QAction *) const;
QAction *actionAt(const QPoint &) const;
QAction *menuAction() const;
QString title() const;
void setTitle(const QString &title);
QIcon icon() const;
void setIcon(const QIcon &icon);
void setNoReplayFor(QWidget *widget);
#ifdef Q_WS_MAC
OSMenuRef macMenu(OSMenuRef merge=0);
#endif
#ifdef Q_WS_WINCE
HMENU wceMenu(bool create = false);
#endif
bool separatorsCollapsible() const;
void setSeparatorsCollapsible(bool collapse);
Q_SIGNALS:
void aboutToShow();
void aboutToHide();
void triggered(QAction *action);
void hovered(QAction *action);
protected:
int columnCount() const;
void changeEvent(QEvent *);
void keyPressEvent(QKeyEvent *);
void mouseReleaseEvent(QMouseEvent *);
void mousePressEvent(QMouseEvent *);
void mouseMoveEvent(QMouseEvent *);
void wheelEvent(QWheelEvent *);
void enterEvent(QEvent *);
void leaveEvent(QEvent *);
void hideEvent(QHideEvent *);
void paintEvent(QPaintEvent *);
void actionEvent(QActionEvent *);
void timerEvent(QTimerEvent *);
bool event(QEvent *);
bool focusNextPrevChild(bool next);
void initStyleOption(QStyleOptionMenuItem *option, const QAction *action) const;
#ifdef Q_WS_WINCE
QAction* wceCommands(uint command);
#endif
private Q_SLOTS:
void internalSetSloppyAction();
void internalDelayedPopup();
private:
Q_PRIVATE_SLOT(d_func(), void _q_actionTriggered())
Q_PRIVATE_SLOT(d_func(), void _q_actionHovered())
Q_PRIVATE_SLOT(d_func(), void _q_overrideMenuActionDestroyed())
#ifdef QT3_SUPPORT
public:
//menudata
inline QT3_SUPPORT uint count() const { return actions().count(); }
inline QT3_SUPPORT int insertItem(const QString &text, const QObject *receiver, const char* member,
const QKeySequence& shortcut = 0, int id = -1, int index = -1) {
return insertAny(0, &text, receiver, member, &shortcut, 0, id, index);
}
inline QT3_SUPPORT int insertItem(const QIcon& icon, const QString &text,
const QObject *receiver, const char* member,
const QKeySequence& shortcut = 0, int id = -1, int index = -1) {
return insertAny(&icon, &text, receiver, member, &shortcut, 0, id, index);
}
inline QT3_SUPPORT int insertItem(const QPixmap &pixmap, const QObject *receiver, const char* member,
const QKeySequence& shortcut = 0, int id = -1, int index = -1) {
QIcon icon(pixmap);
return insertAny(&icon, 0, receiver, member, &shortcut, 0, id, index);
}
inline QT3_SUPPORT int insertItem(const QString &text, int id=-1, int index=-1) {
return insertAny(0, &text, 0, 0, 0, 0, id, index);
}
inline QT3_SUPPORT int insertItem(const QIcon& icon, const QString &text, int id=-1, int index=-1) {
return insertAny(&icon, &text, 0, 0, 0, 0, id, index);
}
inline QT3_SUPPORT int insertItem(const QString &text, QMenu *popup, int id=-1, int index=-1) {
return insertAny(0, &text, 0, 0, 0, popup, id, index);
}
inline QT3_SUPPORT int insertItem(const QIcon& icon, const QString &text, QMenu *popup, int id=-1, int index=-1) {
return insertAny(&icon, &text, 0, 0, 0, popup, id, index);
}
inline QT3_SUPPORT int insertItem(const QPixmap &pixmap, int id=-1, int index=-1) {
QIcon icon(pixmap);
return insertAny(&icon, 0, 0, 0, 0, 0, id, index);
}
inline QT3_SUPPORT int insertItem(const QPixmap &pixmap, QMenu *popup, int id=-1, int index=-1) {
QIcon icon(pixmap);
return insertAny(&icon, 0, 0, 0, 0, popup, id, index);
}
QT3_SUPPORT int insertItem(QMenuItem *item, int id=-1, int index=-1);
QT3_SUPPORT int insertSeparator(int index=-1);
inline QT3_SUPPORT void removeItem(int id) {
if(QAction *act = findActionForId(id))
removeAction(act); }
inline QT3_SUPPORT void removeItemAt(int index) {
if(QAction *act = actions().value(index))
removeAction(act); }
#ifndef QT_NO_SHORTCUT
inline QT3_SUPPORT QKeySequence accel(int id) const {
if(QAction *act = findActionForId(id))
return act->shortcut();
return QKeySequence(); }
inline QT3_SUPPORT void setAccel(const QKeySequence& key, int id) {
if(QAction *act = findActionForId(id))
act->setShortcut(key);
}
#endif
inline QT3_SUPPORT QIcon iconSet(int id) const {
if(QAction *act = findActionForId(id))
return act->icon();
return QIcon(); }
inline QT3_SUPPORT QString text(int id) const {
if(QAction *act = findActionForId(id))
return act->text();
return QString(); }
inline QT3_SUPPORT QPixmap pixmap(int id) const {
if(QAction *act = findActionForId(id))
return act->icon().pixmap(QSize(22, 22));
return QPixmap(); }
inline QT3_SUPPORT void setWhatsThis(int id, const QString &w) {
if(QAction *act = findActionForId(id))
act->setWhatsThis(w); }
inline QT3_SUPPORT QString whatsThis(int id) const {
if(QAction *act = findActionForId(id))
return act->whatsThis();
return QString(); }
inline QT3_SUPPORT void changeItem(int id, const QString &text) {
if(QAction *act = findActionForId(id))
act->setText(text); }
inline QT3_SUPPORT void changeItem(int id, const QPixmap &pixmap) {
if(QAction *act = findActionForId(id))
act->setIcon(QIcon(pixmap)); }
inline QT3_SUPPORT void changeItem(int id, const QIcon &icon, const QString &text) {
if(QAction *act = findActionForId(id)) {
act->setIcon(icon);
act->setText(text);
}
}
inline QT3_SUPPORT void setActiveItem(int id) {
setActiveAction(findActionForId(id));
}
inline QT3_SUPPORT bool isItemActive(int id) const {
return findActionForId(id) == activeAction();
}
inline QT3_SUPPORT bool isItemEnabled(int id) const {
if(QAction *act = findActionForId(id))
return act->isEnabled();
return false; }
inline QT3_SUPPORT void setItemEnabled(int id, bool enable) {
if(QAction *act = findActionForId(id))
act->setEnabled(enable);
}
inline QT3_SUPPORT bool isItemChecked(int id) const {
if(QAction *act = findActionForId(id))
return act->isChecked();
return false;
}
inline QT3_SUPPORT void setItemChecked(int id, bool check) {
if(QAction *act = findActionForId(id)) {
act->setCheckable(true);
act->setChecked(check);
}
}
inline QT3_SUPPORT bool isItemVisible(int id) const {
if(QAction *act = findActionForId(id))
return act->isVisible();
return false;
}
inline QT3_SUPPORT void setItemVisible(int id, bool visible) {
if(QAction *act = findActionForId(id))
act->setVisible(visible);
}
inline QT3_SUPPORT QRect itemGeometry(int index) {
if(QAction *act = actions().value(index))
return actionGeometry(act);
return QRect();
}
inline QT3_SUPPORT QFont itemFont(int id) const {
if(QAction *act = findActionForId(id))
return act->font();
return QFont();
}
inline QT3_SUPPORT void setItemFont(int id, const QFont &font) {
if(QAction *act = findActionForId(id))
act->setFont(font);
}
inline QT3_SUPPORT int indexOf(int id) const {
return actions().indexOf(findActionForId(id));
}
inline QT3_SUPPORT int idAt(int index) const {
return findIdForAction(actions().value(index));
}
QT3_SUPPORT void setId (int index, int id);
inline QT3_SUPPORT void activateItemAt(int index) {
if(QAction *ret = actions().value(index))
ret->activate(QAction::Trigger);
}
inline QT3_SUPPORT bool connectItem(int id, const QObject *receiver, const char* member) {
if(QAction *act = findActionForId(id)) {
QObject::connect(act, SIGNAL(activated(int)), receiver, member);
return true;
}
return false;
}
inline QT3_SUPPORT bool disconnectItem(int id,const QObject *receiver, const char* member) {
if(QAction *act = findActionForId(id)) {
QObject::disconnect(act, SIGNAL(triggered()), receiver, member);
return true;
}
return false;
}
inline QT3_SUPPORT QMenuItem *findItem(int id) const {
return reinterpret_cast<QMenuItem*>(findActionForId(id));
}
inline QT3_SUPPORT void setCheckable(bool){}
inline QT3_SUPPORT bool isCheckable() const {return true;}
QT3_SUPPORT QMenuItem *findPopup( QMenu *popup, int *index );
QT3_SUPPORT bool setItemParameter(int id, int param);
QT3_SUPPORT int itemParameter(int id) const;
//frame
QT3_SUPPORT int frameWidth() const;
//popupmenu
inline QT3_SUPPORT void popup(const QPoint & pos, int indexAtPoint) { popup(pos, actions().value(indexAtPoint)); }
inline QT3_SUPPORT int insertTearOffHandle(int = 0, int = 0) {
setTearOffEnabled(true);
return -1;
}
protected:
inline QT3_SUPPORT int itemAtPos(const QPoint &p, bool ignoreSeparator = true) {
QAction *ret = actionAt(p);
if(ignoreSeparator && ret && ret->isSeparator())
return -1;
return findIdForAction(ret);
}
inline QT3_SUPPORT int columns() const { return columnCount(); }
inline QT3_SUPPORT int itemHeight(int index) {
return actionGeometry(actions().value(index)).height();
}
inline QT3_SUPPORT int itemHeight(QMenuItem *mi) {
return actionGeometry(reinterpret_cast<QAction *>(mi)).height();
}
Q_SIGNALS:
QT_MOC_COMPAT void activated(int itemId);
QT_MOC_COMPAT void highlighted(int itemId);
private:
int insertAny(const QIcon *icon, const QString *text, const QObject *receiver, const char *member,
const QKeySequence *shorcut, const QMenu *popup, int id, int index);
QAction *findActionForId(int id) const;
int findIdForAction(QAction*) const;
#endif
protected:
QMenu(QMenuPrivate &dd, QWidget* parent = 0);
private:
Q_DISABLE_COPY(QMenu)
friend class QMenuBar;
friend class QMenuBarPrivate;
friend class QTornOffMenu;
friend class Q3PopupMenu;
friend class QComboBox;
friend class QAction;
friend class QToolButtonPrivate;
#ifdef Q_WS_MAC
friend void qt_mac_trayicon_activate_action(QMenu *, QAction *action);
friend bool qt_mac_watchingAboutToShow(QMenu *);
friend OSStatus qt_mac_menu_event(EventHandlerCallRef, EventRef, void *);
friend bool qt_mac_activate_action(OSMenuRef, uint, QAction::ActionEvent, bool);
friend void qt_mac_emit_menuSignals(QMenu *, bool);
#endif
};
#endif // QT_NO_MENU
QT_END_NAMESPACE
QT_END_HEADER
#endif // QMENU_H