QContextMenuEvent Class Reference
^{[QtGui module]}

Detailed Description

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

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.

Context menu events contain a special accept flag that indicates whether the receiver accepted the event. If the event handler does not accept the event then, if possible, whatever triggered the event will be handled as a regular input event.

Member Type Documentation

enum QContextMenuEvent::Reason

This enum describes the reason why the event was sent.

Member Function Documentation

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

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.

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.

const QPoint & QContextMenuEvent::globalPos () const

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

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

int QContextMenuEvent::globalX () const

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

See also globalY() and globalPos().

int QContextMenuEvent::globalY () const

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

See also globalX() and globalPos().

const QPoint & QContextMenuEvent::pos () const

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

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

Reason QContextMenuEvent::reason () const

Returns the reason for this context event.

int QContextMenuEvent::x () const

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

See also y() and pos().

int QContextMenuEvent::y () const

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

See also x() and pos().

Member Function Documentation

QContextMenuEvent::QContextMenuEvent ( Reason reason, const QPoint & pos, const QPoint & globalPos, int dummy )

Constructs a context menu event with the given reason for the position specified by pos in widget coordinates and globalPos in global screen coordinates. dummy is ignored.

QContextMenuEvent::QContextMenuEvent ( Reason reason, const QPoint & pos, int dummy )

Constructs a context menu event with the given reason for the position specified by pos in widget coordinates. dummy is ignored.

Qt::ButtonState QContextMenuEvent::state () const

Returns the button state (a combination of mouse buttons and keyboard modifiers) immediately before the event was generated.

The returned value is a selection of the following values, combined with the OR operator: Qt::LeftButton, Qt::RightButton, Qt::MidButton, Qt::ShiftButton, Qt::ControlButton, and Qt::AltButton.