|
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.E4XML.UserProjectHandler</title> |
|
6 <style> |
|
7 b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' |
|
8 </style> |
|
9 </head> |
|
10 <body><a NAME="top" ID="top"></a> |
|
11 <h1>eric5.E4XML.UserProjectHandler</h1> |
|
12 <p> |
|
13 Module implementing the handler class for reading an XML user project properties file. |
|
14 </p> |
|
15 <h3>Global Attributes</h3> |
|
16 <table> |
|
17 <tr><td>None</td></tr> |
|
18 </table> |
|
19 <h3>Classes</h3> |
|
20 <table> |
|
21 <tr> |
|
22 <td><a href="#UserProjectHandler">UserProjectHandler</a></td> |
|
23 <td>Class implementing a sax handler to read an XML user project properties file.</td> |
|
24 </tr> |
|
25 </table> |
|
26 <h3>Functions</h3> |
|
27 <table> |
|
28 <tr><td>None</td></tr> |
|
29 </table> |
|
30 <hr /><hr /> |
|
31 <a NAME="UserProjectHandler" ID="UserProjectHandler"></a> |
|
32 <h2>UserProjectHandler</h2> |
|
33 <p> |
|
34 Class implementing a sax handler to read an XML user project properties file. |
|
35 </p> |
|
36 <h3>Derived from</h3> |
|
37 XMLHandlerBase |
|
38 <h3>Class Attributes</h3> |
|
39 <table> |
|
40 <tr><td>None</td></tr> |
|
41 </table> |
|
42 <h3>Methods</h3> |
|
43 <table> |
|
44 <tr> |
|
45 <td><a href="#UserProjectHandler.__init__">UserProjectHandler</a></td> |
|
46 <td>Constructor</td> |
|
47 </tr><tr> |
|
48 <td><a href="#UserProjectHandler.endVcsType">endVcsType</a></td> |
|
49 <td>Handler method for the "VcsType" end tag.</td> |
|
50 </tr><tr> |
|
51 <td><a href="#UserProjectHandler.getVersion">getVersion</a></td> |
|
52 <td>Public method to retrieve the version of the user project file.</td> |
|
53 </tr><tr> |
|
54 <td><a href="#UserProjectHandler.startDocumentProject">startDocumentProject</a></td> |
|
55 <td>Handler called, when the document parsing is started.</td> |
|
56 </tr><tr> |
|
57 <td><a href="#UserProjectHandler.startUserProject">startUserProject</a></td> |
|
58 <td>Handler method for the "UserProject" start tag.</td> |
|
59 </tr><tr> |
|
60 <td><a href="#UserProjectHandler.startVcsStatusMonitorInterval">startVcsStatusMonitorInterval</a></td> |
|
61 <td>Handler method for the "VcsStatusMonitorInterval" start tag.</td> |
|
62 </tr> |
|
63 </table> |
|
64 <a NAME="UserProjectHandler.__init__" ID="UserProjectHandler.__init__"></a> |
|
65 <h4>UserProjectHandler (Constructor)</h4> |
|
66 <b>UserProjectHandler</b>(<i>project</i>) |
|
67 <p> |
|
68 Constructor |
|
69 </p><dl> |
|
70 <dt><i>project</i></dt> |
|
71 <dd> |
|
72 Reference to the project object to store the |
|
73 information into. |
|
74 </dd> |
|
75 </dl><a NAME="UserProjectHandler.endVcsType" ID="UserProjectHandler.endVcsType"></a> |
|
76 <h4>UserProjectHandler.endVcsType</h4> |
|
77 <b>endVcsType</b>(<i></i>) |
|
78 <p> |
|
79 Handler method for the "VcsType" end tag. |
|
80 </p><a NAME="UserProjectHandler.getVersion" ID="UserProjectHandler.getVersion"></a> |
|
81 <h4>UserProjectHandler.getVersion</h4> |
|
82 <b>getVersion</b>(<i></i>) |
|
83 <p> |
|
84 Public method to retrieve the version of the user project file. |
|
85 </p><dl> |
|
86 <dt>Returns:</dt> |
|
87 <dd> |
|
88 String containing the version number. |
|
89 </dd> |
|
90 </dl><a NAME="UserProjectHandler.startDocumentProject" ID="UserProjectHandler.startDocumentProject"></a> |
|
91 <h4>UserProjectHandler.startDocumentProject</h4> |
|
92 <b>startDocumentProject</b>(<i></i>) |
|
93 <p> |
|
94 Handler called, when the document parsing is started. |
|
95 </p><a NAME="UserProjectHandler.startUserProject" ID="UserProjectHandler.startUserProject"></a> |
|
96 <h4>UserProjectHandler.startUserProject</h4> |
|
97 <b>startUserProject</b>(<i>attrs</i>) |
|
98 <p> |
|
99 Handler method for the "UserProject" start tag. |
|
100 </p><dl> |
|
101 <dt><i>attrs</i></dt> |
|
102 <dd> |
|
103 list of tag attributes |
|
104 </dd> |
|
105 </dl><a NAME="UserProjectHandler.startVcsStatusMonitorInterval" ID="UserProjectHandler.startVcsStatusMonitorInterval"></a> |
|
106 <h4>UserProjectHandler.startVcsStatusMonitorInterval</h4> |
|
107 <b>startVcsStatusMonitorInterval</b>(<i>attrs</i>) |
|
108 <p> |
|
109 Handler method for the "VcsStatusMonitorInterval" start tag. |
|
110 </p><dl> |
|
111 <dt><i>attrs</i></dt> |
|
112 <dd> |
|
113 list of tag attributes |
|
114 </dd> |
|
115 </dl> |
|
116 <div align="right"><a href="#top">Up</a></div> |
|
117 <hr /> |
|
118 </body></html> |