eric7/Documentation/Source/eric7.WebBrowser.GreaseMonkey.GreaseMonkeyJsObject.html

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/eric7/Documentation/Source/eric7.WebBrowser.GreaseMonkey.GreaseMonkeyJsObject.html	Mon May 24 11:19:57 2021 +0200
@@ -0,0 +1,276 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.WebBrowser.GreaseMonkey.GreaseMonkeyJsObject</title>
+<meta charset="UTF-8">
+<style>
+body {
+    background: #EDECE6;
+    margin: 0em 1em 10em 1em;
+    color: black;
+}
+
+h1 { color: white; background: #85774A; }
+h2 { color: white; background: #85774A; }
+h3 { color: white; background: #9D936E; }
+h4 { color: white; background: #9D936E; }
+    
+a { color: #BA6D36; }
+
+</style>
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.WebBrowser.GreaseMonkey.GreaseMonkeyJsObject</h1>
+
+<p>
+Module implementing the Python side for GreaseMonkey scripts.
+</p>
+<h3>Global Attributes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+
+<table>
+
+<tr>
+<td><a href="#GreaseMonkeyJsObject">GreaseMonkeyJsObject</a></td>
+<td>Class implementing the Python side for GreaseMonkey scripts.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr />
+<hr />
+<a NAME="GreaseMonkeyJsObject" ID="GreaseMonkeyJsObject"></a>
+<h2>GreaseMonkeyJsObject</h2>
+
+<p>
+    Class implementing the Python side for GreaseMonkey scripts.
+</p>
+<h3>Derived from</h3>
+QObject
+<h3>Class Attributes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Class Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+
+<table>
+
+<tr>
+<td><a href="#GreaseMonkeyJsObject.__init__">GreaseMonkeyJsObject</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#GreaseMonkeyJsObject.deleteValue">deleteValue</a></td>
+<td>Public slot to set delete the named variable for the identified script.</td>
+</tr>
+<tr>
+<td><a href="#GreaseMonkeyJsObject.getValue">getValue</a></td>
+<td>Public slot to get the value for the named variable for the identified script.</td>
+</tr>
+<tr>
+<td><a href="#GreaseMonkeyJsObject.listValues">listValues</a></td>
+<td>Public slot to list the stored variables for the identified script.</td>
+</tr>
+<tr>
+<td><a href="#GreaseMonkeyJsObject.setClipboard">setClipboard</a></td>
+<td>Public slot to set some clipboard text.</td>
+</tr>
+<tr>
+<td><a href="#GreaseMonkeyJsObject.setSettingsFile">setSettingsFile</a></td>
+<td>Public method to set the settings file for the GreaseMonkey parameters.</td>
+</tr>
+<tr>
+<td><a href="#GreaseMonkeyJsObject.setValue">setValue</a></td>
+<td>Public slot to set the value for the named variable for the identified script.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<a NAME="GreaseMonkeyJsObject.__init__" ID="GreaseMonkeyJsObject.__init__"></a>
+<h4>GreaseMonkeyJsObject (Constructor)</h4>
+<b>GreaseMonkeyJsObject</b>(<i>parent=None</i>)
+
+<p>
+        Constructor
+</p>
+<dl>
+
+<dt><i>parent</i> (QObject)</dt>
+<dd>
+reference to the parent object
+</dd>
+</dl>
+<a NAME="GreaseMonkeyJsObject.deleteValue" ID="GreaseMonkeyJsObject.deleteValue"></a>
+<h4>GreaseMonkeyJsObject.deleteValue</h4>
+<b>deleteValue</b>(<i>nspace, name</i>)
+
+<p>
+        Public slot to set delete the named variable for the identified script.
+</p>
+<dl>
+
+<dt><i>nspace</i> (str)</dt>
+<dd>
+unique script id
+</dd>
+<dt><i>name</i> (str)</dt>
+<dd>
+name of the variable
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating success
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<a NAME="GreaseMonkeyJsObject.getValue" ID="GreaseMonkeyJsObject.getValue"></a>
+<h4>GreaseMonkeyJsObject.getValue</h4>
+<b>getValue</b>(<i>nspace, name, dValue</i>)
+
+<p>
+        Public slot to get the value for the named variable for the identified
+        script.
+</p>
+<dl>
+
+<dt><i>nspace</i> (str)</dt>
+<dd>
+unique script id
+</dd>
+<dt><i>name</i> (str)</dt>
+<dd>
+name of the variable
+</dd>
+<dt><i>dValue</i> (str)</dt>
+<dd>
+default value
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+value for the named variable
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<a NAME="GreaseMonkeyJsObject.listValues" ID="GreaseMonkeyJsObject.listValues"></a>
+<h4>GreaseMonkeyJsObject.listValues</h4>
+<b>listValues</b>(<i>nspace</i>)
+
+<p>
+        Public slot to list the stored variables for the identified script.
+</p>
+<dl>
+
+<dt><i>nspace</i> (str)</dt>
+<dd>
+unique script id
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+list of stored variables
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
+</dd>
+</dl>
+<a NAME="GreaseMonkeyJsObject.setClipboard" ID="GreaseMonkeyJsObject.setClipboard"></a>
+<h4>GreaseMonkeyJsObject.setClipboard</h4>
+<b>setClipboard</b>(<i>text</i>)
+
+<p>
+        Public slot to set some clipboard text.
+</p>
+<dl>
+
+<dt><i>text</i> (str)</dt>
+<dd>
+text to be copied to the clipboard
+</dd>
+</dl>
+<a NAME="GreaseMonkeyJsObject.setSettingsFile" ID="GreaseMonkeyJsObject.setSettingsFile"></a>
+<h4>GreaseMonkeyJsObject.setSettingsFile</h4>
+<b>setSettingsFile</b>(<i>name</i>)
+
+<p>
+        Public method to set the settings file for the GreaseMonkey parameters.
+</p>
+<dl>
+
+<dt><i>name</i> (str)</dt>
+<dd>
+name of the settings file
+</dd>
+</dl>
+<a NAME="GreaseMonkeyJsObject.setValue" ID="GreaseMonkeyJsObject.setValue"></a>
+<h4>GreaseMonkeyJsObject.setValue</h4>
+<b>setValue</b>(<i>nspace, name, value</i>)
+
+<p>
+        Public slot to set the value for the named variable for the identified
+        script.
+</p>
+<dl>
+
+<dt><i>nspace</i> (str)</dt>
+<dd>
+unique script id
+</dd>
+<dt><i>name</i> (str)</dt>
+<dd>
+name of the variable
+</dd>
+<dt><i>value</i> (str)</dt>
+<dd>
+value to be set
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating success
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial