Kanzi  3.9.7
Kanzi Engine API
kanzi::FocusManager::ScopeStateChangeMessageArguments Class Reference

Base message argument class for the focus scope state change message arguments. More...

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

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

Public Member Functions

NodegetNextForemostFocusScope () const
 Returns the next focus scope node to become the foremost focus scope node. More...
 
kanzi::FocusReason getReasonValue () const
 Returns the state change reason value. More...
 
void setNextForemostFocusScope (Node *next)
 Sets the focus scope node that is the next foremost focus scope node. More...
 
void setReasonValue (kanzi::FocusReason reason)
 Sets the focus scope state change reason value for a message. 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
static PropertyType< int > ReasonValueProperty
 Defines the state change reason value defined by the FocusReason enumeration. More...
 
static PropertyType< void * > NextFocusScopeNodeProperty
 Specifies the previous foremost focus scope node. 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 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

Base message argument class for the focus scope state change message arguments.

Since
Kanzi 3.7.0

Member Function Documentation

kanzi::FocusReason kanzi::FocusManager::ScopeStateChangeMessageArguments::getReasonValue ( ) const
inline

Returns the state change reason value.

Returns
The state change reason value.
See also
OverlayBroughtToFrontMessage, OverlaySentToBackMessage, ReasonValueProperty
void kanzi::FocusManager::ScopeStateChangeMessageArguments::setReasonValue ( kanzi::FocusReason  reason)
inline

Sets the focus scope state change reason value for a message.

Parameters
reasonThe reason value.
See also
OverlayBroughtToFrontMessage, OverlaySentToBackMessage, ReasonValueProperty
Node* kanzi::FocusManager::ScopeStateChangeMessageArguments::getNextForemostFocusScope ( ) const
inline

Returns the next focus scope node to become the foremost focus scope node.

Returns
The next foremost focus scope node, nullptr if the source node is the only focus scope node registered to FocusManager.
void kanzi::FocusManager::ScopeStateChangeMessageArguments::setNextForemostFocusScope ( Node next)
inline

Sets the focus scope node that is the next foremost focus scope node.

Parameters
nextThe next foremost focus scope node.

Member Data Documentation

PropertyType<int> kanzi::FocusManager::ScopeStateChangeMessageArguments::ReasonValueProperty
static

Defines the state change reason value defined by the FocusReason enumeration.

Kanzi uses the following focus reason values for focus scopes:

  • FocusReason::Force, specifies that the focus scope is explicitly brought to front or sent to back because another focus scope is sent to back or brought to the front.
PropertyType<void*> kanzi::FocusManager::ScopeStateChangeMessageArguments::NextFocusScopeNodeProperty
static

Specifies the previous foremost focus scope node.

If the property value is nullptr, the source node of the message is the only focus scope node registered to FocusManager.


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