eric6/Documentation/Source/eric6.E5Gui.E5Completers.html

branch
maintenance
changeset 6989
8b8cadf8d7e9
parent 6942
2602857055c5
child 7273
391d6b7b1eff
equal deleted inserted replaced
6938:7926553b7509 6989:8b8cadf8d7e9
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.E5Gui.E5Completers</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body><a NAME="top" ID="top"></a>
22 <h1>eric6.E5Gui.E5Completers</h1>
23 <p>
24 Module implementing various kinds of completers.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#E5DirCompleter">E5DirCompleter</a></td>
34 <td>Class implementing a completer for directory names.</td>
35 </tr><tr>
36 <td><a href="#E5FileCompleter">E5FileCompleter</a></td>
37 <td>Class implementing a completer for file names.</td>
38 </tr><tr>
39 <td><a href="#E5StringListCompleter">E5StringListCompleter</a></td>
40 <td>Class implementing a completer for string lists.</td>
41 </tr>
42 </table>
43 <h3>Functions</h3>
44 <table>
45 <tr><td>None</td></tr>
46 </table>
47 <hr /><hr />
48 <a NAME="E5DirCompleter" ID="E5DirCompleter"></a>
49 <h2>E5DirCompleter</h2>
50 <p>
51 Class implementing a completer for directory names.
52 </p>
53 <h3>Derived from</h3>
54 QCompleter
55 <h3>Class Attributes</h3>
56 <table>
57 <tr><td>None</td></tr>
58 </table>
59 <h3>Class Methods</h3>
60 <table>
61 <tr><td>None</td></tr>
62 </table>
63 <h3>Methods</h3>
64 <table>
65 <tr>
66 <td><a href="#E5DirCompleter.__init__">E5DirCompleter</a></td>
67 <td>Constructor</td>
68 </tr><tr>
69 <td><a href="#E5DirCompleter.rootPath">rootPath</a></td>
70 <td>Public method to get the root path of the model.</td>
71 </tr><tr>
72 <td><a href="#E5DirCompleter.setRootPath">setRootPath</a></td>
73 <td>Public method to set the root path of the model.</td>
74 </tr>
75 </table>
76 <h3>Static Methods</h3>
77 <table>
78 <tr><td>None</td></tr>
79 </table>
80 <a NAME="E5DirCompleter.__init__" ID="E5DirCompleter.__init__"></a>
81 <h4>E5DirCompleter (Constructor)</h4>
82 <b>E5DirCompleter</b>(<i>parent=None, completionMode=QCompleter.PopupCompletion, showHidden=False</i>)
83 <p>
84 Constructor
85 </p><dl>
86 <dt><i>parent</i></dt>
87 <dd>
88 parent widget of the completer (QWidget)
89 </dd><dt><i>completionMode=</i></dt>
90 <dd>
91 completion mode of the
92 completer (QCompleter.CompletionMode)
93 </dd><dt><i>showHidden=</i></dt>
94 <dd>
95 flag indicating to show hidden entries as well
96 (boolean)
97 </dd>
98 </dl><a NAME="E5DirCompleter.rootPath" ID="E5DirCompleter.rootPath"></a>
99 <h4>E5DirCompleter.rootPath</h4>
100 <b>rootPath</b>(<i></i>)
101 <p>
102 Public method to get the root path of the model.
103 </p><dl>
104 <dt>Returns:</dt>
105 <dd>
106 root path of the model
107 </dd>
108 </dl><dl>
109 <dt>Return Type:</dt>
110 <dd>
111 str
112 </dd>
113 </dl><a NAME="E5DirCompleter.setRootPath" ID="E5DirCompleter.setRootPath"></a>
114 <h4>E5DirCompleter.setRootPath</h4>
115 <b>setRootPath</b>(<i>path</i>)
116 <p>
117 Public method to set the root path of the model.
118 </p><dl>
119 <dt><i>path</i> (str)</dt>
120 <dd>
121 root path for the model
122 </dd>
123 </dl>
124 <div align="right"><a href="#top">Up</a></div>
125 <hr /><hr />
126 <a NAME="E5FileCompleter" ID="E5FileCompleter"></a>
127 <h2>E5FileCompleter</h2>
128 <p>
129 Class implementing a completer for file names.
130 </p>
131 <h3>Derived from</h3>
132 QCompleter
133 <h3>Class Attributes</h3>
134 <table>
135 <tr><td>None</td></tr>
136 </table>
137 <h3>Class Methods</h3>
138 <table>
139 <tr><td>None</td></tr>
140 </table>
141 <h3>Methods</h3>
142 <table>
143 <tr>
144 <td><a href="#E5FileCompleter.__init__">E5FileCompleter</a></td>
145 <td>Constructor</td>
146 </tr><tr>
147 <td><a href="#E5FileCompleter.rootPath">rootPath</a></td>
148 <td>Public method to get the root path of the model.</td>
149 </tr><tr>
150 <td><a href="#E5FileCompleter.setRootPath">setRootPath</a></td>
151 <td>Public method to set the root path of the model.</td>
152 </tr>
153 </table>
154 <h3>Static Methods</h3>
155 <table>
156 <tr><td>None</td></tr>
157 </table>
158 <a NAME="E5FileCompleter.__init__" ID="E5FileCompleter.__init__"></a>
159 <h4>E5FileCompleter (Constructor)</h4>
160 <b>E5FileCompleter</b>(<i>parent=None, completionMode=QCompleter.PopupCompletion, showHidden=False</i>)
161 <p>
162 Constructor
163 </p><dl>
164 <dt><i>parent</i></dt>
165 <dd>
166 parent widget of the completer (QWidget)
167 </dd><dt><i>completionMode=</i></dt>
168 <dd>
169 completion mode of the
170 completer (QCompleter.CompletionMode)
171 </dd><dt><i>showHidden=</i></dt>
172 <dd>
173 flag indicating to show hidden entries as well
174 (boolean)
175 </dd>
176 </dl><a NAME="E5FileCompleter.rootPath" ID="E5FileCompleter.rootPath"></a>
177 <h4>E5FileCompleter.rootPath</h4>
178 <b>rootPath</b>(<i></i>)
179 <p>
180 Public method to get the root path of the model.
181 </p><dl>
182 <dt>Returns:</dt>
183 <dd>
184 root path of the model
185 </dd>
186 </dl><dl>
187 <dt>Return Type:</dt>
188 <dd>
189 str
190 </dd>
191 </dl><a NAME="E5FileCompleter.setRootPath" ID="E5FileCompleter.setRootPath"></a>
192 <h4>E5FileCompleter.setRootPath</h4>
193 <b>setRootPath</b>(<i>path</i>)
194 <p>
195 Public method to set the root path of the model.
196 </p><dl>
197 <dt><i>path</i> (str)</dt>
198 <dd>
199 root path for the model
200 </dd>
201 </dl>
202 <div align="right"><a href="#top">Up</a></div>
203 <hr /><hr />
204 <a NAME="E5StringListCompleter" ID="E5StringListCompleter"></a>
205 <h2>E5StringListCompleter</h2>
206 <p>
207 Class implementing a completer for string lists.
208 </p>
209 <h3>Derived from</h3>
210 QCompleter
211 <h3>Class Attributes</h3>
212 <table>
213 <tr><td>None</td></tr>
214 </table>
215 <h3>Class Methods</h3>
216 <table>
217 <tr><td>None</td></tr>
218 </table>
219 <h3>Methods</h3>
220 <table>
221 <tr>
222 <td><a href="#E5StringListCompleter.__init__">E5StringListCompleter</a></td>
223 <td>Constructor</td>
224 </tr>
225 </table>
226 <h3>Static Methods</h3>
227 <table>
228 <tr><td>None</td></tr>
229 </table>
230 <a NAME="E5StringListCompleter.__init__" ID="E5StringListCompleter.__init__"></a>
231 <h4>E5StringListCompleter (Constructor)</h4>
232 <b>E5StringListCompleter</b>(<i>parent=None, strings=None, completionMode=QCompleter.PopupCompletion</i>)
233 <p>
234 Constructor
235 </p><dl>
236 <dt><i>parent</i></dt>
237 <dd>
238 parent widget of the completer (QWidget)
239 </dd><dt><i>strings</i></dt>
240 <dd>
241 list of string to load into the completer
242 (list of strings)
243 </dd><dt><i>completionMode=</i></dt>
244 <dd>
245 completion mode of the
246 completer (QCompleter.CompletionMode)
247 </dd>
248 </dl>
249 <div align="right"><a href="#top">Up</a></div>
250 <hr />
251 </body></html>

eric ide

mercurial