QGraphicsSceneContextMenuEvent Class Reference

The QGraphicsSceneContextMenuEvent class provides context menu events in the graphics view framework. More...

#include <qgraphicssceneevent.h>

Inheritance diagram for QGraphicsSceneContextMenuEvent:

Public Types
enum	Reason { Mouse, Keyboard, Other }
	This enum describes the reason why the context event was sent. More...
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, 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, AccessibilityPrepare = 86, 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, 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,   AccessibilityHelp = 119, AccessibilityDescription = 130, AcceptDropsChange = 152, MenubarUpdated = 153,   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, 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,   MacGLClearDrawable = 191, StateMachineSignal = 192, StateMachineWrapped = 193, TouchBegin = 194,   TouchUpdate = 195, TouchEnd = 196, NativeGesture = 197, RequestSoftwareInputPanel = 199,   CloseSoftwareInputPanel = 200, UpdateSoftKeys = 201, WinIdChange = 203, Gesture = 198,   GestureOverride = 202, PlatformPanel = 212, User = 1000, MaxUser = 65535 }
	This enum type defines the valid event types in Qt. More...

Public Functions
Qt::KeyboardModifiers	modifiers () const
	Returns the keyboard modifiers in use when the context menu was requested. More...
QPointF	pos () const
	Returns the position of the mouse cursor in item coordinates at the moment the context menu was requested. More...
	QGraphicsSceneContextMenuEvent (Type type=None)
	Constructs a graphics scene context menu event of the specified type. More...
Reason	reason () const
	Returns the reason for the context menu event. More...
QPointF	scenePos () const
	Returns the position of the mouse cursor in scene coordinates at the moment the the context menu was requested. More...
QPoint	screenPos () const
	Returns the position of the mouse cursor in screen coordinates at the moment the the context menu was requested. More...
void	setModifiers (Qt::KeyboardModifiers modifiers)
	Sets the keyboard modifiers associated with the context menu to the modifiers specified. More...
void	setPos (const QPointF &pos)
	Sets the position associated with the context menu to the given point in item coordinates. More...
void	setReason (Reason reason)
	Sets the reason for the context menu event to reason. More...
void	setScenePos (const QPointF &pos)
	Sets the position associated with the context menu to the given point in scene coordinates. More...
void	setScreenPos (const QPoint &pos)
	Sets the position associated with the context menu to the given point in screen coordinates. More...
	~QGraphicsSceneContextMenuEvent ()
	Destroys the event. More...
Public Functions inherited from QGraphicsSceneEvent
	QGraphicsSceneEvent (Type type)
	Constructs a generic graphics scene event of the specified type. More...
void	setWidget (QWidget *widget)
	Sets the widget related to this event. More...
QWidget *	widget () const
	Returns the widget where the event originated, or 0 if the event originates from another application. More...
	~QGraphicsSceneEvent ()
	Destroys the event. More...
Public Functions inherited from QEvent
void	accept ()
	Sets the accept flag of the event object, the equivalent of calling setAccepted(true). More...
void	ignore ()
	Clears the accept flag parameter of the event object, the equivalent of calling setAccepted(false). More...
bool	isAccepted () const
	QEvent (Type type)
	Contructs an event object of type type. More...
void	setAccepted (bool accepted)
bool	spontaneous () const
	Returns true if the event originated outside the application (a system event); otherwise returns false. More...
Type	type () const
	Returns the event type. More...
virtual	~QEvent ()
	Destroys the event. More...

Additional Inherited Members
Static Public Functions inherited from QEvent
static int	registerEventType (int hint=-1)
	Registers and returns a custom event type. More...
Protected Functions inherited from QGraphicsSceneEvent
	QGraphicsSceneEvent (QGraphicsSceneEventPrivate &dd, Type type=None)
	Constructs a generic graphics scene event. More...
Protected Variables inherited from QGraphicsSceneEvent
QScopedPointer< QGraphicsSceneEventPrivate >	d_ptr
Protected Variables inherited from QEvent
QEventPrivate *	d
ushort	t

Detailed Description

The QGraphicsSceneContextMenuEvent class provides context menu events in the graphics view framework.

Since

4.2

A QContextMenuEvent received by a QGraphicsView is translated into a QGraphicsSceneContextMenuEvent. The QContextMenuEvent::globalPos() is translated into item, scene, and screen coordinates (pos(), scenePos(), and screenPos()).

See also

QGraphicsSceneMouseEvent, QGraphicsSceneWheelEvent, QContextMenuEvent

Definition at line 166 of file qgraphicssceneevent.h.

Enumerations

Reason

enum QGraphicsSceneContextMenuEvent::Reason

This enum describes the reason why the context event was sent.

• Mouse The mouse caused the event to be sent. On most platforms, this means the right mouse button was clicked.

• Keyboard The keyboard caused this event to be sent. On Windows and Mac OS X, this means the menu button was pressed.

• Other The event was sent by some other means (i.e. not by the mouse or keyboard).

Enumerator
Mouse
Keyboard
Other

Definition at line 169 of file qgraphicssceneevent.h.

{ Mouse, Keyboard, Other };

Constructors and Destructors

QGraphicsSceneContextMenuEvent()

QGraphicsSceneContextMenuEvent::QGraphicsSceneContextMenuEvent

(

Type

type = None

)

Constructs a graphics scene context menu event of the specified type.

Warning

This function is not part of the public interface.

Definition at line 877 of file qgraphicssceneevent.cpp.

    : QGraphicsSceneEvent(*new QGraphicsSceneContextMenuEventPrivate, type)
{
}

~QGraphicsSceneContextMenuEvent()

QGraphicsSceneContextMenuEvent::~QGraphicsSceneContextMenuEvent

(

)

Destroys the event.

Definition at line 885 of file qgraphicssceneevent.cpp.

{
}

Functions

modifiers()

Qt::KeyboardModifiers QGraphicsSceneContextMenuEvent::modifiers

(

)

const

Returns the keyboard modifiers in use when the context menu was requested.

Definition at line 976 of file qgraphicssceneevent.cpp.

Referenced by cloneEvent(), and setModifiers().

{
    Q_D(const QGraphicsSceneContextMenuEvent);
    return d->modifiers;
}

pos()

QPointF QGraphicsSceneContextMenuEvent::pos

(

)

const

Returns the position of the mouse cursor in item coordinates at the moment the context menu was requested.

See also

scenePos(), screenPos()

Definition at line 895 of file qgraphicssceneevent.cpp.

Referenced by cloneEvent(), QTextControl::processEvent(), QGraphicsItemPrivate::remapItemPos(), setPos(), setScenePos(), and setScreenPos().

{
    Q_D(const QGraphicsSceneContextMenuEvent);
    return d->pos;
}

reason()

QGraphicsSceneContextMenuEvent::Reason QGraphicsSceneContextMenuEvent::reason

(

)

const

Returns the reason for the context menu event.

See also

QGraphicsSceneContextMenuEvent::Reason

Definition at line 1002 of file qgraphicssceneevent.cpp.

Referenced by cloneEvent(), QGraphicsProxyWidget::contextMenuEvent(), QDeclarativeMouseArea::contextMenuEvent(), and setReason().

{
    Q_D(const QGraphicsSceneContextMenuEvent);
    return d->reason;
}

scenePos()

QPointF QGraphicsSceneContextMenuEvent::scenePos

(

)

const

Returns the position of the mouse cursor in scene coordinates at the moment the the context menu was requested.

See also

pos(), screenPos()

Definition at line 923 of file qgraphicssceneevent.cpp.

Referenced by cloneEvent(), and QGraphicsScene::contextMenuEvent().

{
    Q_D(const QGraphicsSceneContextMenuEvent);
    return d->scenePos;
}

screenPos()

QPoint QGraphicsSceneContextMenuEvent::screenPos

(

)

const

Returns the position of the mouse cursor in screen coordinates at the moment the the context menu was requested.

See also

pos(), scenePos()

Definition at line 951 of file qgraphicssceneevent.cpp.

Referenced by cloneEvent(), QGraphicsProxyWidget::contextMenuEvent(), QGraphicsScene::contextMenuEvent(), and QTextControl::processEvent().

{
    Q_D(const QGraphicsSceneContextMenuEvent);
    return d->screenPos;
}

setModifiers()

void QGraphicsSceneContextMenuEvent::setModifiers

(

Qt::KeyboardModifiers

modifiers

)

Sets the keyboard modifiers associated with the context menu to the modifiers specified.

Warning

This function is not part of the public interface.

Definition at line 991 of file qgraphicssceneevent.cpp.

Referenced by cloneEvent(), and QGraphicsView::contextMenuEvent().

{
    Q_D(QGraphicsSceneContextMenuEvent);
    d->modifiers = modifiers;
}

setPos()

void QGraphicsSceneContextMenuEvent::setPos

(

const QPointF &

point

)

Sets the position associated with the context menu to the given point in item coordinates.

Warning

This function is not part of the public interface.

Definition at line 911 of file qgraphicssceneevent.cpp.

Referenced by cloneEvent(), QGraphicsScene::contextMenuEvent(), and QGraphicsItemPrivate::remapItemPos().

{
    Q_D(QGraphicsSceneContextMenuEvent);
    d->pos = pos;
}

setReason()

void QGraphicsSceneContextMenuEvent::setReason

(

Reason

reason

)

Sets the reason for the context menu event to reason.

Warning

This function is not part of the public interface.

See also

reason()

Definition at line 1017 of file qgraphicssceneevent.cpp.

Referenced by cloneEvent(), and QGraphicsView::contextMenuEvent().

{
    Q_D(QGraphicsSceneContextMenuEvent);
    d->reason = reason;
}

setScenePos()

void QGraphicsSceneContextMenuEvent::setScenePos

(

const QPointF &

point

)

Sets the position associated with the context menu to the given point in scene coordinates.

Warning

This function is not part of the public interface.

Definition at line 939 of file qgraphicssceneevent.cpp.

Referenced by cloneEvent(), and QGraphicsView::contextMenuEvent().

{
    Q_D(QGraphicsSceneContextMenuEvent);
    d->scenePos = pos;
}

setScreenPos()

void QGraphicsSceneContextMenuEvent::setScreenPos

(

const QPoint &

point

)

Sets the position associated with the context menu to the given point in screen coordinates.

Warning

This function is not part of the public interface.

Definition at line 967 of file qgraphicssceneevent.cpp.

Referenced by cloneEvent(), and QGraphicsView::contextMenuEvent().

{
    Q_D(QGraphicsSceneContextMenuEvent);
    d->screenPos = pos;
}

---

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

• /src/gui/graphicsview/qgraphicssceneevent.h
• /src/gui/graphicsview/qgraphicssceneevent.cpp