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

changeset 58
37f0444c3479
parent 21
b88a0e6268bd
child 409
0ea528e80202
equal deleted inserted replaced
57:81326a94fdca 58:37f0444c3479
20 </style> 20 </style>
21 </head> 21 </head>
22 <body><a NAME="top" ID="top"></a> 22 <body><a NAME="top" ID="top"></a>
23 <h1>eric5.DebugClients.Ruby.Completer</h1> 23 <h1>eric5.DebugClients.Ruby.Completer</h1>
24 <p> 24 <p>
25 &#70;&#105;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#99;&#111;&#109;&#109;&#97;&#110;&#100; &#108;&#105;&#110;&#101; &#99;&#111;&#109;&#112;&#108;&#101;&#116;&#101;&#114; &#99;&#108;&#97;&#115;&#115;. 25 File implementing a command line completer class.
26 </p> 26 </p>
27 <h3>Global Attributes</h3> 27 <h3>Global Attributes</h3>
28 <table> 28 <table>
29 <tr><td>None</td></tr> 29 <tr><td>None</td></tr>
30 </table> 30 </table>
31 <h3>Classes</h3> 31 <h3>Classes</h3>
32 <table> 32 <table>
33 <tr> 33 <tr>
34 <td><a href="#Completer">Completer</a></td> 34 <td><a href="#Completer">Completer</a></td>
35 <td>&#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#99;&#111;&#109;&#109;&#97;&#110;&#100; &#99;&#111;&#109;&#112;&#108;&#101;&#116;&#101;&#114;.</td> 35 <td>Class implementing a command completer.</td>
36 </tr> 36 </tr>
37 </table> 37 </table>
38 <h3>Modules</h3> 38 <h3>Modules</h3>
39 <table> 39 <table>
40 <tr><td>None</td></tr> 40 <tr><td>None</td></tr>
45 </table> 45 </table>
46 <hr /><hr /> 46 <hr /><hr />
47 <a NAME="Completer" ID="Completer"></a> 47 <a NAME="Completer" ID="Completer"></a>
48 <h2>Completer</h2> 48 <h2>Completer</h2>
49 <p> 49 <p>
50 &#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#99;&#111;&#109;&#109;&#97;&#110;&#100; &#99;&#111;&#109;&#112;&#108;&#101;&#116;&#101;&#114;. 50 Class implementing a command completer.
51 </p> 51 </p>
52 <h3>Derived from</h3> 52 <h3>Derived from</h3>
53 None 53 None
54 <h3>Class Attributes</h3> 54 <h3>Class Attributes</h3>
55 <table> 55 <table>
57 </table> 57 </table>
58 <h3>Methods</h3> 58 <h3>Methods</h3>
59 <table> 59 <table>
60 <tr> 60 <tr>
61 <td><a href="#Completer.complete">complete</a></td> 61 <td><a href="#Completer.complete">complete</a></td>
62 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#108;&#101;&#99;&#116; &#116;&#104;&#101; &#112;&#111;&#115;&#115;&#105;&#98;&#108;&#101; &#99;&#111;&#109;&#112;&#108;&#101;&#116;&#105;&#111;&#110;&#115;</td> 62 <td>Public method to select the possible completions</td>
63 </tr><tr> 63 </tr><tr>
64 <td><a href="#Completer.initialize">initialize</a></td> 64 <td><a href="#Completer.initialize">initialize</a></td>
65 <td>&#99;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td> 65 <td>constructor</td>
66 </tr><tr> 66 </tr><tr>
67 <td><a href="#Completer.select_message">select_message</a></td> 67 <td><a href="#Completer.select_message">select_message</a></td>
68 <td>&#77;&#101;&#116;&#104;&#111;&#100; &#117;&#115;&#101;&#100; &#116;&#111; &#112;&#105;&#99;&#107; &#99;&#111;&#109;&#112;&#108;&#101;&#116;&#105;&#111;&#110; &#99;&#97;&#110;&#100;&#105;&#100;&#97;&#116;&#101;&#115;.</td> 68 <td>Method used to pick completion candidates.</td>
69 </tr> 69 </tr>
70 </table> 70 </table>
71 <a NAME="Completer.complete" ID="Completer.complete"></a> 71 <a NAME="Completer.complete" ID="Completer.complete"></a>
72 <h4>Completer.complete</h4> 72 <h4>Completer.complete</h4>
73 <b>complete</b>(<i></i>) 73 <b>complete</b>(<i></i>)
74 <p> 74 <p>
75 &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#108;&#101;&#99;&#116; &#116;&#104;&#101; &#112;&#111;&#115;&#115;&#105;&#98;&#108;&#101; &#99;&#111;&#109;&#112;&#108;&#101;&#116;&#105;&#111;&#110;&#115; 75 Public method to select the possible completions
76 </p><dl> 76 </p><dl>
77 <dt><i>input</i></dt> 77 <dt><i>input</i></dt>
78 <dd> 78 <dd>
79 &#116;&#101;x&#116; &#116;&#111; &#98;&#101; &#99;&#111;&#109;&#112;&#108;&#101;&#116;&#101;&#100; (&#83;&#116;&#114;&#105;&#110;&#103;) 79 text to be completed (String)
80 </dd> 80 </dd>
81 </dl><dl> 81 </dl><dl>
82 <dt>Returns:</dt> 82 <dt>Returns:</dt>
83 <dd> 83 <dd>
84 &#108;&#105;&#115;&#116; &#111;&#102; &#112;&#111;&#115;&#115;&#105;&#98;&#108;&#101; &#99;&#111;&#109;&#112;&#108;&#101;&#116;&#105;&#111;&#110;&#115; (&#65;&#114;&#114;&#97;y) 84 list of possible completions (Array)
85 </dd> 85 </dd>
86 </dl><a NAME="Completer.initialize" ID="Completer.initialize"></a> 86 </dl><a NAME="Completer.initialize" ID="Completer.initialize"></a>
87 <h4>Completer.initialize</h4> 87 <h4>Completer.initialize</h4>
88 <b>initialize</b>(<i></i>) 88 <b>initialize</b>(<i></i>)
89 <p> 89 <p>
90 &#99;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114; 90 constructor
91 </p><dl> 91 </p><dl>
92 <dt><i>binding</i></dt> 92 <dt><i>binding</i></dt>
93 <dd> 93 <dd>
94 &#98;&#105;&#110;&#100;&#105;&#110;&#103; &#111;&#98;&#106;&#101;&#99;&#116; &#117;&#115;&#101;&#100; &#116;&#111; &#100;&#101;&#116;&#101;&#114;&#109;&#105;&#110;&#101; &#116;&#104;&#101; &#112;&#111;&#115;&#115;&#105;&#98;&#108;&#101; &#99;&#111;&#109;&#112;&#108;&#101;&#116;&#105;&#111;&#110;&#115; 94 binding object used to determine the possible completions
95 </dd> 95 </dd>
96 </dl><a NAME="Completer.select_message" ID="Completer.select_message"></a> 96 </dl><a NAME="Completer.select_message" ID="Completer.select_message"></a>
97 <h4>Completer.select_message</h4> 97 <h4>Completer.select_message</h4>
98 <b>select_message</b>(<i>message, candidates</i>) 98 <b>select_message</b>(<i>message, candidates</i>)
99 <p> 99 <p>
100 &#77;&#101;&#116;&#104;&#111;&#100; &#117;&#115;&#101;&#100; &#116;&#111; &#112;&#105;&#99;&#107; &#99;&#111;&#109;&#112;&#108;&#101;&#116;&#105;&#111;&#110; &#99;&#97;&#110;&#100;&#105;&#100;&#97;&#116;&#101;&#115;. 100 Method used to pick completion candidates.
101 </p><dl> 101 </p><dl>
102 <dt><i>receiver</i></dt> 102 <dt><i>receiver</i></dt>
103 <dd> 103 <dd>
104 &#111;&#98;&#106;&#101;&#99;&#116; &#114;&#101;&#99;&#101;&#105;v&#105;&#110;&#103; &#116;&#104;&#101; &#109;&#101;&#115;&#115;&#97;&#103;&#101; 104 object receiving the message
105 </dd><dt><i>message</i></dt> 105 </dd><dt><i>message</i></dt>
106 <dd> 106 <dd>
107 &#109;&#101;&#115;&#115;&#97;&#103;&#101; &#116;&#111; &#98;&#101; &#115;&#101;&#110;&#116; &#116;&#111; &#111;&#98;&#106;&#101;&#99;&#116; 107 message to be sent to object
108 </dd><dt><i>candidates</i></dt> 108 </dd><dt><i>candidates</i></dt>
109 <dd> 109 <dd>
110 &#112;&#111;&#115;&#115;&#105;&#98;&#108;&#101; &#99;&#111;&#109;&#112;&#108;&#101;&#116;&#105;&#111;&#110; &#99;&#97;&#110;&#100;&#105;&#100;&#97;&#116;&#101;&#115; 110 possible completion candidates
111 </dd> 111 </dd>
112 </dl><dl> 112 </dl><dl>
113 <dt>Returns:</dt> 113 <dt>Returns:</dt>
114 <dd> 114 <dd>
115 &#102;&#105;&#108;&#116;&#101;&#114;&#101;&#100; &#108;&#105;&#115;&#116; &#111;&#102; &#99;&#97;&#110;&#100;&#105;&#100;&#97;&#116;&#101;&#115; 115 filtered list of candidates
116 </dd> 116 </dd>
117 </dl> 117 </dl>
118 <div align="right"><a href="#top">Up</a></div> 118 <div align="right"><a href="#top">Up</a></div>
119 <hr /> 119 <hr />
120 </body></html> 120 </body></html>

eric ide

mercurial