Struct qt_gui::QFocusEvent

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

The QFocusEvent class contains event parameters for widget focus events.

C++ class: QFocusEvent.

C++ documentation:

The QFocusEvent class contains event parameters for widget focus events.

Focus events are sent to widgets when the keyboard input focus changes. Focus events occur due to mouse actions, key presses (such as Tab or Backtab), the window system, popup menus, keyboard shortcuts, or other application-specific reasons. The reason for a particular focus event is returned by reason() in the appropriate event handler.

The event handlers QWidget::focusInEvent(), QWidget::focusOutEvent(), QGraphicsItem::focusInEvent and QGraphicsItem::focusOutEvent() receive focus events.

Implementations

impl QFocusEvent

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

The QFocusEvent class contains event parameters for widget focus events.

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

C++ documentation:

The QFocusEvent class contains event parameters for widget focus events.

Focus events are sent to widgets when the keyboard input focus changes. Focus events occur due to mouse actions, key presses (such as Tab or Backtab), the window system, popup menus, keyboard shortcuts, or other application-specific reasons. The reason for a particular focus event is returned by reason() in the appropriate event handler.

The event handlers QWidget::focusInEvent(), QWidget::focusOutEvent(), QGraphicsItem::focusInEvent and QGraphicsItem::focusOutEvent() receive focus events.

pub unsafe fn got_focus(&self) -> bool

Returns true if type() is QEvent::FocusIn; otherwise returns false.

Calls C++ function: bool QFocusEvent::gotFocus() const.

C++ documentation:

Returns true if type() is QEvent::FocusIn; otherwise returns false.

pub unsafe fn lost_focus(&self) -> bool

Returns true if type() is QEvent::FocusOut; otherwise returns false.

Calls C++ function: bool QFocusEvent::lostFocus() const.

C++ documentation:

Returns true if type() is QEvent::FocusOut; otherwise returns false.

pub unsafe fn new_2a(type_: Type, reason: FocusReason) -> CppBox<QFocusEvent>

Constructs a focus event object.

Calls C++ function: [constructor] void QFocusEvent::QFocusEvent(QEvent::Type type, Qt::FocusReason reason = …).

C++ documentation:

Constructs a focus event object.

The type parameter must be either QEvent::FocusIn or QEvent::FocusOut. The reason describes the cause of the change in focus.

pub unsafe fn new_1a(type_: Type) -> CppBox<QFocusEvent>

Constructs a focus event object.

Calls C++ function: [constructor] void QFocusEvent::QFocusEvent(QEvent::Type type).

C++ documentation:

Constructs a focus event object.

The type parameter must be either QEvent::FocusIn or QEvent::FocusOut. The reason describes the cause of the change in focus.

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

The QFocusEvent class contains event parameters for widget focus events.

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

C++ documentation:

The QFocusEvent class contains event parameters for widget focus events.

Focus events are sent to widgets when the keyboard input focus changes. Focus events occur due to mouse actions, key presses (such as Tab or Backtab), the window system, popup menus, keyboard shortcuts, or other application-specific reasons. The reason for a particular focus event is returned by reason() in the appropriate event handler.

The event handlers QWidget::focusInEvent(), QWidget::focusOutEvent(), QGraphicsItem::focusInEvent and QGraphicsItem::focusOutEvent() receive focus events.

pub unsafe fn reason(&self) -> FocusReason

Returns the reason for this focus event.

Calls C++ function: Qt::FocusReason QFocusEvent::reason() const.

C++ documentation:

Returns the reason for this focus 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 QFocusEvent

unsafe fn delete(&self)

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

impl Deref for QFocusEvent

fn deref(&self) -> &QEvent

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

type Target = QEvent

The resulting type after dereferencing.

impl DynamicCast<QFocusEvent> for QEvent

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

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

impl StaticDowncast<QFocusEvent> for QEvent

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

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

impl StaticUpcast<QEvent> for QFocusEvent

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

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