Struct qt_gui::QScrollPrepareEvent

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

The QScrollPrepareEvent class is sent in preparation of scrolling.

C++ class: QScrollPrepareEvent.

C++ documentation:

The QScrollPrepareEvent class is sent in preparation of scrolling.

The scroll prepare event is sent before scrolling (usually by QScroller) is started. The object receiving this event should set viewportSize, maxContentPos and contentPos. It also should accept this event to indicate that scrolling should be started.

It is not guaranteed that a QScrollEvent will be sent after an acceepted QScrollPrepareEvent, e.g. in a case where the maximum content position is (0,0).

Methods

impl QScrollPrepareEvent

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

Returns the current position of the content as set by setContentPos.

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

C++ documentation:

Returns the current position of the content as set by setContentPos.

See also setContentPos().

pub unsafe fn content_pos_range(&self) -> CppBox<QRectF>

Returns the range of coordinates for the content as set by setContentPosRange().

Calls C++ function: QRectF QScrollPrepareEvent::contentPosRange() const.

C++ documentation:

Returns the range of coordinates for the content as set by setContentPosRange().

See also setContentPosRange().

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

The QScrollPrepareEvent class is sent in preparation of scrolling.

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

C++ documentation:

The QScrollPrepareEvent class is sent in preparation of scrolling.

The scroll prepare event is sent before scrolling (usually by QScroller) is started. The object receiving this event should set viewportSize, maxContentPos and contentPos. It also should accept this event to indicate that scrolling should be started.

It is not guaranteed that a QScrollEvent will be sent after an acceepted QScrollPrepareEvent, e.g. in a case where the maximum content position is (0,0).

pub unsafe fn new(
    start_pos: impl CastInto<Ref<QPointF>>
) -> CppBox<QScrollPrepareEvent>

Creates new QScrollPrepareEvent The startPos is the position of a touch or mouse event that started the scrolling.

Calls C++ function: [constructor] void QScrollPrepareEvent::QScrollPrepareEvent(const QPointF& startPos).

C++ documentation:

Creates new QScrollPrepareEvent The startPos is the position of a touch or mouse event that started the scrolling.

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

The QScrollPrepareEvent class is sent in preparation of scrolling.

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

C++ documentation:

The QScrollPrepareEvent class is sent in preparation of scrolling.

The scroll prepare event is sent before scrolling (usually by QScroller) is started. The object receiving this event should set viewportSize, maxContentPos and contentPos. It also should accept this event to indicate that scrolling should be started.

It is not guaranteed that a QScrollEvent will be sent after an acceepted QScrollPrepareEvent, e.g. in a case where the maximum content position is (0,0).

pub unsafe fn set_content_pos(&self, pos: impl CastInto<Ref<QPointF>>)

Sets the current content position to pos.

Calls C++ function: void QScrollPrepareEvent::setContentPos(const QPointF& pos).

C++ documentation:

Sets the current content position to pos.

See also contentPos().

pub unsafe fn set_content_pos_range(&self, rect: impl CastInto<Ref<QRectF>>)

Sets the range of content coordinates to rect.

Calls C++ function: void QScrollPrepareEvent::setContentPosRange(const QRectF& rect).

C++ documentation:

Sets the range of content coordinates to rect.

See also contentPosRange().

pub unsafe fn set_viewport_size(&self, size: impl CastInto<Ref<QSizeF>>)

Sets the size of the area that is to be scrolled to size.

Calls C++ function: void QScrollPrepareEvent::setViewportSize(const QSizeF& size).

C++ documentation:

Sets the size of the area that is to be scrolled to size.

See also viewportSize().

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

Returns the position of the touch or mouse event that started the scrolling.

Calls C++ function: QPointF QScrollPrepareEvent::startPos() const.

C++ documentation:

Returns the position of the touch or mouse event that started the scrolling.

pub unsafe fn viewport_size(&self) -> CppBox<QSizeF>

Returns size of the area that is to be scrolled as set by setViewportSize

Calls C++ function: QSizeF QScrollPrepareEvent::viewportSize() const.

C++ documentation:

Returns size of the area that is to be scrolled as set by setViewportSize

See also setViewportSize().

Trait Implementations

impl CppDeletable for QScrollPrepareEvent

unsafe fn delete(&self)

Destroys QScrollEvent.

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

C++ documentation:

Destroys QScrollEvent.

impl Deref for QScrollPrepareEvent

type Target = QEvent

The resulting type after dereferencing.

fn deref(&self) -> &QEvent

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

impl DynamicCast<QScrollPrepareEvent> for QEvent

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

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

impl StaticDowncast<QScrollPrepareEvent> for QEvent

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

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

impl StaticUpcast<QEvent> for QScrollPrepareEvent

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

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