Represents base message arguments for key input messages. More...

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

Inheritance diagram for kanzi::InputManipulator::KeyInputMessageArguments:

Public Member Functions
void	addKeyGestureArguments (const KeyGestureInfo &gesture)
	Adds key gesture information arguments to the message.

bool	getCapsLock () const
	Returns the value of the Caps Lock argument.

LogicalKey	getKey () const
	Returns the value of the logical key argument.

KeyEvent *	getKeyEvent () const
	Returns the value of the Key Event argument.

KeyModifier	getKeyModifiers () const
	Returns the value of the key modifiers argument.

bool	hasAltModifier () const
	Checks whether the key modifiers argument has one of the Alt key modifiers set.

bool	hasControlModifier () const
	Checks whether the key modifiers argument has one of the Control key modifiers set.

bool	hasModifier (KeyModifier modifier) const
	Checks whether a modifier is set in the key modifiers argument.

bool	hasShiftModifier () const
	Checks whether the key modifiers argument has one of the Shift key modifiers set.

void	setCapsLock (bool value)
	Sets the value of the Caps Lock argument.

void	setKey (LogicalKey value)
	Sets the value of the logical key argument.

void	setKeyEvent (KeyEvent *value)
	Sets the value of the Key Event argument.

void	setKeyModifiers (KeyModifier modifiers)
	Sets the value of the key modifiers argument.

Public Member Functions inherited from kanzi::MessageArguments
bool	getAbstractArgument (AbstractPropertyType argumentType, Variant &variant) const
	Returns the value of an argument using AbstractPropertyType.

template<typename TDataType >
TDataType	getArgument (const PropertyType< TDataType > &argumentType) const
	Returns the value of an argument.

detail::MessageDispatcher *	getDispatcher () const
	Returns the message dispatcher that dispatches a message.

template<typename TDataType >
optional< TDataType >	getOptionalArgument (const PropertyType< TDataType > &argumentType) const
	Returns the value of an argument.

shared_ptr< Node >	getSource () const
	Returns the source node for a message.

TimePoint	getTimestamp () const
	Returns the timestamp of a message.

AbstractMessageType	getType () const
	Returns the message type of these message arguments as an AbstractMessageType instance.

bool	isFrom (const Node &source) const
	Returns whether a node is the source node of a message.

bool	isHandled () const
	Returns whether the message is handled.

bool	isValid () const
	Returns whether a message is valid.

	MessageArguments ()=default
	Constructor.

	MessageArguments (const MessageArguments &)=delete
	Deleted copy.

MessageArguments &	operator= (const MessageArguments &)=delete
	Deleted assignment.

void	setAbstractArgument (AbstractPropertyType argumentType, const Variant &variant)
	Sets the value of an argument using AbstractPropertyType.

template<typename TDataType >
void	setArgument (const PropertyType< TDataType > &argumentType, typename PropertyType< TDataType >::DataType value)
	Sets the value of an argument.

void	setDispatcher (detail::MessageDispatcher *dispatcher)
	Sets a dispatcher for a message.

void	setHandled (bool handled)
	Sets the handling status for a message.

void	setSource (Node *source)
	Sets the source node that dispatches a message.

void	setTimestamp (TimePoint timestamp)
	Sets the timestamp of a message.

void	setType (AbstractMessageType type)
	Sets the type of a message.

void	setValid (bool valid)
	Sets the validity of a message.

	~MessageArguments ()
	Destructor.

Static Public Attributes
Properties
static PropertyType< int >	KeyProperty
	Holds the logical key presses and key released values.

static PropertyType< int >	KeyModifiersProperty
	Holds the key modifiers attached to the key value. The default value is 0.

static PropertyType< bool >	CapsLockProperty
	Indicates whether the Caps Lock key is on during the key event.

static PropertyType< void * >	KeyEventProperty
	Holds the key event instance from which the key input message is translated.

Additional Inherited Members
Static Public Member Functions inherited from kanzi::MessageArguments
static size_t	getArgumentAllocatorPoolSize ()
	Gets the current size of memory pool of argument entries.

static const Metaclass *	getStaticMetaclass ()
	Initializes and returns static metadata of base MessageArguments class.

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

Detailed Description

Represents base message arguments for key input messages.

Since: Kanzi 3.8.0

Member Function Documentation

◆ getKey()

LogicalKey kanzi::InputManipulator::KeyInputMessageArguments::getKey ( ) const

Returns the value of the logical key argument.

Returns: The value of the logical key argument.

See also: LogicalKey

◆ setKey()

void kanzi::InputManipulator::KeyInputMessageArguments::setKey ( LogicalKey value )

Sets the value of the logical key argument.

Parameters

value The logical key value to set.

See also: LogicalKey

◆ getKeyModifiers()

KeyModifier kanzi::InputManipulator::KeyInputMessageArguments::getKeyModifiers ( ) const

Returns the value of the key modifiers argument.

Returns: The value of the key modifiers argument.

See also: KeyModifier

◆ setKeyModifiers()

void kanzi::InputManipulator::KeyInputMessageArguments::setKeyModifiers ( KeyModifier modifiers )

Sets the value of the key modifiers argument.

Parameters

modifiers The key modifiers value to set.

See also: KeyModifier

◆ hasModifier()

bool kanzi::InputManipulator::KeyInputMessageArguments::hasModifier ( KeyModifier modifier ) const

Checks whether a modifier is set in the key modifiers argument.

Parameters

modifier The modifier to check.

Returns: If the modifier is set, true, otherwise false.

See also: KeyModifier

◆ hasShiftModifier()

bool kanzi::InputManipulator::KeyInputMessageArguments::hasShiftModifier ( ) const

Checks whether the key modifiers argument has one of the Shift key modifiers set.

Returns: If the key modifiers argument has at least one of the Shift key modifiers set, true, otherwise false.

See also: KeyModifier, KeyModifier::Shift, KeyModifier::LeftShift, KeyModifier::RightShift

◆ hasControlModifier()

bool kanzi::InputManipulator::KeyInputMessageArguments::hasControlModifier ( ) const

Checks whether the key modifiers argument has one of the Control key modifiers set.

Returns: If the key modifiers argument has at least one of the Control key modifiers set, true, otherwise false.

See also: KeyModifier, KeyModifier::Control, KeyModifier::LeftControl, KeyModifier::RightControl

◆ hasAltModifier()

bool kanzi::InputManipulator::KeyInputMessageArguments::hasAltModifier ( ) const

Checks whether the key modifiers argument has one of the Alt key modifiers set.

Returns: If the key modifiers argument has at least one of the Alt key modifiers set, true, otherwise false.

See also: KeyModifier, KeyModifier::Alt, KeyModifier::LeftAlt, KeyModifier::RightAlt

◆ getCapsLock()

bool kanzi::InputManipulator::KeyInputMessageArguments::getCapsLock ( ) const

Returns the value of the Caps Lock argument.

Returns: The value of the Caps Lock argument.

Since: Kanzi 3.9.0

◆ setCapsLock()

void kanzi::InputManipulator::KeyInputMessageArguments::setCapsLock ( bool value )

Sets the value of the Caps Lock argument.

Parameters

value The Caps Lock value to set.

Since: Kanzi 3.9.0

◆ getKeyEvent()

KeyEvent * kanzi::InputManipulator::KeyInputMessageArguments::getKeyEvent ( ) const

Returns the value of the Key Event argument.

Returns: The value of the Key Event argument.

Since: Kanzi 3.9.8

◆ setKeyEvent()

void kanzi::InputManipulator::KeyInputMessageArguments::setKeyEvent ( KeyEvent * value )

Sets the value of the Key Event argument.

Parameters

value The Key Event value to set.

Since: Kanzi 3.9.8

◆ addKeyGestureArguments()

void kanzi::InputManipulator::KeyInputMessageArguments::addKeyGestureArguments ( const KeyGestureInfo & gesture )

Adds key gesture information arguments to the message.

Parameters

gesture The key gesture.

Since: Kanzi 3.9.0

Member Data Documentation

◆ KeyProperty

PropertyType<int> kanzi::InputManipulator::KeyInputMessageArguments::KeyProperty

static

Holds the logical key presses and key released values.

The default value is 0.

See also: setKey(), getKey()

◆ KeyModifiersProperty

PropertyType<int> kanzi::InputManipulator::KeyInputMessageArguments::KeyModifiersProperty

static

Holds the key modifiers attached to the key value. The default value is 0.

◆ CapsLockProperty

PropertyType<bool> kanzi::InputManipulator::KeyInputMessageArguments::CapsLockProperty

static

Indicates whether the Caps Lock key is on during the key event.

The default value is false.

Since: Kanzi 3.9.0

◆ KeyEventProperty

PropertyType<void*> kanzi::InputManipulator::KeyInputMessageArguments::KeyEventProperty

static

Holds the key event instance from which the key input message is translated.

Since: Kanzi 3.9.8

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

kanzi/core.ui/input/input_manipulator.hpp

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getKey()

◆ setKey()

◆ getKeyModifiers()

◆ setKeyModifiers()

◆ hasModifier()

◆ hasShiftModifier()

◆ hasControlModifier()

◆ hasAltModifier()

◆ getCapsLock()

◆ setCapsLock()

◆ getKeyEvent()

◆ setKeyEvent()

◆ addKeyGestureArguments()

Member Data Documentation

◆ KeyProperty

◆ KeyModifiersProperty

◆ CapsLockProperty

◆ KeyEventProperty