A popup onscreen keyboard for easy alphanumeric and text entry using a remote control or mouse. More...

#include <libmythui/mythvirtualkeyboard.h>

Inheritance diagram for MythUIVirtualKeyboard:

Collaboration diagram for MythUIVirtualKeyboard:

Signals
void	keyPressed (QString key)

Signals inherited from MythScreenType
void	Exiting ()

Signals inherited from MythUIType
void	RequestUpdate ()

void	RequestRegionUpdate (const QRect &)

void	TakingFocus ()

void	LosingFocus ()

void	VisibilityChanged (bool Visible)

void	Showing ()

void	Hiding ()

void	Enabling ()

void	Disabling ()

void	FinishedMoving ()

void	FinishedFading ()

void	DependChanged (bool isDefault)

Public Member Functions
	MythUIVirtualKeyboard (MythScreenStack parentStack, MythUITextEdit m_parentEdit)

	~MythUIVirtualKeyboard () override=default

bool	Create (void) override

bool	keyPressEvent (QKeyEvent *e) override
	Key event handler. More...

Public Member Functions inherited from MythScreenType
	MythScreenType (MythScreenStack *parent, const QString &name, bool fullscreen=true)

	~MythScreenType () override

bool	inputMethodEvent (QInputMethodEvent *event) override
	Input Method event handler. More...

bool	gestureEvent (MythGestureEvent *event) override
	Mouse click/movement handler, receives mouse gesture events from the QCoreApplication event loop. More...

virtual void	ShowMenu (void)

void	doInit (void)

void	LoadInForeground (void)

bool	IsInitialized (void) const
	Has Init() been called on this screen? More...

bool	IsFullscreen (void) const

void	SetFullscreen (bool full)

MythUIType *	GetFocusWidget (void) const

bool	SetFocusWidget (MythUIType *widget=nullptr)

virtual bool	NextPrevWidgetFocus (bool up_or_down)

void	BuildFocusList (void)

MythScreenStack *	GetScreenStack () const

virtual void	aboutToHide (void)

virtual void	aboutToShow (void)

bool	IsDeleting (void) const

void	SetDeleting (bool deleting)

bool	IsLoading (void) const

bool	IsLoaded (void) const

MythPainter *	GetPainter (void) override

Public Member Functions inherited from MythUIComposite
	MythUIComposite (QObject *parent, const QString &name)

	~MythUIComposite () override=default

virtual void	SetTextFromMap (const InfoMap &infoMap)

virtual void	ResetMap (const InfoMap &infoMap)

Public Member Functions inherited from MythUIType
	MythUIType (QObject *parent, const QString &name)

virtual void	Reset (void)
	Reset the widget to it's original state, should not reset changes made by the theme. More...

void	AddChild (MythUIType *child)
	Add a child UIType. More...

MythUIType *	GetChild (const QString &name) const
	Get a named child of this UIType. More...

MythUIType *	GetChildAt (QPoint p, bool recursive=true, bool focusable=true) const
	Return the first MythUIType at the given coordinates. More...

QList< MythUIType * > *	GetAllChildren (void)
	Return a list of all child widgets. More...

QList< MythUIType * >	GetAllDescendants (void)

void	DeleteChild (const QString &name)
	Delete a named child of this UIType. More...

void	DeleteChild (MythUIType *child)
	Delete the given UIType if it is a child of this UIType. More...

void	DeleteAllChildren (void)
	Delete all child widgets. More...

bool	NeedsRedraw (void) const

void	ResetNeedsRedraw (void)

void	SetRedraw (void)

void	SetChildNeedsRedraw (MythUIType *child)

bool	CanTakeFocus (void) const
	Return if this widget can accept input focus. More...

void	SetCanTakeFocus (bool set=true)
	Set whether this widget can take focus. More...

void	SetFocusOrder (int order)

bool	IsEnabled (void) const

void	SetEnabled (bool enable)

bool	MoveToTop (void)

bool	MoveChildToTop (MythUIType *child)

void	ActivateAnimations (MythUIAnimation::Trigger trigger)

QList< MythUIAnimation * > *	GetAnimations (void)

virtual void	Pulse (void)
	Pulse is called 70 times a second to trigger a single frame of an animation. More...

void	Draw (MythPainter *p, int xoffset, int yoffset, int alphaMod=255, QRect clipRect=QRect())

void	SetPosition (int x, int y)
	Convenience method, calls SetPosition(const MythPoint&) Override that instead to change functionality. More...

void	SetPosition (QPoint point)

virtual void	SetPosition (const MythPoint &point)

virtual MythPoint	GetPosition (void) const

virtual void	SetSize (QSize size)

virtual void	SetMinSize (const MythPoint &size)
	Set the minimum size of this widget, for widgets which can be rescaled. More...

virtual QSize	GetMinSize (void) const

virtual void	SetArea (const MythRect &rect)

virtual void	AdjustMinArea (int delta_x, int delta_y, int delta_w, int delta_h)
	Adjust the size of a sibling. More...

virtual void	VanishSibling (void)

virtual void	SetMinAreaParent (MythRect actual_area, MythRect allowed_area, MythUIType *child)
	Adjust the size of sibling objects within the button. More...

virtual void	SetMinArea (const MythRect &rect)
	Set the minimum area based on the given size. More...

virtual MythRect	GetArea (void) const
	If the object has a minimum area defined, return it, other wise return the default area. More...

virtual MythRect	GetFullArea (void) const

virtual void	RecalculateArea (bool recurse=true)

void	ExpandArea (QRect rect)

virtual QRegion	GetDirtyArea (void) const

bool	IsVisible (bool recurse=false) const

virtual void	SetVisible (bool visible)

void	MoveTo (QPoint destXY, QPoint speedXY)

void	AdjustAlpha (int mode, int alphachange, int minalpha=0, int maxalpha=255)

void	SetAlpha (int newalpha)

int	GetAlpha (void) const

virtual void	mediaEvent (MythMediaEvent *event)
	Media/Device status event handler, received from MythMediaMonitor. More...

MythFontProperties *	GetFont (const QString &text) const

bool	AddFont (const QString &text, MythFontProperties *fontProp)

void	SetHelpText (const QString &text)

QString	GetHelpText (void) const

void	SetXMLLocation (const QString &filename, int where)

QString	GetXMLLocation (void) const

void	SetXMLName (const QString &name)

QString	GetXMLName (void) const

bool	IsDeferredLoading (bool recurse=false) const

void	SetDeferLoad (bool defer)

virtual void	LoadNow (void)
	Cause images in this and child widgets to be loaded. More...

bool	ContainsPoint (QPoint point) const
	Check if the given point falls within this widgets area. More...

void	SetPainter (MythPainter *painter)

void	SetCentre (UIEffects::Centre centre)

void	SetZoom (float zoom)

void	SetHorizontalZoom (float zoom)

void	SetVerticalZoom (float zoom)

void	SetAngle (float angle)

void	SetDependIsDefault (bool isDefault)

void	SetReverseDependence (MythUIType *dependee, bool reverse)

void	SetDependsMap (QMap< QString, QString > dependsMap)

QMap< QString, QString >	GetDependsMap () const

Protected Slots
void	charClicked (void)

void	shiftClicked (void)

void	delClicked (void)

void	lockClicked (void)

void	altClicked (void)

void	compClicked (void)

void	moveleftClicked (void)

void	moverightClicked (void)

void	backClicked (void)

void	returnClicked (void)

Private Member Functions
void	loadKeyDefinitions (const QString &lang)

void	parseKey (const QDomElement &element)

void	updateKeys (bool connectSignals=false)

QString	getKeyText (const KeyDefinition &key) const

Static Private Member Functions
static QString	decodeChar (QString c)

static void	loadEventKeyDefinitions (QKeyCombination *keyDef, const QString &action)

Private Attributes
MythUITextEdit *	m_parentEdit {nullptr}

PopupPosition	m_preferredPos

QMap< QString, KeyDefinition >	m_keyMap

MythUIButton *	m_lockButton {nullptr}

MythUIButton *	m_altButton {nullptr}

MythUIButton *	m_compButton {nullptr}

MythUIButton *	m_shiftLButton {nullptr}

MythUIButton *	m_shiftRButton {nullptr}

bool	m_shift {false}

bool	m_alt {false}

bool	m_lock {false}

bool	m_composing {false}

QString	m_composeStr

QKeyCombination	m_upKey

QKeyCombination	m_downKey

QKeyCombination	m_leftKey

QKeyCombination	m_rightKey

QKeyCombination	m_newlineKey

Additional Inherited Members
Public Slots inherited from MythScreenType
virtual void	Close ()

Public Slots inherited from MythUIType
void	LoseFocus ()

bool	TakeFocus ()

void	Activate ()

void	Hide (void)

void	Show (void)

void	Refresh (void)

void	UpdateDependState (bool isDefault)

void	UpdateDependState (MythUIType *dependee, bool isDefault)

Static Public Member Functions inherited from XMLParseBase
static QString	getFirstText (QDomElement &element)

static bool	parseBool (const QString &text)

static bool	parseBool (QDomElement &element)

static MythPoint	parsePoint (const QString &text, bool normalize=true)

static MythPoint	parsePoint (QDomElement &element, bool normalize=true)

static QSize	parseSize (const QString &text, bool normalize=true)

static QSize	parseSize (QDomElement &element, bool normalize=true)

static MythRect	parseRect (const QString &text, bool normalize=true)

static MythRect	parseRect (QDomElement &element, bool normalize=true)

static int	parseAlignment (const QString &text)

static int	parseAlignment (QDomElement &element)

static QBrush	parseGradient (const QDomElement &element)

static QString	parseText (QDomElement &element)

static MythUIType *	GetGlobalObjectStore (void)

static void	ClearGlobalObjectStore (void)

static void	ParseChildren (const QString &filename, QDomElement &element, MythUIType *parent, bool showWarnings)

static MythUIType *	ParseUIType (const QString &filename, QDomElement &element, const QString &type, MythUIType parent, MythScreenType screen, bool showWarnings, QMap< QString, QString > &parentDependsMap)

static bool	WindowExists (const QString &xmlfile, const QString &windowname)

static bool	LoadWindowFromXML (const QString &xmlfile, const QString &windowname, MythUIType *parent)

static bool	LoadBaseTheme (void)

static bool	LoadBaseTheme (const QString &baseTheme)

static bool	CopyWindowFromBase (const QString &windowname, MythScreenType *win)

Protected Member Functions inherited from MythScreenType
	MythScreenType (MythUIType *parent, const QString &name, bool fullscreen=true)

void	CopyFrom (MythUIType *base) override
	Copy this widgets state from another. More...

void	CreateCopy (MythUIType *parent) override
	Copy the state of this widget to the one given, it must be of the same type. More...

bool	ParseElement (const QString &filename, QDomElement &element, bool showWarnings) override
	Parse the xml definition of this widget setting the state of the object accordingly. More...

virtual void	Load (void)
	Load data which will ultimately be displayed on-screen or used to determine what appears on-screen (See Warning) More...

virtual void	Init (void)
	Used after calling Load() to assign data to widgets and other UI initilisation which is prohibited in Load() More...

void	LoadInBackground (const QString &message="")

void	ReloadInBackground (void)

void	OpenBusyPopup (const QString &message="")

void	CloseBusyPopup (void)

void	SetBusyPopupMessage (const QString &message)

void	ResetBusyPopup (void)

Protected Member Functions inherited from MythUIType
	~MythUIType () override

void	customEvent (QEvent *event) override

virtual void	DrawSelf (MythPainter *p, int xoffset, int yoffset, int alphaMod, QRect clipRect)

void	AddFocusableChildrenToList (FocusInfoType &focusList)

void	HandleAlphaPulse ()
	Handle one frame of an alpha (transparency) change animation. More...

void	HandleMovementPulse ()
	Handle one frame of a movement animation. More...

int	CalcAlpha (int alphamod) const

void	ConnectDependants (bool recurse=false)

virtual void	Finalize (void)
	Perform any post-xml parsing initialisation tasks. More...

Static Protected Member Functions inherited from MythUIType
static int	NormX (int width)

static int	NormY (int height)

Protected Attributes inherited from MythScreenType
bool	m_fullScreen {false}

bool	m_isDeleting {false}

QSemaphore	m_loadLock {1}

volatile bool	m_isLoading {false}

volatile bool	m_isLoaded {false}

bool	m_isInitialized {false}

MythUIType *	m_currentFocusWidget {nullptr}

FocusInfoType	m_focusWidgetList

MythScreenStack *	m_screenStack {nullptr}

MythUIBusyDialog *	m_busyPopup {nullptr}

QRegion	m_savedMask

Protected Attributes inherited from MythUIType
QList< MythUIType * >	m_childrenList

QMap< QString, QString >	m_dependsMap

QList< QPair< MythUIType *, bool > >	m_dependsValue

QList< int >	m_dependOperator

bool	m_visible {true}

bool	m_hasFocus {false}

bool	m_canHaveFocus {false}

bool	m_enabled {true}

bool	m_enableInitiator {false}

bool	m_initiator {false}

bool	m_vanish {false}

bool	m_vanished {false}

bool	m_isDependDefault {false}

QMap< MythUIType *, bool >	m_reverseDepend

int	m_focusOrder {0}

MythRect	m_area {0,0,0,0}

MythRect	m_minArea {0,0,0,0}

MythPoint	m_minSize

QRegion	m_dirtyRegion {0,0,0,0}

bool	m_needsRedraw {false}

UIEffects	m_effects

int	m_alphaChangeMode {0}

int	m_alphaChange {0}

int	m_alphaMin {0}

int	m_alphaMax {255}

bool	m_moving {false}

QPoint	m_xyDestination {0,0}

QPoint	m_xySpeed {0,0}

FontMap *	m_fonts {nullptr}

MythUIType *	m_parent {nullptr}

MythPainter *	m_painter {nullptr}

QList< MythUIAnimation * >	m_animations

QString	m_helptext

QString	m_xmlName

QString	m_xmlLocation

bool	m_deferload {false}

QColor	m_borderColor {Qt::black}

Detailed Description

A popup onscreen keyboard for easy alphanumeric and text entry using a remote control or mouse.

The virtual keyboard is invoked by MythUITextEdit when the user triggers the SELECT action. It is not normally necessary to use this widget explicitly.

Definition at line 48 of file mythvirtualkeyboard.h.

Constructor & Destructor Documentation

◆ MythUIVirtualKeyboard()

MythUIVirtualKeyboard::MythUIVirtualKeyboard	(	MythScreenStack *	parentStack,
		MythUITextEdit *	m_parentEdit
	)

Definition at line 79 of file mythvirtualkeyboard.cpp.

◆ ~MythUIVirtualKeyboard()

MythUIVirtualKeyboard::~MythUIVirtualKeyboard ( )

overridedefault

Member Function Documentation

◆ Create()

bool MythUIVirtualKeyboard::Create ( void )

overridevirtual

Reimplemented from MythScreenType.

Definition at line 95 of file mythvirtualkeyboard.cpp.

◆ keyPressEvent()

bool MythUIVirtualKeyboard::keyPressEvent ( QKeyEvent * event )

overridevirtual

Key event handler.

Parameters

event Keypress event

Reimplemented from MythScreenType.

Definition at line 365 of file mythvirtualkeyboard.cpp.

◆ keyPressed

void MythUIVirtualKeyboard::keyPressed ( QString key )

signal

Referenced by backClicked(), charClicked(), delClicked(), moveleftClicked(), moverightClicked(), and returnClicked().

◆ charClicked

void MythUIVirtualKeyboard::charClicked ( void )

protectedslot

Definition at line 422 of file mythvirtualkeyboard.cpp.

Referenced by updateKeys().

◆ shiftClicked

void MythUIVirtualKeyboard::shiftClicked ( void )

protectedslot

Definition at line 484 of file mythvirtualkeyboard.cpp.

Referenced by updateKeys().

◆ delClicked

void MythUIVirtualKeyboard::delClicked ( void )

protectedslot

Definition at line 501 of file mythvirtualkeyboard.cpp.

Referenced by updateKeys().

◆ lockClicked

void MythUIVirtualKeyboard::lockClicked ( void )

protectedslot

Definition at line 524 of file mythvirtualkeyboard.cpp.

Referenced by updateKeys().

◆ altClicked

void MythUIVirtualKeyboard::altClicked ( void )

protectedslot

Definition at line 537 of file mythvirtualkeyboard.cpp.

Referenced by updateKeys().

◆ compClicked

void MythUIVirtualKeyboard::compClicked ( void )

protectedslot

Definition at line 544 of file mythvirtualkeyboard.cpp.

Referenced by updateKeys().

◆ moveleftClicked

void MythUIVirtualKeyboard::moveleftClicked ( void )

protectedslot

Definition at line 565 of file mythvirtualkeyboard.cpp.

Referenced by updateKeys().

◆ moverightClicked

void MythUIVirtualKeyboard::moverightClicked ( void )

protectedslot

Definition at line 586 of file mythvirtualkeyboard.cpp.

Referenced by updateKeys().

◆ backClicked

void MythUIVirtualKeyboard::backClicked ( void )

protectedslot

Definition at line 513 of file mythvirtualkeyboard.cpp.

Referenced by updateKeys().

◆ returnClicked

void MythUIVirtualKeyboard::returnClicked ( void )

protectedslot

Definition at line 550 of file mythvirtualkeyboard.cpp.

Referenced by updateKeys().

◆ loadKeyDefinitions()

void MythUIVirtualKeyboard::loadKeyDefinitions ( const QString & lang )

private

Definition at line 176 of file mythvirtualkeyboard.cpp.

Referenced by Create().

◆ parseKey()

void MythUIVirtualKeyboard::parseKey ( const QDomElement & element )

private

Definition at line 229 of file mythvirtualkeyboard.cpp.

Referenced by loadKeyDefinitions().

◆ updateKeys()

void MythUIVirtualKeyboard::updateKeys ( bool connectSignals = false )

private

Definition at line 286 of file mythvirtualkeyboard.cpp.

Referenced by altClicked(), charClicked(), Create(), lockClicked(), and shiftClicked().

◆ decodeChar()

QString MythUIVirtualKeyboard::decodeChar ( QString c )

staticprivate

Definition at line 607 of file mythvirtualkeyboard.cpp.

Referenced by parseKey().

◆ getKeyText()

QString MythUIVirtualKeyboard::getKeyText ( const KeyDefinition & key ) const

private

Definition at line 642 of file mythvirtualkeyboard.cpp.

Referenced by charClicked(), and updateKeys().

◆ loadEventKeyDefinitions()

void MythUIVirtualKeyboard::loadEventKeyDefinitions	(	QKeyCombination *	keyDef,
		const QString &	action
	)

staticprivate

Definition at line 658 of file mythvirtualkeyboard.cpp.

Referenced by MythUIVirtualKeyboard().

Member Data Documentation

◆ m_parentEdit

MythUITextEdit* MythUIVirtualKeyboard::m_parentEdit {nullptr}

private

Definition at line 87 of file mythvirtualkeyboard.h.

Referenced by backClicked(), charClicked(), Create(), delClicked(), moveleftClicked(), moverightClicked(), MythUIVirtualKeyboard(), and returnClicked().

◆ m_preferredPos

PopupPosition MythUIVirtualKeyboard::m_preferredPos

private

Definition at line 88 of file mythvirtualkeyboard.h.

Referenced by Create(), and MythUIVirtualKeyboard().

◆ m_keyMap

QMap<QString, KeyDefinition> MythUIVirtualKeyboard::m_keyMap

private

Definition at line 90 of file mythvirtualkeyboard.h.

Referenced by charClicked(), keyPressEvent(), parseKey(), and updateKeys().

◆ m_lockButton

MythUIButton* MythUIVirtualKeyboard::m_lockButton {nullptr}

private

Definition at line 92 of file mythvirtualkeyboard.h.

Referenced by shiftClicked(), and updateKeys().

◆ m_altButton

MythUIButton* MythUIVirtualKeyboard::m_altButton {nullptr}

private

Definition at line 93 of file mythvirtualkeyboard.h.

Referenced by updateKeys().

◆ m_compButton

MythUIButton* MythUIVirtualKeyboard::m_compButton {nullptr}

private

Definition at line 94 of file mythvirtualkeyboard.h.

Referenced by charClicked(), and updateKeys().

◆ m_shiftLButton

MythUIButton* MythUIVirtualKeyboard::m_shiftLButton {nullptr}

private

Definition at line 95 of file mythvirtualkeyboard.h.

Referenced by charClicked(), lockClicked(), shiftClicked(), and updateKeys().

◆ m_shiftRButton

MythUIButton* MythUIVirtualKeyboard::m_shiftRButton {nullptr}

private

Definition at line 96 of file mythvirtualkeyboard.h.

Referenced by charClicked(), lockClicked(), shiftClicked(), and updateKeys().

◆ m_shift

bool MythUIVirtualKeyboard::m_shift {false}

private

Definition at line 98 of file mythvirtualkeyboard.h.

Referenced by charClicked(), getKeyText(), lockClicked(), moveleftClicked(), moverightClicked(), returnClicked(), and shiftClicked().

◆ m_alt

bool MythUIVirtualKeyboard::m_alt {false}

private

Definition at line 99 of file mythvirtualkeyboard.h.

Referenced by altClicked(), and getKeyText().

◆ m_lock

bool MythUIVirtualKeyboard::m_lock {false}

private

Definition at line 100 of file mythvirtualkeyboard.h.

Referenced by charClicked(), lockClicked(), and shiftClicked().

◆ m_composing

bool MythUIVirtualKeyboard::m_composing {false}

private

Definition at line 102 of file mythvirtualkeyboard.h.

Referenced by charClicked(), and compClicked().

◆ m_composeStr

QString MythUIVirtualKeyboard::m_composeStr

private

Definition at line 103 of file mythvirtualkeyboard.h.

Referenced by charClicked(), and compClicked().

◆ m_upKey

QKeyCombination MythUIVirtualKeyboard::m_upKey

private

Definition at line 112 of file mythvirtualkeyboard.h.

Referenced by moveleftClicked(), and MythUIVirtualKeyboard().

◆ m_downKey

QKeyCombination MythUIVirtualKeyboard::m_downKey

private

Definition at line 113 of file mythvirtualkeyboard.h.

Referenced by moverightClicked(), and MythUIVirtualKeyboard().

◆ m_leftKey

QKeyCombination MythUIVirtualKeyboard::m_leftKey

private

Definition at line 114 of file mythvirtualkeyboard.h.

Referenced by moveleftClicked(), and MythUIVirtualKeyboard().

◆ m_rightKey

QKeyCombination MythUIVirtualKeyboard::m_rightKey

private

Definition at line 115 of file mythvirtualkeyboard.h.

Referenced by moverightClicked(), and MythUIVirtualKeyboard().

◆ m_newlineKey

QKeyCombination MythUIVirtualKeyboard::m_newlineKey

private

Definition at line 116 of file mythvirtualkeyboard.h.

Referenced by MythUIVirtualKeyboard(), and returnClicked().

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

mythtv/libs/libmythui/mythvirtualkeyboard.h
mythtv/libs/libmythui/mythvirtualkeyboard.cpp

Signals

Public Member Functions

Protected Slots

Private Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MythUIVirtualKeyboard()

◆ ~MythUIVirtualKeyboard()

Member Function Documentation

◆ Create()

◆ keyPressEvent()

◆ keyPressed

◆ charClicked

◆ shiftClicked

◆ delClicked

◆ lockClicked

◆ altClicked

◆ compClicked

◆ moveleftClicked

◆ moverightClicked

◆ backClicked

◆ returnClicked

◆ loadKeyDefinitions()

◆ parseKey()

◆ updateKeys()

◆ decodeChar()

◆ getKeyText()

◆ loadEventKeyDefinitions()

Member Data Documentation

◆ m_parentEdit

◆ m_preferredPos

◆ m_keyMap

◆ m_lockButton

◆ m_altButton

◆ m_compButton

◆ m_shiftLButton

◆ m_shiftRButton

◆ m_shift

◆ m_alt

◆ m_lock

◆ m_composing

◆ m_composeStr

◆ m_upKey

◆ m_downKey

◆ m_leftKey

◆ m_rightKey

◆ m_newlineKey