CopperSpice API  2.0.0
Public Methods | List of all members
QHelpEvent Class Reference
CsGui | Event Classes | Help System

Indicates a request for information about a particular widget. More...

Inheritance diagram for QHelpEvent:
QEvent

Public Methods

 QHelpEvent (Type type, const QPoint &pos, const QPoint &globalPos)
 
const QPoint & globalPos () const
 
int globalX () const
 
int globalY () const
 
const QPoint & pos () const
 
int x () const
 
int y () const
 
- Public Methods inherited from QEvent
 QEvent (const QEvent &other)
 
 QEvent (Type type)
 
virtual ~QEvent ()
 
void accept ()
 
void ignore ()
 
bool isAccepted () const
 
QEvent & operator= (const QEvent &other)
 
void setAccepted (bool accepted)
 
bool spontaneous () const
 
Type type () const
 

Additional Inherited Members

- Public Types inherited from QEvent
enum  Type
 
- Static Public Methods inherited from QEvent
static int registerEventType (int hint=-1)
 

Detailed Description

The QHelpEvent class indicates a request for information about a particular 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

Constructor & Destructor Documentation

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()

Method Documentation

const QPoint & QHelpEvent::globalPos ( ) const
inline

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

See also
pos(), globalX(), globalY()
int QHelpEvent::globalX ( ) const
inline

Equivalent to calling globalPos().x().

See also
x(), globalY(), globalPos()
int QHelpEvent::globalY ( ) const
inline

Equivalent to calling globalPos().y().

See also
y(), globalX(), globalPos()
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()
int QHelpEvent::x ( ) const
inline

Equivalent to calling pos().x().

See also
y(), pos(), globalPos()
int QHelpEvent::y ( ) const
inline

Equivalent to calling pos().y().

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