Struct qt_gui::QPaintEvent

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

The QPaintEvent class contains event parameters for paint events.

C++ class: QPaintEvent.

C++ documentation:

The QPaintEvent class contains event parameters for paint events.

Paint events are sent to widgets that need to update themselves, for instance when part of a widget is exposed because a covering widget was moved.

The event contains a region() that needs to be updated, and a rect() that is the bounding rectangle of that region. Both are provided because many widgets cannot make much use of region(), and rect() can be much faster than region().boundingRect().

Implementations

impl QPaintEvent

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

The QPaintEvent class contains event parameters for paint events.

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

C++ documentation:

The QPaintEvent class contains event parameters for paint events.

Paint events are sent to widgets that need to update themselves, for instance when part of a widget is exposed because a covering widget was moved.

The event contains a region() that needs to be updated, and a rect() that is the bounding rectangle of that region. Both are provided because many widgets cannot make much use of region(), and rect() can be much faster than region().boundingRect().

pub unsafe fn from_q_region( paint_region: impl CastInto<Ref<QRegion>> ) -> CppBox<QPaintEvent>

Constructs a paint event object with the region that needs to be updated. The region is specified by paintRegion.

Calls C++ function: [constructor] void QPaintEvent::QPaintEvent(const QRegion& paintRegion).

C++ documentation:

Constructs a paint event object with the region that needs to be updated. The region is specified by paintRegion.

pub unsafe fn from_q_rect( paint_rect: impl CastInto<Ref<QRect>> ) -> CppBox<QPaintEvent>

Constructs a paint event object with the rectangle that needs to be updated. The region is specified by paintRect.

Calls C++ function: [constructor] void QPaintEvent::QPaintEvent(const QRect& paintRect).

C++ documentation:

Constructs a paint event object with the rectangle that needs to be updated. The region is specified by paintRect.

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

The QPaintEvent class contains event parameters for paint events.

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

C++ documentation:

The QPaintEvent class contains event parameters for paint events.

Paint events are sent to widgets that need to update themselves, for instance when part of a widget is exposed because a covering widget was moved.

The event contains a region() that needs to be updated, and a rect() that is the bounding rectangle of that region. Both are provided because many widgets cannot make much use of region(), and rect() can be much faster than region().boundingRect().

pub unsafe fn rect(&self) -> Ref<QRect>

Returns the rectangle that needs to be updated.

Calls C++ function: const QRect& QPaintEvent::rect() const.

C++ documentation:

Returns the rectangle that needs to be updated.

See also region() and QPainter::setClipRect().

pub unsafe fn region(&self) -> Ref<QRegion>

Returns the region that needs to be updated.

Calls C++ function: const QRegion& QPaintEvent::region() const.

C++ documentation:

Returns the region that needs to be updated.

See also rect() and QPainter::setClipRegion().

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 QPaintEvent

unsafe fn delete(&self)

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

impl Deref for QPaintEvent

fn deref(&self) -> &QEvent

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

type Target = QEvent

The resulting type after dereferencing.

impl DynamicCast<QPaintEvent> for QEvent

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

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

impl StaticDowncast<QPaintEvent> for QEvent

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

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

impl StaticUpcast<QEvent> for QPaintEvent

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

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