QScroller Class

Documentation des fonctions membres

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

Renvoie une liste des objets QScroller actuellement actifs, à l'échelle de l'application. Les objets QScroller actifs se trouvent dans un state() qui n'est pas QScroller::Inactive. Cette fonction est utile lorsque vous écrivez votre propre reconnaissance de gestes.

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

Commence le défilement de manière à ce que le rectangle rect soit visible à l'intérieur de la fenêtre de visualisation, avec des marges supplémentaires spécifiées en pixels par xmargin et ymargin autour du rectangle.

Dans les cas où il n'est pas possible de faire tenir le rectangle et les marges à l'intérieur de la fenêtre de visualisation, le contenu est défilé de manière à ce que la plus grande partie possible soit visible à partir de rect.

La vitesse de défilement est calculée de manière à ce que la position donnée soit atteinte après un laps de temps défini par la plateforme.

Cette fonction effectue le défilement proprement dit en appelant 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); });

Voir aussi scrollTo().

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

Cette version atteindra sa position de destination en scrollTime millisecondes.

// 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

Renvoie la position finale estimée pour le mouvement de défilement actuel. Renvoie la position actuelle si l'état du défileur n'est pas Défilement. Le résultat est indéfini si l'état du défileur est Inactif.

La position cible est exprimée en pixels.

Voir aussi pixelPerMeter() et scrollTo().

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

Enregistre un reconnaissant de geste de défilement personnalisé, le saisit pour target et renvoie le type de geste résultant. Si scrollGestureType est défini sur TouchGesture, le geste se déclenche sur les événements tactiles. S'il est défini sur LeftMouseButtonGesture, RightMouseButtonGesture ou MiddleMouseButtonGesture, il se déclenche sur les événements de souris du bouton correspondant.

Un seul geste de défilement peut être actif simultanément sur un même objet. Si vous appelez cette fonction deux fois sur le même objet, elle annulera le geste existant avant de saisir le nouveau.

Voir également ungrabGesture() et grabbedGesture().

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

Renvoie le type de geste actuellement saisi pour target ou 0 si aucun geste n'est saisi.

Voir aussi grabGesture() et ungrabGesture().

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

Cette fonction est utilisée par les outils de reconnaissance gestuelle pour informer le défileur de l'existence d'un nouvel événement d'entrée. Le défileur modifie son state() interne en fonction de l'événement d'entrée et des propriétés de défilement qui lui sont attachées. Le défileur ne fait pas de distinction entre le type de périphérique d'entrée à l'origine de l'événement. Par conséquent, l'événement doit être divisé en un type input, un position et un milli-seconde timestamp. Le position doit se trouver dans le système de coordonnées de la cible.

La valeur de retour est true si l'événement doit être consommé par le filtre appelant ou false si l'événement doit être transmis au contrôle.

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

Renvoie true si un objet QScroller a déjà été créé pour target; false sinon.

Voir aussi scroller().

QPointF QScroller::pixelPerMeter() const

Renvoie le nombre de pixels par mètre pour le widget défilant.

La valeur est indiquée séparément pour les axes x et y à l'aide d'une adresse QPointF.

[slot] void QScroller::resendPrepareEvent()

Cette fonction renvoie l'adresse QScrollPrepareEvent. L'appel à resendPrepareEvent déclenche l'envoi de QScrollPrepareEvent par le défileur. Cela permet au destinataire de redéfinir la position et la taille du contenu pendant le défilement. Il est inutile d'appeler cette fonction lorsque l'état est inactif, car l'événement de préparation est à nouveau envoyé avant le début du défilement.

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

Démarre le défilement du widget de sorte que le point pos se trouve en haut à gauche de la fenêtre.

Le comportement en cas de défilement en dehors de la zone de défilement valide n'est pas défini. Dans ce cas, le défileur peut ou non dépasser la vitesse de défilement.

La vitesse de défilement sera calculée de manière à ce que la position donnée soit atteinte après un laps de temps défini par la plateforme.

pos La position est donnée en coordonnées de la fenêtre d'affichage.

// 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); });

Voir aussi ensureVisible().

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

Cette version atteindra sa position de destination en scrollTime millisecondes.

// 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)

Renvoie le scroller pour l'objet target. Tant que l'objet existe, cette fonction renvoie toujours la même instance QScroller. S'il n'existe pas de QScroller pour le target, une instance sera implicitement créée. À aucun moment, plus d'un QScroller ne sera actif sur un objet.

Voir également hasScroller() et target().

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

Il s'agit de la version const de scroller().

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

QScroller émet ce signal chaque fois que ses propriétés de défilement changent. newProperties sont les nouvelles propriétés de défilement.

Voir aussi scrollerProperties.

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

Définir les positions d'accrochage pour l'axe horizontal dans une liste de positions. Cela remplace toutes les positions d'accrochage précédemment définies ainsi que l'intervalle d'accrochage précédemment défini. L'accrochage peut être désactivé en définissant une liste de positions vide.

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

Définissez les positions d'accrochage de l'axe horizontal à intervalles réguliers. La première position d'accrochage se trouve à first. La suivante est first + interval. Ceci peut être utilisé pour implémenter un en-tête de liste. Cela écrase toutes les positions d'accrochage précédemment définies, ainsi que l'intervalle d'accrochage précédemment défini. L'accrochage peut être désactivé en définissant un intervalle de 0,0.

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

Définir les positions d'accrochage pour l'axe vertical dans une liste de positions. Cela remplace toutes les positions d'accrochage précédemment définies ainsi que l'intervalle d'accrochage précédemment défini. L'accrochage peut être désactivé en définissant une liste de positions vide.

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

Définissez les positions d'accrochage de l'axe vertical à intervalles réguliers. La première position d'accrochage se trouve à first. La suivante est first + interval. Cela écrase toutes les positions d'accrochage précédemment définies, ainsi que l'intervalle d'accrochage précédemment défini. L'accrochage peut être désactivé en définissant un intervalle de 0,0.

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

QScroller émet ce signal chaque fois que l'état change. newState est le nouvel état.

Voir aussi state.

void QScroller::stop()

Arrête le défileur et rétablit son état à Inactif.

QObject *QScroller::target() const

Renvoie l'objet cible de ce scroller.

Voir aussi hasScroller() et scroller().

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

Libère le geste pour le site target. Ne fait rien si aucun geste n'est saisi.

Voir aussi grabGesture() et grabbedGesture().

QPointF QScroller::velocity() const

Renvoie la vitesse de défilement actuelle en mètres par seconde lorsque l'état est Défilement ou Glissement. Renvoie une vitesse nulle dans le cas contraire.

La vitesse est indiquée séparément pour les axes x et y à l'aide d'une adresse QPointF.

Voir également pixelPerMeter().