Sophie

Sophie

distrib > Mageia > 6 > x86_64 > media > core-updates > by-pkgid > 09bb53e5648f357bb3d35769c00e1902 > files > 451

qtwebengine5-doc-5.9.4-1.mga6.noarch.rpm

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qwebenginecookiestore.cpp -->
  <title>QWebEngineCookieStore 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 >QWebEngineCookieStore</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-functions">Public Functions</a></li>
<li class="level1"><a href="#signals">Signals</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">QWebEngineCookieStore Class</h1>
<!-- $$$QWebEngineCookieStore-brief -->
<p>The <a href="qwebenginecookiestore.html">QWebEngineCookieStore</a> class provides access to Chromium's cookies. <a href="#details">More...</a></p>
<!-- @@@QWebEngineCookieStore -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign">   <span class="preprocessor">#include &lt;QWebEngineCookieStore&gt;</span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign">  Qt 5.6</td></tr></table></div><ul>
<li><a href="qwebenginecookiestore-members.html">List of all members, including inherited members</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"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qwebenginecookiestore.html#dtor.QWebEngineCookieStore">~QWebEngineCookieStore</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwebenginecookiestore.html#deleteAllCookies">deleteAllCookies</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwebenginecookiestore.html#deleteCookie">deleteCookie</a></b>(const QNetworkCookie &amp;<i>cookie</i>, const QUrl &amp;<i>origin</i> = QUrl())</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwebenginecookiestore.html#deleteSessionCookies">deleteSessionCookies</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwebenginecookiestore.html#loadAllCookies">loadAllCookies</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwebenginecookiestore.html#setCookie">setCookie</a></b>(const QNetworkCookie &amp;<i>cookie</i>, const QUrl &amp;<i>origin</i> = QUrl())</td></tr>
</table></div>
<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="qwebenginecookiestore.html#cookieAdded">cookieAdded</a></b>(const QNetworkCookie &amp;<i>cookie</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwebenginecookiestore.html#cookieRemoved">cookieRemoved</a></b>(const QNetworkCookie &amp;<i>cookie</i>)</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$QWebEngineCookieStore-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qwebenginecookiestore.html">QWebEngineCookieStore</a> class provides access to Chromium's cookies.</p>
<p>The class allows to access HTTP cookies of Chromium for a specific profile. It can be used to synchronize cookies of Chromium and the QNetworkAccessManager, as well as to set, delete, and intercept cookies during navigation. Because cookie operations are asynchronous, the user can choose to provide a callback function to get notified about the success of the operation. The signal handlers for removal and addition should not be used to execute heavy tasks, because they might block the IO thread in case of a blocking connection.</p>
<p>Use <a href="qwebengineprofile.html#cookieStore">QWebEngineProfile::cookieStore</a>() and <a href="qquickwebengineprofile.html#cookieStore">QQuickWebEngineProfile::cookieStore</a>() to access the cookie store object for a specific profile.</p>
</div>
<!-- @@@QWebEngineCookieStore -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$~QWebEngineCookieStore[overload1]$$$~QWebEngineCookieStore -->
<h3 class="fn" id="dtor.QWebEngineCookieStore"><a name="dtor.QWebEngineCookieStore"></a><code>[virtual] </code>QWebEngineCookieStore::<span class="name">~QWebEngineCookieStore</span>()</h3>
<p>Destroys this <a href="qwebenginecookiestore.html">QWebEngineCookieStore</a> object.</p>
<!-- @@@~QWebEngineCookieStore -->
<!-- $$$cookieAdded[overload1]$$$cookieAddedconstQNetworkCookie& -->
<h3 class="fn" id="cookieAdded"><a name="cookieAdded"></a><code>[signal] </code><span class="type">void</span> QWebEngineCookieStore::<span class="name">cookieAdded</span>(const <span class="type">QNetworkCookie</span> &amp;<i>cookie</i>)</h3>
<p>This signal is emitted whenever a new <i>cookie</i> is added to the cookie store.</p>
<!-- @@@cookieAdded -->
<!-- $$$cookieRemoved[overload1]$$$cookieRemovedconstQNetworkCookie& -->
<h3 class="fn" id="cookieRemoved"><a name="cookieRemoved"></a><code>[signal] </code><span class="type">void</span> QWebEngineCookieStore::<span class="name">cookieRemoved</span>(const <span class="type">QNetworkCookie</span> &amp;<i>cookie</i>)</h3>
<p>This signal is emitted whenever a <i>cookie</i> is deleted from the cookie store.</p>
<!-- @@@cookieRemoved -->
<!-- $$$deleteAllCookies[overload1]$$$deleteAllCookies -->
<h3 class="fn" id="deleteAllCookies"><a name="deleteAllCookies"></a><span class="type">void</span> QWebEngineCookieStore::<span class="name">deleteAllCookies</span>()</h3>
<p>Deletes all the cookies in the cookie store.</p>
<p><b>Note: </b>This operation is asynchronous.</p><p><b>See also </b><a href="qwebenginecookiestore.html#loadAllCookies">loadAllCookies</a>().</p>
<!-- @@@deleteAllCookies -->
<!-- $$$deleteCookie[overload1]$$$deleteCookieconstQNetworkCookie&constQUrl& -->
<h3 class="fn" id="deleteCookie"><a name="deleteCookie"></a><span class="type">void</span> QWebEngineCookieStore::<span class="name">deleteCookie</span>(const <span class="type">QNetworkCookie</span> &amp;<i>cookie</i>, const <span class="type">QUrl</span> &amp;<i>origin</i> = QUrl())</h3>
<p>Deletes <i>cookie</i> from the cookie store. It is possible to provide an optional <i>origin</i> URL argument to limit the scope of the cookie to be deleted.</p>
<p><b>Note: </b>This operation is asynchronous.</p><!-- @@@deleteCookie -->
<!-- $$$deleteSessionCookies[overload1]$$$deleteSessionCookies -->
<h3 class="fn" id="deleteSessionCookies"><a name="deleteSessionCookies"></a><span class="type">void</span> QWebEngineCookieStore::<span class="name">deleteSessionCookies</span>()</h3>
<p>Deletes all the session cookies in the cookie store. Session cookies do not have an expiration date assigned to them.</p>
<p><b>Note: </b>This operation is asynchronous.</p><p><b>See also </b><a href="qwebenginecookiestore.html#loadAllCookies">loadAllCookies</a>().</p>
<!-- @@@deleteSessionCookies -->
<!-- $$$loadAllCookies[overload1]$$$loadAllCookies -->
<h3 class="fn" id="loadAllCookies"><a name="loadAllCookies"></a><span class="type">void</span> QWebEngineCookieStore::<span class="name">loadAllCookies</span>()</h3>
<p>Loads all the cookies into the cookie store. The <a href="qwebenginecookiestore.html#cookieAdded">cookieAdded</a>() signal is emitted on every loaded cookie. Cookies are loaded automatically when the store gets initialized, which in most cases happens on loading the first URL. However, calling this function is useful if cookies should be listed before entering the web content.</p>
<p><b>Note: </b>This operation is asynchronous.</p><!-- @@@loadAllCookies -->
<!-- $$$setCookie[overload1]$$$setCookieconstQNetworkCookie&constQUrl& -->
<h3 class="fn" id="setCookie"><a name="setCookie"></a><span class="type">void</span> QWebEngineCookieStore::<span class="name">setCookie</span>(const <span class="type">QNetworkCookie</span> &amp;<i>cookie</i>, const <span class="type">QUrl</span> &amp;<i>origin</i> = QUrl())</h3>
<p>Adds <i>cookie</i> to the cookie store. It is possible to provide an optional <i>origin</i> URL argument to limit the scope of the cookie. The provided URL should also include the scheme.</p>
<p><b>Note: </b>This operation is asynchronous.</p><!-- @@@setCookie -->
</div>
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</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>