<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Maliit::AttributeExtension Class Reference</title>
<link href="meego-im.css" rel="stylesheet" type="text/css">
</head><body>
<table>
<tr>
<td></td>
<td>
<a href="index.html">Home</a>
·
<a href="classes.html">API Reference</a>
·
<a href="modules.html">Modules</a>
</td>
</tr>
</table>
<!-- Generated by Doxygen 1.8.12 -->
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespace_maliit.html">Maliit</a></li><li class="navelem"><a class="el" href="class_maliit_1_1_attribute_extension.html">AttributeExtension</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-slots">Public Slots</a> |
<a href="#signals">Signals</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="class_maliit_1_1_attribute_extension-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Maliit::AttributeExtension Class Reference<div class="ingroups"><a class="el" href="group__libmaliit.html">Libmaliit</a></div></div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for Maliit::AttributeExtension:</div>
<div class="dyncontent">
<div class="center"><img src="class_maliit_1_1_attribute_extension__inherit__graph.png" border="0" usemap="#_maliit_1_1_attribute_extension_inherit__map" alt="Inheritance graph"/></div>
<map name="_maliit_1_1_attribute_extension_inherit__map" id="_maliit_1_1_attribute_extension_inherit__map">
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:ac96940c8adbd2acd42fe4e9d4971c720"><td class="memItemLeft" align="right" valign="top">typedef QMap< QString, QVariant > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_maliit_1_1_attribute_extension.html#ac96940c8adbd2acd42fe4e9d4971c720">ExtendedAttributeMap</a></td></tr>
<tr class="separator:ac96940c8adbd2acd42fe4e9d4971c720"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-slots"></a>
Public Slots</h2></td></tr>
<tr class="memitem:a6b5056ae35799b19cfc50e8ab9897dba"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_maliit_1_1_attribute_extension.html#a6b5056ae35799b19cfc50e8ab9897dba">setAttribute</a> (const QString &<a class="el" href="class_maliit_1_1_attribute_extension.html#adf23ab212e0d2d7e32703b63f4c5358d">key</a>, const QVariant &value)</td></tr>
<tr class="separator:a6b5056ae35799b19cfc50e8ab9897dba"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="signals"></a>
Signals</h2></td></tr>
<tr class="memitem:a347a7b1c9ae6149d22e2e1d0fffeb40d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_maliit_1_1_attribute_extension.html#a347a7b1c9ae6149d22e2e1d0fffeb40d">extendedAttributeChanged</a> (const QString &<a class="el" href="class_maliit_1_1_attribute_extension.html#adf23ab212e0d2d7e32703b63f4c5358d">key</a>, const QVariant &value)</td></tr>
<tr class="separator:a347a7b1c9ae6149d22e2e1d0fffeb40d"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a7f8fd37f290d286eff3c079cd79b93d8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_maliit_1_1_attribute_extension.html#a7f8fd37f290d286eff3c079cd79b93d8">AttributeExtension</a> (const QString &<a class="el" href="class_maliit_1_1_attribute_extension.html#a016824f0d991bacb4775f3c2608f2824">fileName</a>=QString())</td></tr>
<tr class="separator:a7f8fd37f290d286eff3c079cd79b93d8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af83ff132de6a91f9b5085abe936181f9"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_maliit_1_1_attribute_extension.html#af83ff132de6a91f9b5085abe936181f9">AttributeExtension</a> (int <a class="el" href="class_maliit_1_1_attribute_extension.html#aab1550461dcf144b8bd7b80236fbc320">id</a>, bool registerExtension=true)</td></tr>
<tr class="separator:af83ff132de6a91f9b5085abe936181f9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4034c1c53bd5f04a78f1381067d9c788"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_maliit_1_1_attribute_extension.html#a4034c1c53bd5f04a78f1381067d9c788">~AttributeExtension</a> ()</td></tr>
<tr class="separator:a4034c1c53bd5f04a78f1381067d9c788"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5fa85215d63bac3008737066de46e548"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_maliit_1_1_attribute_extension.html#ac96940c8adbd2acd42fe4e9d4971c720">ExtendedAttributeMap</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_maliit_1_1_attribute_extension.html#a5fa85215d63bac3008737066de46e548">attributes</a> () const</td></tr>
<tr class="separator:a5fa85215d63bac3008737066de46e548"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a016824f0d991bacb4775f3c2608f2824"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="class_maliit_1_1_attribute_extension.html#a016824f0d991bacb4775f3c2608f2824">fileName</a> () const</td></tr>
<tr class="separator:a016824f0d991bacb4775f3c2608f2824"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aab1550461dcf144b8bd7b80236fbc320"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_maliit_1_1_attribute_extension.html#aab1550461dcf144b8bd7b80236fbc320">id</a> () const</td></tr>
<tr class="separator:aab1550461dcf144b8bd7b80236fbc320"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2151434675ee982c0a770f1d33fdd32b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_maliit_1_1_attribute_extension.html#a2151434675ee982c0a770f1d33fdd32b">updateAttribute</a> (const QString &<a class="el" href="class_maliit_1_1_attribute_extension.html#adf23ab212e0d2d7e32703b63f4c5358d">key</a>, const QVariant &value)</td></tr>
<tr class="separator:a2151434675ee982c0a770f1d33fdd32b"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a5c48493359b4cbbbbe3ded8fc5e6f935"><td class="memItemLeft" align="right" valign="top">static QSharedPointer< <a class="el" href="class_maliit_1_1_attribute_extension.html">AttributeExtension</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_maliit_1_1_attribute_extension.html#a5c48493359b4cbbbbe3ded8fc5e6f935">create</a> (int <a class="el" href="class_maliit_1_1_attribute_extension.html#aab1550461dcf144b8bd7b80236fbc320">id</a>)</td></tr>
<tr class="separator:a5c48493359b4cbbbbe3ded8fc5e6f935"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adf23ab212e0d2d7e32703b63f4c5358d"><td class="memItemLeft" align="right" valign="top">static QString </td><td class="memItemRight" valign="bottom"><a class="el" href="class_maliit_1_1_attribute_extension.html#adf23ab212e0d2d7e32703b63f4c5358d">key</a> (const QString &target, const QString &targetItem, const QString &attribute)</td></tr>
<tr class="separator:adf23ab212e0d2d7e32703b63f4c5358d"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Register extensions such as key overrides. </p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="ac96940c8adbd2acd42fe4e9d4971c720"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac96940c8adbd2acd42fe4e9d4971c720">§ </a></span>ExtendedAttributeMap</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef QMap<QString, QVariant> <a class="el" href="class_maliit_1_1_attribute_extension.html#ac96940c8adbd2acd42fe4e9d4971c720">Maliit::AttributeExtension::ExtendedAttributeMap</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a7f8fd37f290d286eff3c079cd79b93d8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7f8fd37f290d286eff3c079cd79b93d8">§ </a></span>AttributeExtension() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Maliit::AttributeExtension::AttributeExtension </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>fileName</em> = <code>QString()</code></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Registers an attribute extension (toolbar contents, keyboard overrides) which is defined in <em>fileName</em>, and will be assigned to a text input widget (software input panel). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname"></td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="af83ff132de6a91f9b5085abe936181f9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af83ff132de6a91f9b5085abe936181f9">§ </a></span>AttributeExtension() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Maliit::AttributeExtension::AttributeExtension </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>registerExtension</em> = <code>true</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a4034c1c53bd5f04a78f1381067d9c788"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4034c1c53bd5f04a78f1381067d9c788">§ </a></span>~AttributeExtension()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual Maliit::AttributeExtension::~AttributeExtension </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a5fa85215d63bac3008737066de46e548"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5fa85215d63bac3008737066de46e548">§ </a></span>attributes()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_maliit_1_1_attribute_extension.html#ac96940c8adbd2acd42fe4e9d4971c720">ExtendedAttributeMap</a> Maliit::AttributeExtension::attributes </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a5c48493359b4cbbbbe3ded8fc5e6f935"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5c48493359b4cbbbbe3ded8fc5e6f935">§ </a></span>create()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static QSharedPointer<<a class="el" href="class_maliit_1_1_attribute_extension.html">AttributeExtension</a>> Maliit::AttributeExtension::create </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>id</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a347a7b1c9ae6149d22e2e1d0fffeb40d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a347a7b1c9ae6149d22e2e1d0fffeb40d">§ </a></span>extendedAttributeChanged</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Maliit::AttributeExtension::extendedAttributeChanged </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QVariant & </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">signal</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Informs application that input method server has changed the extended attribute. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>a string specifying the target for the attribute. </td></tr>
<tr><td class="paramname">value</td><td>new value. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a016824f0d991bacb4775f3c2608f2824"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a016824f0d991bacb4775f3c2608f2824">§ </a></span>fileName()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString Maliit::AttributeExtension::fileName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the attribute extension definition file name. </p>
<dl class="section return"><dt>Returns</dt><dd>the file name of the attribute extension, or empty QString. </dd></dl>
</div>
</div>
<a id="aab1550461dcf144b8bd7b80236fbc320"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aab1550461dcf144b8bd7b80236fbc320">§ </a></span>id()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Maliit::AttributeExtension::id </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns an unique identifier id for the attribute extension. </p>
<dl class="section return"><dt>Returns</dt><dd>the unique identifier id. </dd></dl>
</div>
</div>
<a id="adf23ab212e0d2d7e32703b63f4c5358d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adf23ab212e0d2d7e32703b63f4c5358d">§ </a></span>key()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static QString Maliit::AttributeExtension::key </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>target</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>targetItem</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>attribute</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return key corresponding to given parameters. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">target</td><td>Attribute extension. </td></tr>
<tr><td class="paramname">targetItem</td><td>Item name. </td></tr>
<tr><td class="paramname">attribute</td><td>Attribute name.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="class_maliit_1_1_attribute_extension.html#a6b5056ae35799b19cfc50e8ab9897dba" title="Set the attribute of the targetItem in the input method registered attribute extension target to valu...">setAttribute()</a> </dd></dl>
</div>
</div>
<a id="a6b5056ae35799b19cfc50e8ab9897dba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6b5056ae35799b19cfc50e8ab9897dba">§ </a></span>setAttribute</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Maliit::AttributeExtension::setAttribute </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QVariant & </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">slot</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the <em>attribute</em> of the <em>targetItem</em> in the input method registered attribute extension <em>target</em> to <em>value</em>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>a string specifying the target for the attribute. </td></tr>
<tr><td class="paramname">value</td><td>new value.</td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>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. </dd></dl>
</div>
</div>
<a id="a2151434675ee982c0a770f1d33fdd32b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2151434675ee982c0a770f1d33fdd32b">§ </a></span>updateAttribute()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Maliit::AttributeExtension::updateAttribute </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QVariant & </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Update cached <em>value</em> of extended attribute corresponding to given <em>key</em>. </p>
</div>
</div>
</div><!-- contents -->
<hr>
<table width="100%" cellspacing="0" border="0"><tr class="address">
<td width="30%" align="left">Copyright © 2011 Nokia Corporation</td>
<td width="40%" align="center" class="generator"><!-- Generated on Thu Nov 17 2016 17:45:20<br>Doxygen 1.8.12 --></td>
<td width="30%" align="right"><div align="right">Maliit</div></td>
</tr></table>
</body>
</html>
