|
1 <?xml version="1.0" encoding="utf-8"?> |
|
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' |
|
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> |
|
4 <html><head> |
|
5 <title>eric5.DebugClients.Ruby.Completer</title> |
|
6 <style> |
|
7 b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' |
|
8 </style> |
|
9 </head> |
|
10 <body><a NAME="top" ID="top"></a> |
|
11 <h1>eric5.DebugClients.Ruby.Completer</h1> |
|
12 <p> |
|
13 File implementing a command line completer class. |
|
14 </p> |
|
15 <h3>Global Attributes</h3> |
|
16 <table> |
|
17 <tr><td>None</td></tr> |
|
18 </table> |
|
19 <h3>Classes</h3> |
|
20 <table> |
|
21 <tr> |
|
22 <td><a href="#Completer">Completer</a></td> |
|
23 <td>Class implementing a command completer.</td> |
|
24 </tr> |
|
25 </table> |
|
26 <h3>Modules</h3> |
|
27 <table> |
|
28 <tr><td>None</td></tr> |
|
29 </table> |
|
30 <h3>Functions</h3> |
|
31 <table> |
|
32 <tr><td>None</td></tr> |
|
33 </table> |
|
34 <hr /><hr /> |
|
35 <a NAME="Completer" ID="Completer"></a> |
|
36 <h2>Completer</h2> |
|
37 <p> |
|
38 Class implementing a command completer. |
|
39 </p> |
|
40 <h3>Derived from</h3> |
|
41 None |
|
42 <h3>Class Attributes</h3> |
|
43 <table> |
|
44 <tr><td>Operators</td></tr><tr><td>ReservedWords</td></tr> |
|
45 </table> |
|
46 <h3>Methods</h3> |
|
47 <table> |
|
48 <tr> |
|
49 <td><a href="#Completer.complete">complete</a></td> |
|
50 <td>Public method to select the possible completions</td> |
|
51 </tr><tr> |
|
52 <td><a href="#Completer.initialize">initialize</a></td> |
|
53 <td>constructor</td> |
|
54 </tr><tr> |
|
55 <td><a href="#Completer.select_message">select_message</a></td> |
|
56 <td>Method used to pick completion candidates.</td> |
|
57 </tr> |
|
58 </table> |
|
59 <a NAME="Completer.complete" ID="Completer.complete"></a> |
|
60 <h4>Completer.complete</h4> |
|
61 <b>complete</b>(<i></i>) |
|
62 <p> |
|
63 Public method to select the possible completions |
|
64 </p><dl> |
|
65 <dt><i>input</i></dt> |
|
66 <dd> |
|
67 text to be completed (String) |
|
68 </dd> |
|
69 </dl><dl> |
|
70 <dt>Returns:</dt> |
|
71 <dd> |
|
72 list of possible completions (Array) |
|
73 </dd> |
|
74 </dl><a NAME="Completer.initialize" ID="Completer.initialize"></a> |
|
75 <h4>Completer.initialize</h4> |
|
76 <b>initialize</b>(<i></i>) |
|
77 <p> |
|
78 constructor |
|
79 </p><dl> |
|
80 <dt><i>binding</i></dt> |
|
81 <dd> |
|
82 binding object used to determine the possible completions |
|
83 </dd> |
|
84 </dl><a NAME="Completer.select_message" ID="Completer.select_message"></a> |
|
85 <h4>Completer.select_message</h4> |
|
86 <b>select_message</b>(<i>message, candidates</i>) |
|
87 <p> |
|
88 Method used to pick completion candidates. |
|
89 </p><dl> |
|
90 <dt><i>receiver</i></dt> |
|
91 <dd> |
|
92 object receiving the message |
|
93 </dd><dt><i>message</i></dt> |
|
94 <dd> |
|
95 message to be sent to object |
|
96 </dd><dt><i>candidates</i></dt> |
|
97 <dd> |
|
98 possible completion candidates |
|
99 </dd> |
|
100 </dl><dl> |
|
101 <dt>Returns:</dt> |
|
102 <dd> |
|
103 filtered list of candidates |
|
104 </dd> |
|
105 </dl> |
|
106 <div align="right"><a href="#top">Up</a></div> |
|
107 <hr /> |
|
108 </body></html> |