eric7/Documentation/Source/eric7.EricWidgets.EricCompleters.html

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/eric7/Documentation/Source/eric7.EricWidgets.EricCompleters.html	Mon May 24 11:19:57 2021 +0200
@@ -0,0 +1,318 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.EricWidgets.EricCompleters</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.EricWidgets.EricCompleters</h1>
+
+<p>
+Module implementing various kinds of completers.
+</p>
+<h3>Global Attributes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+
+<table>
+
+<tr>
+<td><a href="#EricDirCompleter">EricDirCompleter</a></td>
+<td>Class implementing a completer for directory names.</td>
+</tr>
+<tr>
+<td><a href="#EricFileCompleter">EricFileCompleter</a></td>
+<td>Class implementing a completer for file names.</td>
+</tr>
+<tr>
+<td><a href="#EricStringListCompleter">EricStringListCompleter</a></td>
+<td>Class implementing a completer for string lists.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr />
+<hr />
+<a NAME="EricDirCompleter" ID="EricDirCompleter"></a>
+<h2>EricDirCompleter</h2>
+
+<p>
+    Class implementing a completer for directory names.
+</p>
+<h3>Derived from</h3>
+QCompleter
+<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="#EricDirCompleter.__init__">EricDirCompleter</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#EricDirCompleter.rootPath">rootPath</a></td>
+<td>Public method to get the root path of the model.</td>
+</tr>
+<tr>
+<td><a href="#EricDirCompleter.setRootPath">setRootPath</a></td>
+<td>Public method to set the root path of the model.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<a NAME="EricDirCompleter.__init__" ID="EricDirCompleter.__init__"></a>
+<h4>EricDirCompleter (Constructor)</h4>
+<b>EricDirCompleter</b>(<i>parent=None, completionMode=QCompleter.CompletionMode.PopupCompletion, showHidden=False</i>)
+
+<p>
+        Constructor
+</p>
+<dl>
+
+<dt><i>parent</i></dt>
+<dd>
+parent widget of the completer (QWidget)
+</dd>
+<dt><i>completionMode</i></dt>
+<dd>
+completion mode of the
+            completer (QCompleter.CompletionMode)
+</dd>
+<dt><i>showHidden</i></dt>
+<dd>
+flag indicating to show hidden entries as well
+            (boolean)
+</dd>
+</dl>
+<a NAME="EricDirCompleter.rootPath" ID="EricDirCompleter.rootPath"></a>
+<h4>EricDirCompleter.rootPath</h4>
+<b>rootPath</b>(<i></i>)
+
+<p>
+        Public method to get the root path of the model.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+root path of the model
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<a NAME="EricDirCompleter.setRootPath" ID="EricDirCompleter.setRootPath"></a>
+<h4>EricDirCompleter.setRootPath</h4>
+<b>setRootPath</b>(<i>path</i>)
+
+<p>
+        Public method to set the root path of the model.
+</p>
+<dl>
+
+<dt><i>path</i> (str)</dt>
+<dd>
+root path for the model
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="EricFileCompleter" ID="EricFileCompleter"></a>
+<h2>EricFileCompleter</h2>
+
+<p>
+    Class implementing a completer for file names.
+</p>
+<h3>Derived from</h3>
+QCompleter
+<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="#EricFileCompleter.__init__">EricFileCompleter</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#EricFileCompleter.rootPath">rootPath</a></td>
+<td>Public method to get the root path of the model.</td>
+</tr>
+<tr>
+<td><a href="#EricFileCompleter.setRootPath">setRootPath</a></td>
+<td>Public method to set the root path of the model.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<a NAME="EricFileCompleter.__init__" ID="EricFileCompleter.__init__"></a>
+<h4>EricFileCompleter (Constructor)</h4>
+<b>EricFileCompleter</b>(<i>parent=None, completionMode=QCompleter.CompletionMode.PopupCompletion, showHidden=False</i>)
+
+<p>
+        Constructor
+</p>
+<dl>
+
+<dt><i>parent</i></dt>
+<dd>
+parent widget of the completer (QWidget)
+</dd>
+<dt><i>completionMode</i></dt>
+<dd>
+completion mode of the
+            completer (QCompleter.CompletionMode)
+</dd>
+<dt><i>showHidden</i></dt>
+<dd>
+flag indicating to show hidden entries as well
+            (boolean)
+</dd>
+</dl>
+<a NAME="EricFileCompleter.rootPath" ID="EricFileCompleter.rootPath"></a>
+<h4>EricFileCompleter.rootPath</h4>
+<b>rootPath</b>(<i></i>)
+
+<p>
+        Public method to get the root path of the model.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+root path of the model
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<a NAME="EricFileCompleter.setRootPath" ID="EricFileCompleter.setRootPath"></a>
+<h4>EricFileCompleter.setRootPath</h4>
+<b>setRootPath</b>(<i>path</i>)
+
+<p>
+        Public method to set the root path of the model.
+</p>
+<dl>
+
+<dt><i>path</i> (str)</dt>
+<dd>
+root path for the model
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="EricStringListCompleter" ID="EricStringListCompleter"></a>
+<h2>EricStringListCompleter</h2>
+
+<p>
+    Class implementing a completer for string lists.
+</p>
+<h3>Derived from</h3>
+QCompleter
+<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="#EricStringListCompleter.__init__">EricStringListCompleter</a></td>
+<td>Constructor</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<a NAME="EricStringListCompleter.__init__" ID="EricStringListCompleter.__init__"></a>
+<h4>EricStringListCompleter (Constructor)</h4>
+<b>EricStringListCompleter</b>(<i>parent=None, strings=None, completionMode=QCompleter.CompletionMode.PopupCompletion</i>)
+
+<p>
+        Constructor
+</p>
+<dl>
+
+<dt><i>parent</i></dt>
+<dd>
+parent widget of the completer (QWidget)
+</dd>
+<dt><i>strings</i></dt>
+<dd>
+list of string to load into the completer
+            (list of strings)
+</dd>
+<dt><i>completionMode</i></dt>
+<dd>
+completion mode of the
+            completer (QCompleter.CompletionMode)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial