Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.MultiProject.MultiProjectBrowser.html
Documentation/Source/eric5.MultiProject.MultiProjectBrowser.html
- changeset 17
- edde1fe80b3e
- child 21
- b88a0e6268bd
equal
deleted
inserted
replaced
| 16:892c1787d666 | 17:edde1fe80b3e |
|---|---|
| 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.MultiProject.MultiProjectBrowser</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.MultiProject.MultiProjectBrowser</h1> | |
| 12 <p> | |
| 13 Module implementing the multi project browser. | |
| 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="#MultiProjectBrowser">MultiProjectBrowser</a></td> | |
| 23 <td>Class implementing the multi project browser.</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="MultiProjectBrowser" ID="MultiProjectBrowser"></a> | |
| 32 <h2>MultiProjectBrowser</h2> | |
| 33 <p> | |
| 34 Class implementing the multi project browser. | |
| 35 </p> | |
| 36 <h3>Derived from</h3> | |
| 37 QListWidget | |
| 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="#MultiProjectBrowser.__init__">MultiProjectBrowser</a></td> | |
| 46 <td>Constructor</td> | |
| 47 </tr><tr> | |
| 48 <td><a href="#MultiProjectBrowser.__addProject">__addProject</a></td> | |
| 49 <td>Private method to add a project to the list.</td> | |
| 50 </tr><tr> | |
| 51 <td><a href="#MultiProjectBrowser.__configure">__configure</a></td> | |
| 52 <td>Private method to open the configuration dialog.</td> | |
| 53 </tr><tr> | |
| 54 <td><a href="#MultiProjectBrowser.__contextMenuRequested">__contextMenuRequested</a></td> | |
| 55 <td>Private slot to show the context menu.</td> | |
| 56 </tr><tr> | |
| 57 <td><a href="#MultiProjectBrowser.__createPopupMenu">__createPopupMenu</a></td> | |
| 58 <td>Private method to create the popup menu.</td> | |
| 59 </tr><tr> | |
| 60 <td><a href="#MultiProjectBrowser.__findProjectItem">__findProjectItem</a></td> | |
| 61 <td>Private method to search a specific project item.</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#MultiProjectBrowser.__multiProjectClosed">__multiProjectClosed</a></td> | |
| 64 <td>Private slot to handle the closing of a multi project.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#MultiProjectBrowser.__multiProjectOpened">__multiProjectOpened</a></td> | |
| 67 <td>Private slot to handle the opening of a multi project.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#MultiProjectBrowser.__newMultiProject">__newMultiProject</a></td> | |
| 70 <td>Private slot to handle the creation of a new multi project.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#MultiProjectBrowser.__openItem">__openItem</a></td> | |
| 73 <td>Private slot to open a project.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#MultiProjectBrowser.__projectAdded">__projectAdded</a></td> | |
| 76 <td>Private slot to handle the addition of a project to the multi project.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#MultiProjectBrowser.__projectDataChanged">__projectDataChanged</a></td> | |
| 79 <td>Private slot to handle the change of a project of the multi project.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#MultiProjectBrowser.__projectOpened">__projectOpened</a></td> | |
| 82 <td>Private slot to handle the opening of a project.</td> | |
| 83 </tr><tr> | |
| 84 <td><a href="#MultiProjectBrowser.__projectRemoved">__projectRemoved</a></td> | |
| 85 <td>Private slot to handle the removal of a project from the multi project.</td> | |
| 86 </tr><tr> | |
| 87 <td><a href="#MultiProjectBrowser.__removeProject">__removeProject</a></td> | |
| 88 <td>Private method to handle the Remove context menu entry.</td> | |
| 89 </tr><tr> | |
| 90 <td><a href="#MultiProjectBrowser.__setItemData">__setItemData</a></td> | |
| 91 <td>Private method to set the data of a project item.</td> | |
| 92 </tr><tr> | |
| 93 <td><a href="#MultiProjectBrowser.__showProjectProperties">__showProjectProperties</a></td> | |
| 94 <td>Private method to show the data of a project entry.</td> | |
| 95 </tr> | |
| 96 </table> | |
| 97 <a NAME="MultiProjectBrowser.__init__" ID="MultiProjectBrowser.__init__"></a> | |
| 98 <h4>MultiProjectBrowser (Constructor)</h4> | |
| 99 <b>MultiProjectBrowser</b>(<i>multiProject, parent = None</i>) | |
| 100 <p> | |
| 101 Constructor | |
| 102 </p><dl> | |
| 103 <dt><i>project</i></dt> | |
| 104 <dd> | |
| 105 reference to the multi project object | |
| 106 </dd><dt><i>parent</i></dt> | |
| 107 <dd> | |
| 108 parent widget (QWidget) | |
| 109 </dd> | |
| 110 </dl><a NAME="MultiProjectBrowser.__addProject" ID="MultiProjectBrowser.__addProject"></a> | |
| 111 <h4>MultiProjectBrowser.__addProject</h4> | |
| 112 <b>__addProject</b>(<i>project</i>) | |
| 113 <p> | |
| 114 Private method to add a project to the list. | |
| 115 </p><dl> | |
| 116 <dt><i>project</i></dt> | |
| 117 <dd> | |
| 118 reference to the project data dictionary | |
| 119 </dd> | |
| 120 </dl><a NAME="MultiProjectBrowser.__configure" ID="MultiProjectBrowser.__configure"></a> | |
| 121 <h4>MultiProjectBrowser.__configure</h4> | |
| 122 <b>__configure</b>(<i></i>) | |
| 123 <p> | |
| 124 Private method to open the configuration dialog. | |
| 125 </p><a NAME="MultiProjectBrowser.__contextMenuRequested" ID="MultiProjectBrowser.__contextMenuRequested"></a> | |
| 126 <h4>MultiProjectBrowser.__contextMenuRequested</h4> | |
| 127 <b>__contextMenuRequested</b>(<i>coord</i>) | |
| 128 <p> | |
| 129 Private slot to show the context menu. | |
| 130 </p><dl> | |
| 131 <dt><i>coord</i></dt> | |
| 132 <dd> | |
| 133 the position of the mouse pointer (QPoint) | |
| 134 </dd> | |
| 135 </dl><a NAME="MultiProjectBrowser.__createPopupMenu" ID="MultiProjectBrowser.__createPopupMenu"></a> | |
| 136 <h4>MultiProjectBrowser.__createPopupMenu</h4> | |
| 137 <b>__createPopupMenu</b>(<i></i>) | |
| 138 <p> | |
| 139 Private method to create the popup menu. | |
| 140 </p><a NAME="MultiProjectBrowser.__findProjectItem" ID="MultiProjectBrowser.__findProjectItem"></a> | |
| 141 <h4>MultiProjectBrowser.__findProjectItem</h4> | |
| 142 <b>__findProjectItem</b>(<i>project</i>) | |
| 143 <p> | |
| 144 Private method to search a specific project item. | |
| 145 </p><dl> | |
| 146 <dt><i>project</i></dt> | |
| 147 <dd> | |
| 148 reference to the project data dictionary | |
| 149 </dd> | |
| 150 </dl><dl> | |
| 151 <dt>Returns:</dt> | |
| 152 <dd> | |
| 153 row number of the project, -1 if not found (integer) | |
| 154 </dd> | |
| 155 </dl><a NAME="MultiProjectBrowser.__multiProjectClosed" ID="MultiProjectBrowser.__multiProjectClosed"></a> | |
| 156 <h4>MultiProjectBrowser.__multiProjectClosed</h4> | |
| 157 <b>__multiProjectClosed</b>(<i></i>) | |
| 158 <p> | |
| 159 Private slot to handle the closing of a multi project. | |
| 160 </p><a NAME="MultiProjectBrowser.__multiProjectOpened" ID="MultiProjectBrowser.__multiProjectOpened"></a> | |
| 161 <h4>MultiProjectBrowser.__multiProjectOpened</h4> | |
| 162 <b>__multiProjectOpened</b>(<i></i>) | |
| 163 <p> | |
| 164 Private slot to handle the opening of a multi project. | |
| 165 </p><a NAME="MultiProjectBrowser.__newMultiProject" ID="MultiProjectBrowser.__newMultiProject"></a> | |
| 166 <h4>MultiProjectBrowser.__newMultiProject</h4> | |
| 167 <b>__newMultiProject</b>(<i></i>) | |
| 168 <p> | |
| 169 Private slot to handle the creation of a new multi project. | |
| 170 </p><a NAME="MultiProjectBrowser.__openItem" ID="MultiProjectBrowser.__openItem"></a> | |
| 171 <h4>MultiProjectBrowser.__openItem</h4> | |
| 172 <b>__openItem</b>(<i>itm = None</i>) | |
| 173 <p> | |
| 174 Private slot to open a project. | |
| 175 </p><dl> | |
| 176 <dt><i>itm</i></dt> | |
| 177 <dd> | |
| 178 reference to the project item to be opened (QListWidgetItem) | |
| 179 </dd> | |
| 180 </dl><a NAME="MultiProjectBrowser.__projectAdded" ID="MultiProjectBrowser.__projectAdded"></a> | |
| 181 <h4>MultiProjectBrowser.__projectAdded</h4> | |
| 182 <b>__projectAdded</b>(<i>project</i>) | |
| 183 <p> | |
| 184 Private slot to handle the addition of a project to the multi project. | |
| 185 </p><dl> | |
| 186 <dt><i>project</i></dt> | |
| 187 <dd> | |
| 188 reference to the project data dictionary | |
| 189 </dd> | |
| 190 </dl><a NAME="MultiProjectBrowser.__projectDataChanged" ID="MultiProjectBrowser.__projectDataChanged"></a> | |
| 191 <h4>MultiProjectBrowser.__projectDataChanged</h4> | |
| 192 <b>__projectDataChanged</b>(<i>project</i>) | |
| 193 <p> | |
| 194 Private slot to handle the change of a project of the multi project. | |
| 195 </p><dl> | |
| 196 <dt><i>project</i></dt> | |
| 197 <dd> | |
| 198 reference to the project data dictionary | |
| 199 </dd> | |
| 200 </dl><a NAME="MultiProjectBrowser.__projectOpened" ID="MultiProjectBrowser.__projectOpened"></a> | |
| 201 <h4>MultiProjectBrowser.__projectOpened</h4> | |
| 202 <b>__projectOpened</b>(<i>projectfile</i>) | |
| 203 <p> | |
| 204 Private slot to handle the opening of a project. | |
| 205 </p><a NAME="MultiProjectBrowser.__projectRemoved" ID="MultiProjectBrowser.__projectRemoved"></a> | |
| 206 <h4>MultiProjectBrowser.__projectRemoved</h4> | |
| 207 <b>__projectRemoved</b>(<i>project</i>) | |
| 208 <p> | |
| 209 Private slot to handle the removal of a project from the multi project. | |
| 210 </p><dl> | |
| 211 <dt><i>project</i></dt> | |
| 212 <dd> | |
| 213 reference to the project data dictionary | |
| 214 </dd> | |
| 215 </dl><a NAME="MultiProjectBrowser.__removeProject" ID="MultiProjectBrowser.__removeProject"></a> | |
| 216 <h4>MultiProjectBrowser.__removeProject</h4> | |
| 217 <b>__removeProject</b>(<i></i>) | |
| 218 <p> | |
| 219 Private method to handle the Remove context menu entry. | |
| 220 </p><a NAME="MultiProjectBrowser.__setItemData" ID="MultiProjectBrowser.__setItemData"></a> | |
| 221 <h4>MultiProjectBrowser.__setItemData</h4> | |
| 222 <b>__setItemData</b>(<i>itm, project</i>) | |
| 223 <p> | |
| 224 Private method to set the data of a project item. | |
| 225 </p><dl> | |
| 226 <dt><i>itm</i></dt> | |
| 227 <dd> | |
| 228 reference to the item to be set (QListWidgetItem) | |
| 229 </dd><dt><i>project</i></dt> | |
| 230 <dd> | |
| 231 reference to the project data dictionary | |
| 232 </dd> | |
| 233 </dl><a NAME="MultiProjectBrowser.__showProjectProperties" ID="MultiProjectBrowser.__showProjectProperties"></a> | |
| 234 <h4>MultiProjectBrowser.__showProjectProperties</h4> | |
| 235 <b>__showProjectProperties</b>(<i></i>) | |
| 236 <p> | |
| 237 Private method to show the data of a project entry. | |
| 238 </p> | |
| 239 <div align="right"><a href="#top">Up</a></div> | |
| 240 <hr /> | |
| 241 </body></html> |
