Home · API Reference · Modules

MKeyOverride Class Reference
[Maliit server]

MKeyOverride is used to store key attribute overrides for virtual keyboard. More...

List of all members.

Public Types

enum  KeyOverrideAttribute {
  Label = 0x1,
  Icon = 0x2,
  Highlighted = 0x4,
  Enabled = 0x8,
  All = Label | Icon | Highlighted | Enabled
}

Public Slots

void setLabel (const QString &label)
void setIcon (const QString &icon)
void setHighlighted (bool highlighted)
void setEnabled (bool enabled)

Signals

void keyAttributesChanged (const QString &keyId, const MKeyOverride::KeyOverrideAttributes changedAttributes)
void labelChanged (const QString &label)
void iconChanged (const QString &icon)
void highlightedChanged (bool highlighted)
void enabledChanged (bool enabled)

Public Member Functions

 MKeyOverride (const QString &keyId)
 MKeyOverride (const MKeyOverride &)
virtual ~MKeyOverride ()
const MKeyOverrideoperator= (const MKeyOverride &other)
QString keyId () const
QString label () const
QString icon () const
bool highlighted () const
bool enabled () const

Properties

QString label
QString icon
bool highlighted
bool enabled


Detailed Description

MKeyOverride is used to store key attribute overrides for virtual keyboard.

Member Enumeration Documentation

Defines all the attributes of an key override.

Enumerator:
Label 
Icon 
Highlighted 
Enabled 
All 


Constructor & Destructor Documentation

MKeyOverride::MKeyOverride ( const QString &  keyId  )  [explicit]

Constructor.

MKeyOverride::MKeyOverride ( const MKeyOverride other  ) 

Copy constructor.

MKeyOverride::~MKeyOverride (  )  [virtual]

Destructor.


Member Function Documentation

const MKeyOverride & MKeyOverride::operator= ( const MKeyOverride other  ) 

QString MKeyOverride::keyId (  )  const

Returns the key id.

QString MKeyOverride::label (  )  const

Returns text from the key.

QString MKeyOverride::icon (  )  const

Returns icon name.

bool MKeyOverride::highlighted (  )  const

Return true if the key is highlighted; otherwise return false.

bool MKeyOverride::enabled (  )  const

Return true if the key is enabled; otherwise return false.

void MKeyOverride::setLabel ( const QString &  label  )  [slot]

Sets text for the key.

void MKeyOverride::setIcon ( const QString &  icon  )  [slot]

Sets icon name.

void MKeyOverride::setHighlighted ( bool  highlighted  )  [slot]

Set highlighted state for item.

void MKeyOverride::setEnabled ( bool  enabled  )  [slot]

If enabled is true, the key is enabled; otherwise, it is disabled.

void MKeyOverride::keyAttributesChanged ( const QString &  keyId,
const MKeyOverride::KeyOverrideAttributes  changedAttributes 
) [signal]

Emitted when some attributes of the key are changed.

This signal is emitted after attribute specific signal.

Parameters:
keyId,the key id.
changedAttributes Specifies the changed attributes.
See also:
KeyOverrideAttribute

void MKeyOverride::labelChanged ( const QString &  label  )  [signal]

Emitted when label is changed.

This signal is emitted before keyAttributesChanged signal.

void MKeyOverride::iconChanged ( const QString &  icon  )  [signal]

Emitted when icon is changed.

This signal is emitted before keyAttributesChanged signal.

void MKeyOverride::highlightedChanged ( bool  highlighted  )  [signal]

Emitted when highlighted is changed.

This signal is emitted before keyAttributesChanged signal.

void MKeyOverride::enabledChanged ( bool  enabled  )  [signal]

Emitted when enabled is changed.

This signal is emitted before keyAttributesChanged signal.


Property Documentation

QString MKeyOverride::label [read, write]

QString MKeyOverride::icon [read, write]

bool MKeyOverride::highlighted [read, write]

bool MKeyOverride::enabled [read, write]


Copyright © 2011 Nokia Corporation
Maliit