Sophie

Sophie

distrib > Mageia > 4 > i586 > by-pkgid > 41640b7d04ef5b5040e7668305a5ba3d > files > 971

python-kde4-doc-4.11.4-1.mga4.noarch.rpm

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">

<head>
  <title>KParts.HtmlSettingsInterface</title>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  <meta http-equiv="Content-Style-Type" content="text/css" />
  <link rel="stylesheet" type="text/css" href="../common/doxygen.css" />
  <link rel="stylesheet" media="screen" type="text/css" title="KDE Colors" href="../common/kde.css" />
</head>
<body>
<div id="container">
<div id="header">
  <div id="header_top">
    <div>
      <div>
        <img alt ="" src="../common/top-kde.jpg"/>
        KDE 4.9 PyKDE API Reference
      </div>
    </div>
  </div>
  <div id="header_bottom">
    <div id="location">
      <ul>
        <li>KDE's Python API</li>
      </ul>
    </div>

    <div id="menu">
      <ul>
        <li><a href="../modules.html">Overview</a></li>
<li><a href="http://techbase.kde.org/Development/Languages/Python">PyKDE Home</a></li>
<li><a href="http://kde.org/family/">Sitemap</a></li>
<li><a href="http://kde.org/contact/">Contact Us</a></li>
</ul>
    </div>
  </div>
</div>

<div id="body_wrapper">
<div id="body">
<div id="right">
<div class="content">
<div id="main">
<div class="clearer">&nbsp;</div>

<h1>HtmlSettingsInterface Class Reference</h1>
<code>from PyKDE4.kparts import *</code>
<p>


Namespace: <a href="../kparts/KParts.html">KParts</a><br />
<h2>Detailed Description</h2>

<p>An interface for modifying the settings of browser engines.
</p>
<p>
This interface provides a generic means for querying or changing the
settings of browser engines that implement it.
</p>
<p>
To use this class simply cast an instance of the HTMLExtension object
using qobject_cast&lt;KParts.HtmlSettingsInterface&gt;.
</p>
<p>
Example:
<pre>
KParts.HTMLExtension* extension = KParts.HTMLExtension.childObject(part);
KParts.HtmlSettingsInterface* settings = qobject_cast&amp;lt;KParts.HtmlSettingsInterface&amp;gt;(extension);
const bool autoLoadImages = settings-&gt;attribute(KParts.AutoLoadImages);
</pre>
</p>
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.8.1
</dd></dl>
</p>
<table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#HtmlSettingsType">HtmlSettingsType</a>&nbsp;</td><td class="memItemRight" valign="bottom">{&nbsp;AutoLoadImages, DnsPrefetchEnabled, JavaEnabled, JavascriptEnabled, MetaRefreshEnabled, PluginsEnabled, PrivateBrowsingEnabled, OfflineStorageDatabaseEnabled, OfflineWebApplicationCacheEnabled, LocalStorageEnabled, UserDefinedStyleSheetURL&nbsp;}</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#JSWindowFocusPolicy">JSWindowFocusPolicy</a>&nbsp;</td><td class="memItemRight" valign="bottom">{&nbsp;JSWindowFocusAllow, JSWindowFocusIgnore&nbsp;}</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#JSWindowMovePolicy">JSWindowMovePolicy</a>&nbsp;</td><td class="memItemRight" valign="bottom">{&nbsp;JSWindowMoveAllow, JSWindowMoveIgnore&nbsp;}</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#JSWindowOpenPolicy">JSWindowOpenPolicy</a>&nbsp;</td><td class="memItemRight" valign="bottom">{&nbsp;JSWindowOpenAllow, JSWindowOpenAsk, JSWindowOpenDeny, JSWindowOpenSmart&nbsp;}</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#JSWindowResizePolicy">JSWindowResizePolicy</a>&nbsp;</td><td class="memItemRight" valign="bottom">{&nbsp;JSWindowResizeAllow, JSWindowResizeIgnore&nbsp;}</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#JSWindowStatusPolicy">JSWindowStatusPolicy</a>&nbsp;</td><td class="memItemRight" valign="bottom">{&nbsp;JSWindowStatusAllow, JSWindowStatusIgnore&nbsp;}</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#JavaScriptAdvice">JavaScriptAdvice</a>&nbsp;</td><td class="memItemRight" valign="bottom">{&nbsp;JavaScriptDunno, JavaScriptAccept, JavaScriptReject&nbsp;}</td></tr>
<tr><td colspan="2"><br><h2>Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QVariant&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#htmlSettingsProperty">htmlSettingsProperty</a> (self, <a href="../kparts/KParts.HtmlSettingsInterface.html#HtmlSettingsType">KParts.HtmlSettingsInterface.HtmlSettingsType</a> type)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#setHtmlSettingsProperty">setHtmlSettingsProperty</a> (self, <a href="../kparts/KParts.HtmlSettingsInterface.html#HtmlSettingsType">KParts.HtmlSettingsInterface.HtmlSettingsType</a> type, QVariant value)</td></tr>
<tr><td colspan="2"><br><h2>Static Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#javascriptAdviceToText">javascriptAdviceToText</a> (<a href="../kparts/KParts.HtmlSettingsInterface.html#JavaScriptAdvice">KParts.HtmlSettingsInterface.JavaScriptAdvice</a> advice)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#splitDomainAdvice">splitDomainAdvice</a> (QString text, QString domain, <a href="../kparts/KParts.HtmlSettingsInterface.html#JavaScriptAdvice">KParts.HtmlSettingsInterface.JavaScriptAdvice</a> javaAdvice, <a href="../kparts/KParts.HtmlSettingsInterface.html#JavaScriptAdvice">KParts.HtmlSettingsInterface.JavaScriptAdvice</a> javaScriptAdvice)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kparts/KParts.HtmlSettingsInterface.html#JavaScriptAdvice">KParts.HtmlSettingsInterface.JavaScriptAdvice</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#textToJavascriptAdvice">textToJavascriptAdvice</a> (QString text)</td></tr>
</table>
<hr><h2>Method Documentation</h2><a class="anchor" name="htmlSettingsProperty"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QVariant htmlSettingsProperty</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kparts/KParts.HtmlSettingsInterface.html#HtmlSettingsType">KParts.HtmlSettingsInterface.HtmlSettingsType</a>&nbsp;</td>
<td class="paramname"><em>type</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Returns the value of the browser engine's attribute <b>type.</b>
</p></div></div><a class="anchor" name="setHtmlSettingsProperty"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool setHtmlSettingsProperty</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kparts/KParts.HtmlSettingsInterface.html#HtmlSettingsType">KParts.HtmlSettingsInterface.HtmlSettingsType</a>&nbsp;</td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QVariant&nbsp;</td>
<td class="paramname"><em>value</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Sets the value of the browser engine's attribute <b>type</b> to <b>value.</b>
</p></div></div><hr><h2>Static Method Documentation</h2><a class="anchor" name="javascriptAdviceToText"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString javascriptAdviceToText</td>
<td>(</td>
<td class="paramtype"><a href="../kparts/KParts.HtmlSettingsInterface.html#JavaScriptAdvice">KParts.HtmlSettingsInterface.JavaScriptAdvice</a>&nbsp;</td>
<td class="paramname"><em>advice</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>A convenience function Returns the text for the given JavascriptAdvice <b>advice.</b>
</p>
<p>
If <b>advice</b> is not either JavaScriptAccept or JavaScriptReject, this
function returns a NULL string.
</p>
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.8.2
</dd></dl>
</p></div></div><a class="anchor" name="splitDomainAdvice"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> splitDomainAdvice</td>
<td>(</td>
<td class="paramtype">QString&nbsp;</td>
<td class="paramname"><em>text</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString&nbsp;</td>
<td class="paramname"><em>domain</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kparts/KParts.HtmlSettingsInterface.html#JavaScriptAdvice">KParts.HtmlSettingsInterface.JavaScriptAdvice</a>&nbsp;</td>
<td class="paramname"><em>javaAdvice</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kparts/KParts.HtmlSettingsInterface.html#JavaScriptAdvice">KParts.HtmlSettingsInterface.JavaScriptAdvice</a>&nbsp;</td>
<td class="paramname"><em>javaScriptAdvice</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>A convenience function that splits <b>text</b> into <b>domain,</b> <b>javaAdvice</b>
and <b>jScriptAdvice.</b>
</p>
<p>
If <b>text</b> is empty or does not contain the proper delimiter (':'), this
function will set <b>domain</b> to <b>text</b> and the other two parameters to
JavaScriptDunno.
</p>
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.8.2
</dd></dl>
</p></div></div><a class="anchor" name="textToJavascriptAdvice"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kparts/KParts.HtmlSettingsInterface.html#JavaScriptAdvice">KParts.HtmlSettingsInterface.JavaScriptAdvice</a> textToJavascriptAdvice</td>
<td>(</td>
<td class="paramtype">QString&nbsp;</td>
<td class="paramname"><em>text</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>A convenience function that returns the javascript advice for <b>text.</b>
</p>
<p>
If text is not either "accept" or "reject", this function returns
JavaScriptDunno.
</p>
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.8.2
</dd></dl>
</p></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="HtmlSettingsType"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">HtmlSettingsType</td>
</tr>
</table>
</div>
<div class="memdoc"><p>Settings attribute types.
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>AutoLoadImages</em>&nbsp;</td><td><tr><td valign="top"><em>DnsPrefetchEnabled</em>&nbsp;</td><td><tr><td valign="top"><em>JavaEnabled</em>&nbsp;</td><td><tr><td valign="top"><em>JavascriptEnabled</em>&nbsp;</td><td><tr><td valign="top"><em>MetaRefreshEnabled</em>&nbsp;</td><td><tr><td valign="top"><em>PluginsEnabled</em>&nbsp;</td><td><tr><td valign="top"><em>PrivateBrowsingEnabled</em>&nbsp;</td><td><tr><td valign="top"><em>OfflineStorageDatabaseEnabled</em>&nbsp;</td><td><tr><td valign="top"><em>OfflineWebApplicationCacheEnabled</em>&nbsp;</td><td><tr><td valign="top"><em>LocalStorageEnabled</em>&nbsp;</td><td><tr><td valign="top"><em>UserDefinedStyleSheetURL</em>&nbsp;</td><td></table>
</dl>
</div></div><p><a class="anchor" name="JSWindowFocusPolicy"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">JSWindowFocusPolicy</td>
</tr>
</table>
</div>
<div class="memdoc"><p>This enum specifies the policy for window.focus
</p>
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.8.2
</dd></dl>
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>JSWindowFocusAllow</em>&nbsp;=&nbsp;0</td><td><tr><td valign="top"><em>JSWindowFocusIgnore</em>&nbsp;</td><td></table>
</dl>
</div></div><p><a class="anchor" name="JSWindowMovePolicy"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">JSWindowMovePolicy</td>
</tr>
</table>
</div>
<div class="memdoc"><p>This enum specifies the policy for window.moveBy and .moveTo
</p>
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.8.2
</dd></dl>
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>JSWindowMoveAllow</em>&nbsp;=&nbsp;0</td><td><tr><td valign="top"><em>JSWindowMoveIgnore</em>&nbsp;</td><td></table>
</dl>
</div></div><p><a class="anchor" name="JSWindowOpenPolicy"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">JSWindowOpenPolicy</td>
</tr>
</table>
</div>
<div class="memdoc"><p>This enum specifies the policy for window.open
</p>
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.8.2
</dd></dl>
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>JSWindowOpenAllow</em>&nbsp;=&nbsp;0</td><td><tr><td valign="top"><em>JSWindowOpenAsk</em>&nbsp;</td><td><tr><td valign="top"><em>JSWindowOpenDeny</em>&nbsp;</td><td><tr><td valign="top"><em>JSWindowOpenSmart</em>&nbsp;</td><td></table>
</dl>
</div></div><p><a class="anchor" name="JSWindowResizePolicy"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">JSWindowResizePolicy</td>
</tr>
</table>
</div>
<div class="memdoc"><p>This enum specifies the policy for window.resizeBy and .resizeTo
</p>
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.8.2
</dd></dl>
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>JSWindowResizeAllow</em>&nbsp;=&nbsp;0</td><td><tr><td valign="top"><em>JSWindowResizeIgnore</em>&nbsp;</td><td></table>
</dl>
</div></div><p><a class="anchor" name="JSWindowStatusPolicy"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">JSWindowStatusPolicy</td>
</tr>
</table>
</div>
<div class="memdoc"><p>This enum specifies the policy for window.status and .defaultStatus
</p>
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.8.2
</dd></dl>
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>JSWindowStatusAllow</em>&nbsp;=&nbsp;0</td><td><tr><td valign="top"><em>JSWindowStatusIgnore</em>&nbsp;</td><td></table>
</dl>
</div></div><p><a class="anchor" name="JavaScriptAdvice"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">JavaScriptAdvice</td>
</tr>
</table>
</div>
<div class="memdoc"><p>This enum specifies whether Java/JavaScript execution is allowed.
</p>
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.8.2
</dd></dl>
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>JavaScriptDunno</em>&nbsp;=&nbsp;0</td><td><tr><td valign="top"><em>JavaScriptAccept</em>&nbsp;</td><td><tr><td valign="top"><em>JavaScriptReject</em>&nbsp;</td><td></table>
</dl>
</div></div><p>
</div>
</div>
</div>

<div id="left">

<div class="menu_box">
<div class="nav_list">
<ul>
<li><a href="../allclasses.html">Full Index</a></li>
</ul>
</div>

<a name="cp-menu" /><div class="menutitle"><div>
  <h2 id="cp-menu-project">Modules</h2>
</div></div>
<div class="nav_list">
<ul><li><a href="../akonadi/index.html">akonadi</a></li>
<li><a href="../dnssd/index.html">dnssd</a></li>
<li><a href="../kdecore/index.html">kdecore</a></li>
<li><a href="../kdeui/index.html">kdeui</a></li>
<li><a href="../khtml/index.html">khtml</a></li>
<li><a href="../kio/index.html">kio</a></li>
<li><a href="../knewstuff/index.html">knewstuff</a></li>
<li><a href="../kparts/index.html">kparts</a></li>
<li><a href="../kutils/index.html">kutils</a></li>
<li><a href="../nepomuk/index.html">nepomuk</a></li>
<li><a href="../phonon/index.html">phonon</a></li>
<li><a href="../plasma/index.html">plasma</a></li>
<li><a href="../polkitqt/index.html">polkitqt</a></li>
<li><a href="../solid/index.html">solid</a></li>
<li><a href="../soprano/index.html">soprano</a></li>
</ul></div></div>

</div>

</div>
  <div class="clearer"/>
</div>

<div id="end_body"></div>
</div>
<div id="footer"><div id="footer_text">
This documentation is maintained by <a href="&#109;&#97;&#105;&#108;&#116;&#111;&#58;simon&#64;simonzone&#46;com">Simon Edwards</a>.<br />
        KDE<sup>&#174;</sup> and <a href="../images/kde_gear_black.png">the K Desktop Environment<sup>&#174;</sup> logo</a> are registered trademarks of <a href="http://ev.kde.org/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
        <a href="http://www.kde.org/contact/impressum.php">Legal</a>
    </div></div>
</body>
</html>