<!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::Plugins::InputMethodPlugin 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="namespace_maliit_1_1_plugins.html">Plugins</a></li><li class="navelem"><a class="el" href="class_maliit_1_1_plugins_1_1_input_method_plugin.html">InputMethodPlugin</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="class_maliit_1_1_plugins_1_1_input_method_plugin-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Maliit::Plugins::InputMethodPlugin Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span><div class="ingroups"><a class="el" href="group__pluginapi.html">Plugin API</a></div></div> </div>
</div><!--header-->
<div class="contents">
<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:adc3b5e8e5bcbba19fffd7c3e832d1136"><td class="memItemLeft" align="right" valign="top">virtual QString </td><td class="memItemRight" valign="bottom"><a class="el" href="class_maliit_1_1_plugins_1_1_input_method_plugin.html#adc3b5e8e5bcbba19fffd7c3e832d1136">name</a> () const =0</td></tr>
<tr class="separator:adc3b5e8e5bcbba19fffd7c3e832d1136"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad6e5d158ac896120f19b3490f8df79df"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_m_abstract_input_method.html">MAbstractInputMethod</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_maliit_1_1_plugins_1_1_input_method_plugin.html#ad6e5d158ac896120f19b3490f8df79df">createInputMethod</a> (<a class="el" href="class_m_abstract_input_method_host.html">MAbstractInputMethodHost</a> *host)=0</td></tr>
<tr class="separator:ad6e5d158ac896120f19b3490f8df79df"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acf2781014e7179affa3a7bdd062f8682"><td class="memItemLeft" align="right" valign="top">virtual QSet< <a class="el" href="namespace_maliit.html#ab6d2ff53033371d0605afb6544745caa">Maliit::HandlerState</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_maliit_1_1_plugins_1_1_input_method_plugin.html#acf2781014e7179affa3a7bdd062f8682">supportedStates</a> () const =0</td></tr>
<tr class="separator:acf2781014e7179affa3a7bdd062f8682"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>An interface class for all input method plugins. </p>
<p>To create a virtual keyboard / input method plugin, re-implement the virtual functions and instantiate the input method implementation in the <a class="el" href="class_maliit_1_1_plugins_1_1_input_method_plugin.html#ad6e5d158ac896120f19b3490f8df79df" title="Creates and returns the MAbstractInputMethod object for this plugin. This function will be only calle...">createInputMethod()</a> method. Make sure your plugin links against the m im framework library as well. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ad6e5d158ac896120f19b3490f8df79df"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad6e5d158ac896120f19b3490f8df79df">§ </a></span>createInputMethod()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="class_m_abstract_input_method.html">MAbstractInputMethod</a>* Maliit::Plugins::InputMethodPlugin::createInputMethod </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_m_abstract_input_method_host.html">MAbstractInputMethodHost</a> * </td>
<td class="paramname"><em>host</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates and returns the <a class="el" href="class_m_abstract_input_method.html" title="A base class for input methods. ">MAbstractInputMethod</a> object for this plugin. This function will be only called once and the allocated resources will be owned by the input method server. </p>
</div>
</div>
<a id="adc3b5e8e5bcbba19fffd7c3e832d1136"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adc3b5e8e5bcbba19fffd7c3e832d1136">§ </a></span>name()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual QString Maliit::Plugins::InputMethodPlugin::name </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implement this function to return the identifier for this input method. </p>
</div>
</div>
<a id="acf2781014e7179affa3a7bdd062f8682"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acf2781014e7179affa3a7bdd062f8682">§ </a></span>supportedStates()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual QSet<<a class="el" href="namespace_maliit.html#ab6d2ff53033371d0605afb6544745caa">Maliit::HandlerState</a>> Maliit::Plugins::InputMethodPlugin::supportedStates </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns set of states which could be handled by this plugin. </p>
<p>WARNING: If result is empty then this plugin will not be loaded during startup. </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>
