<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qinputmethod.cpp -->
<title>QInputMethod Class | Qt GUI 5.9</title>
<link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
<script type="text/javascript">
document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
// loading style sheet breaks anchors that were jumped to before
// so force jumping to anchor again
setTimeout(function() {
var anchor = location.hash;
// need to jump to different anchor first (e.g. none)
location.hash = "#";
setTimeout(function() {
location.hash = anchor;
}, 0);
}, 0);
</script>
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<table><tr>
<td >Qt 5.9</td><td ><a href="qtgui-index.html">Qt GUI</a></td><td ><a href="qtgui-module.html">C++ Classes</a></td><td >QInputMethod</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.9.4 Reference Documentation</td>
</tr></table>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-types">Public Types</a></li>
<li class="level1"><a href="#properties">Properties</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#public-slots">Public Slots</a></li>
<li class="level1"><a href="#signals">Signals</a></li>
<li class="level1"><a href="#static-public-members">Static Public Members</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">QInputMethod Class</h1>
<!-- $$$QInputMethod-brief -->
<p>The <a href="qinputmethod.html">QInputMethod</a> class provides access to the active text input method. <a href="#details">More...</a></p>
<!-- @@@QInputMethod -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QInputMethod></span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += gui</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="../qtcore/qobject.html">QObject</a></td></tr></table></div><ul>
<li><a href="qinputmethod-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h2 id="public-types">Public Types</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qinputmethod.html#Action-enum">Action</a></b> { Click, ContextMenu }</td></tr>
</table></div>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<div class="table"><table class="propsummary">
<tr><td class="topAlign"><ul>
<li class="fn"><b><a href="qinputmethod.html#anchorRectangle-prop">anchorRectangle</a></b> : const QRectF</li>
<li class="fn"><b><a href="qinputmethod.html#animating-prop">animating</a></b> : const bool</li>
<li class="fn"><b><a href="qinputmethod.html#cursorRectangle-prop">cursorRectangle</a></b> : const QRectF</li>
<li class="fn"><b><a href="qinputmethod.html#inputDirection-prop">inputDirection</a></b> : const Qt::LayoutDirection</li>
</ul></td><td class="topAlign"><ul>
<li class="fn"><b><a href="qinputmethod.html#inputItemClipRectangle-prop">inputItemClipRectangle</a></b> : const QRectF</li>
<li class="fn"><b><a href="qinputmethod.html#keyboardRectangle-prop">keyboardRectangle</a></b> : const QRectF</li>
<li class="fn"><b><a href="qinputmethod.html#locale-prop">locale</a></b> : const QLocale</li>
<li class="fn"><b><a href="qinputmethod.html#visible-prop">visible</a></b> : const bool</li>
</ul>
</td></tr>
</table></div>
<ul>
<li class="fn">1 property inherited from <a href="../qtcore/qobject.html#properties">QObject</a></li>
</ul>
<a name="public-functions"></a>
<h2 id="public-functions">Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> QRectF </td><td class="memItemRight bottomAlign"><b><a href="qinputmethod.html#anchorRectangle-prop">anchorRectangle</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QRectF </td><td class="memItemRight bottomAlign"><b><a href="qinputmethod.html#cursorRectangle-prop">cursorRectangle</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Qt::LayoutDirection </td><td class="memItemRight bottomAlign"><b><a href="qinputmethod.html#inputDirection-prop">inputDirection</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QRectF </td><td class="memItemRight bottomAlign"><b><a href="qinputmethod.html#inputItemClipRectangle-prop">inputItemClipRectangle</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QRectF </td><td class="memItemRight bottomAlign"><b><a href="qinputmethod.html#inputItemRectangle">inputItemRectangle</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QTransform </td><td class="memItemRight bottomAlign"><b><a href="qinputmethod.html#inputItemTransform">inputItemTransform</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qinputmethod.html#animating-prop">isAnimating</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qinputmethod.html#visible-prop">isVisible</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QRectF </td><td class="memItemRight bottomAlign"><b><a href="qinputmethod.html#keyboardRectangle-prop">keyboardRectangle</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QLocale </td><td class="memItemRight bottomAlign"><b><a href="qinputmethod.html#locale-prop">locale</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qinputmethod.html#setInputItemRectangle">setInputItemRectangle</a></b>(const QRectF &<i>rect</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qinputmethod.html#setInputItemTransform">setInputItemTransform</a></b>(const QTransform &<i>transform</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qinputmethod.html#setVisible">setVisible</a></b>(bool <i>visible</i>)</td></tr>
</table></div>
<ul>
<li class="fn">32 public functions inherited from <a href="../qtcore/qobject.html#public-functions">QObject</a></li>
</ul>
<a name="public-slots"></a>
<h2 id="public-slots">Public Slots</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qinputmethod.html#commit">commit</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qinputmethod.html#hide">hide</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qinputmethod.html#invokeAction">invokeAction</a></b>(Action <i>a</i>, int <i>cursorPosition</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qinputmethod.html#reset">reset</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qinputmethod.html#show">show</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qinputmethod.html#update">update</a></b>(Qt::InputMethodQueries <i>queries</i>)</td></tr>
</table></div>
<ul>
<li class="fn">1 public slot inherited from <a href="../qtcore/qobject.html#public-slots">QObject</a></li>
</ul>
<a name="signals"></a>
<h2 id="signals">Signals</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qinputmethod.html#anchorRectangle-prop">anchorRectangleChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qinputmethod.html#animating-prop">animatingChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qinputmethod.html#cursorRectangle-prop">cursorRectangleChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qinputmethod.html#inputDirection-prop">inputDirectionChanged</a></b>(Qt::LayoutDirection <i>newDirection</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qinputmethod.html#inputItemClipRectangle-prop">inputItemClipRectangleChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qinputmethod.html#keyboardRectangle-prop">keyboardRectangleChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qinputmethod.html#locale-prop">localeChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qinputmethod.html#visible-prop">visibleChanged</a></b>()</td></tr>
</table></div>
<ul>
<li class="fn">2 signals inherited from <a href="../qtcore/qobject.html#signals">QObject</a></li>
</ul>
<a name="static-public-members"></a>
<h2 id="static-public-members">Static Public Members</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> QVariant </td><td class="memItemRight bottomAlign"><b><a href="qinputmethod.html#queryFocusObject">queryFocusObject</a></b>(Qt::InputMethodQuery <i>query</i>, QVariant <i>argument</i>)</td></tr>
</table></div>
<ul>
<li class="fn">10 static public members inherited from <a href="../qtcore/qobject.html#static-public-members">QObject</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">1 public variable inherited from <a href="../qtcore/qobject.html#public-variables">QObject</a></li>
<li class="fn">9 protected functions inherited from <a href="../qtcore/qobject.html#protected-functions">QObject</a></li>
<li class="fn">2 protected variables inherited from <a href="../qtcore/qobject.html#protected-variables">QObject</a></li>
</ul>
<a name="details"></a>
<!-- $$$QInputMethod-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qinputmethod.html">QInputMethod</a> class provides access to the active text input method.</p>
<p><a href="qinputmethod.html">QInputMethod</a> is used by the text editors for integrating to the platform text input methods and more commonly by application views for querying various text input method-related information like virtual keyboard visibility and keyboard dimensions.</p>
<p>Qt Quick also provides access to <a href="qinputmethod.html">QInputMethod</a> in QML through Qt global object as <code>Qt.inputMethod</code> property.</p>
</div>
<!-- @@@QInputMethod -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$Action$$$Click$$$ContextMenu -->
<h3 class="fn" id="Action-enum"><a name="Action-enum"></a>enum QInputMethod::<span class="name">Action</span></h3>
<p>Indicates the kind of action performed by the user.</p>
<div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><code>QInputMethod::Click</code></td><td class="topAlign tblval"><code>0</code></td><td class="topAlign">A normal click/tap</td></tr>
<tr><td class="topAlign"><code>QInputMethod::ContextMenu</code></td><td class="topAlign tblval"><code>1</code></td><td class="topAlign">A context menu click/tap (e.g. right-button or tap-and-hold)</td></tr>
</table></div>
<p><b>See also </b><a href="qinputmethod.html#invokeAction">invokeAction</a>().</p>
<!-- @@@Action -->
</div>
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$anchorRectangle-prop$$$anchorRectangle$$$anchorRectangleChanged -->
<h3 class="fn" id="anchorRectangle-prop"><a name="anchorRectangle-prop"></a><span class="name">anchorRectangle</span> : const <span class="type"><a href="../qtcore/qrectf.html">QRectF</a></span></h3>
<p>Input item's anchor rectangle in window coordinates.</p>
<p>Anchor rectangle is often used by various text editing controls like text prediction popups for following the text selection.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QRectF </td><td class="memItemRight bottomAlign"><span class="name"><b>anchorRectangle</b></span>() const</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>anchorRectangleChanged</b></span>()</td></tr>
</table></div>
<!-- @@@anchorRectangle -->
<!-- $$$animating-prop$$$isAnimating$$$animatingChanged -->
<h3 class="fn" id="animating-prop"><a name="animating-prop"></a><span class="name">animating</span> : const <span class="type">bool</span></h3>
<p>True when the virtual keyboard is being opened or closed.</p>
<p>Animating is false when keyboard is fully open or closed. When <code>animating</code> is <code>true</code> and <code>visibility</code> is <code>true</code> keyboard is being opened. When <code>animating</code> is <code>true</code> and <code>visibility</code> is false keyboard is being closed.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> bool </td><td class="memItemRight bottomAlign"><span class="name"><b>isAnimating</b></span>() const</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>animatingChanged</b></span>()</td></tr>
</table></div>
<!-- @@@animating -->
<!-- $$$cursorRectangle-prop$$$cursorRectangle$$$cursorRectangleChanged -->
<h3 class="fn" id="cursorRectangle-prop"><a name="cursorRectangle-prop"></a><span class="name">cursorRectangle</span> : const <span class="type"><a href="../qtcore/qrectf.html">QRectF</a></span></h3>
<p>Input item's cursor rectangle in window coordinates.</p>
<p>Cursor rectangle is often used by various text editing controls like text prediction popups for following the text being typed.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QRectF </td><td class="memItemRight bottomAlign"><span class="name"><b>cursorRectangle</b></span>() const</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>cursorRectangleChanged</b></span>()</td></tr>
</table></div>
<!-- @@@cursorRectangle -->
<!-- $$$inputDirection-prop$$$inputDirection$$$inputDirectionChangedQt::LayoutDirection -->
<h3 class="fn" id="inputDirection-prop"><a name="inputDirection-prop"></a><span class="name">inputDirection</span> : const <span class="type"><a href="../qtcore/qt.html#LayoutDirection-enum">Qt::LayoutDirection</a></span></h3>
<p>Current input direction.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> Qt::LayoutDirection </td><td class="memItemRight bottomAlign"><span class="name"><b>inputDirection</b></span>() const</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>inputDirectionChanged</b></span>(Qt::LayoutDirection <i>newDirection</i>)</td></tr>
</table></div>
<!-- @@@inputDirection -->
<!-- $$$inputItemClipRectangle-prop$$$inputItemClipRectangle$$$inputItemClipRectangleChanged -->
<h3 class="fn" id="inputItemClipRectangle-prop"><a name="inputItemClipRectangle-prop"></a><span class="name">inputItemClipRectangle</span> : const <span class="type"><a href="../qtcore/qrectf.html">QRectF</a></span></h3>
<p>Input item's clipped rectangle in window coordinates.</p>
<p>The clipped input rectangle is often used by various input methods to determine how much screen real estate is available for the input method (e.g. Virtual Keyboard).</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QRectF </td><td class="memItemRight bottomAlign"><span class="name"><b>inputItemClipRectangle</b></span>() const</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>inputItemClipRectangleChanged</b></span>()</td></tr>
</table></div>
<!-- @@@inputItemClipRectangle -->
<!-- $$$keyboardRectangle-prop$$$keyboardRectangle$$$keyboardRectangleChanged -->
<h3 class="fn" id="keyboardRectangle-prop"><a name="keyboardRectangle-prop"></a><span class="name">keyboardRectangle</span> : const <span class="type"><a href="../qtcore/qrectf.html">QRectF</a></span></h3>
<p>Virtual keyboard's geometry in window coordinates.</p>
<p>This might be an empty rectangle if it is not possible to know the geometry of the keyboard. This is the case for a floating keyboard on android.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QRectF </td><td class="memItemRight bottomAlign"><span class="name"><b>keyboardRectangle</b></span>() const</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>keyboardRectangleChanged</b></span>()</td></tr>
</table></div>
<!-- @@@keyboardRectangle -->
<!-- $$$locale-prop$$$locale$$$localeChanged -->
<h3 class="fn" id="locale-prop"><a name="locale-prop"></a><span class="name">locale</span> : const <span class="type"><a href="../qtcore/qlocale.html">QLocale</a></span></h3>
<p>Current input locale.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QLocale </td><td class="memItemRight bottomAlign"><span class="name"><b>locale</b></span>() const</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>localeChanged</b></span>()</td></tr>
</table></div>
<!-- @@@locale -->
<!-- $$$visible-prop$$$isVisible$$$visibleChanged -->
<h3 class="fn" id="visible-prop"><a name="visible-prop"></a><span class="name">visible</span> : const <span class="type">bool</span></h3>
<p>Virtual keyboard's visibility on the screen</p>
<p>Input method visibility remains false for devices with no virtual keyboards.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> bool </td><td class="memItemRight bottomAlign"><span class="name"><b>isVisible</b></span>() const</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>visibleChanged</b></span>()</td></tr>
</table></div>
<p><b>See also </b><a href="qinputmethod.html#show">show</a>() and <a href="qinputmethod.html#hide">hide</a>().</p>
<!-- @@@visible -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$commit[overload1]$$$commit -->
<h3 class="fn" id="commit"><a name="commit"></a><code>[slot] </code><span class="type">void</span> QInputMethod::<span class="name">commit</span>()</h3>
<p>Commits the word user is currently composing to the editor. The function is mostly needed by the input methods with text prediction features and by the methods where the script used for typing characters is different from the script that actually gets appended to the editor. Any kind of action that interrupts the text composing needs to flush the composing state by calling the commit() function, for example when the cursor is moved elsewhere.</p>
<!-- @@@commit -->
<!-- $$$hide[overload1]$$$hide -->
<h3 class="fn" id="hide"><a name="hide"></a><code>[slot] </code><span class="type">void</span> QInputMethod::<span class="name">hide</span>()</h3>
<p>Requests virtual keyboard to close.</p>
<p>Normally applications should not need to call this function, keyboard should automatically close when the text editor loses focus, for example when the parent view is closed.</p>
<!-- @@@hide -->
<!-- $$$inputItemRectangle[overload1]$$$inputItemRectangle -->
<h3 class="fn" id="inputItemRectangle"><a name="inputItemRectangle"></a><span class="type"><a href="../qtcore/qrectf.html">QRectF</a></span> QInputMethod::<span class="name">inputItemRectangle</span>() const</h3>
<p>Returns the input item's geometry in input item coordinates.</p>
<p>This function was introduced in Qt 5.1.</p>
<p><b>See also </b><a href="qinputmethod.html#setInputItemRectangle">setInputItemRectangle</a>().</p>
<!-- @@@inputItemRectangle -->
<!-- $$$inputItemTransform[overload1]$$$inputItemTransform -->
<h3 class="fn" id="inputItemTransform"><a name="inputItemTransform"></a><span class="type"><a href="qtransform.html">QTransform</a></span> QInputMethod::<span class="name">inputItemTransform</span>() const</h3>
<p>Returns the transformation from input item coordinates to the window coordinates.</p>
<p><b>See also </b><a href="qinputmethod.html#setInputItemTransform">setInputItemTransform</a>().</p>
<!-- @@@inputItemTransform -->
<!-- $$$invokeAction[overload1]$$$invokeActionActionint -->
<h3 class="fn" id="invokeAction"><a name="invokeAction"></a><code>[slot] </code><span class="type">void</span> QInputMethod::<span class="name">invokeAction</span>(<span class="type"><a href="qinputmethod.html#Action-enum">Action</a></span> <i>a</i>, <span class="type">int</span> <i>cursorPosition</i>)</h3>
<p>Called by the input item when the word currently being composed is tapped by the user, as indicated by the action <i>a</i> and the given <i>cursorPosition</i>. Input methods often use this information to offer more word suggestions to the user.</p>
<!-- @@@invokeAction -->
<!-- $$$queryFocusObject[overload1]$$$queryFocusObjectQt::InputMethodQueryQVariant -->
<h3 class="fn" id="queryFocusObject"><a name="queryFocusObject"></a><code>[static] </code><span class="type"><a href="../qtcore/qvariant.html">QVariant</a></span> QInputMethod::<span class="name">queryFocusObject</span>(<span class="type"><a href="../qtcore/qt.html#InputMethodQuery-enum">Qt::InputMethodQuery</a></span> <i>query</i>, <span class="type"><a href="../qtcore/qvariant.html">QVariant</a></span> <i>argument</i>)</h3>
<p>Send <i>query</i> to the current focus object with parameters <i>argument</i> and return the result.</p>
<!-- @@@queryFocusObject -->
<!-- $$$reset[overload1]$$$reset -->
<h3 class="fn" id="reset"><a name="reset"></a><code>[slot] </code><span class="type">void</span> QInputMethod::<span class="name">reset</span>()</h3>
<p>Resets the input method state. For example, a text editor normally calls this method before inserting a text to make widget ready to accept a text.</p>
<p>Input method resets automatically when the focused editor changes.</p>
<!-- @@@reset -->
<!-- $$$setInputItemRectangle[overload1]$$$setInputItemRectangleconstQRectF& -->
<h3 class="fn" id="setInputItemRectangle"><a name="setInputItemRectangle"></a><span class="type">void</span> QInputMethod::<span class="name">setInputItemRectangle</span>(const <span class="type"><a href="../qtcore/qrectf.html">QRectF</a></span> &<i>rect</i>)</h3>
<p>Sets the input item's geometry to be <i>rect</i>, in input item coordinates. This needs to be updated by the focused window like QQuickCanvas whenever item is moved inside the scene, or focus is changed.</p>
<p>This function was introduced in Qt 5.1.</p>
<p><b>See also </b><a href="qinputmethod.html#inputItemRectangle">inputItemRectangle</a>().</p>
<!-- @@@setInputItemRectangle -->
<!-- $$$setInputItemTransform[overload1]$$$setInputItemTransformconstQTransform& -->
<h3 class="fn" id="setInputItemTransform"><a name="setInputItemTransform"></a><span class="type">void</span> QInputMethod::<span class="name">setInputItemTransform</span>(const <span class="type"><a href="qtransform.html">QTransform</a></span> &<i>transform</i>)</h3>
<p>Sets the transformation from input item coordinates to window coordinates to be <i>transform</i>. Item transform needs to be updated by the focused window like QQuickCanvas whenever item is moved inside the scene.</p>
<p><b>See also </b><a href="qinputmethod.html#inputItemTransform">inputItemTransform</a>().</p>
<!-- @@@setInputItemTransform -->
<!-- $$$setVisible[overload1]$$$setVisiblebool -->
<h3 class="fn" id="setVisible"><a name="setVisible"></a><span class="type">void</span> QInputMethod::<span class="name">setVisible</span>(<span class="type">bool</span> <i>visible</i>)</h3>
<p>Controls the keyboard visibility. Equivalent to calling <a href="qinputmethod.html#show">show</a>() (if <i>visible</i> is <code>true</code>) or <a href="qinputmethod.html#hide">hide</a>() (if <i>visible</i> is <code>false</code>).</p>
<p><b>See also </b><a href="qinputmethod.html#visible-prop">isVisible</a>(), <a href="qinputmethod.html#show">show</a>(), and <a href="qinputmethod.html#hide">hide</a>().</p>
<!-- @@@setVisible -->
<!-- $$$show[overload1]$$$show -->
<h3 class="fn" id="show"><a name="show"></a><code>[slot] </code><span class="type">void</span> QInputMethod::<span class="name">show</span>()</h3>
<p>Requests virtual keyboard to open. If the platform doesn't provide virtual keyboard the visibility remains false.</p>
<p>Normally applications should not need to call this function, keyboard should automatically open when the text editor gains focus.</p>
<!-- @@@show -->
<!-- $$$update[overload1]$$$updateQt::InputMethodQueries -->
<h3 class="fn" id="update"><a name="update"></a><code>[slot] </code><span class="type">void</span> QInputMethod::<span class="name">update</span>(<span class="type"><a href="../qtcore/qt.html#InputMethodQuery-enum">Qt::InputMethodQueries</a></span> <i>queries</i>)</h3>
<p>Called by the input item to inform the platform input methods when there has been state changes in editor's input method query attributes. When calling the function <i>queries</i> parameter has to be used to tell what has changes, which input method can use to make queries for attributes it's interested with <a href="qinputmethodqueryevent.html">QInputMethodQueryEvent</a>.</p>
<p>In particular calling update whenever the cursor position changes is important as that often causes other query attributes like surrounding text and text selection to change as well. The attributes that often change together with cursor position have been grouped in <a href="../qtcore/qt.html#InputMethodQuery-enum">Qt::ImQueryInput</a> value for convenience.</p>
<!-- @@@update -->
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2017 The Qt Company Ltd.
Documentation contributions included herein are the copyrights of
their respective owners.<br> The documentation provided herein is licensed under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License version 1.3</a> as published by the Free Software Foundation.<br> Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
distrib
>
Mageia
>
6
>
armv5tl
>
media
>
core-updates
>
by-pkgid
>
768f7d9f703884aa2562bf0a651086df
>
files
>
1338
