<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- qwebenginecontextmenudata.cpp --> <title>QWebEngineContextMenuData Class | Qt WebEngine 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="qtwebengine-index.html">Qt WebEngine</a></td><td ><a href="qtwebengine-modules.html">C++ Classes</a></td><td >QWebEngineContextMenuData</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="#public-functions">Public Functions</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">QWebEngineContextMenuData Class</h1> <!-- $$$QWebEngineContextMenuData-brief --> <p>The <a href="qwebenginecontextmenudata.html">QWebEngineContextMenuData</a> class provides context data for populating or extending a context menu with actions. <a href="#details">More...</a></p> <!-- @@@QWebEngineContextMenuData --> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QWebEngineContextMenuData></span> </td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += webenginewidgets</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.7</td></tr></table></div><ul> <li><a href="qwebenginecontextmenudata-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="qwebenginecontextmenudata.html#MediaType-enum">MediaType</a></b> { MediaTypeNone, MediaTypeImage, MediaTypeVideo, MediaTypeAudio, ..., MediaTypePlugin }</td></tr> </table></div> <a name="public-functions"></a> <h2 id="public-functions">Public Functions</h2> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qwebenginecontextmenudata.html#QWebEngineContextMenuData">QWebEngineContextMenuData</a></b>()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qwebenginecontextmenudata.html#QWebEngineContextMenuData-1">QWebEngineContextMenuData</a></b>(const QWebEngineContextMenuData &<i>other</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qwebenginecontextmenudata.html#dtor.QWebEngineContextMenuData">~QWebEngineContextMenuData</a></b>()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qwebenginecontextmenudata.html#isContentEditable">isContentEditable</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qwebenginecontextmenudata.html#isValid">isValid</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qwebenginecontextmenudata.html#linkText">linkText</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QUrl </td><td class="memItemRight bottomAlign"><b><a href="qwebenginecontextmenudata.html#linkUrl">linkUrl</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> MediaType </td><td class="memItemRight bottomAlign"><b><a href="qwebenginecontextmenudata.html#mediaType">mediaType</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QUrl </td><td class="memItemRight bottomAlign"><b><a href="qwebenginecontextmenudata.html#mediaUrl">mediaUrl</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qwebenginecontextmenudata.html#misspelledWord">misspelledWord</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QPoint </td><td class="memItemRight bottomAlign"><b><a href="qwebenginecontextmenudata.html#position">position</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qwebenginecontextmenudata.html#selectedText">selectedText</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QStringList </td><td class="memItemRight bottomAlign"><b><a href="qwebenginecontextmenudata.html#spellCheckerSuggestions">spellCheckerSuggestions</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QWebEngineContextMenuData &</td><td class="memItemRight bottomAlign"><b><a href="qwebenginecontextmenudata.html#operator-eq">operator=</a></b>(const QWebEngineContextMenuData &<i>other</i>)</td></tr> </table></div> <a name="details"></a> <!-- $$$QWebEngineContextMenuData-description --> <div class="descr"> <h2 id="details">Detailed Description</h2> <p>The <a href="qwebenginecontextmenudata.html">QWebEngineContextMenuData</a> class provides context data for populating or extending a context menu with actions.</p> <p><a href="qwebenginecontextmenudata.html">QWebEngineContextMenuData</a> is returned by <a href="qwebenginepage.html#contextMenuData">QWebEnginePage::contextMenuData</a>() after a context menu event, and contains information about where the context menu event took place. This is also in the context in which any context specific <a href="qwebenginepage.html#WebAction-enum">QWebEnginePage::WebAction</a> will be performed.</p> </div> <!-- @@@QWebEngineContextMenuData --> <div class="types"> <h2>Member Type Documentation</h2> <!-- $$$MediaType$$$MediaTypeNone$$$MediaTypeImage$$$MediaTypeVideo$$$MediaTypeAudio$$$MediaTypeCanvas$$$MediaTypeFile$$$MediaTypePlugin --> <h3 class="fn" id="MediaType-enum"><a name="MediaType-enum"></a>enum QWebEngineContextMenuData::<span class="name">MediaType</span></h3> <p>This enum describes the media type of the context if any.</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>QWebEngineContextMenuData::MediaTypeNone</code></td><td class="topAlign tblval"><code>0</code></td><td class="topAlign">The context is not a media type.</td></tr> <tr><td class="topAlign"><code>QWebEngineContextMenuData::MediaTypeImage</code></td><td class="topAlign tblval"><code>1</code></td><td class="topAlign">The context is an image element.</td></tr> <tr><td class="topAlign"><code>QWebEngineContextMenuData::MediaTypeVideo</code></td><td class="topAlign tblval"><code>2</code></td><td class="topAlign">The context is a video element.</td></tr> <tr><td class="topAlign"><code>QWebEngineContextMenuData::MediaTypeAudio</code></td><td class="topAlign tblval"><code>3</code></td><td class="topAlign">The context is an audio element.</td></tr> <tr><td class="topAlign"><code>QWebEngineContextMenuData::MediaTypeCanvas</code></td><td class="topAlign tblval"><code>4</code></td><td class="topAlign">The context is a canvas element.</td></tr> <tr><td class="topAlign"><code>QWebEngineContextMenuData::MediaTypeFile</code></td><td class="topAlign tblval"><code>5</code></td><td class="topAlign">The context is a file.</td></tr> <tr><td class="topAlign"><code>QWebEngineContextMenuData::MediaTypePlugin</code></td><td class="topAlign tblval"><code>6</code></td><td class="topAlign">The context is a plugin element.</td></tr> </table></div> <!-- @@@MediaType --> </div> <div class="func"> <h2>Member Function Documentation</h2> <!-- $$$QWebEngineContextMenuData[overload1]$$$QWebEngineContextMenuData --> <h3 class="fn" id="QWebEngineContextMenuData"><a name="QWebEngineContextMenuData"></a>QWebEngineContextMenuData::<span class="name">QWebEngineContextMenuData</span>()</h3> <p>Constructs null context menu data.</p> <!-- @@@QWebEngineContextMenuData --> <!-- $$$QWebEngineContextMenuData$$$QWebEngineContextMenuDataconstQWebEngineContextMenuData& --> <h3 class="fn" id="QWebEngineContextMenuData-1"><a name="QWebEngineContextMenuData-1"></a>QWebEngineContextMenuData::<span class="name">QWebEngineContextMenuData</span>(const <span class="type"><a href="qwebenginecontextmenudata.html#QWebEngineContextMenuData">QWebEngineContextMenuData</a></span> &<i>other</i>)</h3> <p>Constructs context menu data from <i>other</i>.</p> <!-- @@@QWebEngineContextMenuData --> <!-- $$$~QWebEngineContextMenuData[overload1]$$$~QWebEngineContextMenuData --> <h3 class="fn" id="dtor.QWebEngineContextMenuData"><a name="dtor.QWebEngineContextMenuData"></a>QWebEngineContextMenuData::<span class="name">~QWebEngineContextMenuData</span>()</h3> <p>Destroys the context menu data.</p> <!-- @@@~QWebEngineContextMenuData --> <!-- $$$isContentEditable[overload1]$$$isContentEditable --> <h3 class="fn" id="isContentEditable"><a name="isContentEditable"></a><span class="type">bool</span> QWebEngineContextMenuData::<span class="name">isContentEditable</span>() const</h3> <p>Returns <code>true</code> if the content is editable by the user; otherwise returns <code>false</code>.</p> <!-- @@@isContentEditable --> <!-- $$$isValid[overload1]$$$isValid --> <h3 class="fn" id="isValid"><a name="isValid"></a><span class="type">bool</span> QWebEngineContextMenuData::<span class="name">isValid</span>() const</h3> <p>Returns <code>true</code> if the context data is valid; otherwise returns <code>false</code>.</p> <!-- @@@isValid --> <!-- $$$linkText[overload1]$$$linkText --> <h3 class="fn" id="linkText"><a name="linkText"></a><span class="type">QString</span> QWebEngineContextMenuData::<span class="name">linkText</span>() const</h3> <p>Returns the text of a link if the context is a link.</p> <!-- @@@linkText --> <!-- $$$linkUrl[overload1]$$$linkUrl --> <h3 class="fn" id="linkUrl"><a name="linkUrl"></a><span class="type">QUrl</span> QWebEngineContextMenuData::<span class="name">linkUrl</span>() const</h3> <p>Returns the URL of a link if the context is a link.</p> <!-- @@@linkUrl --> <!-- $$$mediaType[overload1]$$$mediaType --> <h3 class="fn" id="mediaType"><a name="mediaType"></a><span class="type"><a href="qwebenginecontextmenudata.html#MediaType-enum">MediaType</a></span> QWebEngineContextMenuData::<span class="name">mediaType</span>() const</h3> <p>Returns the type of the media element or <code>MediaTypeNone</code> if the context is not a media element.</p> <!-- @@@mediaType --> <!-- $$$mediaUrl[overload1]$$$mediaUrl --> <h3 class="fn" id="mediaUrl"><a name="mediaUrl"></a><span class="type">QUrl</span> QWebEngineContextMenuData::<span class="name">mediaUrl</span>() const</h3> <p>If the context is a media element, returns the URL of that media.</p> <!-- @@@mediaUrl --> <!-- $$$misspelledWord[overload1]$$$misspelledWord --> <h3 class="fn" id="misspelledWord"><a name="misspelledWord"></a><span class="type">QString</span> QWebEngineContextMenuData::<span class="name">misspelledWord</span>() const</h3> <p>If the context is a word considered misspelled by the spell-checker, returns the misspelled word.</p> <p>For possible replacements of the word, see <a href="qwebenginecontextmenudata.html#spellCheckerSuggestions">spellCheckerSuggestions</a>().</p> <p>This function was introduced in Qt 5.8.</p> <!-- @@@misspelledWord --> <!-- $$$position[overload1]$$$position --> <h3 class="fn" id="position"><a name="position"></a><span class="type">QPoint</span> QWebEngineContextMenuData::<span class="name">position</span>() const</h3> <p>Returns the position of the context, usually the mouse position where the context menu event was triggered.</p> <!-- @@@position --> <!-- $$$selectedText[overload1]$$$selectedText --> <h3 class="fn" id="selectedText"><a name="selectedText"></a><span class="type">QString</span> QWebEngineContextMenuData::<span class="name">selectedText</span>() const</h3> <p>Returns the selected text of the context.</p> <!-- @@@selectedText --> <!-- $$$spellCheckerSuggestions[overload1]$$$spellCheckerSuggestions --> <h3 class="fn" id="spellCheckerSuggestions"><a name="spellCheckerSuggestions"></a><span class="type">QStringList</span> QWebEngineContextMenuData::<span class="name">spellCheckerSuggestions</span>() const</h3> <p>If the context is a word considered misspelled by the spell-checker, returns a list of suggested replacements for <a href="qwebenginecontextmenudata.html#misspelledWord">misspelledWord</a>().</p> <p>This function was introduced in Qt 5.8.</p> <!-- @@@spellCheckerSuggestions --> <!-- $$$operator=[overload1]$$$operator=constQWebEngineContextMenuData& --> <h3 class="fn" id="operator-eq"><a name="operator-eq"></a><span class="type"><a href="qwebenginecontextmenudata.html#QWebEngineContextMenuData">QWebEngineContextMenuData</a></span> &QWebEngineContextMenuData::<span class="name">operator=</span>(const <span class="type"><a href="qwebenginecontextmenudata.html#QWebEngineContextMenuData">QWebEngineContextMenuData</a></span> &<i>other</i>)</h3> <p>Assigns the <i>other</i> context menu data to this.</p> <!-- @@@operator= --> </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>