Message arguments used by the SendScopeToBackMessage. More...

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

Inheritance diagram for kanzi::FocusManager::SendScopeToBackMessageArguments:

Public Member Functions
FocusReason	getReasonValue () const
	Returns the deactivation reason value. More...

void	setReasonValue (FocusReason reason)
	Sets the deactivation 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< 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
Properties
Defines the state change reason value defined by the FocusReason enumeration. You can use the following focus reason values when a focus scope is sent to the back: ForceFocusReason, specifies that the focus scope is explicitly brought to front or sent to back OtherScopeInFront, specifies that the focus scope receiving the message is no longer the foremost focus because an other focus scope is brought to the front OtherFocusReason, specifies other, custom focus reasons.
static PropertyType< int >	ReasonValueProperty

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...

Detailed Description

Message arguments used by the SendScopeToBackMessage.

Since: Kanzi 3.7.0

Member Function Documentation

◆ getReasonValue()

FocusReason kanzi::FocusManager::SendScopeToBackMessageArguments::getReasonValue ( ) const

inline

Returns the deactivation reason value.

Returns: The deactivation reason value.

See also: SendScopeToBackMessage, ReasonValueProperty

◆ setReasonValue()

void kanzi::FocusManager::SendScopeToBackMessageArguments::setReasonValue ( FocusReason reason )

inline

Sets the deactivation reason value for a message.

Parameters

reason The deactivation reason value.

See also: SendScopeToBackMessage, ReasonValueProperty

Member Data Documentation

◆ ReasonValueProperty

PropertyType<int> kanzi::FocusManager::SendScopeToBackMessageArguments::ReasonValueProperty

static

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

kanzi/core.ui/input/focus_manager.hpp

Public Member Functions