A message containing the widget focus state. More...

Inheritance diagram for ramses::WidgetFocusStatusMessage:

Collaboration diagram for ramses::WidgetFocusStatusMessage:

Public Types
enum class	Status : uint32_t { Unknown = 0 , Focused , NotFocused }
	The focus states of the widget on the instrument cluster. More...

Public Member Functions
	WidgetFocusStatusMessage (Status status)
	Create a WidgetFocusStatusMessage object containing the provided status. More...

Status	getWidgetFocusStatus () const
	Returns the contained status. More...

	WidgetFocusStatusMessage (std::unique_ptr< DcsmStatusMessageImpl > &&impl_)
	Constructor from impl, only for internal usage. More...

Public Member Functions inherited from ramses::DcsmStatusMessage
class StreamStatusMessage const *	getAsStreamStatus () const
	Convenience function to get the derived class of DcsmStatusMessage easily. More...

class ActiveLayoutMessage const *	getAsActiveLayout () const
	Convenience function to get the derived class of DcsmStatusMessage easily. More...

class WidgetFocusStatusMessage const *	getAsWidgetFocusStatus () const
	Convenience function to get the derived class of DcsmStatusMessage easily. More...

virtual	~DcsmStatusMessage ()
	Default destructor of DcsmStatusMessage. More...

	DcsmStatusMessage (DcsmStatusMessage const &)=delete
	Disable copying. More...

	DcsmStatusMessage (DcsmStatusMessage &&)=delete
	Disable moving. More...

Additional Inherited Members
Public Attributes inherited from ramses::DcsmStatusMessage
std::unique_ptr< DcsmStatusMessageImpl >	impl

Protected Member Functions inherited from ramses::DcsmStatusMessage
	DcsmStatusMessage (std::unique_ptr< DcsmStatusMessageImpl > &&impl_)
	Constructor from impl. More...

Detailed Description

A message containing the widget focus state.

Member Enumeration Documentation

strong

The focus states of the widget on the instrument cluster.

ramses::WidgetFocusStatusMessage::WidgetFocusStatusMessage ( Status status )

explicit

Create a WidgetFocusStatusMessage object containing the provided status.

Parameters

status The status to transmit.

ramses::WidgetFocusStatusMessage::WidgetFocusStatusMessage ( std::unique_ptr< DcsmStatusMessageImpl > && impl_ )

explicit

Constructor from impl, only for internal usage.

Parameters

impl_ impl

Status ramses::WidgetFocusStatusMessage::getWidgetFocusStatus ( ) const

Returns the contained status.

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

/home/runner/work/ramses/ramses/framework/ramses-framework-api/include/ramses-framework-api/DcsmStatusMessage.h