Documentation/Source/eric4.DebugClients.Ruby.Completer.html

changeset 3
0d9daebf5b8c
equal deleted inserted replaced
2:bc6196164237 3:0d9daebf5b8c
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>eric4.DebugClients.Ruby.Completer</title>
6 <style>
7 body {
8 background:white;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #4FA4FF; }
14 h2 { color: white; background: #4FA4FF; }
15 h3 { color: white; background: #00557F; }
16 h4 { color: white; background: #00557F; }
17
18 a { color: #AA5500; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>eric4.DebugClients.Ruby.Completer</h1>
24 <p>
25 File implementing a command line completer class.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#Completer">Completer</a></td>
35 <td>Class implementing a command completer.</td>
36 </tr>
37 </table>
38 <h3>Modules</h3>
39 <table>
40 <tr><td>None</td></tr>
41 </table>
42 <h3>Functions</h3>
43 <table>
44 <tr><td>None</td></tr>
45 </table>
46 <hr /><hr />
47 <a NAME="Completer" ID="Completer"></a>
48 <h2>Completer</h2>
49 <p>
50 Class implementing a command completer.
51 </p>
52 <h3>Derived from</h3>
53 None
54 <h3>Class Attributes</h3>
55 <table>
56 <tr><td>Operators</td></tr><tr><td>ReservedWords</td></tr>
57 </table>
58 <h3>Methods</h3>
59 <table>
60 <tr>
61 <td><a href="#Completer.complete">complete</a></td>
62 <td>Public method to select the possible completions</td>
63 </tr><tr>
64 <td><a href="#Completer.initialize">initialize</a></td>
65 <td>constructor</td>
66 </tr><tr>
67 <td><a href="#Completer.select_message">select_message</a></td>
68 <td>Method used to pick completion candidates.</td>
69 </tr>
70 </table>
71 <a NAME="Completer.complete" ID="Completer.complete"></a>
72 <h4>Completer.complete</h4>
73 <b>complete</b>(<i></i>)
74 <p>
75 Public method to select the possible completions
76 </p><dl>
77 <dt><i>input</i></dt>
78 <dd>
79 text to be completed (String)
80 </dd>
81 </dl><dl>
82 <dt>Returns:</dt>
83 <dd>
84 list of possible completions (Array)
85 </dd>
86 </dl><a NAME="Completer.initialize" ID="Completer.initialize"></a>
87 <h4>Completer.initialize</h4>
88 <b>initialize</b>(<i></i>)
89 <p>
90 constructor
91 </p><dl>
92 <dt><i>binding</i></dt>
93 <dd>
94 binding object used to determine the possible completions
95 </dd>
96 </dl><a NAME="Completer.select_message" ID="Completer.select_message"></a>
97 <h4>Completer.select_message</h4>
98 <b>select_message</b>(<i>message, candidates</i>)
99 <p>
100 Method used to pick completion candidates.
101 </p><dl>
102 <dt><i>receiver</i></dt>
103 <dd>
104 object receiving the message
105 </dd><dt><i>message</i></dt>
106 <dd>
107 message to be sent to object
108 </dd><dt><i>candidates</i></dt>
109 <dd>
110 possible completion candidates
111 </dd>
112 </dl><dl>
113 <dt>Returns:</dt>
114 <dd>
115 filtered list of candidates
116 </dd>
117 </dl>
118 <div align="right"><a href="#top">Up</a></div>
119 <hr />
120 </body></html>

eric ide

mercurial