Skip to content

GestureMixin

Base classes

Name Children Inherits
ObjectMixin
prettyqt.core.object

Subclasses

Class Module Description
Gesture prettyqt.widgets.gesture
TapGesture prettyqt.widgets.tapgesture
TapAndHoldGesture prettyqt.widgets.tapandholdgesture
PanGesture prettyqt.widgets.pangesture
PinchGesture prettyqt.widgets.pinchgesture
SwipeGestureMixin prettyqt.widgets.swipegesture

⋔ Inheritance diagram

graph TD
  1473296392528["widgets.GestureMixin"]
  1473299815024["core.ObjectMixin"]
  140713234304496["builtins.object"]
  1473299815024 --> 1473296392528
  140713234304496 --> 1473299815024

🛈 DocStrings

Bases: ObjectMixin

Source code in prettyqt\widgets\gesture.py
class GestureMixin(core.ObjectMixin):
    def get_state(self) -> constants.GestureStateStr:
        """Return current state.

        Returns:
            state
        """
        return constants.GESTURE_STATE.inverse[self.state()]

    def get_gesture_type(self) -> constants.GestureTypeStr:
        """Return current gesture type.

        Returns:
            gesture type
        """
        return constants.GESTURE_TYPE.inverse[self.gestureType()]

    def get_hot_spot(self) -> core.PointF:
        return core.PointF(self.hotSpot())

    def set_gesture_cancel_policy(
        self, policy: GestureCancelPolicyStr | widgets.QGesture.GestureCancelPolicy
    ):
        """Set gesture cancel policy.

        Args:
            policy: gesture cancel policy to use
        """
        self.setGestureCancelPolicy(GESTURE_CANCEL_POLICY.get_enum_value(policy))

    def get_gesture_cancel_policy(self) -> GestureCancelPolicyStr:
        """Return current gesture cancel policy.

        Returns:
            gesture cancel policy
        """
        return GESTURE_CANCEL_POLICY.inverse[self.gestureCancelPolicy()]

get_gesture_cancel_policy() -> GestureCancelPolicyStr

Return current gesture cancel policy.

Source code in prettyqt\widgets\gesture.py
def get_gesture_cancel_policy(self) -> GestureCancelPolicyStr:
    """Return current gesture cancel policy.

    Returns:
        gesture cancel policy
    """
    return GESTURE_CANCEL_POLICY.inverse[self.gestureCancelPolicy()]

get_gesture_type() -> constants.GestureTypeStr

Return current gesture type.

Source code in prettyqt\widgets\gesture.py
def get_gesture_type(self) -> constants.GestureTypeStr:
    """Return current gesture type.

    Returns:
        gesture type
    """
    return constants.GESTURE_TYPE.inverse[self.gestureType()]

get_state() -> constants.GestureStateStr

Return current state.

Source code in prettyqt\widgets\gesture.py
def get_state(self) -> constants.GestureStateStr:
    """Return current state.

    Returns:
        state
    """
    return constants.GESTURE_STATE.inverse[self.state()]

set_gesture_cancel_policy(policy: GestureCancelPolicyStr | widgets.QGesture.GestureCancelPolicy)

Set gesture cancel policy.

Parameters:

Name Type Description Default
policy GestureCancelPolicyStr | GestureCancelPolicy

gesture cancel policy to use

required
Source code in prettyqt\widgets\gesture.py
def set_gesture_cancel_policy(
    self, policy: GestureCancelPolicyStr | widgets.QGesture.GestureCancelPolicy
):
    """Set gesture cancel policy.

    Args:
        policy: gesture cancel policy to use
    """
    self.setGestureCancelPolicy(GESTURE_CANCEL_POLICY.get_enum_value(policy))