M_HidDisplay::ConfigButtonLabel Struct Reference

Public Member Functions
	ConfigButtonLabel ()
	ConfigButtonLabel (uint32_t KeyButtonIndex, std::string const &Label, M_Common::ImageType const &Image, bool IsEnabled, bool IsHighlighted, bool IsRemoved)

Public Attributes
uint32_t	KeyButtonIndex
	Index identifying the button. More...
std::string	Label
	Label to display for the button. More...
M_Common::ImageType	Image
	Image to display for the button. More...
bool	IsEnabled
bool	IsHighlighted
bool	IsRemoved

Detailed Description

Config with the label and image to be displayed for a button. Note: This function is only relevant for input devices which can display this kind of information.

Constructor & Destructor Documentation

ConfigButtonLabel() [1/2]

M_HidDisplay::ConfigButtonLabel::ConfigButtonLabel

(

)

ConfigButtonLabel() [2/2]

M_HidDisplay::ConfigButtonLabel::ConfigButtonLabel	(	uint32_t	KeyButtonIndex,
		std::string const &	Label,
		M_Common::ImageType const &	Image,
		bool	IsEnabled,
		bool	IsHighlighted,
		bool	IsRemoved
	)

Member Data Documentation

Image

M_Common::ImageType M_HidDisplay::ConfigButtonLabel::Image

Image to display for the button.

IsEnabled

bool M_HidDisplay::ConfigButtonLabel::IsEnabled

Indicates if the button is enabled (true) or disabled (false). An enabled button can be used by the user. A disabled button can NOT be used by the user. True = Enabled False = Disabled

IsHighlighted

bool M_HidDisplay::ConfigButtonLabel::IsHighlighted

Indicates if the button is highlighted (true). True = Highlighted False = Not highlighted

IsRemoved

bool M_HidDisplay::ConfigButtonLabel::IsRemoved

Indicates if the payload is no longer available Note: This will always be set to true when the instance has been shut down After this has been set to true, the payload will no longer be available to late joiners.

KeyButtonIndex

uint32_t M_HidDisplay::ConfigButtonLabel::KeyButtonIndex

Index identifying the button.

Label

std::string M_HidDisplay::ConfigButtonLabel::Label

Label to display for the button.