All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
kanzi::DragAndDropManipulator Class Reference

Drag and Drop. More...

#include <kanzi/input/drag_and_drop_manipulator.hpp>

Inheritance diagram for kanzi::DragAndDropManipulator:
kanzi::InputManipulator kanzi::Object

Classes

class  FinishedMessageArguments
 
class  MovedMessageArguments
 
class  StartedMessageArguments
 

Public Member Functions

virtual kzsError notifyTouchInside (const TouchInfo &touchInfo) KZ_OVERRIDE
 Touch inside implementation for drag and drop manipulator. More...
 
virtual kzsError notifyTouchOutside (const TouchInfo &touchInfo) KZ_OVERRIDE
 Touch outside implementation for drag and drop manipulator. More...
 
void setPressDuration (unsigned int pressDuration)
 Set long press duration before drag and drop starts in milliseconds. More...
 
- Public Member Functions inherited from kanzi::InputManipulator
 InputManipulator (Domain *domain)
 Create base input manipulator. More...
 
virtual ~InputManipulator ()
 
kzsError attach (Node *objectNode)
 Attach an input manipulator to an object node. More...
 
kzsError detach ()
 Detach an input manipulator. More...
 
kzsError reset ()
 Reset manipulator. More...
 
kzsError cancel ()
 Notify manipulator of touch canceling. More...
 
KzuInputManipulatorState getState () const
 Get the state of a manipulator. More...
 
kzsError setState (KzuInputManipulatorState state)
 Set the state of a manipulator. More...
 
NodegetObjectNode () const
 Get the object node an input manipulator is attached to. More...
 
void requireToFail (InputManipulator *manipulatorToFail)
 Sets the manipulator that is required to fail before this manipulator can succeed. More...
 
InputManipulatorgetFailManipulator () const
 Gets the fail manipulator. More...
 
InputManipulatorgetDependManipulator () const
 Gets the depend manipulator. More...
 
bool isHandled () const
 Get the change flag of a manipulator. More...
 
void setHandled (bool handled)
 Set the change flag of a manipulator. More...
 
kzsError setInputManager (KzuInputManager *inputManager)
 Attach or detach an input manager to a manipulator during recognition. More...
 
KzuInputManagergetInputManager () const
 Get the attached input manager of a manipulator. More...
 
bool isAttached () const
 Tells if the input manipulator is attached (has a valid node reference). More...
 
void setReferenceNode (NodeWeakPtr referenceNode)
 
kzsError addHitTestArguments (MessageArguments *message, const KzuInputTouchPoint *touchPoint)
 Add hit test information arguments to a message from a touch point. More...
 
- Public Member Functions inherited from kanzi::Object
 Object (Domain *domain)
 
virtual ~Object ()
 
DomaingetDomain () const
 Returns the domain the object belongs to. More...
 
KzuPropertyManager * getPropertyManager () const
 Returns the property manager of the object. More...
 
KzuTaskSchedulergetTaskScheduler () const
 Returns the task scheduler of the object. More...
 
KzuMessageDispatchergetMessageDispatcher () const
 Returns the message dispatcher of the object. More...
 
ResourceManagergetResourceManager () const
 Returns the resource manager of the object. More...
 
virtual const MetaclassgetDynamicMetaclass () const
 Returns the metaclass of the dynamic type of the object. More...
 
bool isTypeOf (const Metaclass *objectType) const
 Determines if the type of this object is the given type or derived from it. More...
 
template<typename DataType >
void setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::DataType value)
 Sets the local value of a property. More...
 
void setProperty (const PropertyType< ResourceID > &propertyType, ResourceSharedPtr value)
 Sets the local value of a resource id property with a resource pointer. More...
 
template<typename DataType >
DataType getProperty (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property. More...
 
template<typename DataType >
bool getProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::DataType &value) 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 >
void setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::DataType value)
 
void setAbstractProperty (AbstractPropertyType abstractPropertyType, ResourceSharedPtr value)
 
template<typename DataType >
DataType getAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
bool getAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::DataType &value) const
 
bool hasValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value. More...
 
bool hasLocalValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a local value set for the property. More...
 
void removeLocalValue (AbstractPropertyType propertyType)
 Removes the local value associated with the property. More...
 
void copyLocalValues (const Object &other)
 Copies all local values from another object. More...
 
virtual void onPropertyChanged (AbstractPropertyType propertyType, KzuPropertyNotificationReason reason)
 Virtual function to handle property change notifications. More...
 
AppliedStyleEntryapplyObjectStyle (kanzi::StyleSharedPtr style)
 Applies a style to an object. More...
 
void unapplyObjectStyle (AppliedStyleEntry *appliedStyleEntry)
 
void applyObjectStyles ()
 Apply all styles for an object node. More...
 
void unapplyObjectStyles ()
 Unapplies and removes all applied styles. More...
 

Static Public Member Functions

static
DragAndDropManipulatorSharedPtr 
create (Domain *domain, string_view="")
 
- 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...
 

Public Attributes

unsigned int pressDuration
 Press delay. More...
 
unsigned int touchId
 Touch ID. More...
 
kzBool dragging
 Has dragging started. More...
 
KzuInputTouchPoint lastTouchPoint
 Last touch point. More...
 
- Public Attributes inherited from kanzi::InputManipulator
Nodem_node
 Object node reference. More...
 
KzuInputManagerm_inputManager
 Input manager reference. More...
 
KzuInputManipulatorState m_state
 The state of the manipulator. More...
 
bool m_handled
 The handled flag to identify input phases. More...
 
InputManipulatorm_failManipulator
 The input manipulator that has to fail for this manipulator to succeed. More...
 
InputManipulatorm_dependManipulator
 The input manipulator that will be notified in case this manipulator fails. More...
 
NodeWeakPtr m_referenceNode
 

Static Public Attributes

static MessageType
< StartedMessageArguments
StartedMessage
 
static MessageType
< MovedMessageArguments
MovedMessage
 
static MessageType
< FinishedMessageArguments
FinishedMessage
 

Protected Member Functions

 DragAndDropManipulator (Domain *domain)
 
virtual kzsError onReset () KZ_OVERRIDE
 Reset implementation for Drag and Drop input manipulator. More...
 
- Protected Member Functions inherited from kanzi::InputManipulator
virtual kzsError onAttach ()
 Attach function for input manipulators. More...
 
virtual kzsError onDetach ()
 Detach function for input manipulators. More...
 
virtual kzsError onCancel ()
 Cancel function for input manipulators. More...
 
virtual kzsError onFail ()
 Fail function for input manipulators. More...
 
- Protected Member Functions inherited from kanzi::Object
void initialize ()
 
void onCopy (const Object &other)
 

Additional Inherited Members

- Protected Types inherited from kanzi::Object
typedef vector
< AppliedStyleEntry * > 
AppliedStyleContainer
 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.

Constructor & Destructor Documentation

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

Member Function Documentation

virtual kzsError kanzi::DragAndDropManipulator::notifyTouchInside ( const TouchInfo touchInfo)
virtual

Touch inside implementation for drag and drop manipulator.

Reimplemented from kanzi::InputManipulator.

virtual kzsError kanzi::DragAndDropManipulator::notifyTouchOutside ( const TouchInfo touchInfo)
virtual

Touch outside implementation for drag and drop manipulator.

Reimplemented from kanzi::InputManipulator.

void kanzi::DragAndDropManipulator::setPressDuration ( unsigned int  pressDuration)

Set long press duration before drag and drop starts in milliseconds.

Default is 500ms.

static DragAndDropManipulatorSharedPtr kanzi::DragAndDropManipulator::create ( Domain domain,
string_view  = "" 
)
inlinestatic
virtual kzsError kanzi::DragAndDropManipulator::onReset ( )
protectedvirtual

Reset implementation for Drag and Drop input manipulator.

Reimplemented from kanzi::InputManipulator.

Member Data Documentation

MessageType<StartedMessageArguments> kanzi::DragAndDropManipulator::StartedMessage
static
MessageType<MovedMessageArguments> kanzi::DragAndDropManipulator::MovedMessage
static
MessageType<FinishedMessageArguments> kanzi::DragAndDropManipulator::FinishedMessage
static
unsigned int kanzi::DragAndDropManipulator::pressDuration

Press delay.

unsigned int kanzi::DragAndDropManipulator::touchId

Touch ID.

kzBool kanzi::DragAndDropManipulator::dragging

Has dragging started.

KzuInputTouchPoint kanzi::DragAndDropManipulator::lastTouchPoint

Last touch point.


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