The KeyManipulatorComponent node component installs a KeyManipulator to the attached node, and configures the key gesture of the manipulator. More...

#include <kanzi/ui/node_component/input/key_manipulator_component.hpp>

Inheritance diagram for kanzi::KeyManipulatorComponent:

[legend]

Public Member Functions
optional< bool >	getCapsLock () const
	Returns the value of the CapsLockProperty. More...

KeyModifier	getKeyModifiers () const
	Returns the value of the KeyModifiersProperty. More...

LogicalKey	getLogicalKey () const
	Returns the value of the LogicalKeyProperty. More...

void	setCapsLock (bool capsLock)
	Sets the value of the CapsLockProperty. More...

void	setKeyModifiers (KeyModifier modifiers)
	Sets the value of the KeyModifiersProperty. More...

void	setLogicalKey (LogicalKey key)
	Sets the value of the LogicalKeyProperty. More...

Public Member Functions inherited from kanzi::NodeComponent
void	attach (NodeWeakPtr node)
	Attaches node component to node. More...

void	detach ()
	Detaches node component from the node it was attached to. More...

string	getName () const
	Gets the name of node component. More...

NodeSharedPtr	getNode () const
	Returns the node the node component is attached to or null pointer if node component is not attached to a node. More...

State	getState () const
	Gets the state of node component indicating if component is attached to a node, detached from any node or in process of attaching/detaching. More...

bool	isAttached () const
	Indicates whether node component is attached to a node. More...

bool	isAttaching () const
	Indicates whether node component is in the process of attaching to a node. More...

bool	isAttachingOrAttached () const
	Indicates whether node component is in the process of attaching to a node or already attached. More...

bool	isDetached () const
	Indicates whether node component is detached from any node. More...

bool	isDetaching () const
	Indicates whether node component currently detaching from the node. More...

bool	isDetachingOrDetached () const
	Indicates whether node component is in the process of detaching from the node or already detached. More...

void	setName (string_view name)
	Sets the name of node component. More...

	~NodeComponent () 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...

Domain *	getDomain () const
	Returns the domain the object belongs to. More...

const Metaclass *	getDynamicMetaclass () const override
	Returns the metaclass of the dynamic type of the object. More...

MainLoopScheduler *	getMainLoopScheduler () const
	Returns the MainLoopScheduler instance of the associated Domain. More...

detail::MessageDispatcher *	getMessageDispatcher () const
	Returns the message dispatcher of the object. More...

ResourceManager *	getResourceManager () 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

	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 KeyManipulatorComponentSharedPtr	create (Domain *domain, string_view name)
	Creates an instance of a KeyManipulatorComponent node component. More...

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Initializes and returns the Kanzi Studio editor information. More...

Static Public Member Functions inherited from kanzi::NodeComponent
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Static Public Member Functions inherited from kanzi::Object
static const Metaclass *	getStaticMetaclass ()
	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 Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class. More...

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info. More...

Static Public Attributes
Properties
static PropertyType< int >	LogicalKeyProperty
	The property that holds the logical key of the key input that the installed KeyManipulator recognizes. More...

static PropertyType< int >	KeyModifiersProperty
	The property that holds the key modifiers of the key input that the installed KeyManipulator recognizes. More...

static PropertyType< bool >	CapsLockProperty
	The property that indicates whether Caps Lock needs to be on for the installed KeyManipulator to recognize key input. More...

Static Public Attributes inherited from kanzi::NodeComponent
static PropertyType< string >	NameProperty
	Name property specifies the name of node component. More...

Protected Member Functions
void	attachOverride () override
	NodeComponent::attachOverride() implementation. More...

void	detachOverride () override
	NodeComponent::detachOverride() implementation. More...

	KeyManipulatorComponent (Domain *domain, string_view name)
	Constructs a key handler node component. More...

void	onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) final
	NodeComponent::onPropertyChanged implementation. More...

Protected Member Functions inherited from kanzi::NodeComponent
template<typename TMessageType , typename TClass , typename TMethod >
Node::MessageSubscriptionToken	addNodeComponentMessageHandler (TMessageType &messageType, TClass *messageHandlerObject, TMethod method)
	Kanzi calls the message handler that you add using this function when the target name of the incoming message matches the name of this node component, or if the message is broadcast to all node components with an empty target name. More...

template<typename TMessageType >
Node::MessageSubscriptionToken	addNodeComponentMessageHandler (TMessageType &messageType, typename TMessageType::FunctionType function)
	Kanzi calls the message handler that you add using this function when the target name of the incoming message matches the name of the node component, or if the message is broadcast to all node components with an empty target name. More...

void	dispatchAbstractMessage (const AbstractMessageType &messageType, MessageArguments &messageArguments)
	Adds the name of the node component to the abstract message arguments and dispatches the message to the node of the node component. More...

template<typename TArgumentsType >
void	dispatchMessage (const MessageType< TArgumentsType > &messageType, typename MessageType< TArgumentsType >::ArgumentsType &messageArguments)
	Adds the name of the node component to the message arguments and dispatches the message to the node of the node component. More...

	NodeComponent (Domain *domain, string_view name)
	Constructor. More...

void	removeNodeComponentMessageFilter (Node::MessageSubscriptionToken subscriptionToken)
	Removes message handler added via addNodeComponentMessageHandler function. 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::ValueSourceEntry *	acquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Acquires a local value source entry that is free for the assignment of a value. More...

AbstractPropertyTypeDescriptor::ModifierStorage *	acquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

AbstractPropertyTypeDescriptor::NotificationStorage *	acquireNotificationStorage (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::ValueSourceEntry *	constructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

PropertyStoragePtr	constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

void	copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
	Copy local value from property storage. More...

AbstractPropertyTypeDescriptor::ModifierStorage *	findModifierStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::NotificationStorage *	findNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::PropertyStorage *	findPropertyStorage (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...

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const
	Finds a property type descriptor by name and data type. More...

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names. More...

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names. More...

AbstractPropertyTypeDescriptor::ValueSource *	getClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getTopValueSource (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::NodeComponent
using	NodeComponentMessageArguments = NodeComponentTargetMessageArguments
	Legacy name for NodeComponentTargetMessageArguments. More...

enum	State { StateDetached, StateDetaching, StateAttaching, StateAttached }
	State indicating if component is attached to a node, detached from any node or in process of attaching/detaching. More...

Public Types inherited from kanzi::PropertyObject
typedef PropertyStorageContainer::const_iterator	PropertyStorageConstIterator

typedef vector< PropertyStoragePtr >	PropertyStorageContainer

typedef PropertyStorageContainer::iterator	PropertyStorageIterator

typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStorage >	PropertyStoragePtr

typedef PropertyStorageContainer::reverse_iterator	PropertyStorageReverseIterator

Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtr >	AppliedStyleContainer
	Applied style container. More...

Static Protected Member Functions inherited from kanzi::NodeComponent
template<typename TMessageType >
static void	nodeComponentMessageHandler (const NodeComponent *nodeComponent, const typename TMessageType::FunctionType &function, typename TMessageType::ArgumentsType &messageArguments)
	Handler function for node component messages. More...

Protected Attributes inherited from kanzi::Object
AppliedStyleContainer	m_appliedStyles
	Listing of applied styles applied to this object. More...

Detailed Description

The KeyManipulatorComponent node component installs a KeyManipulator to the attached node, and configures the key gesture of the manipulator.

See also: KeyManipulator, InputManipulator, NodeComponent

Since: Kanzi 3.8.0

Constructor & Destructor Documentation

◆ KeyManipulatorComponent()

kanzi::KeyManipulatorComponent::KeyManipulatorComponent	(	Domain *	domain,
		string_view	name
	)

explicitprotected

Constructs a key handler node component.

Parameters

domain	The domain that holds the KeyManipulatorComponent.
name	The name of the KeyManipulatorComponent instance.

Member Function Documentation

◆ getLogicalKey()

LogicalKey kanzi::KeyManipulatorComponent::getLogicalKey ( ) const

inline

Returns the value of the LogicalKeyProperty.

Returns: The value of the LogicalKeyProperty.

See also: LogicalKey

◆ setLogicalKey()

void kanzi::KeyManipulatorComponent::setLogicalKey ( LogicalKey key )

inline

Sets the value of the LogicalKeyProperty.

Parameters

key	The logical key value to set.

See also: LogicalKey

◆ getKeyModifiers()

KeyModifier kanzi::KeyManipulatorComponent::getKeyModifiers ( ) const

inline

Returns the value of the KeyModifiersProperty.

Returns: The value of the KeyModifiersProperty.

See also: KeyModifier

◆ setKeyModifiers()

void kanzi::KeyManipulatorComponent::setKeyModifiers ( KeyModifier modifiers )

inline

Sets the value of the KeyModifiersProperty.

Parameters

modifiers The key modifiers value to set.

See also: KeyModifier

◆ getCapsLock()

optional<bool> kanzi::KeyManipulatorComponent::getCapsLock ( ) const

inline

Returns the value of the CapsLockProperty.

Returns: The value of the CapsLockProperty.

Since: Kanzi 3.9.0

◆ setCapsLock()

void kanzi::KeyManipulatorComponent::setCapsLock ( bool capsLock )

inline

Sets the value of the CapsLockProperty.

Parameters

capsLock The Caps Lock value to set.

Since: Kanzi 3.9.0

◆ create()

static KeyManipulatorComponentSharedPtr kanzi::KeyManipulatorComponent::create	(	Domain *	domain,
		string_view	name
	)

static

Creates an instance of a KeyManipulatorComponent node component.

Parameters

domain	The domain that holds the KeyManipulatorComponent.
name	The name of the KeyManipulatorComponent instance.

Returns: The created KeyManipulatorComponent.

◆ makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::KeyManipulatorComponent::makeEditorInfo ( )

static

Initializes and returns the Kanzi Studio editor information.

Returns: Editor information for Kanzi Studio.

◆ attachOverride()

void kanzi::KeyManipulatorComponent::attachOverride ( )

overrideprotectedvirtual

NodeComponent::attachOverride() implementation.

Reimplemented from kanzi::NodeComponent.

◆ detachOverride()

void kanzi::KeyManipulatorComponent::detachOverride ( )

overrideprotectedvirtual

NodeComponent::detachOverride() implementation.

Reimplemented from kanzi::NodeComponent.

◆ onPropertyChanged()

void kanzi::KeyManipulatorComponent::onPropertyChanged	(	AbstractPropertyType	propertyType,
		PropertyNotificationReason	reason
	)

finalprotectedvirtual

NodeComponent::onPropertyChanged implementation.

Parameters

propertyType	The property type that identifies the property that has changed.
reason	The reason that caused the property notification to be invoked.

Reimplemented from kanzi::PropertyObject.

Member Data Documentation

◆ LogicalKeyProperty

PropertyType<int> kanzi::KeyManipulatorComponent::LogicalKeyProperty

static

The property that holds the logical key of the key input that the installed KeyManipulator recognizes.

The default value is LogicalKey::Unknown.

See also: setLogicalKey(), getLogicalKey()

◆ KeyModifiersProperty

PropertyType<int> kanzi::KeyManipulatorComponent::KeyModifiersProperty

static

The property that holds the key modifiers of the key input that the installed KeyManipulator recognizes.

The default value is KeyModifier::Undefined.

See also: setKeyModifiers(), getKeyModifiers()

◆ CapsLockProperty

PropertyType<bool> kanzi::KeyManipulatorComponent::CapsLockProperty

static

The property that indicates whether Caps Lock needs to be on for the installed KeyManipulator to recognize key input.

This property is optional. If this property is not set, the installed KeyManipulator ignores the Caps Lock state.

See also: setCapsLock(), getCapsLock()

Since: Kanzi 3.9.0

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

kanzi/ui/node_component/input/key_manipulator_component.hpp

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KeyManipulatorComponent()

Member Function Documentation

◆ getLogicalKey()

◆ setLogicalKey()

◆ getKeyModifiers()

◆ setKeyModifiers()

◆ getCapsLock()

◆ setCapsLock()

◆ create()

◆ makeEditorInfo()

◆ attachOverride()

◆ detachOverride()

◆ onPropertyChanged()

Member Data Documentation

◆ LogicalKeyProperty

◆ KeyModifiersProperty

◆ CapsLockProperty