Struct qt_gui::QScrollEvent

#[repr(C)]
pub struct QScrollEvent { /* fields omitted */ }

The QScrollEvent class is sent when scrolling.

C++ class: QScrollEvent.

C++ documentation:

The QScrollEvent class is sent when scrolling.

The scroll event is sent to indicate that the receiver should be scrolled. Usually the receiver should be something visual like QWidget or QGraphicsObject.

Some care should be taken that no conflicting QScrollEvents are sent from two sources. Using QScroller::scrollTo is save however.

Methods

impl QScrollEvent

pub unsafe fn content_pos(&self) -> CppBox<QPointF>

Returns the new scroll position.

Calls C++ function: QPointF QScrollEvent::contentPos() const.

C++ documentation:

Returns the new scroll position.

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

The QScrollEvent class is sent when scrolling.

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

C++ documentation:

The QScrollEvent class is sent when scrolling.

The scroll event is sent to indicate that the receiver should be scrolled. Usually the receiver should be something visual like QWidget or QGraphicsObject.

Some care should be taken that no conflicting QScrollEvents are sent from two sources. Using QScroller::scrollTo is save however.

pub unsafe fn new(
    content_pos: impl CastInto<Ref<QPointF>>,
    overshoot: impl CastInto<Ref<QPointF>>,
    scroll_state: ScrollState
) -> CppBox<QScrollEvent>

Creates a new QScrollEvent contentPos is the new content position, overshootDistance is the new overshoot distance while scrollState indicates if this scroll event is the first one, the last one or some event in between.

Calls C++ function: [constructor] void QScrollEvent::QScrollEvent(const QPointF& contentPos, const QPointF& overshoot, QScrollEvent::ScrollState scrollState).

C++ documentation:

Creates a new QScrollEvent contentPos is the new content position, overshootDistance is the new overshoot distance while scrollState indicates if this scroll event is the first one, the last one or some event in between.

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

The QScrollEvent class is sent when scrolling.

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

C++ documentation:

The QScrollEvent class is sent when scrolling.

The scroll event is sent to indicate that the receiver should be scrolled. Usually the receiver should be something visual like QWidget or QGraphicsObject.

Some care should be taken that no conflicting QScrollEvents are sent from two sources. Using QScroller::scrollTo is save however.

pub unsafe fn overshoot_distance(&self) -> CppBox<QPointF>

Returns the new overshoot distance. See QScroller for an explanation of the term overshoot.

Calls C++ function: QPointF QScrollEvent::overshootDistance() const.

C++ documentation:

Returns the new overshoot distance. See QScroller for an explanation of the term overshoot.

See also QScroller.

pub unsafe fn scroll_state(&self) -> ScrollState

Returns the current scroll state as a combination of ScrollStateFlag values. ScrollStarted (or ScrollFinished) will be set, if this scroll event is the first (or last) event in a scrolling activity. Please note that both values can be set at the same time, if the activity consists of a single QScrollEvent. All other scroll events in between will have their state set to ScrollUpdated.

Calls C++ function: QScrollEvent::ScrollState QScrollEvent::scrollState() const.

C++ documentation:

Returns the current scroll state as a combination of ScrollStateFlag values. ScrollStarted (or ScrollFinished) will be set, if this scroll event is the first (or last) event in a scrolling activity. Please note that both values can be set at the same time, if the activity consists of a single QScrollEvent. All other scroll events in between will have their state set to ScrollUpdated.

A widget could for example revert selections when scrolling is started and stopped.

Trait Implementations

impl CppDeletable for QScrollEvent

unsafe fn delete(&mut self)

Destroys QScrollEvent.

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

C++ documentation:

Destroys QScrollEvent.

impl Deref for QScrollEvent

type Target = QEvent

The resulting type after dereferencing.

fn deref(&self) -> &QEvent

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

impl DerefMut for QScrollEvent

fn deref_mut(&mut self) -> &mut QEvent

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

impl DynamicCast<QScrollEvent> for QEvent

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

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

unsafe fn dynamic_cast_mut(ptr: MutPtr<QEvent>) -> MutPtr<QScrollEvent>

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

impl StaticDowncast<QScrollEvent> for QEvent

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

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

unsafe fn static_downcast_mut(ptr: MutPtr<QEvent>) -> MutPtr<QScrollEvent>

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

impl StaticUpcast<QEvent> for QScrollEvent

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

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

unsafe fn static_upcast_mut(ptr: MutPtr<QScrollEvent>) -> MutPtr<QEvent>

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