gva::WidgetKeyboard Class Reference

Class defining the mode widget. More...

#include <keyboard.h>

Inheritance diagram for gva::WidgetKeyboard:

Collaboration diagram for gva::WidgetKeyboard:

Public Member Functions
	WidgetKeyboard (const RendererGva &renderer)
	Construct a new Widget Keyboard object.
	~WidgetKeyboard () final=default
	Destroy the Widget Keyboard object.
std::string	GetWidgetName () const final
	Get the Widget Name attribute.
void	Draw () final
	Draw the current widget.
void	DrawKeyboard (const widget::KeyboardModeType mode)
	Draw the on screen keyboard.
void	SetMode (const widget::KeyboardModeType mode)
	Set the Mode object.
widget::KeyboardModeType	GetMode () const
	Get the Mode object.
Public Member Functions inherited from gva::WidgetX
	WidgetX (const RendererGva &renderer, widget::WidgetEnum widget_type)
	Construct a new Widget X object.
virtual widget::WidgetEnum	GetWidgetType () const
	Get the Widget Type attribute.
void	SetVisible (bool visible)
	Set the Visible object.
bool	GetVisible () const
	Get the Visible object.
virtual void	SetX (uint32_t x)
	Set the X dimension.
uint32_t	GetX () const
	Get the Y dimension.
virtual void	SetY (uint32_t y)
	Set the Y dimension.
uint32_t	GetY () const
	Get the Y dimension.
void	SetWidth (uint32_t width)
	Set the Width.
uint32_t	GetWidth () const
	Get the Width.
void	SetHeight (uint32_t width)
	Set the Height.
uint32_t	GetHeight () const
	Get the Height.
widget::WidgetEnum	GetType () const
	Get the Type object.
RendererGva *	GetRenderer () const
	Get the Renderer object.
void	SetStateText (LabelStates state)
	Set the State Text of an on screen label.
void	SetStateLabel (const LabelStates state)
	Set the State Label object.
uint32_t	GetStateTextColour (LabelStates state) const
	Get the State Text Colour object.

Additional Inherited Members
Data Fields inherited from gva::WidgetX
uint32_t	x_ = 0
	The widget x location in pixels.
uint32_t	y_ = 0
	The widget y location in pixels.
uint32_t	width_ = 0
	The widget width in pixels.
uint32_t	height_ = 0
	The widget height in pixels.

Detailed Description

Class defining the mode widget.

Constructor & Destructor Documentation

WidgetKeyboard()

gva::WidgetKeyboard::WidgetKeyboard ( const RendererGva &  renderer )

explicit

Construct a new Widget Keyboard object.

Parameters

renderer

Member Function Documentation

Draw()

void gva::WidgetKeyboard::Draw ( )

finalvirtual

Draw the current widget.

Implements gva::WidgetX.

DrawKeyboard()

void gva::WidgetKeyboard::DrawKeyboard

(

const widget::KeyboardModeType

mode

)

Draw the on screen keyboard.

Parameters

mode

GetMode()

widget::KeyboardModeType gva::WidgetKeyboard::GetMode

(

)

const

Get the Mode object.

Returns

KeyboardModeType

GetWidgetName()

std::string gva::WidgetKeyboard::GetWidgetName ( ) const

inlinefinalvirtual

Get the Widget Name attribute.

Returns

std::string

Implements gva::WidgetX.

SetMode()

void gva::WidgetKeyboard::SetMode

(

const widget::KeyboardModeType

mode

)

Set the Mode object.

void SetMode(KeyboardModeType mode) { mode_ = mode; }

---

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

• src/hmicore/widgets/keyboard.h
• src/hmicore/widgets/keyboard.cc