Struct qt_gui::QScrollPrepareEvent
source · #[repr(C)]pub struct QScrollPrepareEvent { /* private fields */ }
Expand description
The QScrollPrepareEvent class is sent in preparation of scrolling.
C++ class: QScrollPrepareEvent
.
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).
Implementations§
source§impl QScrollPrepareEvent
impl QScrollPrepareEvent
sourcepub unsafe fn content_pos(&self) -> CppBox<QPointF>
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
.
Returns the current position of the content as set by setContentPos.
See also setContentPos().
sourcepub unsafe fn content_pos_range(&self) -> CppBox<QRectF>
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
.
Returns the range of coordinates for the content as set by setContentPosRange().
See also setContentPosRange().
sourcepub unsafe fn copy_from(
&self,
other: impl CastInto<Ref<QScrollPrepareEvent>>
) -> Ref<QScrollPrepareEvent>
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)
.
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).
sourcepub unsafe fn new(
start_pos: impl CastInto<Ref<QPointF>>
) -> CppBox<QScrollPrepareEvent>
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)
.
Creates new QScrollPrepareEvent The startPos is the position of a touch or mouse event that started the scrolling.
sourcepub unsafe fn new_copy(
other: impl CastInto<Ref<QScrollPrepareEvent>>
) -> CppBox<QScrollPrepareEvent>
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)
.
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).
sourcepub unsafe fn set_content_pos(&self, pos: impl CastInto<Ref<QPointF>>)
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)
.
Sets the current content position to pos.
See also contentPos().
sourcepub unsafe fn set_content_pos_range(&self, rect: impl CastInto<Ref<QRectF>>)
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)
.
Sets the range of content coordinates to rect.
See also contentPosRange().
sourcepub unsafe fn set_viewport_size(&self, size: impl CastInto<Ref<QSizeF>>)
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)
.
Sets the size of the area that is to be scrolled to size.
See also viewportSize().
sourcepub unsafe fn start_pos(&self) -> CppBox<QPointF>
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
.
Returns the position of the touch or mouse event that started the scrolling.
sourcepub unsafe fn viewport_size(&self) -> CppBox<QSizeF>
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
.
Returns size of the area that is to be scrolled as set by setViewportSize
See also setViewportSize().
Methods from Deref<Target = QEvent>§
sourcepub unsafe fn accept(&self)
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()
.
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().
sourcepub unsafe fn copy_from(&self, other: impl CastInto<Ref<QEvent>>) -> Ref<QEvent>
pub unsafe fn copy_from(&self, other: impl CastInto<Ref<QEvent>>) -> Ref<QEvent>
Calls C++ function: QEvent& QEvent::operator=(const QEvent& other)
.
sourcepub unsafe fn ignore(&self)
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()
.
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().
sourcepub unsafe fn is_accepted(&self) -> bool
pub unsafe fn is_accepted(&self) -> bool
the accept flag of the event object
Calls C++ function: bool QEvent::isAccepted() const
.
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) |
sourcepub unsafe fn set_accepted(&self, accepted: bool)
pub unsafe fn set_accepted(&self, accepted: bool)
the accept flag of the event object
Calls C++ function: void QEvent::setAccepted(bool accepted)
.
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) |
sourcepub unsafe fn spontaneous(&self) -> bool
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
.
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.
Trait Implementations§
source§impl CppDeletable for QScrollPrepareEvent
impl CppDeletable for QScrollPrepareEvent
source§unsafe fn delete(&self)
unsafe fn delete(&self)
Destroys QScrollEvent.
Calls C++ function: virtual [destructor] void QScrollPrepareEvent::~QScrollPrepareEvent()
.
Destroys QScrollEvent.
source§impl Deref for QScrollPrepareEvent
impl Deref for QScrollPrepareEvent
source§impl DynamicCast<QScrollPrepareEvent> for QEvent
impl DynamicCast<QScrollPrepareEvent> for QEvent
source§unsafe fn dynamic_cast(ptr: Ptr<QEvent>) -> Ptr<QScrollPrepareEvent>
unsafe fn dynamic_cast(ptr: Ptr<QEvent>) -> Ptr<QScrollPrepareEvent>
Calls C++ function: QScrollPrepareEvent* dynamic_cast<QScrollPrepareEvent*>(QEvent* ptr)
.
source§impl StaticDowncast<QScrollPrepareEvent> for QEvent
impl StaticDowncast<QScrollPrepareEvent> for QEvent
source§unsafe fn static_downcast(ptr: Ptr<QEvent>) -> Ptr<QScrollPrepareEvent>
unsafe fn static_downcast(ptr: Ptr<QEvent>) -> Ptr<QScrollPrepareEvent>
Calls C++ function: QScrollPrepareEvent* static_cast<QScrollPrepareEvent*>(QEvent* ptr)
.
source§impl StaticUpcast<QEvent> for QScrollPrepareEvent
impl StaticUpcast<QEvent> for QScrollPrepareEvent
source§unsafe fn static_upcast(ptr: Ptr<QScrollPrepareEvent>) -> Ptr<QEvent>
unsafe fn static_upcast(ptr: Ptr<QScrollPrepareEvent>) -> Ptr<QEvent>
Calls C++ function: QEvent* static_cast<QEvent*>(QScrollPrepareEvent* ptr)
.