QScroller Class

Documentación de las funciones miembro

[static] QList<QScroller *> QScroller::activeScrollers()

Devuelve una lista de todos los objetos QScroller activos en la aplicación. Los objetos QScroller activos se encuentran en un state() que no es QScroller::Inactive. Esta función es útil cuando escribes tu propio reconocedor de gestos.

[slot] void QScroller::ensureVisible(const QRectF &rect, qreal xmargin, qreal ymargin)

Inicia el desplazamiento de forma que el rectángulo rect sea visible dentro de la ventana gráfica con márgenes adicionales especificados en píxeles por xmargin y ymargin alrededor del rectángulo.

En los casos en los que no es posible ajustar el rectángulo más los márgenes dentro de la ventana gráfica, el contenido se desplaza de forma que sea visible desde rect tanto como sea posible.

La velocidad de desplazamiento se calcula de forma que la posición dada se alcance tras un lapso de tiempo definido por la plataforma.

Esta función realiza el desplazamiento real llamando a scrollTo().

// Connect using qOverload:
connect(sender, &SenderClass::signal,
        scroller, qOverload(&QScroller::ensureVisible));

// Or using a lambda as wrapper:
connect(sender, &SenderClass::signal,
        scroller, [receiver = scroller](const QRectF &rect, qreal xmargin, qreal ymargin) { receiver->ensureVisible(rect, xmargin, ymargin); });

Véase también scrollTo().

[slot] void QScroller::ensureVisible(const QRectF &rect, qreal xmargin, qreal ymargin, int scrollTime)

Esta versión alcanzará su posición de destino en scrollTime milisegundos.

// Connect using qOverload:
connect(sender, &SenderClass::signal,
        scroller, qOverload(&QScroller::ensureVisible));

// Or using a lambda as wrapper:
connect(sender, &SenderClass::signal,
        scroller, [receiver = scroller](const QRectF &rect, qreal xmargin, qreal ymargin, int scrollTime) { receiver->ensureVisible(rect, xmargin, ymargin, scrollTime); });

QPointF QScroller::finalPosition() const

Devuelve la posición final estimada para el movimiento de desplazamiento actual. Devuelve la posición actual si el estado del desplazamiento no es Desplazamiento. El resultado es indefinido si el estado del desplazamiento es Inactivo.

La posición final está en píxeles.

Véase también pixelPerMeter() y scrollTo().

[static] Qt::GestureType QScroller::grabGesture(QObject *target, QScroller::ScrollerGestureType scrollGestureType = TouchGesture)

Registra un reconocedor de gestos de desplazamiento personalizado, lo toma para target y devuelve el tipo de gesto resultante. Si scrollGestureType está configurado como TouchGesture, el gesto se activa con los eventos táctiles. Si está configurado como LeftMouseButtonGesture, RightMouseButtonGesture o MiddleMouseButtonGesture, el gesto se activa con los eventos de ratón del botón correspondiente.

Sólo puede haber un gesto de desplazamiento activo en un objeto al mismo tiempo. Si se llama a esta función dos veces sobre el mismo objeto, se desanclará el gesto existente antes de anclar el nuevo.

Véase también ungrabGesture() y grabbedGesture().

[static] Qt::GestureType QScroller::grabbedGesture(QObject *target)

Devuelve el tipo de gesto actualmente capturado para target o 0 si no hay ningún gesto capturado.

Véase también grabGesture() y ungrabGesture().

bool QScroller::handleInput(QScroller::Input input, const QPointF &position, qint64 timestamp = 0)

Esta función es utilizada por los reconocedores de gestos para informar al desplazador sobre un nuevo evento de entrada. El desplazador cambia su dirección interna state() de acuerdo con el evento de entrada y sus propiedades de desplazamiento adjuntas. El scroller no distingue entre el tipo de dispositivo de entrada del que proviene el evento. Por lo tanto el evento necesita ser dividido en el tipo input, un position y un milisegundo timestamp. El position necesita estar en el sistema de coordenadas del objetivo.

El valor de retorno es true si el evento debe ser consumido por el filtro de llamada o false si el evento debe ser reenviado al control.

[static] bool QScroller::hasScroller(QObject *target)

Devuelve true si ya se ha creado un objeto QScroller para target; false en caso contrario.

Véase también scroller().

QPointF QScroller::pixelPerMeter() const

Devuelve la métrica de píxeles por metro para el widget desplazado.

El valor se indica para los ejes x e y por separado utilizando QPointF.

[slot] void QScroller::resendPrepareEvent()

Esta función reenvía el QScrollPrepareEvent. La llamada a resendPrepareEvent desencadena un QScrollPrepareEvent desde el scroller. Esto permite al receptor reajustar la posición y el tamaño del contenido mientras se desplaza. Llamar a esta función mientras se está en estado Inactivo es inútil ya que el evento prepare se envía de nuevo antes de que comience el desplazamiento.

[slot] void QScroller::scrollTo(const QPointF &pos)

Inicia el desplazamiento del widget de modo que el punto pos se encuentre en la posición superior izquierda de la ventana gráfica.

El comportamiento cuando se desplaza fuera del área de desplazamiento válida no está definido. En este caso, el desplazamiento puede sobrepasarse o no.

La velocidad de desplazamiento se calculará de forma que la posición dada se alcance tras un lapso de tiempo definido por la plataforma.

pos se da en coordenadas de la ventana gráfica.

// Connect using qOverload:
connect(sender, &SenderClass::signal,
        scroller, qOverload(&QScroller::scrollTo));

// Or using a lambda as wrapper:
connect(sender, &SenderClass::signal,
        scroller, [receiver = scroller](const QPointF &pos) { receiver->scrollTo(pos); });

Véase también ensureVisible().

[slot] void QScroller::scrollTo(const QPointF &pos, int scrollTime)

Esta versión alcanzará su posición de destino en scrollTime milisegundos.

// Connect using qOverload:
connect(sender, &SenderClass::signal,
        scroller, qOverload(&QScroller::scrollTo));

// Or using a lambda as wrapper:
connect(sender, &SenderClass::signal,
        scroller, [receiver = scroller](const QPointF &pos, int scrollTime) { receiver->scrollTo(pos, scrollTime); });

[static] QScroller *QScroller::scroller(QObject *target)

Devuelve el desplazamiento del objeto target. Mientras el objeto exista, esta función devolverá siempre la misma instancia QScroller. Si no existe ningún QScroller para el target, se creará uno implícitamente. En ningún momento habrá más de un QScroller activo en un objeto.

Véase también hasScroller() y target().

[static] const QScroller *QScroller::scroller(const QObject *target)

Esta es la versión const de scroller().

[signal] void QScroller::scrollerPropertiesChanged(const QScrollerProperties &newProperties)

QScroller emite esta señal cada vez que sus propiedades de desplazamiento cambian. newProperties son las nuevas propiedades de desplazamiento.

Véase también scrollerProperties.

void QScroller::setSnapPositionsX(const QList<qreal> &positions)

Establezca las posiciones de ajuste para el eje horizontal en una lista de positions. Esto sobrescribe todas las posiciones de ajuste establecidas anteriormente y también un intervalo de ajuste establecido previamente. El ajuste puede desactivarse estableciendo una lista vacía de posiciones.

void QScroller::setSnapPositionsX(qreal first, qreal interval)

Ajuste las posiciones de ajuste para el eje horizontal a intervalos espaciados regulares. La primera posición de ajuste es first. La siguiente en first + interval. Esto se puede utilizar para implementar una cabecera de lista. Esto sobrescribe todas las posiciones de ajuste previamente establecidas y también un intervalo de ajuste previamente establecido. El ajuste puede desactivarse estableciendo un intervalo de 0.0

void QScroller::setSnapPositionsY(const QList<qreal> &positions)

Establezca las posiciones de ajuste para el eje vertical en una lista de positions. Esto sobrescribe todas las posiciones de ajuste establecidas anteriormente y también un intervalo de ajuste establecido previamente. El ajuste puede desactivarse estableciendo una lista vacía de posiciones.

void QScroller::setSnapPositionsY(qreal first, qreal interval)

Ajuste las posiciones de ajuste para el eje vertical a intervalos espaciados regulares. La primera posición de ajuste es first. La siguiente en first + interval. Esto sobrescribe todas las posiciones de ajuste previamente establecidas y también un intervalo de ajuste previamente establecido. El ajuste puede desactivarse estableciendo un intervalo de 0.0

[signal] void QScroller::stateChanged(QScroller::State newState)

QScroller emite esta señal cada vez que cambia el estado. newState es el nuevo Estado.

Véase también state.

void QScroller::stop()

Detiene el desplazamiento y restablece su estado a Inactivo.

QObject *QScroller::target() const

Devuelve el objeto destino de este scroller.

Véase también hasScroller() y scroller().

[static] void QScroller::ungrabGesture(QObject *target)

Libera el gesto para target. No hace nada si no hay ningún gesto agarrado.

Véase también grabGesture() y grabbedGesture().

QPointF QScroller::velocity() const

Devuelve la velocidad de desplazamiento actual en metros por segundo cuando el estado es Desplazamiento o Arrastre. En caso contrario, devuelve una velocidad cero.

La velocidad se indica para los ejes x e y por separado utilizando QPointF.

Véase también pixelPerMeter().