Message arguments used by the OverlayBroughtToFrontMessage. More...

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

Inheritance diagram for kanzi::FocusManager::OverlayBroughtToFrontMessageArguments:

Additional Inherited Members
Public Member Functions inherited from kanzi::FocusManager::ScopeStateChangeMessageArguments
Node *	getNextForemostFocusScope () const
	Returns the next focus scope node to become the foremost focus scope node.

kanzi::FocusReason	getReasonValue () const
	Returns the state change reason value.

void	setNextForemostFocusScope (Node *next)
	Sets the focus scope node that is the next foremost focus scope node.

void	setReasonValue (kanzi::FocusReason reason)
	Sets the focus scope state change reason value for a message.

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

Static Public Attributes inherited from kanzi::FocusManager::ScopeStateChangeMessageArguments
static PropertyType< int >	ReasonValueProperty
	Defines the state change reason value defined by the FocusReason enumeration.

static PropertyType< void * >	NextFocusScopeNodeProperty
	Specifies the previous foremost focus scope node.

Detailed Description

Message arguments used by the OverlayBroughtToFrontMessage.

Since: Kanzi 3.9.2

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

kanzi/core.ui/input/focus_manager.hpp

Additional Inherited Members

Detailed Description