Struct qt_gui::QPlatformSurfaceEvent

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

The QPlatformSurfaceEvent class is used to notify about native platform surface events.

C++ class: QPlatformSurfaceEvent.

C++ documentation:

The QPlatformSurfaceEvent class is used to notify about native platform surface events.

Platform window events are synchronously sent to windows and offscreen surfaces when their underlying native surfaces are created or are about to be destroyed.

Applications can respond to these events to know when the underlying platform surface exists.

Implementations

impl QPlatformSurfaceEvent

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

The QPlatformSurfaceEvent class is used to notify about native platform surface events.

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

C++ documentation:

The QPlatformSurfaceEvent class is used to notify about native platform surface events.

Platform window events are synchronously sent to windows and offscreen surfaces when their underlying native surfaces are created or are about to be destroyed.

Applications can respond to these events to know when the underlying platform surface exists.

pub unsafe fn new( surface_event_type: SurfaceEventType ) -> CppBox<QPlatformSurfaceEvent>

Constructs a platform surface event for the given surfaceEventType.

Calls C++ function: [constructor] void QPlatformSurfaceEvent::QPlatformSurfaceEvent(QPlatformSurfaceEvent::SurfaceEventType surfaceEventType).

C++ documentation:

Constructs a platform surface event for the given surfaceEventType.

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

The QPlatformSurfaceEvent class is used to notify about native platform surface events.

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

C++ documentation:

The QPlatformSurfaceEvent class is used to notify about native platform surface events.

Platform window events are synchronously sent to windows and offscreen surfaces when their underlying native surfaces are created or are about to be destroyed.

Applications can respond to these events to know when the underlying platform surface exists.

pub unsafe fn surface_event_type(&self) -> SurfaceEventType

Returns the specific type of platform surface event.

Calls C++ function: QPlatformSurfaceEvent::SurfaceEventType QPlatformSurfaceEvent::surfaceEventType() const.

C++ documentation:

Returns the specific type of platform surface event.

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 QPlatformSurfaceEvent

unsafe fn delete(&self)

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

impl Deref for QPlatformSurfaceEvent

fn deref(&self) -> &QEvent

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

type Target = QEvent

The resulting type after dereferencing.

impl DynamicCast<QPlatformSurfaceEvent> for QEvent

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

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

impl StaticDowncast<QPlatformSurfaceEvent> for QEvent

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

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

impl StaticUpcast<QEvent> for QPlatformSurfaceEvent

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

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