Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.E5XML.TasksHandler.html
Documentation/Source/eric5.E5XML.TasksHandler.html
- changeset 585
- f40889943c0a
- parent 584
- b5d4c116952a
- child 586
- 9dbffeed66a9
equal
deleted
inserted
replaced
| 584:b5d4c116952a | 585:f40889943c0a |
|---|---|
| 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.E5XML.TasksHandler</title> | |
| 6 <style> | |
| 7 body { | |
| 8 background: #EDECE6; | |
| 9 margin: 0em 1em 10em 1em; | |
| 10 color: black; | |
| 11 } | |
| 12 | |
| 13 h1 { color: white; background: #85774A; } | |
| 14 h2 { color: white; background: #85774A; } | |
| 15 h3 { color: white; background: #9D936E; } | |
| 16 h4 { color: white; background: #9D936E; } | |
| 17 | |
| 18 a { color: #BA6D36; } | |
| 19 | |
| 20 </style> | |
| 21 </head> | |
| 22 <body><a NAME="top" ID="top"></a> | |
| 23 <h1>eric5.E5XML.TasksHandler</h1> | |
| 24 <p> | |
| 25 Module implementing the handler class for reading an XML tasks file. | |
| 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="#TasksHandler">TasksHandler</a></td> | |
| 35 <td>Class implementing a sax handler to read an XML tasks file.</td> | |
| 36 </tr> | |
| 37 </table> | |
| 38 <h3>Functions</h3> | |
| 39 <table> | |
| 40 <tr><td>None</td></tr> | |
| 41 </table> | |
| 42 <hr /><hr /> | |
| 43 <a NAME="TasksHandler" ID="TasksHandler"></a> | |
| 44 <h2>TasksHandler</h2> | |
| 45 <p> | |
| 46 Class implementing a sax handler to read an XML tasks file. | |
| 47 </p> | |
| 48 <h3>Derived from</h3> | |
| 49 XMLHandlerBase | |
| 50 <h3>Class Attributes</h3> | |
| 51 <table> | |
| 52 <tr><td>None</td></tr> | |
| 53 </table> | |
| 54 <h3>Methods</h3> | |
| 55 <table> | |
| 56 <tr> | |
| 57 <td><a href="#TasksHandler.__init__">TasksHandler</a></td> | |
| 58 <td>Constructor</td> | |
| 59 </tr><tr> | |
| 60 <td><a href="#TasksHandler.__buildPath">__buildPath</a></td> | |
| 61 <td>Private method to assemble a path.</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#TasksHandler.endCreated">endCreated</a></td> | |
| 64 <td>Handler method for the "Created" end tag.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#TasksHandler.endDescription">endDescription</a></td> | |
| 67 <td>Handler method for the "Description" end tag.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#TasksHandler.endDir">endDir</a></td> | |
| 70 <td>Handler method for the "Dir" end tag.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#TasksHandler.endFilename">endFilename</a></td> | |
| 73 <td>Handler method for the "Filename" end tag.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#TasksHandler.endLinenumber">endLinenumber</a></td> | |
| 76 <td>Handler method for the "Linenumber" end tag.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#TasksHandler.endName">endName</a></td> | |
| 79 <td>Handler method for the "Name" end tag.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#TasksHandler.endSummary">endSummary</a></td> | |
| 82 <td>Handler method for the "Summary" end tag.</td> | |
| 83 </tr><tr> | |
| 84 <td><a href="#TasksHandler.endTask">endTask</a></td> | |
| 85 <td>Handler method for the "Task" end tag.</td> | |
| 86 </tr><tr> | |
| 87 <td><a href="#TasksHandler.getVersion">getVersion</a></td> | |
| 88 <td>Public method to retrieve the version of the tasks file.</td> | |
| 89 </tr><tr> | |
| 90 <td><a href="#TasksHandler.startDocumentTasks">startDocumentTasks</a></td> | |
| 91 <td>Handler called, when the document parsing is started.</td> | |
| 92 </tr><tr> | |
| 93 <td><a href="#TasksHandler.startFilename">startFilename</a></td> | |
| 94 <td>Handler method for the "Filename" start tag.</td> | |
| 95 </tr><tr> | |
| 96 <td><a href="#TasksHandler.startTask">startTask</a></td> | |
| 97 <td>Handler method for the "Task" start tag.</td> | |
| 98 </tr><tr> | |
| 99 <td><a href="#TasksHandler.startTasks">startTasks</a></td> | |
| 100 <td>Handler method for the "Tasks" start tag.</td> | |
| 101 </tr> | |
| 102 </table> | |
| 103 <a NAME="TasksHandler.__init__" ID="TasksHandler.__init__"></a> | |
| 104 <h4>TasksHandler (Constructor)</h4> | |
| 105 <b>TasksHandler</b>(<i>forProject = False, taskViewer=None</i>) | |
| 106 <p> | |
| 107 Constructor | |
| 108 </p><dl> | |
| 109 <dt><i>forProject</i></dt> | |
| 110 <dd> | |
| 111 flag indicating project related mode (boolean) | |
| 112 </dd><dt><i>taskViewer</i></dt> | |
| 113 <dd> | |
| 114 reference to the task viewer object | |
| 115 </dd> | |
| 116 </dl><a NAME="TasksHandler.__buildPath" ID="TasksHandler.__buildPath"></a> | |
| 117 <h4>TasksHandler.__buildPath</h4> | |
| 118 <b>__buildPath</b>(<i></i>) | |
| 119 <p> | |
| 120 Private method to assemble a path. | |
| 121 </p><dl> | |
| 122 <dt>Returns:</dt> | |
| 123 <dd> | |
| 124 The ready assembled path. (string) | |
| 125 </dd> | |
| 126 </dl><a NAME="TasksHandler.endCreated" ID="TasksHandler.endCreated"></a> | |
| 127 <h4>TasksHandler.endCreated</h4> | |
| 128 <b>endCreated</b>(<i></i>) | |
| 129 <p> | |
| 130 Handler method for the "Created" end tag. | |
| 131 </p><a NAME="TasksHandler.endDescription" ID="TasksHandler.endDescription"></a> | |
| 132 <h4>TasksHandler.endDescription</h4> | |
| 133 <b>endDescription</b>(<i></i>) | |
| 134 <p> | |
| 135 Handler method for the "Description" end tag. | |
| 136 </p><a NAME="TasksHandler.endDir" ID="TasksHandler.endDir"></a> | |
| 137 <h4>TasksHandler.endDir</h4> | |
| 138 <b>endDir</b>(<i></i>) | |
| 139 <p> | |
| 140 Handler method for the "Dir" end tag. | |
| 141 </p><a NAME="TasksHandler.endFilename" ID="TasksHandler.endFilename"></a> | |
| 142 <h4>TasksHandler.endFilename</h4> | |
| 143 <b>endFilename</b>(<i></i>) | |
| 144 <p> | |
| 145 Handler method for the "Filename" end tag. | |
| 146 </p><a NAME="TasksHandler.endLinenumber" ID="TasksHandler.endLinenumber"></a> | |
| 147 <h4>TasksHandler.endLinenumber</h4> | |
| 148 <b>endLinenumber</b>(<i></i>) | |
| 149 <p> | |
| 150 Handler method for the "Linenumber" end tag. | |
| 151 </p><a NAME="TasksHandler.endName" ID="TasksHandler.endName"></a> | |
| 152 <h4>TasksHandler.endName</h4> | |
| 153 <b>endName</b>(<i></i>) | |
| 154 <p> | |
| 155 Handler method for the "Name" end tag. | |
| 156 </p><a NAME="TasksHandler.endSummary" ID="TasksHandler.endSummary"></a> | |
| 157 <h4>TasksHandler.endSummary</h4> | |
| 158 <b>endSummary</b>(<i></i>) | |
| 159 <p> | |
| 160 Handler method for the "Summary" end tag. | |
| 161 </p><a NAME="TasksHandler.endTask" ID="TasksHandler.endTask"></a> | |
| 162 <h4>TasksHandler.endTask</h4> | |
| 163 <b>endTask</b>(<i></i>) | |
| 164 <p> | |
| 165 Handler method for the "Task" end tag. | |
| 166 </p><a NAME="TasksHandler.getVersion" ID="TasksHandler.getVersion"></a> | |
| 167 <h4>TasksHandler.getVersion</h4> | |
| 168 <b>getVersion</b>(<i></i>) | |
| 169 <p> | |
| 170 Public method to retrieve the version of the tasks file. | |
| 171 </p><dl> | |
| 172 <dt>Returns:</dt> | |
| 173 <dd> | |
| 174 String containing the version number. | |
| 175 </dd> | |
| 176 </dl><a NAME="TasksHandler.startDocumentTasks" ID="TasksHandler.startDocumentTasks"></a> | |
| 177 <h4>TasksHandler.startDocumentTasks</h4> | |
| 178 <b>startDocumentTasks</b>(<i></i>) | |
| 179 <p> | |
| 180 Handler called, when the document parsing is started. | |
| 181 </p><a NAME="TasksHandler.startFilename" ID="TasksHandler.startFilename"></a> | |
| 182 <h4>TasksHandler.startFilename</h4> | |
| 183 <b>startFilename</b>(<i>attrs</i>) | |
| 184 <p> | |
| 185 Handler method for the "Filename" start tag. | |
| 186 </p><dl> | |
| 187 <dt><i>attrs</i></dt> | |
| 188 <dd> | |
| 189 list of tag attributes | |
| 190 </dd> | |
| 191 </dl><a NAME="TasksHandler.startTask" ID="TasksHandler.startTask"></a> | |
| 192 <h4>TasksHandler.startTask</h4> | |
| 193 <b>startTask</b>(<i>attrs</i>) | |
| 194 <p> | |
| 195 Handler method for the "Task" start tag. | |
| 196 </p><dl> | |
| 197 <dt><i>attrs</i></dt> | |
| 198 <dd> | |
| 199 list of tag attributes | |
| 200 </dd> | |
| 201 </dl><a NAME="TasksHandler.startTasks" ID="TasksHandler.startTasks"></a> | |
| 202 <h4>TasksHandler.startTasks</h4> | |
| 203 <b>startTasks</b>(<i>attrs</i>) | |
| 204 <p> | |
| 205 Handler method for the "Tasks" start tag. | |
| 206 </p><dl> | |
| 207 <dt><i>attrs</i></dt> | |
| 208 <dd> | |
| 209 list of tag attributes | |
| 210 </dd> | |
| 211 </dl> | |
| 212 <div align="right"><a href="#top">Up</a></div> | |
| 213 <hr /> | |
| 214 </body></html> |
