Qt 4.8
Public Functions | Properties | 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:
QEvent

Public Functions

const QPointglobalPos () const
 Returns the mouse cursor position when the event was generated in global coordinates. More...
 
int globalX () const
 Same as globalPos(). More...
 
int globalY () const
 Same as globalPos(). More...
 
const QPointpos () const
 Returns the mouse cursor position when the event was generated, relative to the widget to which the event is dispatched. More...
 
 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. More...
 
int x () const
 Same as pos(). More...
 
int y () const
 Same as pos(). More...
 
 ~QHelpEvent ()
 
- 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...
 

Properties

QPoint gp
 
QPoint p
 

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, 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...
 
- Static Public Functions inherited from QEvent
static int registerEventType (int hint=-1)
 Registers and returns a custom event type. More...
 
- Protected Variables inherited from QEvent
QEventPrivate * d
 
ushort t
 

Detailed Description

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

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 586 of file qevent.h.

Constructors and Destructors

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

3094  : QEvent(type), p(pos), gp(globalPos)
3095 {}
QEvent(Type type)
Contructs an event object of type type.
Definition: qcoreevent.cpp:289
QPoint gp
Definition: qevent.h:602
Type type() const
Returns the event type.
Definition: qcoreevent.h:303
QPoint p
Definition: qevent.h:601

◆ ~QHelpEvent()

QHelpEvent::~QHelpEvent ( )
Warning
This function is not part of the public interface.

Definition at line 3167 of file qevent.cpp.

3168 {
3169 }

Functions

◆ 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 598 of file qevent.h.

Referenced by QScriptDebuggerCodeView::event(), QMDIControl::event(), QAbstractItemDelegate::helpEvent(), QApplication::notify(), QTextControl::processEvent(), showToolTip(), QHeaderView::viewportEvent(), and QGraphicsView::viewportEvent().

598 { return gp; }
QPoint gp
Definition: qevent.h:602

◆ globalX()

int QHelpEvent::globalX ( ) const
inline

Same as globalPos().

x().

\sa x(), globalY(), globalPos()

Definition at line 594 of file qevent.h.

594 { return gp.x(); }
int x() const
Returns the x coordinate of this point.
Definition: qpoint.h:128
QPoint gp
Definition: qevent.h:602

◆ globalY()

int QHelpEvent::globalY ( ) const
inline

Same as globalPos().

y().

\sa y(), globalX(), globalPos()

Definition at line 595 of file qevent.h.

595 { return gp.y(); }
int y() const
Returns the y coordinate of this point.
Definition: qpoint.h:131
QPoint gp
Definition: qevent.h:602

◆ 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 597 of file qevent.h.

Referenced by QScriptDebuggerCodeView::event(), QMDIControl::event(), QMdi::ControllerWidget::event(), QApplication::notify(), QTextControl::processEvent(), QHeaderView::viewportEvent(), QGraphicsView::viewportEvent(), and QAbstractItemView::viewportEvent().

597 { return p; }
QPoint p
Definition: qevent.h:601

◆ x()

int QHelpEvent::x ( ) const
inline

Same as pos().

x().

\sa y(), pos(), globalPos()

Definition at line 592 of file qevent.h.

592 { return p.x(); }
int x() const
Returns the x coordinate of this point.
Definition: qpoint.h:128
QPoint p
Definition: qevent.h:601

◆ y()

int QHelpEvent::y ( ) const
inline

Same as pos().

y().

\sa x(), pos(), globalPos()

Definition at line 593 of file qevent.h.

593 { return p.y(); }
int y() const
Returns the y coordinate of this point.
Definition: qpoint.h:131
QPoint p
Definition: qevent.h:601

Properties

◆ gp

QPoint QHelpEvent::gp
private

Definition at line 602 of file qevent.h.

◆ p

QPoint QHelpEvent::p
private

Definition at line 601 of file qevent.h.


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