Kanzi  3.9.4
Kanzi Engine API
kanzi::FocusManager::FocusEnteredFocusScopeMessageArguments Class Reference

Message arguments used by the FocusEnteredFocusScopeMessage. More...

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

Inheritance diagram for kanzi::FocusManager::FocusEnteredFocusScopeMessageArguments:
[legend]

Public Member Functions

NodeSharedPtr getPreviousFocusScope () const
 Returns the focus scope node that previously contained the keyboard focus node. More...
 
void setPreviousFocusScope (Node *scopeNode)
 Sets the focus scope node that previously contained the keyboard focus node. More...
 
- Public Member Functions inherited from kanzi::FocusManager::PostFocusMessageArguments
kanzi::FocusReason getFocusReason () const
 Returns the stored value for the focus reason. More...
 
void setFocusReason (kanzi::FocusReason reason)
 Sets the focus reason value. 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< NodegetSource () 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...
 
MessageArgumentsoperator= (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

Properties

Holds the focus scope node that previously contained the keyboard focus node.

static PropertyType< void * > PreviousFocusScopeNodeProperty
 
- Static Public Attributes inherited from kanzi::FocusManager::PostFocusMessageArguments
static PropertyType< int > FocusReasonProperty
 

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 MetaclassgetStaticMetaclass ()
 Initializes and returns static metadata of base MessageArguments class. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Initializes and returns the Kanzi Studio editor information. More...
 

Detailed Description

Message arguments used by the FocusEnteredFocusScopeMessage.

Since
Kanzi 3.8.0

Member Function Documentation

◆ setPreviousFocusScope()

void kanzi::FocusManager::FocusEnteredFocusScopeMessageArguments::setPreviousFocusScope ( Node scopeNode)

Sets the focus scope node that previously contained the keyboard focus node.

Parameters
scopeNodeThe focus scope node.

◆ getPreviousFocusScope()

NodeSharedPtr kanzi::FocusManager::FocusEnteredFocusScopeMessageArguments::getPreviousFocusScope ( ) const

Returns the focus scope node that previously contained the keyboard focus node.

Returns
The focus scope node that previously contained the keyboard focus node.

Member Data Documentation

◆ PreviousFocusScopeNodeProperty

PropertyType<void*> kanzi::FocusManager::FocusEnteredFocusScopeMessageArguments::PreviousFocusScopeNodeProperty
static

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