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

#include <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	RequestUpdate (const QRect &)
void	RequestRegionUpdate (const QRect &)
void	TakingFocus ()
void	LosingFocus ()
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 ()
bool	Create (void)
bool	keyPressEvent (QKeyEvent *e)
	Key event handler.
Public Member Functions inherited from MythScreenType
	MythScreenType (MythScreenStack *parent, const QString &name, bool fullscreen=true)
virtual	~MythScreenType ()
virtual bool	gestureEvent (MythGestureEvent *)
	Mouse click/movement handler, receives mouse gesture events from the QCoreApplication event loop.
virtual void	ShowMenu (void)
void	doInit (void)
void	LoadInForeground (void)
bool	IsInitialized (void) const
	Has Init() been called on this screen?
bool	IsFullscreen (void) const
void	SetFullscreen (bool full)
MythUIType *	GetFocusWidget (void) const
bool	SetFocusWidget (MythUIType *widget=NULL)
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)
bool	IsLoaded (void)
void	SetTextFromMap (InfoMap &infoMap)
void	ResetMap (InfoMap &infoMap)
virtual MythPainter *	GetPainter (void)
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.
void	AddChild (MythUIType *child)
	Add a child UIType.
MythUIType *	GetChild (const QString &name) const
	Get a named child of this UIType.
MythUIType *	GetChildAt (const QPoint &p, bool recursive=true, bool focusable=true) const
	Return the first MythUIType which accepts focus found at the given coordinates.
QList< MythUIType * > *	GetAllChildren (void)
	Return a list of all child widgets.
void	DeleteChild (const QString &name)
	Delete a named child of this UIType.
void	DeleteChild (MythUIType *child)
	Delete the given UIType if it is a child of this UIType.
void	DeleteAllChildren (void)
	Delete all child widgets.
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.
void	SetCanTakeFocus (bool set=true)
	Set whether this widget can take focus.
void	SetFocusOrder (int)
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.
void	Draw (MythPainter *p, int xoffset, int yoffset, int alphaMod=255, QRect clipRegion=QRect())
void	SetPosition (int x, int y)
	Convenience method, calls SetPosition(const MythPoint&) Override that instead to change functionality.
virtual void	SetPosition (const MythPoint &pos)
virtual MythPoint	GetPosition (void) const
virtual void	SetSize (const QSize &size)
virtual void	SetMinSize (const MythPoint &size)
	Set the minimum size of this widget, for widgets which can be rescaled.
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.
virtual void	VanishSibling (void)
virtual void	SetMinAreaParent (MythRect actual_area, MythRect full_area, MythUIType *child)
	Adjust the size of sibling objects within the button.
virtual void	SetMinArea (const MythRect &rect)
	Set the minimum area based on the given size.
virtual MythRect	GetArea (void) const
	If the object has a minimum area defined, return it, other wise return the default area.
virtual MythRect	GetFullArea (void) const
virtual void	RecalculateArea (bool recurse=true)
void	ExpandArea (const MythRect &rect)
virtual QRegion	GetDirtyArea (void) const
bool	IsVisible (bool recurse=false) const
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 *)
	Media/Device status event handler, received from MythMediaMonitor.
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
bool	IsDeferredLoading (bool recurse=false) const
void	SetDeferLoad (bool defer)
virtual void	LoadNow (void)
	Cause images in this and child widgets to be loaded.
bool	ContainsPoint (const QPoint &point) const
	Check if the given point falls within this widgets area.
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 (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	decodeChar (QString c)
QString	getKeyText (KeyDefinition key)
void	loadEventKeyDefinitions (KeyEventDefinition *keyDef, const QString &action)

Private Attributes
MythUITextEdit *	m_parentEdit
PopupPosition	m_preferredPos
QMap< QString, KeyDefinition >	m_keyMap
MythUIButton *	m_lockButton
MythUIButton *	m_altButton
MythUIButton *	m_compButton
MythUIButton *	m_shiftLButton
MythUIButton *	m_shiftRButton
bool	m_shift
bool	m_alt
bool	m_lock
bool	m_composing
QString	m_composeStr
KeyEventDefinition	m_upKey
KeyEventDefinition	m_downKey
KeyEventDefinition	m_leftKey
KeyEventDefinition	m_rightKey
KeyEventDefinition	m_newlineKey

Additional Inherited Members
Public Slots inherited from MythScreenType
virtual void	Close ()
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)
virtual void	CopyFrom (MythUIType *base)
	Copy this widgets state from another.
virtual void	CreateCopy (MythUIType *parent)
	Copy the state of this widget to the one given, it must be of the same type.
virtual bool	ParseElement (const QString &filename, QDomElement &element, bool showWarnings)
	Parse the xml definition of this widget setting the state of the object accordingly.
virtual void	Load (void)
	Load data which will ultimately be displayed on-screen or used to determine what appears on-screen (See Warning)
virtual void	Init (void)
	Used after calling Load() to assign data to widgets and other UI initilisation which is prohibited in Load()
void	LoadInBackground (QString message="")
void	ReloadInBackground (void)
void	OpenBusyPopup (QString message="")
void	CloseBusyPopup (void)
void	SetBusyPopupMessage (const QString &message)
void	ResetBusyPopup (void)
Protected Attributes inherited from MythScreenType
bool	m_FullScreen
bool	m_IsDeleting
QSemaphore	m_LoadLock
volatile bool	m_IsLoading
volatile bool	m_IsLoaded
bool	m_IsInitialized
MythUIType *	m_CurrentFocusWidget
QMap< int, MythUIType * >	m_FocusWidgetList
MythScreenStack *	m_ScreenStack
MythUIBusyDialog *	m_BusyPopup
QRegion	m_SavedMask

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 42 of file mythvirtualkeyboard.h.

Constructor & Destructor Documentation

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

Definition at line 78 of file mythvirtualkeyboard.cpp.

MythUIVirtualKeyboard::~MythUIVirtualKeyboard ( void )

Definition at line 107 of file mythvirtualkeyboard.cpp.

Member Function Documentation

bool MythUIVirtualKeyboard::Create ( void )

virtual

Reimplemented from MythScreenType.

Definition at line 111 of file mythvirtualkeyboard.cpp.

Referenced by MythUITextEdit::keyPressEvent().

bool MythUIVirtualKeyboard::keyPressEvent ( QKeyEvent * )

virtual

Key event handler.

Parameters

event Keypress event

Reimplemented from MythScreenType.

Definition at line 361 of file mythvirtualkeyboard.cpp.

void MythUIVirtualKeyboard::keyPressed ( QString key )

signal

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

void MythUIVirtualKeyboard::charClicked ( void )

protectedslot

Definition at line 416 of file mythvirtualkeyboard.cpp.

Referenced by updateKeys().

void MythUIVirtualKeyboard::shiftClicked ( void )

protectedslot

Definition at line 478 of file mythvirtualkeyboard.cpp.

Referenced by updateKeys().

void MythUIVirtualKeyboard::delClicked ( void )

protectedslot

Definition at line 495 of file mythvirtualkeyboard.cpp.

Referenced by updateKeys().

void MythUIVirtualKeyboard::lockClicked ( void )

protectedslot

Definition at line 518 of file mythvirtualkeyboard.cpp.

Referenced by updateKeys().

void MythUIVirtualKeyboard::altClicked ( void )

protectedslot

Definition at line 531 of file mythvirtualkeyboard.cpp.

Referenced by updateKeys().

void MythUIVirtualKeyboard::compClicked ( void )

protectedslot

Definition at line 538 of file mythvirtualkeyboard.cpp.

Referenced by updateKeys().

void MythUIVirtualKeyboard::moveleftClicked ( void )

protectedslot

Definition at line 556 of file mythvirtualkeyboard.cpp.

Referenced by updateKeys().

void MythUIVirtualKeyboard::moverightClicked ( void )

protectedslot

Definition at line 575 of file mythvirtualkeyboard.cpp.

Referenced by updateKeys().

void MythUIVirtualKeyboard::backClicked ( void )

protectedslot

Definition at line 507 of file mythvirtualkeyboard.cpp.

Referenced by updateKeys().

void MythUIVirtualKeyboard::returnClicked ( void )

protectedslot

Definition at line 544 of file mythvirtualkeyboard.cpp.

Referenced by updateKeys().

void MythUIVirtualKeyboard::loadKeyDefinitions ( const QString & lang )

private

Definition at line 194 of file mythvirtualkeyboard.cpp.

Referenced by Create().

void MythUIVirtualKeyboard::parseKey ( const QDomElement & element )

private

Definition at line 247 of file mythvirtualkeyboard.cpp.

Referenced by loadKeyDefinitions().

void MythUIVirtualKeyboard::updateKeys ( bool connectSignals = false )

private

Definition at line 296 of file mythvirtualkeyboard.cpp.

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

QString MythUIVirtualKeyboard::decodeChar ( QString c )

private

Definition at line 594 of file mythvirtualkeyboard.cpp.

Referenced by parseKey().

QString MythUIVirtualKeyboard::getKeyText ( KeyDefinition key )

private

Definition at line 627 of file mythvirtualkeyboard.cpp.

Referenced by charClicked(), and updateKeys().

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

private

Definition at line 644 of file mythvirtualkeyboard.cpp.

Referenced by MythUIVirtualKeyboard().

Member Data Documentation

MythUITextEdit* MythUIVirtualKeyboard::m_parentEdit

private

Definition at line 75 of file mythvirtualkeyboard.h.

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

PopupPosition MythUIVirtualKeyboard::m_preferredPos

private

Definition at line 76 of file mythvirtualkeyboard.h.

Referenced by Create(), and MythUIVirtualKeyboard().

QMap<QString, KeyDefinition> MythUIVirtualKeyboard::m_keyMap

private

Definition at line 78 of file mythvirtualkeyboard.h.

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

MythUIButton* MythUIVirtualKeyboard::m_lockButton

private

Definition at line 80 of file mythvirtualkeyboard.h.

Referenced by MythUIVirtualKeyboard(), shiftClicked(), and updateKeys().

MythUIButton* MythUIVirtualKeyboard::m_altButton

private

Definition at line 81 of file mythvirtualkeyboard.h.

Referenced by MythUIVirtualKeyboard(), and updateKeys().

MythUIButton* MythUIVirtualKeyboard::m_compButton

private

Definition at line 82 of file mythvirtualkeyboard.h.

Referenced by charClicked(), MythUIVirtualKeyboard(), and updateKeys().

MythUIButton* MythUIVirtualKeyboard::m_shiftLButton

private

Definition at line 83 of file mythvirtualkeyboard.h.

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

MythUIButton* MythUIVirtualKeyboard::m_shiftRButton

private

Definition at line 84 of file mythvirtualkeyboard.h.

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

bool MythUIVirtualKeyboard::m_shift

private

Definition at line 86 of file mythvirtualkeyboard.h.

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

bool MythUIVirtualKeyboard::m_alt

private

Definition at line 87 of file mythvirtualkeyboard.h.

Referenced by altClicked(), getKeyText(), and MythUIVirtualKeyboard().

bool MythUIVirtualKeyboard::m_lock

private

Definition at line 88 of file mythvirtualkeyboard.h.

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

bool MythUIVirtualKeyboard::m_composing

private

Definition at line 90 of file mythvirtualkeyboard.h.

Referenced by charClicked(), compClicked(), and MythUIVirtualKeyboard().

QString MythUIVirtualKeyboard::m_composeStr

private

Definition at line 91 of file mythvirtualkeyboard.h.

Referenced by charClicked(), and compClicked().

KeyEventDefinition MythUIVirtualKeyboard::m_upKey

private

Definition at line 93 of file mythvirtualkeyboard.h.

Referenced by moveleftClicked(), and MythUIVirtualKeyboard().

KeyEventDefinition MythUIVirtualKeyboard::m_downKey

private

Definition at line 94 of file mythvirtualkeyboard.h.

Referenced by moverightClicked(), and MythUIVirtualKeyboard().

KeyEventDefinition MythUIVirtualKeyboard::m_leftKey

private

Definition at line 95 of file mythvirtualkeyboard.h.

Referenced by moveleftClicked(), and MythUIVirtualKeyboard().

KeyEventDefinition MythUIVirtualKeyboard::m_rightKey

private

Definition at line 96 of file mythvirtualkeyboard.h.

Referenced by moverightClicked(), and MythUIVirtualKeyboard().

KeyEventDefinition MythUIVirtualKeyboard::m_newlineKey

private

Definition at line 97 of file mythvirtualkeyboard.h.

Referenced by MythUIVirtualKeyboard(), and returnClicked().

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

Signals

Public Member Functions

Protected Slots

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation