PinchHandler QML Type

Handler for pinch gestures. 更多...

import 语句：	import QtQuick
继承：	MultiPointHandler

• 所有成员列表，包括继承成员
• 弃用成员

特性

• acceptedDevices : flags
• acceptedModifiers : flags
• acceptedPointerTypes : flags
• active : bool
• activeRotation : real
• activeScale : real
• activeTranslation : QPointF
• centroid : QtQuick::handlerPoint
• cursorShape : Qt::CursorShape
• dragThreshold : int
• enabled : bool
• grabPermissions : flags
• margin : real
• parent : Item
• persistentRotation : real
• persistentScale : real
• persistentTranslation : QPointF
• rotationAxis
  • rotationAxis.activeValue : real
  • rotationAxis.enabled : bool
  • rotationAxis.maximum : real
  • rotationAxis.minimum : real
• scaleAxis
  • scaleAxis.activeValue : real
  • scaleAxis.enabled : bool
  • scaleAxis.maximum : real
  • scaleAxis.minimum : real
• target : Item
• xAxis
  • xAxis.activeValue : real
  • xAxis.enabled : bool
  • xAxis.maximum : real
  • xAxis.minimum : real
• yAxis
  • yAxis.activeValue : real
  • yAxis.enabled : bool
  • yAxis.maximum : real
  • yAxis.minimum : real

信号

• canceled (eventPoint point )
• grabChanged (PointerDevice::GrabTransition transition , eventPoint point )
• rotationChanged (qreal delta )
• scaleChanged (qreal delta )
• translationChanged (QVector2D delta )

详细描述

PinchHandler is a handler that interprets a multi-finger gesture to interactively rotate, zoom, and drag an Item. Like other Input Handlers, by default it is fully functional, and manipulates its target , which is the Item within which it is declared.

import QtQuick
Rectangle {
    width: 400
    height: 300
    color: "lightsteelblue"
    PinchHandler { }
}
					

It has properties to restrict the range of dragging, rotation, and zoom.

If it is declared within one Item but is assigned a different target , it handles events within the bounds of the outer Item but manipulates the target Item instead:

import QtQuick
Item {
    width: 640
    height: 480
    Rectangle {
        id: map
        color: "aqua"
        width: 400
        height: 300
    }
    PinchHandler {
        target: map
    }
}
					

A third way to use it is to set target to null and react to property changes in some other way:

import QtQuick
Window {
    width: 320; height: 240
    visible: true
    title: handler.persistentRotation.toFixed(1) + "° " +
           handler.persistentTranslation.x.toFixed(1) + ", " +
           handler.persistentTranslation.y.toFixed(1) + " " +
           (handler.persistentScale * 100).toFixed(1) + "%"
    PinchHandler {
        id: handler
        target: null
        persistentScale: 0.25
        onTranslationChanged: (delta) => {
            image.x -= delta.x
            image.y -= delta.y
        }
    }
    Image {
        id: image
        source: "images/album-cover.jpg"
        scale: handler.persistentScale
        x: -600; y: -450
    }
}
					

注意： The pinch begins when the number of fingers pressed is between minimumPointCount and maximumPointCount , inclusive. Until then, PinchHandler tracks the positions of any pressed fingers, but if it's a disallowed number, it does not scale or rotate its target ，和 active property remains false .

另请参阅 PinchArea , QPointerEvent::pointCount (), QNativeGestureEvent::fingerCount ()，和 Qt Quick Examples - Pointer Handlers .

特性文档编制

acceptedDevices : flags

The types of pointing devices that can activate this Pointer Handler.

默认情况下，此特性被设为 PointerDevice.AllDevices . If you set it to an OR combination of device types, it will ignore events from non-matching devices.

For example, a control could be made to respond to mouse and stylus clicks in one way, and touchscreen taps in another way, with two handlers:

Item {
   TapHandler {
       acceptedDevices: PointerDevice.Mouse | PointerDevice.TouchPad | PointerDevice.Stylus
       onTapped: console.log("clicked")
   }
   TapHandler {
       acceptedDevices: PointerDevice.TouchScreen
       onTapped: console.log("tapped")
   }
}
					

注意： Not all platforms are yet able to distinguish mouse and touchpad; and on those that do, you often want to make mouse and touchpad behavior the same.

acceptedModifiers : flags

If this property is set, it will require the given keyboard modifiers to be pressed in order to react to pointer events, and otherwise ignore them.

If this property is set to Qt.KeyboardModifierMask (the default value), then the PointerHandler ignores the modifier keys.

For example, an Item could have two handlers of the same type, one of which is enabled only if the required keyboard modifiers are pressed:

Item {
   TapHandler {
       acceptedModifiers: Qt.ControlModifier
       onTapped: console.log("control-tapped")
   }
   TapHandler {
       acceptedModifiers: Qt.NoModifier
       onTapped: console.log("tapped")
   }
}
					

若设置 acceptedModifiers to an OR combination of modifier keys, it means all of those modifiers must be pressed to activate the handler:

Item {
   TapHandler {
       acceptedModifiers: Qt.ControlModifier | Qt.AltModifier | Qt.ShiftModifier
       onTapped: console.log("control-alt-shift-tapped")
   }
}
					

The available modifiers are as follows:

常量	描述
NoModifier	No modifier key is allowed.
ShiftModifier	A Shift key on the keyboard must be pressed.
ControlModifier	A Ctrl key on the keyboard must be pressed.
AltModifier	An Alt key on the keyboard must be pressed.
MetaModifier	A Meta key on the keyboard must be pressed.
KeypadModifier	A keypad button must be pressed.
GroupSwitchModifier	X11 only (unless activated on Windows by a command line argument). A Mode_switch key on the keyboard must be pressed.
KeyboardModifierMask	The handler does not care which modifiers are pressed.

If you need even more complex behavior than can be achieved with combinations of multiple handlers with multiple modifier flags, you can check the modifiers in JavaScript code:

Item {
    TapHandler {
        onTapped:
            switch (point.modifiers) {
            case Qt.ControlModifier | Qt.AltModifier:
                console.log("CTRL+ALT");
                break;
            case Qt.ControlModifier | Qt.AltModifier | Qt.MetaModifier:
                console.log("CTRL+META+ALT");
                break;
            default:
                console.log("other modifiers", point.modifiers);
                break;
            }
    }
}
					

另请参阅 Qt::KeyboardModifier .

acceptedPointerTypes : flags

The types of pointing instruments (finger, stylus, eraser, etc.) that can activate this Pointer Handler.

默认情况下，此特性被设为 PointerDevice.AllPointerTypes . If you set it to an OR combination of device types, it will ignore events from non-matching devices .

For example, a control could be made to respond to mouse, touch, and stylus clicks in some way, but delete itself if tapped with an eraser tool on a graphics tablet, with two handlers:

Rectangle {
   id: rect
   TapHandler {
       acceptedPointerTypes: PointerDevice.Generic | PointerDevice.Finger | PointerDevice.Pen
       onTapped: console.log("clicked")
   }
   TapHandler {
       acceptedPointerTypes: PointerDevice.Eraser
       onTapped: rect.destroy()
   }
}
					

active : bool [read-only]

此特性是 true when all the constraints (epecially minimumPointCount and maximumPointCount ) are satisfied and the target , if any, is being manipulated.

activeRotation : real [read-only]

The rotation of the pinch gesture in degrees, with positive values clockwise. It is 0 when the gesture begins. If target is not null, this will be automatically added to its rotation . Otherwise, bindings can be used to do arbitrary things with this value.

另请参阅 QtQuick::PinchHandler::rotationAxis.activeValue .

activeScale : real [read-only]

The scale factor while the pinch gesture is being performed. It is 1.0 when the gesture begins, increases as the touchpoints are spread apart, and decreases as the touchpoints are brought together. If target is not null, its scale will be automatically multiplied by this value. Otherwise, bindings can be used to do arbitrary things with this value.

另请参阅 QtQuick::PinchHandler::scaleAxis.activeValue .

activeTranslation : QPointF [read-only]

The translation of the cluster of points while the pinch gesture is being performed. It is 0, 0 when the gesture begins, and increases as the eventPoint(s) are dragged downward and to the right. After the gesture ends, it stays the same; and when the next pinch gesture begins, it is reset to 0, 0 再次。

注意： On some touchpads, such as on a macOS trackpad, native gestures do not generate any translation values, and this property stays at (0, 0) .

centroid : QtQuick::handlerPoint [read-only]

A point exactly in the middle of the currently-pressed touch points. The target will be rotated around this point.

cursorShape : Qt::CursorShape

This property holds the cursor shape that will appear whenever the mouse is hovering over the parent item while active is true .

The available cursor shapes are:

• Qt.ArrowCursor
• Qt.UpArrowCursor
• Qt.CrossCursor
• Qt.WaitCursor
• Qt.IBeamCursor
• Qt.SizeVerCursor
• Qt.SizeHorCursor
• Qt.SizeBDiagCursor
• Qt.SizeFDiagCursor
• Qt.SizeAllCursor
• Qt.BlankCursor
• Qt.SplitVCursor
• Qt.SplitHCursor
• Qt.PointingHandCursor
• Qt.ForbiddenCursor
• Qt.WhatsThisCursor
• Qt.BusyCursor
• Qt.OpenHandCursor
• Qt.ClosedHandCursor
• Qt.DragCopyCursor
• Qt.DragMoveCursor
• Qt.DragLinkCursor

The default value is not set, which allows the cursor of parent item to appear. This property can be reset to the same initial condition by setting it to undefined.

注意： When this property has not been set, or has been set to undefined , if you read the value it will return Qt.ArrowCursor .

另请参阅 Qt::CursorShape , QQuickItem::cursor ()，和 HoverHandler::cursorShape .

dragThreshold : int

The distance in pixels that the user must drag an eventPoint in order to have it treated as a drag gesture.

The default value depends on the platform and screen resolution. It can be reset back to the default value by setting it to undefined. The behavior when a drag gesture begins varies in different handlers.

enabled : bool

若 PointerHandler is disabled, it will reject all events and no signals will be emitted.

grabPermissions : flags

This property specifies the permissions when this handler's logic decides to take over the exclusive grab, or when it is asked to approve grab takeover or cancellation by another handler.

常量	描述
PointerHandler.TakeOverForbidden	This handler neither takes from nor gives grab permission to any type of Item or Handler.
PointerHandler.CanTakeOverFromHandlersOfSameType	This handler can take the exclusive grab from another handler of the same class.
PointerHandler.CanTakeOverFromHandlersOfDifferentType	This handler can take the exclusive grab from any kind of handler.
PointerHandler.CanTakeOverFromItems	This handler can take the exclusive grab from any type of Item.
PointerHandler.CanTakeOverFromAnything	This handler can take the exclusive grab from any type of Item or Handler.
PointerHandler.ApprovesTakeOverByHandlersOfSameType	This handler gives permission for another handler of the same class to take the grab.
PointerHandler.ApprovesTakeOverByHandlersOfDifferentType	This handler gives permission for any kind of handler to take the grab.
PointerHandler.ApprovesTakeOverByItems	This handler gives permission for any kind of Item to take the grab.
PointerHandler.ApprovesCancellation	This handler will allow its grab to be set to null.
PointerHandler.ApprovesTakeOverByAnything	This handler gives permission for any type of Item or Handler to take the grab.

默认为 PointerHandler.CanTakeOverFromItems | PointerHandler.CanTakeOverFromHandlersOfDifferentType | PointerHandler.ApprovesTakeOverByAnything which allows most takeover scenarios but avoids e.g. two PinchHandlers fighting over the same touchpoints.

margin : real

The margin beyond the bounds of the parent item within which an eventPoint can activate this handler. For example, on a PinchHandler 在哪里 target is also the parent , it's useful to set this to a distance at least half the width of a typical user's finger, so that if the parent has been scaled down to a very small size, the pinch gesture is still possible. Or, if a TapHandler -based button is placed near the screen edge, it can be used to comply with Fitts's Law: react to mouse clicks at the screen edge even though the button is visually spaced away from the edge by a few pixels.

默认值为 0。

import QtQuick
Rectangle {
    width: 100; height: 100
    color: "lightsteelblue"; antialiasing: true
    PinchHandler {
        id: handler
        target: null
        xAxis.onActiveValueChanged: (delta) => parent.radius -= delta
        yAxis.onActiveValueChanged: (delta) => parent.border.width += delta
        rotationAxis.onActiveValueChanged: (delta) => parent.rotation += delta // add
        scaleAxis.onActiveValueChanged: (delta) => parent.scale *= delta // multiply
    }
    WheelHandler {
        acceptedModifiers: Qt.NoModifier
        property: "rotation"
    }
    WheelHandler {
        acceptedModifiers: Qt.ControlModifier
        property: "scale"
    }
}
				

import QtQuick
Rectangle {
    width: 100; height: 100
    color: "lightsteelblue"; antialiasing: true
    PinchHandler {
        id: handler
        target: null
        xAxis.onActiveValueChanged: (delta) => parent.radius -= delta
        yAxis.onActiveValueChanged: (delta) => parent.border.width += delta
        rotationAxis.onActiveValueChanged: (delta) => parent.rotation += delta // add
        scaleAxis.onActiveValueChanged: (delta) => parent.scale *= delta // multiply
    }
    WheelHandler {
        acceptedModifiers: Qt.NoModifier
        property: "rotation"
    }
    WheelHandler {
        acceptedModifiers: Qt.ControlModifier
        property: "scale"
    }
}
				

import QtQuick
Rectangle {
    width: 100; height: 100
    color: "lightsteelblue"; antialiasing: true
    PinchHandler {
        id: handler
        target: null
        xAxis.onActiveValueChanged: (delta) => parent.radius -= delta
        yAxis.onActiveValueChanged: (delta) => parent.border.width += delta
        rotationAxis.onActiveValueChanged: (delta) => parent.rotation += delta // add
        scaleAxis.onActiveValueChanged: (delta) => parent.scale *= delta // multiply
    }
    WheelHandler {
        acceptedModifiers: Qt.NoModifier
        property: "rotation"
    }
    WheelHandler {
        acceptedModifiers: Qt.ControlModifier
        property: "scale"
    }
}
				

import QtQuick
Rectangle {
    width: 100; height: 100
    color: "lightsteelblue"; antialiasing: true
    PinchHandler {
        id: handler
        target: null
        xAxis.onActiveValueChanged: (delta) => parent.radius -= delta
        yAxis.onActiveValueChanged: (delta) => parent.border.width += delta
        rotationAxis.onActiveValueChanged: (delta) => parent.rotation += delta // add
        scaleAxis.onActiveValueChanged: (delta) => parent.scale *= delta // multiply
    }
    WheelHandler {
        acceptedModifiers: Qt.NoModifier
        property: "rotation"
    }
    WheelHandler {
        acceptedModifiers: Qt.ControlModifier
        property: "scale"
    }
}
				

import QtQuick
Rectangle {
    width: 100; height: 100
    color: "lightsteelblue"
    PinchHandler {
        id: handler
        target: null
        onRotationChanged: (delta) => parent.rotation += delta // add
        onScaleChanged: (delta) => parent.scale *= delta // multiply
    }
}
				

import QtQuick
Rectangle {
    width: 100; height: 100
    color: "lightsteelblue"
    PinchHandler {
        id: handler
        target: null
        onRotationChanged: (delta) => parent.rotation += delta // add
        onScaleChanged: (delta) => parent.scale *= delta // multiply
    }
}
				

import QtQuick
Window {
    width: 320; height: 240
    visible: true
    title: handler.persistentRotation.toFixed(1) + "° " +
           handler.persistentTranslation.x.toFixed(1) + ", " +
           handler.persistentTranslation.y.toFixed(1) + " " +
           (handler.persistentScale * 100).toFixed(1) + "%"
    PinchHandler {
        id: handler
        target: null
        persistentScale: 0.25
        onTranslationChanged: (delta) => {
            image.x -= delta.x
            image.y -= delta.y
        }
    }
    Image {
        id: image
        source: "images/album-cover.jpg"
        scale: handler.persistentScale
        x: -600; y: -450
    }
}