API reference - Class QScrollPrepareEvent

Notation used in Ruby API documentation

Module: QtGui

Description: Binding of QScrollPrepareEvent

Class hierarchy: QScrollPrepareEvent » QEvent

Public constructors

new QScrollPrepareEventnew(const QPointF startPos)Constructor QScrollPrepareEvent::QScrollPrepareEvent(const QPointF &startPos)

Public methods

void_assign(const QScrollPrepareEvent other)Assigns another object to self
void_createEnsures the C++ object is created
void_destroyExplicitly destroys the object
[const]bool_destroyed?Returns a value indicating whether the object was already destroyed
[const]new QScrollPrepareEvent ptr_dupCreates a copy of self
[const]bool_is_const_object?Returns a value indicating whether the reference is a const reference
void_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
[const]QPointFcontentPosMethod QPointF QScrollPrepareEvent::contentPos()
voidcontentPos=(const QPointF pos)Method void QScrollPrepareEvent::setContentPos(const QPointF &pos)
[const]QRectFcontentPosRangeMethod QRectF QScrollPrepareEvent::contentPosRange()
voidcontentPosRange=(const QRectF rect)Method void QScrollPrepareEvent::setContentPosRange(const QRectF &rect)
voidsetContentPos(const QPointF pos)Method void QScrollPrepareEvent::setContentPos(const QPointF &pos)
voidsetContentPosRange(const QRectF rect)Method void QScrollPrepareEvent::setContentPosRange(const QRectF &rect)
voidsetViewportSize(const QSizeF size)Method void QScrollPrepareEvent::setViewportSize(const QSizeF &size)
[const]QPointFstartPosMethod QPointF QScrollPrepareEvent::startPos()
[const]QSizeFviewportSizeMethod QSizeF QScrollPrepareEvent::viewportSize()
voidviewportSize=(const QSizeF size)Method void QScrollPrepareEvent::setViewportSize(const QSizeF &size)

Detailed description

_assign

Signature: void _assign (const QScrollPrepareEvent other)

Description: Assigns another object to self

_create

Signature: void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

_destroy

Signature: void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

_destroyed?

Signature: [const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

_dup

Signature: [const] new QScrollPrepareEvent ptr _dup

Description: Creates a copy of self

_is_const_object?

Signature: [const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

_manage

Signature: void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

_unmanage

Signature: void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

contentPos

Signature: [const] QPointF contentPos

Description: Method QPointF QScrollPrepareEvent::contentPos()

Python specific notes:
The object exposes a readable attribute 'contentPos'. This is the getter.

contentPos=

Signature: void contentPos= (const QPointF pos)

Description: Method void QScrollPrepareEvent::setContentPos(const QPointF &pos)

Python specific notes:
The object exposes a writable attribute 'contentPos'. This is the setter.

contentPosRange

Signature: [const] QRectF contentPosRange

Description: Method QRectF QScrollPrepareEvent::contentPosRange()

Python specific notes:
The object exposes a readable attribute 'contentPosRange'. This is the getter.

contentPosRange=

Signature: void contentPosRange= (const QRectF rect)

Description: Method void QScrollPrepareEvent::setContentPosRange(const QRectF &rect)

Python specific notes:
The object exposes a writable attribute 'contentPosRange'. This is the setter.

new

Signature: [static] new QScrollPrepareEvent new (const QPointF startPos)

Description: Constructor QScrollPrepareEvent::QScrollPrepareEvent(const QPointF &startPos)

This method creates an object of class QScrollPrepareEvent.

Python specific notes:
This method is the default initializer of the object.

setContentPos

Signature: void setContentPos (const QPointF pos)

Description: Method void QScrollPrepareEvent::setContentPos(const QPointF &pos)

Python specific notes:
The object exposes a writable attribute 'contentPos'. This is the setter.

setContentPosRange

Signature: void setContentPosRange (const QRectF rect)

Description: Method void QScrollPrepareEvent::setContentPosRange(const QRectF &rect)

Python specific notes:
The object exposes a writable attribute 'contentPosRange'. This is the setter.

setViewportSize

Signature: void setViewportSize (const QSizeF size)

Description: Method void QScrollPrepareEvent::setViewportSize(const QSizeF &size)

Python specific notes:
The object exposes a writable attribute 'viewportSize'. This is the setter.

startPos

Signature: [const] QPointF startPos

Description: Method QPointF QScrollPrepareEvent::startPos()

viewportSize

Signature: [const] QSizeF viewportSize

Description: Method QSizeF QScrollPrepareEvent::viewportSize()

Python specific notes:
The object exposes a readable attribute 'viewportSize'. This is the getter.

viewportSize=

Signature: void viewportSize= (const QSizeF size)

Description: Method void QScrollPrepareEvent::setViewportSize(const QSizeF &size)

Python specific notes:
The object exposes a writable attribute 'viewportSize'. This is the setter.