Kanzi  3.9.4
Kanzi Engine API
kanzi::DragAndDropManipulator Class Reference

Drag-and-drop input manipulator recognizes the drag-and-drop gesture from incoming touch events. More...

#include <kanzi/core.ui/input/drag_and_drop_manipulator.hpp>

Inheritance diagram for kanzi::DragAndDropManipulator:
[legend]

Classes

class  CanceledMessageArguments
 Message arguments for the drag-and-drop cancel message. More...
 
class  FinishedMessageArguments
 Message arguments for drag-and-drop finished message. Inherits argument properties from InputManipulator::InputMessageArguments. More...
 
class  MovedMessageArguments
 Message arguments for drag-and-drop moved message. Inherits argument properties from InputManipulator::InputMessageArguments. More...
 
class  StartedMessageArguments
 Message arguments for drag-and-drop started message. Inherits argument properties from InputManipulator::InputMessageArguments. More...
 

Public Member Functions

void setPressDuration (chrono::milliseconds pressDuration)
 Set the duration in milliseconds of the long press before drag-and-drop starts. The default duration is 500ms. More...
 
- Public Member Functions inherited from kanzi::InputManipulator
void attach (Node &node)
 Attaches an input manipulator to a node. More...
 
void cancel ()
 Notify manipulator of touch canceling. More...
 
void detach ()
 Detaches an input manipulator. More...
 
NodegetAttachedNode () const
 Gets the node to which the input manipulator is attached. More...
 
InputManipulatorgetDependantManipulator () const
 Gets the dependant input manipulator. More...
 
EventRoutingMode getEventRoutingMode ()
 Returns the current input event routing mode. More...
 
InputManipulatorWeakPtr getFailManipulator () const
 Gets the fail manipulator. More...
 
State getState () const
 Get the state of an input manipulator. More...
 
KZ_DEPRECATED TouchEventRoutingMode getTouchEventRoutingMode ()
 Returns the current touch event routing mode. More...
 
ManipulatorType getType () const
 Returns the type of the input manipulator. More...
 
bool isActive () const
 Checks whether an input manipulator is in active state. More...
 
bool isAttached () const
 Tells whether the input manipulator is attached to a node. More...
 
bool isCancelable () const
 Returns whether an input manipulator is in a cancelable state. More...
 
bool isResettable () const
 Returns whether an input manipulator is in a resettable state. More...
 
void requireToFail (InputManipulatorWeakPtr manipulatorToFail)
 Sets the input manipulator that must fail before Kanzi can recognize this input manipulator. More...
 
void reset ()
 Reset the manipulator. More...
 
void setEventRoutingMode (EventRoutingMode mode)
 Sets the input event routing mode that you want the input manager to use when distributing the input event data to manipulators. More...
 
void setReferenceNode (NodeWeakPtr referenceNode)
 Override the attached node as the hit test reference node. More...
 
void setState (State state)
 Set the state of an input manipulator. More...
 
KZ_DEPRECATED void setTouchEventRoutingMode (TouchEventRoutingMode mode)
 Sets the touch event routing mode that you want the input manager to use when distributing the touch points to input manipulators. More...
 
 ~InputManipulator () override
 Destructor. More...
 
- Public Member Functions inherited from kanzi::Object
AppliedStyleEntrySharedPtr applyObjectStyle (kanzi::StyleSharedPtr style)
 Applies a style to an object. More...
 
void applyObjectStyles ()
 Apply all styles for an object node. More...
 
DomaingetDomain () const
 Returns the domain the object belongs to. More...
 
const MetaclassgetDynamicMetaclass () const override
 Returns the metaclass of the dynamic type of the object. More...
 
MainLoopSchedulergetMainLoopScheduler () const
 Returns the MainLoopScheduler instance of the associated Domain. More...
 
detail::MessageDispatcher * getMessageDispatcher () const
 Returns the message dispatcher of the object. More...
 
ResourceManagergetResourceManager () const
 Returns the resource manager of the object. More...
 
ScriptingContextSharedPtr getScriptingContext () const
 Gets the scripting context of the object. More...
 
 Object (Domain *domain)
 
void setScriptingContext (ScriptingContextSharedPtr context)
 Sets the scripting context of the object. More...
 
void unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)
 
void unapplyObjectStyles ()
 Unapplies and removes all applied styles. More...
 
 ~Object () override
 
- Public Member Functions inherited from kanzi::MetaObject
bool isTypeOf (const Metaclass *objectType) const
 Determines if the type of this object is the given type or derived from it. More...
 
virtual ~MetaObject ()
 
- Public Member Functions inherited from kanzi::PropertyObject
template<typename DataType >
void addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
template<typename DataType >
void addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
void addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer)
 
template<typename DataType >
void addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner)
 
PropertyStorageContainer::iterator beginPropertyStorage ()
 Returns the begin iterator to the internal property storage container. More...
 
PropertyStorageContainer::const_iterator beginPropertyStorage () const
 Returns the begin iterator to the internal property storage container. More...
 
void clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
void copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
 Copies local value of single property from another object. More...
 
void copyLocalValues (const PropertyObject &other)
 Copies all local values from another object. More...
 
PropertyStorageContainer::iterator endPropertyStorage ()
 Returns the end iterator to the internal property storage container. More...
 
PropertyStorageContainer::const_iterator endPropertyStorage () const
 Returns the end iterator to the internal property storage container. More...
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalProperty (const PropertyType< DataType > &propertyType) const
 Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. More...
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalPropertyBase (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property disregarding modifiers, but does not default to the value in property metadata if there are no inputs to the property value. More...
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getProperty (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property type. More...
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getPropertyBase (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property disregarding modifiers. More...
 
template<typename DataType >
size_t getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const
 Gets number of current notification handlers for given property type. More...
 
bool hasBaseValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value, disregarding modifiers. More...
 
bool hasLocalValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a local value set for the property. More...
 
bool hasNonClassValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a value of any precedence higher than class default value set for the property. More...
 
bool hasValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value. More...
 
bool isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const
 
virtual void onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason)
 Virtual function to handle property change notifications. More...
 
 PropertyObject ()
 
void removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties)
 Remove all KZB properties that are not included in a given set. More...
 
void removeKzbProperties ()
 Remove all KZB properties. More...
 
template<typename DataType >
void removeLocalPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer)
 
void removeLocalValue (AbstractPropertyType propertyType)
 Removes the local value associated with the property. More...
 
template<typename DataType >
void removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
template<typename DataType >
void removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
void removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer)
 
template<typename DataType >
void setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 
template<typename DataType >
void setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 Sets the local value of a property type. More...
 
void setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
void validatePropertyModifiers (AbstractPropertyType propertyType)
 
virtual ~PropertyObject ()
 

Static Public Member Functions

static DragAndDropManipulatorSharedPtr create (Domain *domain, string_view="")
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- Static Public Member Functions inherited from kanzi::Object
static const MetaclassgetStaticMetaclass ()
 Returns the metaclass of Object class. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Default implementation that returns empty editor info. More...
 
- Static Public Member Functions inherited from kanzi::MetaObject
static const MetaclassgetStaticMetaclass ()
 Returns the metaclass of Object class. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Default implementation that returns empty editor info. More...
 

Static Public Attributes

static MessageType< CanceledMessageArgumentsCanceledMessage
 Message type that notifies about the cancellation of the drag-and-drop gesture. More...
 
static MessageType< FinishedMessageArgumentsFinishedMessage
 Message type for notifying end of the recognized drag-and-drop gesture. More...
 
static MessageType< MovedMessageArgumentsMovedMessage
 Message type for notifying update on position for the recognized gesture. More...
 
static MessageType< StartedMessageArgumentsStartedMessage
 Message type for notifying the beginning of the drag-and-drop gesture. More...
 

Protected Member Functions

 DragAndDropManipulator (Domain *domain)
 Constructor. More...
 
bool isCancelableOverride () const override
 InputManipulator::isCancelableOverride implementation. More...
 
void notifyTouchInside (const TouchInfo &touchInfo) override
 InputManipulator::notifyTouchInside implementation. More...
 
void notifyTouchOutside (const TouchInfo &touchInfo) override
 InputManipulator::notifyTouchOutside implementation. More...
 
void onCancel () override
 Kanzi calls this when DragAndDropManipulator is canceled. More...
 
void onLongPressCompleted ()
 Timer callback for successful long press. More...
 
void onReset () override
 InputManipulator::onReset implementation. More...
 
void trackDragAndDrop (const TouchInfo &touchInfo)
 Update the drag-and-drop gesture state with touch event. More...
 
- Protected Member Functions inherited from kanzi::InputManipulator
void addHitTestArguments (MessageArguments &message, const TouchPoint &touchPoint)
 Add hit test information arguments to the message from the touch point. More...
 
bool detectKeyGesture (const KeyEvent &event, KeyGestureInfo &gesture)
 Detects key gestures from the event that you pass as an argument. More...
 
Node2DfindNearestParent2D ()
 Find the 2D manipulator node for this input manipulator. More...
 
InputManagergetInputManager () const
 Get the attached input manager of an input manipulator. More...
 
 InputManipulator (Domain *domain, ManipulatorType type=ManipulatorType::TouchInputHandler)
 Constructor. More...
 
virtual bool isResettableOverride () const
 Overridable check for the resettable status of an input manipulator. More...
 
virtual bool notifyKeyInput (const KeyEvent &event)
 Notify an input manipulator about a key event that occurs on the attached node. More...
 
virtual void onAttach ()
 Attach function for input manipulators. More...
 
virtual void onDetach ()
 Detach function for input manipulators. More...
 
virtual void onFail ()
 Fail function for input manipulators. More...
 
virtual void onKeyPressGesture (KeyGestureInfo &gesture)
 The detectKeyGesture() method calls this method when it detects a key press gesture. More...
 
virtual void onKeyReleaseGesture (KeyGestureInfo &gesture)
 The detectKeyGesture() method calls this method when it detects a key release gesture. More...
 
virtual void onPartialKeyPressGesture (KeyGestureInfo &gesture)
 The detectKeyGesture() method calls this method when it detects a partial key press gesture. More...
 
- Protected Member Functions inherited from kanzi::Object
void initialize ()
 
void onCopy (const Object &other)
 
- Protected Member Functions inherited from kanzi::MetaObject
void initialize ()
 
 MetaObject ()
 
- Protected Member Functions inherited from kanzi::PropertyObject
AbstractPropertyTypeDescriptor::ValueSourceEntryacquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
 Acquires a local value source entry that is free for the assignment of a value. More...
 
AbstractPropertyTypeDescriptor::ModifierStorageacquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
AbstractPropertyTypeDescriptor::NotificationStorageacquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)
 
PropertyStoragePtr acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
void addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer)
 Internally adds a property value source. More...
 
void addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner)
 Internally adds a property value source. More...
 
AbstractPropertyTypeDescriptor::ValueSourceEntryconstructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
PropertyStoragePtr constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
void copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
 Copy local value from property storage. More...
 
AbstractPropertyTypeDescriptor::ModifierStoragefindModifierStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::NotificationStoragefindNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::PropertyStoragefindPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
 Gets the property storage for given property type descriptor. More...
 
PropertyStoragePtr findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
 Gets property storage intrusive pointer which you can use to hold a reference until the end of the operation. More...
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const
 Finds a property type descriptor by name and data type. More...
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const
 Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names. More...
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const
 Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names. More...
 
AbstractPropertyTypeDescriptor::ValueSourcegetClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 Gets the top-level value source for a given property descriptor. More...
 
virtual void notifyPropertyHandlers (PropertyStoragePtr &propertyStorage, PropertyNotificationReason reason)
 
void onCopy (const PropertyObject &other)
 
void removeLocalValue (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
 Removes a local value from the given property storage. More...
 
void removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, void *owner)
 Removes a property value source. More...
 
void validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
 

Additional Inherited Members

- Public Types inherited from kanzi::InputManipulator
enum  EventRoutingMode { RoutingBubbling, RoutingTunneling }
 Enumeration for the available input event routing modes. More...
 
enum  ManipulatorType { ManipulatorType::TouchInputHandler, ManipulatorType::KeyInputHandler }
 Enumeration for the input manipulator type. More...
 
enum  State {
  StateReady, StatePossible, StateBegin, StateChange,
  StateEnd, StateFail, StateDelayed, StateCanceled
}
 Enumeration for possible input manipulator states during touch, mouse, or key input sequence. More...
 
using TouchEventRoutingMode = EventRoutingMode
 Enumeration for the available touch event routing modes. More...
 
using TouchPointsConstIterator = TouchPointsContainer::const_iterator
 
using TouchPointsContainer = vector< TouchPoint * >
 
- Public Types inherited from kanzi::PropertyObject
typedef PropertyStorageContainer::const_iterator PropertyStorageConstIterator
 
typedef vector< PropertyStoragePtrPropertyStorageContainer
 
typedef PropertyStorageContainer::iterator PropertyStorageIterator
 
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStoragePropertyStoragePtr
 
typedef PropertyStorageContainer::reverse_iterator PropertyStorageReverseIterator
 
- Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtrAppliedStyleContainer
 Applied style container. More...
 
- Static Protected Member Functions inherited from kanzi::InputManipulator
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- Protected Attributes inherited from kanzi::Object
AppliedStyleContainer m_appliedStyles
 Listing of applied styles applied to this object. More...
 

Detailed Description

Drag-and-drop input manipulator recognizes the drag-and-drop gesture from incoming touch events.

It generates messages required to implement the logic for objects which react to the drag-and-drop gesture. For example, use the drag-and-drop input manipulator to move objects in an application.

See also
ClickManipulator, LongPressManipulator, MultiClickManipulator, PanManipulator, PinchManipulator

Examples

To receive the drag moved events, add the message handler for the MovedMessage message.

First create a handler method:

void onDragMoved(DragAndDropManipulator::MovedMessageArguments& /*messageArguments*/)
{
// Insert your code to handle the drag moved event here
}

Then add a message handler for your node:

node->addInputManipulator(dragManipulator);
movedMessageSubscription = node->addMessageHandler(DragAndDropManipulator::MovedMessage, bind(&InputManipulatorSnippet::onDragMoved, this, placeholders::_1));

Constructor & Destructor Documentation

◆ DragAndDropManipulator()

kanzi::DragAndDropManipulator::DragAndDropManipulator ( Domain domain)
explicitprotected

Constructor.

Member Function Documentation

◆ makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::DragAndDropManipulator::makeEditorInfo ( )
static

◆ create()

static DragAndDropManipulatorSharedPtr kanzi::DragAndDropManipulator::create ( Domain domain,
string_view  = "" 
)
inlinestatic

◆ setPressDuration()

void kanzi::DragAndDropManipulator::setPressDuration ( chrono::milliseconds  pressDuration)

Set the duration in milliseconds of the long press before drag-and-drop starts. The default duration is 500ms.

◆ notifyTouchInside()

void kanzi::DragAndDropManipulator::notifyTouchInside ( const TouchInfo touchInfo)
overrideprotectedvirtual

InputManipulator::notifyTouchInside implementation.

Reimplemented from kanzi::InputManipulator.

◆ notifyTouchOutside()

void kanzi::DragAndDropManipulator::notifyTouchOutside ( const TouchInfo touchInfo)
overrideprotectedvirtual

◆ onReset()

void kanzi::DragAndDropManipulator::onReset ( )
overrideprotectedvirtual

InputManipulator::onReset implementation.

Reimplemented from kanzi::InputManipulator.

◆ onCancel()

void kanzi::DragAndDropManipulator::onCancel ( )
overrideprotectedvirtual

Kanzi calls this when DragAndDropManipulator is canceled.

When you call this method it generates CanceledMessage.

Reimplemented from kanzi::InputManipulator.

◆ isCancelableOverride()

bool kanzi::DragAndDropManipulator::isCancelableOverride ( ) const
overrideprotectedvirtual

◆ trackDragAndDrop()

void kanzi::DragAndDropManipulator::trackDragAndDrop ( const TouchInfo touchInfo)
protected

Update the drag-and-drop gesture state with touch event.

◆ onLongPressCompleted()

void kanzi::DragAndDropManipulator::onLongPressCompleted ( )
protected

Timer callback for successful long press.

Member Data Documentation

◆ StartedMessage

MessageType<StartedMessageArguments> kanzi::DragAndDropManipulator::StartedMessage
static

Message type for notifying the beginning of the drag-and-drop gesture.

StartedMessage is generated after successful long press over the node area.

◆ MovedMessage

MessageType<MovedMessageArguments> kanzi::DragAndDropManipulator::MovedMessage
static

Message type for notifying update on position for the recognized gesture.

MovedMessage is generated when the tracked touch has moved while the drag is active.

◆ FinishedMessage

MessageType<FinishedMessageArguments> kanzi::DragAndDropManipulator::FinishedMessage
static

Message type for notifying end of the recognized drag-and-drop gesture.

FinishedMessage is generated when the tracked touch is released while the drag is active.

◆ CanceledMessage

MessageType<CanceledMessageArguments> kanzi::DragAndDropManipulator::CanceledMessage
static

Message type that notifies about the cancellation of the drag-and-drop gesture.

CanceledMessage is generated when DragAndDropManipulator is canceled.


The documentation for this class was generated from the following file: