Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
QGraphicsSceneHelpEvent Class Reference

The QGraphicsSceneHelpEvent class provides events when a tooltip is requested. More...

#include <qgraphicssceneevent.h>

+ Inheritance diagram for QGraphicsSceneHelpEvent:
+ Collaboration diagram for QGraphicsSceneHelpEvent:

Public Member Functions

 QGraphicsSceneHelpEvent (Type type=None)
 
 ~QGraphicsSceneHelpEvent ()
 Destroys the event.
 
QPointF scenePos () const
 Returns the position of the mouse cursor in scene coordinates at the moment the help event was sent.
 
void setScenePos (const QPointF &pos)
 
QPoint screenPos () const
 Returns the position of the mouse cursor in screen coordinates at the moment the help event was sent.
 
void setScreenPos (const QPoint &pos)
 
- Public Member Functions inherited from QGraphicsSceneEvent
 QGraphicsSceneEvent (Type type)
 
 ~QGraphicsSceneEvent ()
 Destroys the event.
 
QWidgetwidget () const
 Returns the widget where the event originated, or \nullptr if the event originates from another application.
 
void setWidget (QWidget *widget)
 
quint64 timestamp () const
 
void setTimestamp (quint64 ts)
 
- 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 QEventclone () const
 Creates and returns an identical copy of this event.
 

Additional Inherited Members

- 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 , WindowAboutToChangeInternal = 221 , DevicePixelRatioChange = 222 ,
  ChildWindowAdded = 223 , ChildWindowRemoved = 224 , ParentWindowAboutToChange = 225 , ParentWindowChange = 226 ,
  User = 1000 , MaxUser = 65535
}
 This enum type defines the valid event types in Qt. More...
 
- Static Public Member Functions inherited from QEvent
static int registerEventType (int hint=-1) noexcept
 
- Protected Member Functions inherited from QGraphicsSceneEvent
 QGraphicsSceneEvent (QGraphicsSceneEventPrivate &dd, Type type=None)
 
- Protected Member Functions inherited from QEvent
 QEvent (Type type, InputEventTag)
 
 QEvent (Type type, PointerEventTag)
 
 QEvent (Type type, SinglePointEventTag)
 
- Protected Attributes inherited from QGraphicsSceneEvent
QScopedPointer< QGraphicsSceneEventPrivated_ptr
 
- Protected Attributes inherited from QEvent
quint16 t
 

Detailed Description

The QGraphicsSceneHelpEvent class provides events when a tooltip is requested.

Since
4.2

\inmodule QtWidgets

When a QGraphicsView receives a QEvent of type QEvent::ToolTip, it creates a QGraphicsSceneHelpEvent, which is forwarded to the scene. You can set a tooltip on a QGraphicsItem with \l{QGraphicsItem::}{setToolTip()}; by default QGraphicsScene displays the tooltip of the QGraphicsItem with the highest z-value (i.e, the top-most item) under the mouse position.

QGraphicsView does not forward events when \l{QWhatsThis}{"What's This"} and \l{QStatusTipEvent}{status tip} help is requested. If you need this, you can reimplement QGraphicsView::viewportEvent() and forward QStatusTipEvent events and \l{QEvent}{QEvents} of type QEvent::WhatsThis to the scene.

See also
QEvent

Definition at line 204 of file qgraphicssceneevent.h.

Constructor & Destructor Documentation

◆ QGraphicsSceneHelpEvent()

QGraphicsSceneHelpEvent::QGraphicsSceneHelpEvent ( Type type = None)
explicit

Constructs a graphics scene help event of the specified type.

Definition at line 1281 of file qgraphicssceneevent.cpp.

◆ ~QGraphicsSceneHelpEvent()

QGraphicsSceneHelpEvent::~QGraphicsSceneHelpEvent ( )

Destroys the event.

Definition at line 1289 of file qgraphicssceneevent.cpp.

Member Function Documentation

◆ scenePos()

QPointF QGraphicsSceneHelpEvent::scenePos ( ) const

Returns the position of the mouse cursor in scene coordinates at the moment the help event was sent.

See also
screenPos()

Definition at line 1299 of file qgraphicssceneevent.cpp.

References d.

◆ screenPos()

QPoint QGraphicsSceneHelpEvent::screenPos ( ) const

Returns the position of the mouse cursor in screen coordinates at the moment the help event was sent.

See also
scenePos()

Definition at line 1324 of file qgraphicssceneevent.cpp.

References d.

◆ setScenePos()

void QGraphicsSceneHelpEvent::setScenePos ( const QPointF & point)

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

Definition at line 1312 of file qgraphicssceneevent.cpp.

References d, and pos.

Referenced by QGraphicsView::viewportEvent().

+ Here is the caller graph for this function:

◆ setScreenPos()

void QGraphicsSceneHelpEvent::setScreenPos ( const QPoint & point)

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

Definition at line 1337 of file qgraphicssceneevent.cpp.

References d, and pos.

Referenced by QGraphicsView::viewportEvent().

+ Here is the caller graph for this function:

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