Struct qt_gui::QShortcutEvent

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

The QShortcutEvent class provides an event which is generated when the user presses a key combination.

C++ class: QShortcutEvent.

C++ documentation:

The QShortcutEvent class provides an event which is generated when the user presses a key combination.

Normally you do not need to use this class directly; QShortcut provides a higher-level interface to handle shortcut keys.

Implementations

impl QShortcutEvent

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

The QShortcutEvent class provides an event which is generated when the user presses a key combination.

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

C++ documentation:

The QShortcutEvent class provides an event which is generated when the user presses a key combination.

Normally you do not need to use this class directly; QShortcut provides a higher-level interface to handle shortcut keys.

pub unsafe fn is_ambiguous(&self) -> bool

Returns true if the key sequence that triggered the event is ambiguous.

Calls C++ function: bool QShortcutEvent::isAmbiguous() const.

C++ documentation:

Returns true if the key sequence that triggered the event is ambiguous.

See also QShortcut::activatedAmbiguously().

pub unsafe fn key(&self) -> Ref<QKeySequence>

Returns the key sequence that triggered the event.

Calls C++ function: const QKeySequence& QShortcutEvent::key() const.

C++ documentation:

Returns the key sequence that triggered the event.

pub unsafe fn new_3a( key: impl CastInto<Ref<QKeySequence>>, id: c_int, ambiguous: bool ) -> CppBox<QShortcutEvent>

Constructs a shortcut event for the given key press, associated with the QShortcut ID id.

Calls C++ function: [constructor] void QShortcutEvent::QShortcutEvent(const QKeySequence& key, int id, bool ambiguous = …).

C++ documentation:

Constructs a shortcut event for the given key press, associated with the QShortcut ID id.

ambiguous specifies whether there is more than one QShortcut for the same key sequence.

pub unsafe fn new_2a( key: impl CastInto<Ref<QKeySequence>>, id: c_int ) -> CppBox<QShortcutEvent>

Constructs a shortcut event for the given key press, associated with the QShortcut ID id.

Calls C++ function: [constructor] void QShortcutEvent::QShortcutEvent(const QKeySequence& key, int id).

C++ documentation:

Constructs a shortcut event for the given key press, associated with the QShortcut ID id.

ambiguous specifies whether there is more than one QShortcut for the same key sequence.

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

The QShortcutEvent class provides an event which is generated when the user presses a key combination.

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

C++ documentation:

The QShortcutEvent class provides an event which is generated when the user presses a key combination.

Normally you do not need to use this class directly; QShortcut provides a higher-level interface to handle shortcut keys.

pub unsafe fn shortcut_id(&self) -> c_int

Returns the ID of the QShortcut object for which this event was generated.

Calls C++ function: int QShortcutEvent::shortcutId() const.

C++ documentation:

Returns the ID of the QShortcut object for which this event was generated.

See also QShortcut::id().

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 QShortcutEvent

unsafe fn delete(&self)

Destroys the event object.

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

C++ documentation:

Destroys the event object.

impl Deref for QShortcutEvent

fn deref(&self) -> &QEvent

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

type Target = QEvent

The resulting type after dereferencing.

impl DynamicCast<QShortcutEvent> for QEvent

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

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

impl StaticDowncast<QShortcutEvent> for QEvent

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

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

impl StaticUpcast<QEvent> for QShortcutEvent

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

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