QtBase  v6.3.1
Public Types | Public Member Functions | Protected Attributes | List of all members
QContextMenuEvent Class Reference

The QContextMenuEvent class contains parameters that describe a context menu event. \inmodule QtGui. More...

#include <qevent.h>

Inheritance diagram for QContextMenuEvent:
Inheritance graph
[legend]
Collaboration diagram for QContextMenuEvent:
Collaboration graph
[legend]

Public Types

enum  Reason { Mouse , Keyboard , Other }
 
- Public Types inherited from QEvent
enum  Type {
  None = 0 , Timer = 1 , MouseButtonPress = 2 , MouseButtonRelease = 3 ,
  MouseButtonDblClick = 4 , MouseMove = 5 , KeyPress = 6 , KeyRelease = 7 ,
  FocusIn = 8 , FocusOut = 9 , FocusAboutToChange = 23 , Enter = 10 ,
  Leave = 11 , Paint = 12 , Move = 13 , Resize = 14 ,
  Create = 15 , Destroy = 16 , Show = 17 , Hide = 18 ,
  Close = 19 , Quit = 20 , ParentChange = 21 , ParentAboutToChange = 131 ,
  ThreadChange = 22 , WindowActivate = 24 , WindowDeactivate = 25 , ShowToParent = 26 ,
  HideToParent = 27 , Wheel = 31 , WindowTitleChange = 33 , WindowIconChange = 34 ,
  ApplicationWindowIconChange = 35 , ApplicationFontChange = 36 , ApplicationLayoutDirectionChange = 37 , ApplicationPaletteChange = 38 ,
  PaletteChange = 39 , Clipboard = 40 , Speech = 42 , MetaCall = 43 ,
  SockAct = 50 , WinEventAct = 132 , DeferredDelete = 52 , DragEnter = 60 ,
  DragMove = 61 , DragLeave = 62 , Drop = 63 , DragResponse = 64 ,
  ChildAdded = 68 , ChildPolished = 69 , ChildRemoved = 71 , ShowWindowRequest = 73 ,
  PolishRequest = 74 , Polish = 75 , LayoutRequest = 76 , UpdateRequest = 77 ,
  UpdateLater = 78 , EmbeddingControl = 79 , ActivateControl = 80 , DeactivateControl = 81 ,
  ContextMenu = 82 , InputMethod = 83 , TabletMove = 87 , LocaleChange = 88 ,
  LanguageChange = 89 , LayoutDirectionChange = 90 , Style = 91 , TabletPress = 92 ,
  TabletRelease = 93 , OkRequest = 94 , HelpRequest = 95 , IconDrag = 96 ,
  FontChange = 97 , EnabledChange = 98 , ActivationChange = 99 , StyleChange = 100 ,
  IconTextChange = 101 , ModifiedChange = 102 , MouseTrackingChange = 109 , WindowBlocked = 103 ,
  WindowUnblocked = 104 , WindowStateChange = 105 , ReadOnlyChange = 106 , ToolTip = 110 ,
  WhatsThis = 111 , StatusTip = 112 , ActionChanged = 113 , ActionAdded = 114 ,
  ActionRemoved = 115 , FileOpen = 116 , Shortcut = 117 , ShortcutOverride = 51 ,
  WhatsThisClicked = 118 , ToolBarChange = 120 , ApplicationActivate = 121 , ApplicationActivated = ApplicationActivate ,
  ApplicationDeactivate = 122 , ApplicationDeactivated = ApplicationDeactivate , QueryWhatsThis = 123 , EnterWhatsThisMode = 124 ,
  LeaveWhatsThisMode = 125 , ZOrderChange = 126 , HoverEnter = 127 , HoverLeave = 128 ,
  HoverMove = 129 , AcceptDropsChange = 152 , ZeroTimerEvent = 154 , GraphicsSceneMouseMove = 155 ,
  GraphicsSceneMousePress = 156 , GraphicsSceneMouseRelease = 157 , GraphicsSceneMouseDoubleClick = 158 , GraphicsSceneContextMenu = 159 ,
  GraphicsSceneHoverEnter = 160 , GraphicsSceneHoverMove = 161 , GraphicsSceneHoverLeave = 162 , GraphicsSceneHelp = 163 ,
  GraphicsSceneDragEnter = 164 , GraphicsSceneDragMove = 165 , GraphicsSceneDragLeave = 166 , GraphicsSceneDrop = 167 ,
  GraphicsSceneWheel = 168 , GraphicsSceneLeave = 220 , KeyboardLayoutChange = 169 , DynamicPropertyChange = 170 ,
  TabletEnterProximity = 171 , TabletLeaveProximity = 172 , NonClientAreaMouseMove = 173 , NonClientAreaMouseButtonPress = 174 ,
  NonClientAreaMouseButtonRelease = 175 , NonClientAreaMouseButtonDblClick = 176 , MacSizeChange = 177 , ContentsRectChange = 178 ,
  MacGLWindowChange = 179 , FutureCallOut = 180 , GraphicsSceneResize = 181 , GraphicsSceneMove = 182 ,
  CursorChange = 183 , ToolTipChange = 184 , NetworkReplyUpdated = 185 , GrabMouse = 186 ,
  UngrabMouse = 187 , GrabKeyboard = 188 , UngrabKeyboard = 189 , StateMachineSignal = 192 ,
  StateMachineWrapped = 193 , TouchBegin = 194 , TouchUpdate = 195 , TouchEnd = 196 ,
  NativeGesture = 197 , RequestSoftwareInputPanel = 199 , CloseSoftwareInputPanel = 200 , WinIdChange = 203 ,
  Gesture = 198 , GestureOverride = 202 , ScrollPrepare = 204 , Scroll = 205 ,
  Expose = 206 , InputMethodQuery = 207 , OrientationChange = 208 , TouchCancel = 209 ,
  ThemeChange = 210 , SockClose = 211 , PlatformPanel = 212 , StyleAnimationUpdate = 213 ,
  ApplicationStateChange = 214 , WindowChangeInternal = 215 , ScreenChangeInternal = 216 , PlatformSurface = 217 ,
  Pointer = 218 , TabletTrackingChange = 219 , User = 1000 , MaxUser = 65535
}
 

Public Member Functions

 QContextMenuEvent (Reason reason, const QPoint &pos, const QPoint &globalPos, Qt::KeyboardModifiers modifiers=Qt::NoModifier)
 
 QContextMenuEvent (Reason reason, const QPoint &pos)
 
 ~QContextMenuEvent ()
 
QContextMenuEventclone () const override
 
int x () const
 
int y () const
 
int globalX () const
 
int globalY () const
 
const QPointpos () const
 
const QPointglobalPos () const
 
Reason reason () const
 
- Public Member Functions inherited from QInputEvent
 QInputEvent (Type type, const QInputDevice *m_dev, Qt::KeyboardModifiers modifiers=Qt::NoModifier)
 
 ~QInputEvent ()
 
const QInputDevicedevice () const
 
QInputDevice::DeviceType deviceType () const
 
Qt::KeyboardModifiers modifiers () const
 
void setModifiers (Qt::KeyboardModifiers modifiers)
 
quint64 timestamp () const
 
virtual void setTimestamp (quint64 timestamp)
 
- Public Member Functions inherited from QEvent
 QEvent (Type type)
 
virtual ~QEvent ()
 
Type type () const
 
bool spontaneous () const
 
virtual void setAccepted (bool accepted)
 
bool isAccepted () const
 
void accept ()
 
void ignore ()
 
bool isInputEvent () const noexcept
 
bool isPointerEvent () const noexcept
 
bool isSinglePointEvent () const noexcept
 

Protected Attributes

QPoint m_pos
 
QPoint m_globalPos
 
uint m_reason: 8
 
- Protected Attributes inherited from QInputEvent
const QInputDevicem_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
 QEvent (Type type, InputEventTag)
 
 QEvent (Type type, PointerEventTag)
 
 QEvent (Type type, SinglePointEventTag)
 

Detailed Description

The QContextMenuEvent class contains parameters that describe a context menu event. \inmodule QtGui.

Context menu events are sent to widgets when a user performs an action associated with opening a context menu. The actions required to open context menus vary between platforms; for example, on Windows, pressing the menu button or clicking the right mouse button will cause this event to be sent.

When this event occurs it is customary to show a QMenu with a context menu, if this is relevant to the context.

Definition at line 664 of file qevent.h.

Member Enumeration Documentation

◆ Reason

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 

Definition at line 668 of file qevent.h.

Constructor & Destructor Documentation

◆ QContextMenuEvent() [1/2]

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 2007 of file qevent.cpp.

◆ QContextMenuEvent() [2/2]

QContextMenuEvent::QContextMenuEvent ( Reason  reason,
const QPoint pos 
)

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.

The globalPos() is initialized to QCursor::pos(), which may not be appropriate. Use the other constructor to specify the global position explicitly.

Definition at line 2031 of file qevent.cpp.

Here is the call graph for this function:

◆ ~QContextMenuEvent()

QContextMenuEvent::~QContextMenuEvent ( )

Definition at line 2014 of file qevent.cpp.

Member Function Documentation

◆ clone()

QContextMenuEvent* QContextMenuEvent::clone ( ) const
inlineoverridevirtual

Creates and returns an identical copy of this event.

Since
6.0

Reimplemented from QInputEvent.

Definition at line 675 of file qevent.h.

◆ globalPos()

const QPoint & QContextMenuEvent::globalPos ( ) const
inline

Returns the global position of the mouse pointer at the time of the event.

See also
x(), y(), pos()

Definition at line 683 of file qevent.h.

Here is the caller graph for this function:

◆ globalX()

int QContextMenuEvent::globalX ( ) const
inline

Returns the global x position of the mouse pointer at the time of the event.

See also
globalY(), globalPos()

Definition at line 679 of file qevent.h.

◆ globalY()

int QContextMenuEvent::globalY ( ) const
inline

Returns the global y position of the mouse pointer at the time of the event.

See also
globalX(), globalPos()

Definition at line 680 of file qevent.h.

◆ pos()

const QPoint & QContextMenuEvent::pos ( ) const
inline

Returns the position of the mouse pointer relative to the widget that received the event.

See also
x(), y(), globalPos()

Definition at line 682 of file qevent.h.

Here is the caller graph for this function:

◆ reason()

QContextMenuEvent::Reason QContextMenuEvent::reason ( ) const
inline

Returns the reason for this context event.

Definition at line 685 of file qevent.h.

Here is the caller graph for this function:

◆ x()

int QContextMenuEvent::x ( ) const
inline

Returns the x position of the mouse pointer, relative to the widget that received the event.

See also
y(), pos()

Definition at line 677 of file qevent.h.

◆ y()

int QContextMenuEvent::y ( ) const
inline

Returns the y position of the mouse pointer, relative to the widget that received the event.

See also
x(), pos()

Definition at line 678 of file qevent.h.

Member Data Documentation

◆ m_globalPos

QPoint QContextMenuEvent::m_globalPos
protected

Definition at line 689 of file qevent.h.

◆ m_pos

QPoint QContextMenuEvent::m_pos
protected

Definition at line 688 of file qevent.h.

◆ m_reason

uint QContextMenuEvent::m_reason
protected

Definition at line 690 of file qevent.h.


The documentation for this class was generated from the following files: