Mercurial Repositories > Kivy Project / file comparison
comparison: ProjectKivy/Documentation/source/Plugin_Project_Kivy.ProjectKivy.CompleterKivy.html
ProjectKivy/Documentation/source/Plugin_Project_Kivy.ProjectKivy.CompleterKivy.html
- branch
- eric7
- changeset 59
- fb361b396c68
equal
deleted
inserted
replaced
| 58:610af455ef9a | 59:fb361b396c68 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>Plugin_Project_Kivy.ProjectKivy.CompleterKivy</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>Plugin_Project_Kivy.ProjectKivy.CompleterKivy</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the Kivy typing completer. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#CompleterKivy">CompleterKivy</a></td> | |
| 25 <td>Class implementing the Kivy typing completer.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <hr /> | |
| 34 <hr /> | |
| 35 <a NAME="CompleterKivy" ID="CompleterKivy"></a> | |
| 36 <h2>CompleterKivy</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing the Kivy typing completer. | |
| 40 </p> | |
| 41 <h3>Derived from</h3> | |
| 42 CompleterBase | |
| 43 <h3>Class Attributes</h3> | |
| 44 | |
| 45 <table> | |
| 46 <tr><td>None</td></tr> | |
| 47 </table> | |
| 48 <h3>Class Methods</h3> | |
| 49 | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Methods</h3> | |
| 54 | |
| 55 <table> | |
| 56 | |
| 57 <tr> | |
| 58 <td><a href="#CompleterKivy.__init__">CompleterKivy</a></td> | |
| 59 <td>Constructor</td> | |
| 60 </tr> | |
| 61 <tr> | |
| 62 <td><a href="#CompleterKivy.__inComment">__inComment</a></td> | |
| 63 <td>Private method to check, if the cursor is inside a comment.</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#CompleterKivy.charAdded">charAdded</a></td> | |
| 67 <td>Public slot called to handle the user entering a character.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#CompleterKivy.readSettings">readSettings</a></td> | |
| 71 <td>Public slot called to reread the configuration parameters.</td> | |
| 72 </tr> | |
| 73 </table> | |
| 74 <h3>Static Methods</h3> | |
| 75 | |
| 76 <table> | |
| 77 <tr><td>None</td></tr> | |
| 78 </table> | |
| 79 | |
| 80 <a NAME="CompleterKivy.__init__" ID="CompleterKivy.__init__"></a> | |
| 81 <h4>CompleterKivy (Constructor)</h4> | |
| 82 <b>CompleterKivy</b>(<i>plugin, editor, parent=None</i>) | |
| 83 | |
| 84 <p> | |
| 85 Constructor | |
| 86 </p> | |
| 87 <dl> | |
| 88 | |
| 89 <dt><i>plugin</i> (ProjectKivyPlugin)</dt> | |
| 90 <dd> | |
| 91 reference to the plugin object | |
| 92 </dd> | |
| 93 <dt><i>editor</i> (Editor)</dt> | |
| 94 <dd> | |
| 95 reference to the editor object | |
| 96 </dd> | |
| 97 <dt><i>parent</i> (QObject)</dt> | |
| 98 <dd> | |
| 99 reference to the parent object | |
| 100 </dd> | |
| 101 </dl> | |
| 102 <a NAME="CompleterKivy.__inComment" ID="CompleterKivy.__inComment"></a> | |
| 103 <h4>CompleterKivy.__inComment</h4> | |
| 104 <b>__inComment</b>(<i>line, col</i>) | |
| 105 | |
| 106 <p> | |
| 107 Private method to check, if the cursor is inside a comment. | |
| 108 </p> | |
| 109 <dl> | |
| 110 | |
| 111 <dt><i>line</i> (int)</dt> | |
| 112 <dd> | |
| 113 current line | |
| 114 </dd> | |
| 115 <dt><i>col</i> (int)</dt> | |
| 116 <dd> | |
| 117 current position within line | |
| 118 </dd> | |
| 119 </dl> | |
| 120 <dl> | |
| 121 <dt>Return:</dt> | |
| 122 <dd> | |
| 123 flag indicating, if the cursor is inside a comment | |
| 124 </dd> | |
| 125 </dl> | |
| 126 <dl> | |
| 127 <dt>Return Type:</dt> | |
| 128 <dd> | |
| 129 bool | |
| 130 </dd> | |
| 131 </dl> | |
| 132 <a NAME="CompleterKivy.charAdded" ID="CompleterKivy.charAdded"></a> | |
| 133 <h4>CompleterKivy.charAdded</h4> | |
| 134 <b>charAdded</b>(<i>charNumber</i>) | |
| 135 | |
| 136 <p> | |
| 137 Public slot called to handle the user entering a character. | |
| 138 </p> | |
| 139 <dl> | |
| 140 | |
| 141 <dt><i>charNumber</i> (int)</dt> | |
| 142 <dd> | |
| 143 value of the character entered | |
| 144 </dd> | |
| 145 </dl> | |
| 146 <a NAME="CompleterKivy.readSettings" ID="CompleterKivy.readSettings"></a> | |
| 147 <h4>CompleterKivy.readSettings</h4> | |
| 148 <b>readSettings</b>(<i></i>) | |
| 149 | |
| 150 <p> | |
| 151 Public slot called to reread the configuration parameters. | |
| 152 </p> | |
| 153 <div align="right"><a href="#top">Up</a></div> | |
| 154 <hr /> | |
| 155 </body></html> |
