 |
Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
|
|
Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
|
The QContextMenuEvent class contains parameters that describe a context menu event. More...
#include <qevent.h>
Public Member Functions | |
| QContextMenuEvent (Reason reason, const QPoint &pos, const QPoint &globalPos, Qt::KeyboardModifiers modifiers=Qt::NoModifier) | |
| Constructs a context menu event object with the accept parameter flag set to false. | |
| int | x () const |
| Returns the x position of the mouse pointer, relative to the widget that received the event. | |
| int | y () const |
| Returns the y position of the mouse pointer, relative to the widget that received the event. | |
| int | globalX () const |
| Returns the global x position of the mouse pointer at the time of the event. | |
| int | globalY () const |
| Returns the global y position of the mouse pointer at the time of the event. | |
| const QPoint & | pos () const |
| Returns the position of the mouse pointer relative to the widget that received the event. | |
| const QPoint & | globalPos () const |
| Returns the global position of the mouse pointer at the time of the event. | |
| Reason | reason () const |
| Returns the reason for this context event. | |
| Public Member Functions inherited from QInputEvent | |
| QInputEvent (Type type, const QInputDevice *m_dev, Qt::KeyboardModifiers modifiers=Qt::NoModifier) | |
| const QInputDevice * | device () const |
| QInputDevice::DeviceType | deviceType () const |
| Returns the type of device that generated the event. | |
| Qt::KeyboardModifiers | modifiers () const |
| Returns the keyboard modifier flags that existed immediately before the event occurred. | |
| void | setModifiers (Qt::KeyboardModifiers modifiers) |
| quint64 | timestamp () const |
| Returns the window system's timestamp for this event. | |
| virtual void | setTimestamp (quint64 timestamp) |
| Public Member Functions inherited from QEvent | |
| QEvent (Type type) | |
| Constructs an event object of type type. | |
| virtual | ~QEvent () |
| Destroys the event. | |
| Type | type () const |
| Returns the event type. | |
| bool | spontaneous () const |
Returns true if the event originated outside the application (a system event); otherwise returns false. | |
| virtual void | setAccepted (bool accepted) |
| bool | isAccepted () const |
| void | accept () |
| Sets the accept flag of the event object, the equivalent of calling setAccepted(true). | |
| void | ignore () |
| Clears the accept flag parameter of the event object, the equivalent of calling setAccepted(false). | |
| bool | isInputEvent () const noexcept |
| bool | isPointerEvent () const noexcept |
| bool | isSinglePointEvent () const noexcept |
| virtual QEvent * | clone () const |
| Creates and returns an identical copy of this event. | |
Protected Attributes | |
| QPoint | m_pos |
| QPoint | m_globalPos |
| uint | m_reason: 8 |
| Protected Attributes inherited from QInputEvent | |
| const QInputDevice * | m_dev = nullptr |
| quint64 | m_timeStamp = 0 |
| Qt::KeyboardModifiers | m_modState = Qt::NoModifier |
| quint32 | m_reserved = 0 |
| Protected Attributes inherited from QEvent | |
| quint16 | t |
Additional Inherited Members | |
| Static Public Member Functions inherited from QEvent | |
| static int | registerEventType (int hint=-1) noexcept |
| Protected Member Functions inherited from QInputEvent | |
| QInputEvent (Type type, PointerEventTag, const QInputDevice *dev, Qt::KeyboardModifiers modifiers=Qt::NoModifier) | |
| QInputEvent (Type type, SinglePointEventTag, const QInputDevice *dev, Qt::KeyboardModifiers modifiers=Qt::NoModifier) | |
| Protected Member Functions inherited from QEvent | |
| QT_DEFINE_TAG_STRUCT (InputEventTag) | |
| QEvent (Type type, InputEventTag) | |
| QT_DEFINE_TAG_STRUCT (PointerEventTag) | |
| QEvent (Type type, PointerEventTag) | |
| QT_DEFINE_TAG_STRUCT (SinglePointEventTag) | |
| QEvent (Type type, SinglePointEventTag) | |
The QContextMenuEvent class contains parameters that describe a context menu event.
\inmodule QtGui
A context menu event is sent when a user performs an action that should open a contextual menu: \list
The expected context menu should contain \l {QAction}{actions} that are relevant to some content within the application (the "context"). In Qt, the context is at least the particular \l {QWidget}{widget} or Qt Quick \l Item that receives the QContextMenuEvent. If there is a selection, that should probably be treated as the context. The context can be further refined using \l QContextMenuEvent::pos() to pinpoint the content within the widget, item or selection.
Widgets can override \l QWidget::contextMenuEvent() to handle this event. Many widgets already do that, and have useful context menus by default. Some widgets have a function such as \l {QLineEdit::createStandardContextMenu()}{createStandardContextMenu()} to populate the default set of actions into a \l QMenu, which can be customized further in your subclass and then shown.
In Qt Quick, the event can be handled via the \l {QtQuick.Controls::}{ContextMenu} attached property. Some \l {QtQuick.Controls} Controls already provide context menus by default.
Unlike most synthetic events (such as a QMouseEvent that is sent only after a QTouchEvent or QTabletEvent was not accepted), QContextMenuEvent is sent regardless of whether the original mouse or key event was already handled and \l {QEvent::isAccepted()}{accepted}. This is to accommodate the Windows UI pattern of selecting some kind of items (icons, drawing elements, or cells in an Item View) using the right mouse button (clicking or dragging), and then getting a context menu as soon as you release the right mouse button. (The actions on the menu are meant to apply to the selection.) Therefore, on Windows the QContextMenuEvent is sent on mouse release; while on other platforms, it's sent on press. Qt follows the \l {QStyleHints::contextMenuTrigger()}{platform convention} by default.
There are also some Qt Quick Controls such as \l {QtQuick.Controls::}{Pane} that accept mouse events, and nevertheless receive a QContextMenuEvent after a mouse press or click.
If you prefer to support the press-drag-release UI pattern to open a context menu on press, and drag over a menu item to select it on release, you will need to do that by handling \l {QMouseEvent}{QMouseEvents} directly (by overriding \l {QWidget::mousePressEvent()}{virtual functions} in QWidget subclasses, or using \l TapHandler to open a \l Menu in Qt Quick); and then the QContextMenuEvent will be redundant when the \l reason() is Mouse. You should \l ignore() the event in that case; but you should still ensure that the widget, custom control or application can respond to a QContextMenuEvent that \l {reason()}{comes from} the platform-specific keyboard shortcut.
When a QContextMenuEvent is \l {ignore()}{ignored}, Qt attempts to deliver it to other widgets and/or Items under the \l {pos()}{position} (which is usually translated from the cursor position).
This enum describes the reason why the event was sent.
\value Mouse The mouse caused the event to be sent. Normally this means the right mouse button was clicked, but this is platform dependent.
\value Keyboard The keyboard caused this event to be sent. On Windows, this means the menu button was pressed.
\value Other The event was sent by some other means (i.e. not by the mouse or keyboard).
| Enumerator | |
|---|---|
| Mouse | |
| Keyboard | |
| Other | |
| QContextMenuEvent::QContextMenuEvent | ( | Reason | reason, |
| const QPoint & | pos, | ||
| const QPoint & | globalPos, | ||
| Qt::KeyboardModifiers | modifiers = Qt::NoModifier ) |
Constructs a context menu event object with the accept parameter flag set to false.
The reason parameter must be QContextMenuEvent::Mouse or QContextMenuEvent::Keyboard.
The pos parameter specifies the mouse position relative to the receiving widget. globalPos is the mouse position in absolute coordinates. The modifiers holds the keyboard modifiers.
Definition at line 2059 of file qevent.cpp.
|
inline |
|
inline |
Returns the global x position of the mouse pointer at the time of the event.
|
inline |
Returns the global y position of the mouse pointer at the time of the event.
|
inline |
Returns the position of the mouse pointer relative to the widget that received the event.
pos() may be \l {QPoint::isNull()}{null}.
|
inline |
|
inline |
|
inline |
1.14.0