Sophie

Sophie

distrib > Mageia > 6 > x86_64 > by-pkgid > 279e1392635986df1af89cdbd290e105 > files > 308

maliit-framework-docs-0.94.2-11.mga6.noarch.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Plugin API</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><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Plugin API</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_abstract_input_method.html">MAbstractInputMethod</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_im_abstract_plugin_factory.html">MImAbstractPluginFactory</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_maliit_1_1_plugins_1_1_abstract_surface.html">Maliit::Plugins::AbstractSurface</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_maliit_1_1_plugins_1_1_abstract_surface_factory.html">Maliit::Plugins::AbstractSurfaceFactory</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_attribute_extension.html">MAttributeExtension</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_im_extension_event.html">MImExtensionEvent</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_maliit_1_1_plugins_1_1_input_method_plugin.html">Maliit::Plugins::InputMethodPlugin</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_im_update_event.html">MImUpdateEvent</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_im_update_receiver.html">MImUpdateReceiver</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gaaebbae9d8bce98fa8921d8616c995a61"><td class="memItemLeft" align="right" valign="top">QSharedPointer&lt; <a class="el" href="class_maliit_1_1_plugins_1_1_abstract_surface.html">AbstractSurface</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pluginapi.html#gaaebbae9d8bce98fa8921d8616c995a61">Maliit::Plugins::createTestSurface</a> (AbstractSurface::Options options, const QSharedPointer&lt; <a class="el" href="class_maliit_1_1_plugins_1_1_abstract_surface.html">AbstractSurface</a> &gt; &amp;parent)</td></tr>
<tr class="separator:gaaebbae9d8bce98fa8921d8616c995a61"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae9948ad500475c5b0f51a6a47ee9527f"><td class="memItemLeft" align="right" valign="top">QSharedPointer&lt; <a class="el" href="class_maliit_1_1_plugins_1_1_abstract_graphics_view_surface.html">AbstractGraphicsViewSurface</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pluginapi.html#gae9948ad500475c5b0f51a6a47ee9527f">Maliit::Plugins::createTestGraphicsViewSurface</a> (const QSharedPointer&lt; <a class="el" href="class_maliit_1_1_plugins_1_1_abstract_surface.html">AbstractSurface</a> &gt; &amp;parent)</td></tr>
<tr class="separator:gae9948ad500475c5b0f51a6a47ee9527f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga54266f571e04bdc641a430405c4ad109"><td class="memItemLeft" align="right" valign="top">QSharedPointer&lt; <a class="el" href="class_maliit_1_1_plugins_1_1_abstract_widget_surface.html">AbstractWidgetSurface</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pluginapi.html#ga54266f571e04bdc641a430405c4ad109">Maliit::Plugins::createTestWidgetSurface</a> (const QSharedPointer&lt; <a class="el" href="class_maliit_1_1_plugins_1_1_abstract_surface.html">AbstractSurface</a> &gt; &amp;parent)</td></tr>
<tr class="separator:ga54266f571e04bdc641a430405c4ad109"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Input method plugin API. </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="gae9948ad500475c5b0f51a6a47ee9527f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae9948ad500475c5b0f51a6a47ee9527f">&sect;&nbsp;</a></span>createTestGraphicsViewSurface()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">QSharedPointer&lt; <a class="el" href="class_maliit_1_1_plugins_1_1_abstract_graphics_view_surface.html">AbstractGraphicsViewSurface</a> &gt; Maliit::Plugins::createTestGraphicsViewSurface </td>
          <td>(</td>
          <td class="paramtype">const QSharedPointer&lt; <a class="el" href="class_maliit_1_1_plugins_1_1_abstract_surface.html">AbstractSurface</a> &gt; &amp;&#160;</td>
          <td class="paramname"><em>parent</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Allows to create a graphics view surface without a running maliit-server instance. </p>
<p>Useful for tests.</p>
<dl class="section note"><dt>Note</dt><dd><a class="el" href="namespace_maliit_1_1_plugins.html">Plugins</a> must not use this, but should instead use the <a class="el" href="class_maliit_1_1_plugins_1_1_abstract_surface_factory.html" title="The AbstractSurfaceFactory class is used to create AbstractSurface instances. ">Maliit::Plugins::AbstractSurfaceFactory</a> returned by <a class="el" href="class_m_abstract_input_method_host.html#aa964b6ec03cc9f57eb473fbe3d8b0fde">MAbstractInputMethodHost::surfaceFactory()</a>.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">parent</td><td>the parent of the new surface </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a new shared <a class="el" href="class_maliit_1_1_plugins_1_1_abstract_graphics_view_surface.html" title="The AbstractGraphicsViewSurface class provides an AbstractSurface backed by a QGraphicsView. ">Maliit::Plugins::AbstractGraphicsViewSurface</a> </dd></dl>

</div>
</div>
<a id="gaaebbae9d8bce98fa8921d8616c995a61"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaaebbae9d8bce98fa8921d8616c995a61">&sect;&nbsp;</a></span>createTestSurface()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">QSharedPointer&lt; <a class="el" href="class_maliit_1_1_plugins_1_1_abstract_surface.html">AbstractSurface</a> &gt; Maliit::Plugins::createTestSurface </td>
          <td>(</td>
          <td class="paramtype">AbstractSurface::Options&#160;</td>
          <td class="paramname"><em>options</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const QSharedPointer&lt; <a class="el" href="class_maliit_1_1_plugins_1_1_abstract_surface.html">AbstractSurface</a> &gt; &amp;&#160;</td>
          <td class="paramname"><em>parent</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Allows to create a surface without a running maliit-server instance. </p>
<p>Useful for tests.</p>
<dl class="section note"><dt>Note</dt><dd><a class="el" href="namespace_maliit_1_1_plugins.html">Plugins</a> must not use this, but should instead use the <a class="el" href="class_maliit_1_1_plugins_1_1_abstract_surface_factory.html" title="The AbstractSurfaceFactory class is used to create AbstractSurface instances. ">Maliit::Plugins::AbstractSurfaceFactory</a> returned by <a class="el" href="class_m_abstract_input_method_host.html#aa964b6ec03cc9f57eb473fbe3d8b0fde">MAbstractInputMethodHost::surfaceFactory()</a>.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">options</td><td>the options the surface should have </td></tr>
    <tr><td class="paramname">parent</td><td>the parent of the new surface </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a new shared <a class="el" href="class_maliit_1_1_plugins_1_1_abstract_surface.html" title="The AbstractSurface class provides a window abstraction for rendering the plugin. ...">Maliit::Plugins::AbstractSurface</a> </dd></dl>

</div>
</div>
<a id="ga54266f571e04bdc641a430405c4ad109"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga54266f571e04bdc641a430405c4ad109">&sect;&nbsp;</a></span>createTestWidgetSurface()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">QSharedPointer&lt; <a class="el" href="class_maliit_1_1_plugins_1_1_abstract_widget_surface.html">AbstractWidgetSurface</a> &gt; Maliit::Plugins::createTestWidgetSurface </td>
          <td>(</td>
          <td class="paramtype">const QSharedPointer&lt; <a class="el" href="class_maliit_1_1_plugins_1_1_abstract_surface.html">AbstractSurface</a> &gt; &amp;&#160;</td>
          <td class="paramname"><em>parent</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Allows to create a widget surface without a running maliit-server instance. </p>
<p>Useful for tests.</p>
<dl class="section note"><dt>Note</dt><dd><a class="el" href="namespace_maliit_1_1_plugins.html">Plugins</a> must not use this, but should instead use the <a class="el" href="class_maliit_1_1_plugins_1_1_abstract_surface_factory.html" title="The AbstractSurfaceFactory class is used to create AbstractSurface instances. ">Maliit::Plugins::AbstractSurfaceFactory</a> returned by <a class="el" href="class_m_abstract_input_method_host.html#aa964b6ec03cc9f57eb473fbe3d8b0fde">MAbstractInputMethodHost::surfaceFactory()</a>.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">parent</td><td>the parent of the new surface </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a new shared <a class="el" href="class_maliit_1_1_plugins_1_1_abstract_widget_surface.html" title="The AbstractWidgetSurface class provides an AbstractSurface backed by a QWidget. ">Maliit::Plugins::AbstractWidgetSurface</a> </dd></dl>

</div>
</div>
</div><!-- contents -->
<hr>
<table width="100%" cellspacing="0" border="0"><tr class="address">
<td width="30%" align="left">Copyright &copy; 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>