Struct qt_gui::QHelpEvent

#[repr(C)]
pub struct QHelpEvent { /* private fields */ }

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

C++ class: QHelpEvent.

C++ documentation:

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.

Implementations

impl QHelpEvent

pub unsafe fn copy_from( &self, other: impl CastInto<Ref<QHelpEvent>> ) -> Ref<QHelpEvent>

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

Calls C++ function: QHelpEvent& QHelpEvent::operator=(const QHelpEvent& other).

C++ documentation:

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.

pub unsafe fn global_pos(&self) -> Ref<QPoint>

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

Calls C++ function: const QPoint& QHelpEvent::globalPos() const.

C++ documentation:

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

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

pub unsafe fn global_x(&self) -> c_int

Same as globalPos().x().

Calls C++ function: int QHelpEvent::globalX() const.

C++ documentation:

Same as globalPos().x().

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

pub unsafe fn global_y(&self) -> c_int

Same as globalPos().y().

Calls C++ function: int QHelpEvent::globalY() const.

C++ documentation:

Same as globalPos().y().

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

pub unsafe fn new( type_: Type, pos: impl CastInto<Ref<QPoint>>, global_pos: impl CastInto<Ref<QPoint>> ) -> CppBox<QHelpEvent>

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

Calls C++ function: [constructor] void QHelpEvent::QHelpEvent(QEvent::Type type, const QPoint& pos, const QPoint& globalPos).

C++ documentation:

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() and globalPos().

pub unsafe fn new_copy( other: impl CastInto<Ref<QHelpEvent>> ) -> CppBox<QHelpEvent>

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

Calls C++ function: [constructor] void QHelpEvent::QHelpEvent(const QHelpEvent& other).

C++ documentation:

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.

pub unsafe fn pos(&self) -> Ref<QPoint>

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

Calls C++ function: const QPoint& QHelpEvent::pos() const.

C++ documentation:

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

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

pub unsafe fn x(&self) -> c_int

Same as pos().x().

Calls C++ function: int QHelpEvent::x() const.

C++ documentation:

Same as pos().x().

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

pub unsafe fn y(&self) -> c_int

Same as pos().y().

Calls C++ function: int QHelpEvent::y() const.

C++ documentation:

Same as pos().y().

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

Methods from Deref<Target = QEvent>

pub unsafe fn accept(&self)

Sets the accept flag of the event object, the equivalent of calling setAccepted(true).

Calls C++ function: void QEvent::accept().

C++ documentation:

Sets the accept flag of the event object, the equivalent of calling setAccepted(true).

Setting the accept parameter indicates that the event receiver wants the event. Unwanted events might be propagated to the parent widget.

See also ignore().

pub unsafe fn copy_from(&self, other: impl CastInto<Ref<QEvent>>) -> Ref<QEvent>

Calls C++ function: QEvent& QEvent::operator=(const QEvent& other).

pub unsafe fn ignore(&self)

Clears the accept flag parameter of the event object, the equivalent of calling setAccepted(false).

Calls C++ function: void QEvent::ignore().

C++ documentation:

Clears the accept flag parameter of the event object, the equivalent of calling setAccepted(false).

Clearing the accept parameter indicates that the event receiver does not want the event. Unwanted events might be propagated to the parent widget.

See also accept().

pub unsafe fn is_accepted(&self) -> bool

the accept flag of the event object

Calls C++ function: bool QEvent::isAccepted() const.

C++ documentation:

the accept flag of the event object

Setting the accept parameter indicates that the event receiver wants the event. Unwanted events might be propagated to the parent widget. By default, isAccepted() is set to true, but don't rely on this as subclasses may choose to clear it in their constructor.

For convenience, the accept flag can also be set with accept(), and cleared with ignore().

Access functions:

bool	isAccepted() const
void	setAccepted(bool accepted)

pub unsafe fn set_accepted(&self, accepted: bool)

the accept flag of the event object

Calls C++ function: void QEvent::setAccepted(bool accepted).

C++ documentation:

the accept flag of the event object

Setting the accept parameter indicates that the event receiver wants the event. Unwanted events might be propagated to the parent widget. By default, isAccepted() is set to true, but don't rely on this as subclasses may choose to clear it in their constructor.

For convenience, the accept flag can also be set with accept(), and cleared with ignore().

Access functions:

bool	isAccepted() const
void	setAccepted(bool accepted)

pub unsafe fn spontaneous(&self) -> bool

Returns true if the event originated outside the application (a system event); otherwise returns false.

Calls C++ function: bool QEvent::spontaneous() const.

C++ documentation:

Returns true if the event originated outside the application (a system event); otherwise returns false.

The return value of this function is not defined for paint events.

pub unsafe fn type_(&self) -> Type

Returns the event type.

Calls C++ function: QEvent::Type QEvent::type() const.

C++ documentation:

Returns the event type.

Trait Implementations

impl CppDeletable for QHelpEvent

unsafe fn delete(&self)

Calls C++ function: virtual [destructor] void QHelpEvent::~QHelpEvent().

impl Deref for QHelpEvent

fn deref(&self) -> &QEvent

Calls C++ function: QEvent* static_cast<QEvent*>(QHelpEvent* ptr).

type Target = QEvent

The resulting type after dereferencing.

impl DynamicCast<QHelpEvent> for QEvent

unsafe fn dynamic_cast(ptr: Ptr<QEvent>) -> Ptr<QHelpEvent>

Calls C++ function: QHelpEvent* dynamic_cast<QHelpEvent*>(QEvent* ptr).

impl StaticDowncast<QHelpEvent> for QEvent

unsafe fn static_downcast(ptr: Ptr<QEvent>) -> Ptr<QHelpEvent>

Calls C++ function: QHelpEvent* static_cast<QHelpEvent*>(QEvent* ptr).

impl StaticUpcast<QEvent> for QHelpEvent

unsafe fn static_upcast(ptr: Ptr<QHelpEvent>) -> Ptr<QEvent>

Calls C++ function: QEvent* static_cast<QEvent*>(QHelpEvent* ptr).