QScroller Class

メンバ関数のドキュメント

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

現在アクティブなQScroller オブジェクトのアプリケーション全体のリストを返します。アクティブなQScroller オブジェクトは、state()の範囲内にあるものの、QScroller::Inactive ではないものです。この関数は、独自のジェスチャー認識器を作成する際に役立ちます。

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

ビューポート内に矩形rect が表示されるようにスクロールが開始され、その矩形の周囲には、xmargin およびymargin でピクセル単位で指定された追加のマージンが適用されます。

矩形と余白の合計がビューポート内に収まらない場合、rect からできるだけ多くの部分が見えるようにコンテンツがスクロールされます。

スクロール速度は、プラットフォームで定義された時間経過後に指定された位置に到達するように計算されます。

この関数は、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); });

scrollTo()も参照してください 。

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

このバージョンは、scrollTime ミリ秒で目的の位置に到達します。

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

現在のスクロール動作に対する推定最終位置を返します。スクロール状態が「Scrolling」でない場合は、現在の位置を返します。スクロール状態が「Inactive」の場合、結果は未定義となります。

目標位置はピクセル単位です。

pixelPerMeter() およびscrollTo()も参照してください 。

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

カスタムスクロールジェスチャ認識子を登録し、target 用にそれを取得して、結果として得られるジェスチャタイプを返します。scrollGestureType がTouchGesture に設定されている場合、ジェスチャはタッチイベントでトリガーされます。LeftMouseButtonGesture 、RightMouseButtonGesture 、またはMiddleMouseButtonGesture のいずれかに設定されている場合、対応するボタンのマウスイベントでトリガーされます。

1つのオブジェクトに対して、同時に有効にできるスクロールジェスチャーは1つだけです。同じオブジェクトに対してこの関数を2回呼び出すと、新しいジェスチャーを登録する前に、既存のジェスチャーが解除されます。

ungrabGesture() およびgrabbedGesture()も参照してください 。

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

target に対して現在取得されているジェスチャーの種類を返します。ジェスチャーが取得されていない場合は0を返します。

grabGesture() およびungrabGesture()も参照してください 。

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

この関数は、ジェスチャー認識機能が新しい入力イベントをスクローラーに通知するために使用されます。スクローラーは、入力イベントおよび関連付けられたスクローラーのプロパティに基づいて、内部のstate()を変更します。スクローラーは、イベントの発生元となった入力デバイスの種類を区別しません。 したがって、イベントはinput 型、position 、およびミリ秒単位のtimestamp に分割する必要があります。position は、ターゲットの座標系で指定されている必要があります。

戻り値は、イベントを呼び出し元のフィルタで処理する場合はtrue 、コントロールに転送する場合はfalse となります。

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

target に対してQScroller オブジェクトがすでに作成されている場合はtrue を返し、そうでない場合はfalse を返します。

scroller()も参照してください 。

QPointF QScroller::pixelPerMeter() const

スクロールされたウィジェットの「1メートルあたりのピクセル数」という指標を返します。

この値は、QPointF を使用して、x 軸と y 軸それぞれについて個別に報告されます。

[slot] void QScroller::resendPrepareEvent()

この関数は、QScrollPrepareEvent を再送信します。resendPrepareEventを呼び出すと、スクローラーからQScrollPrepareEvent がトリガーされます。これにより、受信側はスクロール中にコンテンツの位置やサイズを再設定できるようになります。非アクティブ状態のときにこの関数を呼び出しても意味がありません。スクロールが開始される前に、準備イベントが再度送信されるためです。

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

ビューポートの左上隅に点pos が来るよう、ウィジェットのスクロールを開始します。

有効なスクロール領域の外側をスクロールした場合の挙動は未定義です。この場合、スクロールがオーバーシュートする場合もあれば、しない場合もあります。

スクロール速度は、プラットフォームで定義された時間経過後に指定された位置に到達するように計算されます。

pos はビューポート座標で指定されます。

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

ensureVisible()も参照してください 。

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

このバージョンは、scrollTime ミリ秒で目的の位置に到達します。

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

指定されたtarget に対応するスクローラーを返します。オブジェクトが存在する限り、この関数は常に同じQScroller インスタンスを返します。target に対応するQScroller が存在しない場合、暗黙的に作成されます。1つのオブジェクトに対して、QScroller が同時に複数アクティブになることはありません。

hasScroller() およびtarget()も参照してください 。

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

これは scroller() の const バージョンです。

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

QScroller スクローラーのプロパティが変更されるたびに、このシグナルを発行します。newProperties は、新しいスクローラーのプロパティです。

「scrollerProperties」も参照してください 。

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

水平軸のスナップ位置を、positions のリストに設定します。これにより、以前に設定されたすべてのスナップ位置およびスナップ間隔が上書きされます。スナップ機能を無効にするには、位置のリストを空に設定します。

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

横軸のスナップ位置を等間隔に設定します。最初のスナップ位置はfirst です。次のスナップ位置はfirst +interval です。これを利用してリストの見出しを実装できます。この設定を行うと、以前に設定されたすべてのスナップ位置およびスナップ間隔が上書きされます。間隔を0.0に設定することで、スナップ機能を無効にできます。

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

垂直軸のスナップ位置を、positions のリストに設定します。これにより、以前に設定されたすべてのスナップ位置およびスナップ間隔が上書きされます。位置のリストを空にすることで、スナップ機能を無効にすることができます。

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

垂直軸のスナップ位置を等間隔に設定します。最初のスナップ位置はfirst です。次のスナップ位置はfirst +interval です。これにより、以前に設定されたすべてのスナップ位置およびスナップ間隔が上書きされます。間隔を0.0に設定することで、スナップ機能を無効にすることができます。

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

QScroller 状態が変化するたびにこのシグナルを発生させます。newState は新しい状態です。

「state」も参照してください 。

void QScroller::stop()

スクロールバーを停止し、その状態を「非アクティブ」に戻します。

QObject *QScroller::target() const

このスクロラーのターゲットオブジェクトを返します。

hasScroller() およびscroller()も参照してください 。

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

target のジェスチャーを解放します。ジェスチャーが取得されていない場合は、何も行いません。

grabGesture() およびgrabbedGesture()も参照してください 。

QPointF QScroller::velocity() const

状態が「Scrolling」または「Dragging」の場合、現在のスクロール速度をメートル毎秒単位で返します。それ以外の場合は、速度をゼロとして返します。

QPointF を使用することで、x 軸と y 軸の速度がそれぞれ個別に報告されます。

pixelPerMeter()も参照してください 。