Message arguments used by the OverlayGainedFocusMessage. More...

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

Inheritance diagram for kanzi::FocusManager::OverlayGainedFocusMessageArguments:

Public Member Functions
NodeSharedPtr	getPreviousFocusedOverlay () const
	Returns the overlay scope node that previously contained the key focus node.

void	setPreviousFocusedOverlay (Node *scopeNode)
	Sets the overlay scope node that previously contained the key focus node.

Public Member Functions inherited from kanzi::FocusManager::PostFocusMessageArguments
kanzi::FocusReason	getFocusReason () const
	Returns the stored value for the focus reason.

void	setFocusReason (kanzi::FocusReason reason)
	Sets the focus reason value.

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 Attributes
Properties
static PropertyType< void * >	PreviousFocusedOverlayScopeNodeProperty
	Holds the overlay scope node that previously contained the key focus node.

Static Public Attributes inherited from kanzi::FocusManager::PostFocusMessageArguments
static PropertyType< int >	FocusReasonProperty
	The property that holds the reason for the focus move.

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.

static const Metaclass *	getStaticMetaclass ()
	Initializes and returns static metadata of base MessageArguments class.

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Initializes and returns the Kanzi Studio editor information.

Detailed Description

Message arguments used by the OverlayGainedFocusMessage.

Since: Kanzi 3.9.2

Member Function Documentation

◆ setPreviousFocusedOverlay()

void kanzi::FocusManager::OverlayGainedFocusMessageArguments::setPreviousFocusedOverlay ( Node * scopeNode )

Sets the overlay scope node that previously contained the key focus node.

Parameters

scopeNode The overlay scope node.

◆ getPreviousFocusedOverlay()

NodeSharedPtr kanzi::FocusManager::OverlayGainedFocusMessageArguments::getPreviousFocusedOverlay ( ) const

Returns the overlay scope node that previously contained the key focus node.

Returns: The overlay scope node that previously contained the key focus node.

Member Data Documentation

◆ PreviousFocusedOverlayScopeNodeProperty

PropertyType<void*> kanzi::FocusManager::OverlayGainedFocusMessageArguments::PreviousFocusedOverlayScopeNodeProperty

static

Holds the overlay scope node that previously contained the key focus node.

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

kanzi/core.ui/input/focus_manager.hpp

Public Member Functions