Message arguments used by the KeyPressedMessage. More...
#include <kanzi/core.ui/input/key_manipulator.hpp>
Public Member Functions | |
| void | addKeyGestureArguments (const KeyGestureInfo &gesture) |
| Adds key gesture information arguments to the message. More... | |
| bool | isRepeat () const |
| Returns the IsRepeatProperty argument value. More... | |
| void | setRepeat (bool repeat) |
| Sets the value of the IsRepeatProperty argument. More... | |
 Public Member Functions inherited from kanzi::InputManipulator::KeyInputMessageArguments | |
| void | addKeyGestureArguments (const KeyGestureInfo &gesture) |
| Adds key gesture information arguments to the message. More... | |
| bool | getCapsLock () const |
| Returns the value of the Caps Lock argument. More... | |
| LogicalKey | getKey () const |
| Returns the value of the logical key argument. More... | |
| KeyEvent * | getKeyEvent () const |
| Returns the value of the Key Event argument. More... | |
| KeyModifier | getKeyModifiers () const |
| Returns the value of the key modifiers argument. More... | |
| bool | hasAltModifier () const |
| Checks whether the key modifiers argument has one of the Alt key modifiers set. More... | |
| bool | hasControlModifier () const |
| Checks whether the key modifiers argument has one of the Control key modifiers set. More... | |
| bool | hasModifier (KeyModifier modifier) const |
| Checks whether a modifier is set in the key modifiers argument. More... | |
| bool | hasShiftModifier () const |
| Checks whether the key modifiers argument has one of the Shift key modifiers set. More... | |
| void | setCapsLock (bool value) |
| Sets the value of the Caps Lock argument. More... | |
| void | setKey (LogicalKey value) |
| Sets the value of the logical key argument. More... | |
| void | setKeyEvent (KeyEvent *value) |
| Sets the value of the Key Event argument. More... | |
| void | setKeyModifiers (KeyModifier modifiers) |
| Sets the value of the key modifiers argument. More... | |
| Public Member Functions inherited from kanzi::MessageArguments | |
| bool | getAbstractArgument (AbstractPropertyType argumentType, Variant &variant) const |
| Returns the value of an argument using AbstractPropertyType. More... | |
| template<typename TDataType > | |
| TDataType | getArgument (const PropertyType< TDataType > &argumentType) const |
| Returns the value of an argument. More... | |
| detail::MessageDispatcher * | getDispatcher () const |
| Returns the message dispatcher that dispatches a message. More... | |
| template<typename TDataType > | |
| optional< TDataType > | getOptionalArgument (const PropertyType< TDataType > &argumentType) const |
| Returns the value of an argument. More... | |
| shared_ptr< Node > | getSource () const |
| Returns the source node for a message. More... | |
| TimePoint | getTimestamp () const |
| Returns the timestamp of a message. More... | |
| AbstractMessageType | getType () const |
| Returns the message type of these message arguments as an AbstractMessageType instance. More... | |
| bool | isFrom (const Node &source) const |
| Returns whether a node is the source node of a message. More... | |
| bool | isHandled () const |
| Returns whether the message is handled. More... | |
| bool | isValid () const |
| Returns whether a message is valid. More... | |
| MessageArguments ()=default | |
| Constructor. More... | |
| MessageArguments (const MessageArguments &)=delete | |
| Deleted copy. More... | |
| MessageArguments & | operator= (const MessageArguments &)=delete |
| Deleted assignment. More... | |
| void | setAbstractArgument (AbstractPropertyType argumentType, const Variant &variant) |
| Sets the value of an argument using AbstractPropertyType. More... | |
| template<typename TDataType > | |
| void | setArgument (const PropertyType< TDataType > &argumentType, typename PropertyType< TDataType >::DataType value) |
| Sets the value of an argument. More... | |
| void | setDispatcher (detail::MessageDispatcher *dispatcher) |
| Sets a dispatcher for a message. More... | |
| void | setHandled (bool handled) |
| Sets the handling status for a message. More... | |
| void | setSource (Node *source) |
| Sets the source node that dispatches a message. More... | |
| void | setTimestamp (TimePoint timestamp) |
| Sets the timestamp of a message. More... | |
| void | setType (AbstractMessageType type) |
| Sets the type of a message. More... | |
| void | setValid (bool valid) |
| Sets the validity of a message. More... | |
| ~MessageArguments () | |
| Destructor. More... | |
Static Public Attributes | |
| static PropertyType< bool > | IsRepeatProperty |
| Indicates whether the key press is a repeat, which occurs when the user holds a key down. More... | |
| Static Public Attributes inherited from kanzi::InputManipulator::KeyInputMessageArguments | |
| static PropertyType< int > | KeyProperty |
| Holds the logical key presses and key released values. More... | |
| static PropertyType< int > | KeyModifiersProperty |
| Holds the key modifiers attached to the key value. The default value is 0. More... | |
| static PropertyType< bool > | CapsLockProperty |
| Indicates whether the Caps Lock key is on during the key event. More... | |
| static PropertyType< void * > | KeyEventProperty |
| Holds the key event instance from which the key input message is translated. More... | |
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. More... | |
| static const Metaclass * | getStaticMetaclass () |
| Initializes and returns static metadata of base MessageArguments class. More... | |
| static PropertyTypeEditorInfoSharedPtr | makeEditorInfo () |
| Initializes and returns the Kanzi Studio editor information. More... | |
Message arguments used by the KeyPressedMessage.
| bool kanzi::KeyManipulator::KeyPressedMessageArguments::isRepeat | ( | ) | const |
Returns the IsRepeatProperty argument value.
| void kanzi::KeyManipulator::KeyPressedMessageArguments::setRepeat | ( | bool | repeat | ) |
Sets the value of the IsRepeatProperty argument.
| repeat | The IsRepeatProperty value to set. |
| void kanzi::KeyManipulator::KeyPressedMessageArguments::addKeyGestureArguments | ( | const KeyGestureInfo & | gesture | ) |
Adds key gesture information arguments to the message.
| gesture | The key gesture. |
|
static |
Indicates whether the key press is a repeat, which occurs when the user holds a key down.
