QtBase  v6.3.1
Public Member Functions | List of all members
QHelpEvent Class Reference

The QHelpEvent class provides an event that is used to request helpful information about a particular point in a widget. More...

#include <qevent.h>

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

Public Member Functions

 QHelpEvent (Type type, const QPoint &pos, const QPoint &globalPos)
 
 ~QHelpEvent ()
 
QHelpEventclone () const override
 
int x () const
 
int y () const
 
int globalX () const
 
int globalY () const
 
const QPointpos () const
 
const QPointglobalPos () const
 
- 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
 

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 , User = 1000 , MaxUser = 65535
}
 
- Static Public Member Functions inherited from QEvent
static int registerEventType (int hint=-1) noexcept
 
- Protected Member Functions inherited from QEvent
 QEvent (Type type, InputEventTag)
 
 QEvent (Type type, PointerEventTag)
 
 QEvent (Type type, SinglePointEventTag)
 
- Protected Attributes inherited from QEvent
quint16 t
 

Detailed Description

The QHelpEvent class provides an event that is used to request helpful information about a particular point in a widget.

\inmodule QtGui

This event can be intercepted in applications to provide tooltips or "What's This?" help for custom widgets. The type() can be either QEvent::ToolTip or QEvent::WhatsThis.

See also
QToolTip, QWhatsThis, QStatusTipEvent, QWhatsThisClickedEvent

Definition at line 872 of file qevent.h.

Constructor & Destructor Documentation

◆ QHelpEvent()

QHelpEvent::QHelpEvent ( Type  type,
const QPoint pos,
const QPoint globalPos 
)

Constructs a help event with the given type corresponding to the widget-relative position specified by pos and the global position specified by globalPos.

type must be either QEvent::ToolTip or QEvent::WhatsThis.

See also
pos(), globalPos()

Definition at line 3382 of file qevent.cpp.

◆ ~QHelpEvent()

QHelpEvent::~QHelpEvent ( )

Definition at line 3438 of file qevent.cpp.

Member Function Documentation

◆ clone()

QHelpEvent* QHelpEvent::clone ( ) const
inlineoverridevirtual

Creates and returns an identical copy of this event.

Since
6.0

Reimplemented from QEvent.

Definition at line 879 of file qevent.h.

◆ globalPos()

const QPoint & QHelpEvent::globalPos ( ) const
inline

Returns the mouse cursor position when the event was generated in global coordinates.

See also
pos(), globalX(), globalY()

Definition at line 887 of file qevent.h.

Here is the caller graph for this function:

◆ globalX()

int QHelpEvent::globalX ( ) const
inline

Same as globalPos().x().

See also
x(), globalY(), globalPos()

Definition at line 883 of file qevent.h.

◆ globalY()

int QHelpEvent::globalY ( ) const
inline

Same as globalPos().y().

See also
y(), globalX(), globalPos()

Definition at line 884 of file qevent.h.

◆ pos()

const QPoint & QHelpEvent::pos ( ) const
inline

Returns the mouse cursor position when the event was generated, relative to the widget to which the event is dispatched.

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

Definition at line 886 of file qevent.h.

Here is the caller graph for this function:

◆ x()

int QHelpEvent::x ( ) const
inline

Same as pos().x().

See also
y(), pos(), globalPos()

Definition at line 881 of file qevent.h.

◆ y()

int QHelpEvent::y ( ) const
inline

Same as pos().y().

See also
x(), pos(), globalPos()

Definition at line 882 of file qevent.h.


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