Maliit::AttributeExtension Class Reference

Inheritance diagram for Maliit::AttributeExtension:

Public Types
typedef QMap< QString, QVariant >	ExtendedAttributeMap

Public Slots
void	setAttribute (const QString &key, const QVariant &value)

Signals
void	extendedAttributeChanged (const QString &key, const QVariant &value)

Public Member Functions
	AttributeExtension (const QString &fileName=QString())
	AttributeExtension (int id, bool registerExtension=true)
virtual	~AttributeExtension ()
ExtendedAttributeMap	attributes () const
QString	fileName () const
int	id () const
void	updateAttribute (const QString &key, const QVariant &value)

Static Public Member Functions
static QSharedPointer< AttributeExtension >	create (int id)
static QString	key (const QString &target, const QString &targetItem, const QString &attribute)

Detailed Description

Register extensions such as key overrides.

Member Typedef Documentation

ExtendedAttributeMap

typedef QMap<QString, QVariant> Maliit::AttributeExtension::ExtendedAttributeMap

Constructor & Destructor Documentation

AttributeExtension() [1/2]

Maliit::AttributeExtension::AttributeExtension ( const QString &  fileName = QString() )

explicit

Registers an attribute extension (toolbar contents, keyboard overrides) which is defined in fileName, and will be assigned to a text input widget (software input panel).

Parameters

AttributeExtension() [2/2]

Maliit::AttributeExtension::AttributeExtension ( int  id, bool  registerExtension = true  )

explicit

~AttributeExtension()

virtual Maliit::AttributeExtension::~AttributeExtension ( )

virtual

Member Function Documentation

attributes()

ExtendedAttributeMap Maliit::AttributeExtension::attributes

(

)

const

create()

static QSharedPointer<AttributeExtension> Maliit::AttributeExtension::create ( int  id )

static

extendedAttributeChanged

void Maliit::AttributeExtension::extendedAttributeChanged ( const QString &  key, const QVariant &  value  )

signal

Informs application that input method server has changed the extended attribute.

Parameters

key	a string specifying the target for the attribute.
value	new value.

fileName()

QString Maliit::AttributeExtension::fileName

(

)

const

Returns the attribute extension definition file name.

Returns

the file name of the attribute extension, or empty QString.

id()

int Maliit::AttributeExtension::id

(

)

const

Returns an unique identifier id for the attribute extension.

Returns

the unique identifier id.

key()

static QString Maliit::AttributeExtension::key ( const QString &  target, const QString &  targetItem, const QString &  attribute  )

static

Return key corresponding to given parameters.

Parameters

target	Attribute extension.
targetItem	Item name.
attribute	Attribute name.

See also

setAttribute()

setAttribute

void Maliit::AttributeExtension::setAttribute ( const QString &  key, const QVariant &  value  )

slot

Set the attribute of the targetItem in the input method registered attribute extension target to value.

Parameters

key	a string specifying the target for the attribute.
value	new value.

Note

Every key begins with a slash character ('/') and is of the form /target/item/attribute Target "keys" is used for virtual keyboard keys, "toolbar" for toolbar contents. Additional targets can be added in the future.

updateAttribute()

void Maliit::AttributeExtension::updateAttribute	(	const QString &	key,
		const QVariant &	value
	)

Update cached value of extended attribute corresponding to given key.