Home · API Reference · Modules

Maliit::AttributeExtension Class Reference
[Libmaliit]

Register extensions such as key overrides. More...

List of all members.

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())
virtual ~AttributeExtension ()
ExtendedAttributeMap attributes () const
QString fileName () const
int id () const
void updateAttribute (const QString &key, const QVariant &value)

Static Public Member Functions

static QString key (const QString &target, const QString &targetItem, const QString &attribute)


Detailed Description

Register extensions such as key overrides.

Member Typedef Documentation

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


Constructor & Destructor Documentation

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:
\a fileName is the file name of the attribute extension. The filename should be absolute. If the filename is relative, it will be looked up in the default directory provided by the framework.
Note:
if fileName is an empty string, then it means don't load any content, just get a new id.
Returns:
the registered unique identifier of this attribute extension.

Maliit::AttributeExtension::~AttributeExtension (  )  [virtual]


Member Function Documentation

AttributeExtension::ExtendedAttributeMap Maliit::AttributeExtension::attributes (  )  const

QString Maliit::AttributeExtension::fileName (  )  const

Returns the attribute extension definition file name.

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

int Maliit::AttributeExtension::id (  )  const

Returns an unique identifier id for the attribute extension.

Returns:
the unique identifier id.

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()

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

Update cached value of extended attribute corresponding to given key.

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.

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.


Copyright © 2011 Nokia Corporation
Maliit