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

changeset 3673
e26d7d0c1088
equal deleted inserted replaced
3670:f0cb7579c0b4 3673:e26d7d0c1088
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.DebugClients.Ruby.Completer</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.DebugClients.Ruby.Completer</h1>
23 <p>
24 File implementing a command line completer class.
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="#Completer">Completer</a></td>
34 <td>Class implementing a command completer.</td>
35 </tr>
36 </table>
37 <h3>Modules</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <h3>Functions</h3>
42 <table>
43 <tr><td>None</td></tr>
44 </table>
45 <hr /><hr />
46 <a NAME="Completer" ID="Completer"></a>
47 <h2>Completer</h2>
48 <p>
49 Class implementing a command completer.
50 </p>
51 <h3>Derived from</h3>
52 None
53 <h3>Class Attributes</h3>
54 <table>
55 <tr><td>Operators</td></tr><tr><td>ReservedWords</td></tr>
56 </table>
57 <h3>Class Methods</h3>
58 <table>
59 <tr><td>None</td></tr>
60 </table>
61 <h3>Methods</h3>
62 <table>
63 <tr>
64 <td><a href="#Completer.complete">complete</a></td>
65 <td>Public method to select the possible completions</td>
66 </tr><tr>
67 <td><a href="#Completer.initialize">initialize</a></td>
68 <td>constructor</td>
69 </tr><tr>
70 <td><a href="#Completer.select_message">select_message</a></td>
71 <td>Method used to pick completion candidates.</td>
72 </tr>
73 </table>
74 <h3>Static Methods</h3>
75 <table>
76 <tr><td>None</td></tr>
77 </table>
78 <a NAME="Completer.complete" ID="Completer.complete"></a>
79 <h4>Completer.complete</h4>
80 <b>complete</b>(<i></i>)
81 <p>
82 Public method to select the possible completions
83 </p><dl>
84 <dt><i>input</i></dt>
85 <dd>
86 text to be completed (String)
87 </dd>
88 </dl><dl>
89 <dt>Returns:</dt>
90 <dd>
91 list of possible completions (Array)
92 </dd>
93 </dl><a NAME="Completer.initialize" ID="Completer.initialize"></a>
94 <h4>Completer.initialize</h4>
95 <b>initialize</b>(<i></i>)
96 <p>
97 constructor
98 </p><dl>
99 <dt><i>binding</i></dt>
100 <dd>
101 binding object used to determine the possible completions
102 </dd>
103 </dl><a NAME="Completer.select_message" ID="Completer.select_message"></a>
104 <h4>Completer.select_message</h4>
105 <b>select_message</b>(<i>message, candidates, sep = "."</i>)
106 <p>
107 Method used to pick completion candidates.
108 </p><dl>
109 <dt><i>receiver</i></dt>
110 <dd>
111 object receiving the message
112 </dd><dt><i>message</i></dt>
113 <dd>
114 message to be sent to object
115 </dd><dt><i>candidates</i></dt>
116 <dd>
117 possible completion candidates
118 </dd><dt><i>sep</i></dt>
119 <dd>
120 separater string
121 </dd>
122 </dl><dl>
123 <dt>Returns:</dt>
124 <dd>
125 filtered list of candidates
126 </dd>
127 </dl>
128 <div align="right"><a href="#top">Up</a></div>
129 <hr />
130 </body></html>

eric ide

mercurial