Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.E5XML.UserProjectHandler.html
Documentation/Source/eric5.E5XML.UserProjectHandler.html
- changeset 58
- 37f0444c3479
- parent 50
- a36eecf45b2e
- 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.E5XML.UserProjectHandler</h1> | 23 <h1>eric5.E5XML.UserProjectHandler</h1> |
| 24 <p> | 24 <p> |
| 25 Module implementing the handler class for reading an XML user project properties file. | 25 Module implementing the handler class for reading an XML user project properties file. |
| 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="#UserProjectHandler">UserProjectHandler</a></td> | 34 <td><a href="#UserProjectHandler">UserProjectHandler</a></td> |
| 35 <td>Class implementing a sax handler to read an XML user project properties file.</td> | 35 <td>Class implementing a sax handler to read an XML user project properties file.</td> |
| 36 </tr> | 36 </tr> |
| 37 </table> | 37 </table> |
| 38 <h3>Functions</h3> | 38 <h3>Functions</h3> |
| 39 <table> | 39 <table> |
| 40 <tr><td>None</td></tr> | 40 <tr><td>None</td></tr> |
| 41 </table> | 41 </table> |
| 42 <hr /><hr /> | 42 <hr /><hr /> |
| 43 <a NAME="UserProjectHandler" ID="UserProjectHandler"></a> | 43 <a NAME="UserProjectHandler" ID="UserProjectHandler"></a> |
| 44 <h2>UserProjectHandler</h2> | 44 <h2>UserProjectHandler</h2> |
| 45 <p> | 45 <p> |
| 46 Class implementing a sax handler to read an XML user project properties file. | 46 Class implementing a sax handler to read an XML user project properties file. |
| 47 </p> | 47 </p> |
| 48 <h3>Derived from</h3> | 48 <h3>Derived from</h3> |
| 49 XMLHandlerBase | 49 XMLHandlerBase |
| 50 <h3>Class Attributes</h3> | 50 <h3>Class Attributes</h3> |
| 51 <table> | 51 <table> |
| 53 </table> | 53 </table> |
| 54 <h3>Methods</h3> | 54 <h3>Methods</h3> |
| 55 <table> | 55 <table> |
| 56 <tr> | 56 <tr> |
| 57 <td><a href="#UserProjectHandler.__init__">UserProjectHandler</a></td> | 57 <td><a href="#UserProjectHandler.__init__">UserProjectHandler</a></td> |
| 58 <td>Constructor</td> | 58 <td>Constructor</td> |
| 59 </tr><tr> | 59 </tr><tr> |
| 60 <td><a href="#UserProjectHandler.endVcsType">endVcsType</a></td> | 60 <td><a href="#UserProjectHandler.endVcsType">endVcsType</a></td> |
| 61 <td>Handler method for the "VcsType" end tag.</td> | 61 <td>Handler method for the "VcsType" end tag.</td> |
| 62 </tr><tr> | 62 </tr><tr> |
| 63 <td><a href="#UserProjectHandler.getVersion">getVersion</a></td> | 63 <td><a href="#UserProjectHandler.getVersion">getVersion</a></td> |
| 64 <td>Public method to retrieve the version of the user project file.</td> | 64 <td>Public method to retrieve the version of the user project file.</td> |
| 65 </tr><tr> | 65 </tr><tr> |
| 66 <td><a href="#UserProjectHandler.startDocumentProject">startDocumentProject</a></td> | 66 <td><a href="#UserProjectHandler.startDocumentProject">startDocumentProject</a></td> |
| 67 <td>Handler called, when the document parsing is started.</td> | 67 <td>Handler called, when the document parsing is started.</td> |
| 68 </tr><tr> | 68 </tr><tr> |
| 69 <td><a href="#UserProjectHandler.startUserProject">startUserProject</a></td> | 69 <td><a href="#UserProjectHandler.startUserProject">startUserProject</a></td> |
| 70 <td>Handler method for the "UserProject" start tag.</td> | 70 <td>Handler method for the "UserProject" start tag.</td> |
| 71 </tr><tr> | 71 </tr><tr> |
| 72 <td><a href="#UserProjectHandler.startVcsStatusMonitorInterval">startVcsStatusMonitorInterval</a></td> | 72 <td><a href="#UserProjectHandler.startVcsStatusMonitorInterval">startVcsStatusMonitorInterval</a></td> |
| 73 <td>Handler method for the "VcsStatusMonitorInterval" start tag.</td> | 73 <td>Handler method for the "VcsStatusMonitorInterval" start tag.</td> |
| 74 </tr> | 74 </tr> |
| 75 </table> | 75 </table> |
| 76 <a NAME="UserProjectHandler.__init__" ID="UserProjectHandler.__init__"></a> | 76 <a NAME="UserProjectHandler.__init__" ID="UserProjectHandler.__init__"></a> |
| 77 <h4>UserProjectHandler (Constructor)</h4> | 77 <h4>UserProjectHandler (Constructor)</h4> |
| 78 <b>UserProjectHandler</b>(<i>project</i>) | 78 <b>UserProjectHandler</b>(<i>project</i>) |
| 79 <p> | 79 <p> |
| 80 Constructor | 80 Constructor |
| 81 </p><dl> | 81 </p><dl> |
| 82 <dt><i>project</i></dt> | 82 <dt><i>project</i></dt> |
| 83 <dd> | 83 <dd> |
| 84 Reference to the project object to store the | 84 Reference to the project object to store the |
| 85 information into. | 85 information into. |
| 86 </dd> | 86 </dd> |
| 87 </dl><a NAME="UserProjectHandler.endVcsType" ID="UserProjectHandler.endVcsType"></a> | 87 </dl><a NAME="UserProjectHandler.endVcsType" ID="UserProjectHandler.endVcsType"></a> |
| 88 <h4>UserProjectHandler.endVcsType</h4> | 88 <h4>UserProjectHandler.endVcsType</h4> |
| 89 <b>endVcsType</b>(<i></i>) | 89 <b>endVcsType</b>(<i></i>) |
| 90 <p> | 90 <p> |
| 91 Handler method for the "VcsType" end tag. | 91 Handler method for the "VcsType" end tag. |
| 92 </p><a NAME="UserProjectHandler.getVersion" ID="UserProjectHandler.getVersion"></a> | 92 </p><a NAME="UserProjectHandler.getVersion" ID="UserProjectHandler.getVersion"></a> |
| 93 <h4>UserProjectHandler.getVersion</h4> | 93 <h4>UserProjectHandler.getVersion</h4> |
| 94 <b>getVersion</b>(<i></i>) | 94 <b>getVersion</b>(<i></i>) |
| 95 <p> | 95 <p> |
| 96 Public method to retrieve the version of the user project file. | 96 Public method to retrieve the version of the user project file. |
| 97 </p><dl> | 97 </p><dl> |
| 98 <dt>Returns:</dt> | 98 <dt>Returns:</dt> |
| 99 <dd> | 99 <dd> |
| 100 String containing the version number. | 100 String containing the version number. |
| 101 </dd> | 101 </dd> |
| 102 </dl><a NAME="UserProjectHandler.startDocumentProject" ID="UserProjectHandler.startDocumentProject"></a> | 102 </dl><a NAME="UserProjectHandler.startDocumentProject" ID="UserProjectHandler.startDocumentProject"></a> |
| 103 <h4>UserProjectHandler.startDocumentProject</h4> | 103 <h4>UserProjectHandler.startDocumentProject</h4> |
| 104 <b>startDocumentProject</b>(<i></i>) | 104 <b>startDocumentProject</b>(<i></i>) |
| 105 <p> | 105 <p> |
| 106 Handler called, when the document parsing is started. | 106 Handler called, when the document parsing is started. |
| 107 </p><a NAME="UserProjectHandler.startUserProject" ID="UserProjectHandler.startUserProject"></a> | 107 </p><a NAME="UserProjectHandler.startUserProject" ID="UserProjectHandler.startUserProject"></a> |
| 108 <h4>UserProjectHandler.startUserProject</h4> | 108 <h4>UserProjectHandler.startUserProject</h4> |
| 109 <b>startUserProject</b>(<i>attrs</i>) | 109 <b>startUserProject</b>(<i>attrs</i>) |
| 110 <p> | 110 <p> |
| 111 Handler method for the "UserProject" start tag. | 111 Handler method for the "UserProject" start tag. |
| 112 </p><dl> | 112 </p><dl> |
| 113 <dt><i>attrs</i></dt> | 113 <dt><i>attrs</i></dt> |
| 114 <dd> | 114 <dd> |
| 115 list of tag attributes | 115 list of tag attributes |
| 116 </dd> | 116 </dd> |
| 117 </dl><a NAME="UserProjectHandler.startVcsStatusMonitorInterval" ID="UserProjectHandler.startVcsStatusMonitorInterval"></a> | 117 </dl><a NAME="UserProjectHandler.startVcsStatusMonitorInterval" ID="UserProjectHandler.startVcsStatusMonitorInterval"></a> |
| 118 <h4>UserProjectHandler.startVcsStatusMonitorInterval</h4> | 118 <h4>UserProjectHandler.startVcsStatusMonitorInterval</h4> |
| 119 <b>startVcsStatusMonitorInterval</b>(<i>attrs</i>) | 119 <b>startVcsStatusMonitorInterval</b>(<i>attrs</i>) |
| 120 <p> | 120 <p> |
| 121 Handler method for the "VcsStatusMonitorInterval" start tag. | 121 Handler method for the "VcsStatusMonitorInterval" start tag. |
| 122 </p><dl> | 122 </p><dl> |
| 123 <dt><i>attrs</i></dt> | 123 <dt><i>attrs</i></dt> |
| 124 <dd> | 124 <dd> |
| 125 list of tag attributes | 125 list of tag attributes |
| 126 </dd> | 126 </dd> |
| 127 </dl> | 127 </dl> |
| 128 <div align="right"><a href="#top">Up</a></div> | 128 <div align="right"><a href="#top">Up</a></div> |
| 129 <hr /> | 129 <hr /> |
| 130 </body></html> | 130 </body></html> |
