Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.BookmarksExtension.ProjectHelper.html
Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.BookmarksExtension.ProjectHelper.html
- changeset 1020
- adf7e95f05e7
- child 1064
- 10bdbb173c0f
equal
deleted
inserted
replaced
| 1019:d8a9697f78d1 | 1020:adf7e95f05e7 |
|---|---|
| 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.Plugins.VcsPlugins.vcsMercurial.BookmarksExtension.ProjectHelper</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.Plugins.VcsPlugins.vcsMercurial.BookmarksExtension.ProjectHelper</h1> | |
| 24 <p> | |
| 25 Module implementing the bookmarks extension project helper. | |
| 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="#BookmarksProjectHelper">BookmarksProjectHelper</a></td> | |
| 35 <td>Class implementing the bookmarks extension project helper.</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="BookmarksProjectHelper" ID="BookmarksProjectHelper"></a> | |
| 44 <h2>BookmarksProjectHelper</h2> | |
| 45 <p> | |
| 46 Class implementing the bookmarks extension project helper. | |
| 47 </p> | |
| 48 <h3>Derived from</h3> | |
| 49 QObject | |
| 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="#BookmarksProjectHelper.__init__">BookmarksProjectHelper</a></td> | |
| 58 <td>Constructor</td> | |
| 59 </tr><tr> | |
| 60 <td><a href="#BookmarksProjectHelper.__hgBookmarkDefine">__hgBookmarkDefine</a></td> | |
| 61 <td>Private slot used to define a bookmark.</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#BookmarksProjectHelper.__hgBookmarkDelete">__hgBookmarkDelete</a></td> | |
| 64 <td>Private slot used to delete a bookmark.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#BookmarksProjectHelper.__hgBookmarkIncoming">__hgBookmarkIncoming</a></td> | |
| 67 <td>Private slot used to show a list of incoming bookmarks.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#BookmarksProjectHelper.__hgBookmarkMove">__hgBookmarkMove</a></td> | |
| 70 <td>Private slot used to move a bookmark.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#BookmarksProjectHelper.__hgBookmarkOutgoing">__hgBookmarkOutgoing</a></td> | |
| 73 <td>Private slot used to show a list of outgoing bookmarks.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#BookmarksProjectHelper.__hgBookmarkPull">__hgBookmarkPull</a></td> | |
| 76 <td>Private slot used to pull a bookmark from a remote repository.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#BookmarksProjectHelper.__hgBookmarkPush">__hgBookmarkPush</a></td> | |
| 79 <td>Private slot used to push a bookmark to a remote repository.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#BookmarksProjectHelper.__hgBookmarkRename">__hgBookmarkRename</a></td> | |
| 82 <td>Private slot used to rename a bookmark.</td> | |
| 83 </tr><tr> | |
| 84 <td><a href="#BookmarksProjectHelper.__hgBookmarksList">__hgBookmarksList</a></td> | |
| 85 <td>Private slot used to list the bookmarks.</td> | |
| 86 </tr><tr> | |
| 87 <td><a href="#BookmarksProjectHelper.getActions">getActions</a></td> | |
| 88 <td>Public method to get a list of all actions.</td> | |
| 89 </tr><tr> | |
| 90 <td><a href="#BookmarksProjectHelper.initActions">initActions</a></td> | |
| 91 <td>Public method to generate the action objects.</td> | |
| 92 </tr><tr> | |
| 93 <td><a href="#BookmarksProjectHelper.initMenu">initMenu</a></td> | |
| 94 <td>Public method to generate the VCS menu.</td> | |
| 95 </tr><tr> | |
| 96 <td><a href="#BookmarksProjectHelper.setObjects">setObjects</a></td> | |
| 97 <td>Public method to set references to the vcs and project objects.</td> | |
| 98 </tr> | |
| 99 </table> | |
| 100 <a NAME="BookmarksProjectHelper.__init__" ID="BookmarksProjectHelper.__init__"></a> | |
| 101 <h4>BookmarksProjectHelper (Constructor)</h4> | |
| 102 <b>BookmarksProjectHelper</b>(<i></i>) | |
| 103 <p> | |
| 104 Constructor | |
| 105 </p><a NAME="BookmarksProjectHelper.__hgBookmarkDefine" ID="BookmarksProjectHelper.__hgBookmarkDefine"></a> | |
| 106 <h4>BookmarksProjectHelper.__hgBookmarkDefine</h4> | |
| 107 <b>__hgBookmarkDefine</b>(<i></i>) | |
| 108 <p> | |
| 109 Private slot used to define a bookmark. | |
| 110 </p><a NAME="BookmarksProjectHelper.__hgBookmarkDelete" ID="BookmarksProjectHelper.__hgBookmarkDelete"></a> | |
| 111 <h4>BookmarksProjectHelper.__hgBookmarkDelete</h4> | |
| 112 <b>__hgBookmarkDelete</b>(<i></i>) | |
| 113 <p> | |
| 114 Private slot used to delete a bookmark. | |
| 115 </p><a NAME="BookmarksProjectHelper.__hgBookmarkIncoming" ID="BookmarksProjectHelper.__hgBookmarkIncoming"></a> | |
| 116 <h4>BookmarksProjectHelper.__hgBookmarkIncoming</h4> | |
| 117 <b>__hgBookmarkIncoming</b>(<i></i>) | |
| 118 <p> | |
| 119 Private slot used to show a list of incoming bookmarks. | |
| 120 </p><a NAME="BookmarksProjectHelper.__hgBookmarkMove" ID="BookmarksProjectHelper.__hgBookmarkMove"></a> | |
| 121 <h4>BookmarksProjectHelper.__hgBookmarkMove</h4> | |
| 122 <b>__hgBookmarkMove</b>(<i></i>) | |
| 123 <p> | |
| 124 Private slot used to move a bookmark. | |
| 125 </p><a NAME="BookmarksProjectHelper.__hgBookmarkOutgoing" ID="BookmarksProjectHelper.__hgBookmarkOutgoing"></a> | |
| 126 <h4>BookmarksProjectHelper.__hgBookmarkOutgoing</h4> | |
| 127 <b>__hgBookmarkOutgoing</b>(<i></i>) | |
| 128 <p> | |
| 129 Private slot used to show a list of outgoing bookmarks. | |
| 130 </p><a NAME="BookmarksProjectHelper.__hgBookmarkPull" ID="BookmarksProjectHelper.__hgBookmarkPull"></a> | |
| 131 <h4>BookmarksProjectHelper.__hgBookmarkPull</h4> | |
| 132 <b>__hgBookmarkPull</b>(<i></i>) | |
| 133 <p> | |
| 134 Private slot used to pull a bookmark from a remote repository. | |
| 135 </p><a NAME="BookmarksProjectHelper.__hgBookmarkPush" ID="BookmarksProjectHelper.__hgBookmarkPush"></a> | |
| 136 <h4>BookmarksProjectHelper.__hgBookmarkPush</h4> | |
| 137 <b>__hgBookmarkPush</b>(<i></i>) | |
| 138 <p> | |
| 139 Private slot used to push a bookmark to a remote repository. | |
| 140 </p><a NAME="BookmarksProjectHelper.__hgBookmarkRename" ID="BookmarksProjectHelper.__hgBookmarkRename"></a> | |
| 141 <h4>BookmarksProjectHelper.__hgBookmarkRename</h4> | |
| 142 <b>__hgBookmarkRename</b>(<i></i>) | |
| 143 <p> | |
| 144 Private slot used to rename a bookmark. | |
| 145 </p><a NAME="BookmarksProjectHelper.__hgBookmarksList" ID="BookmarksProjectHelper.__hgBookmarksList"></a> | |
| 146 <h4>BookmarksProjectHelper.__hgBookmarksList</h4> | |
| 147 <b>__hgBookmarksList</b>(<i></i>) | |
| 148 <p> | |
| 149 Private slot used to list the bookmarks. | |
| 150 </p><a NAME="BookmarksProjectHelper.getActions" ID="BookmarksProjectHelper.getActions"></a> | |
| 151 <h4>BookmarksProjectHelper.getActions</h4> | |
| 152 <b>getActions</b>(<i></i>) | |
| 153 <p> | |
| 154 Public method to get a list of all actions. | |
| 155 </p><dl> | |
| 156 <dt>Returns:</dt> | |
| 157 <dd> | |
| 158 list of all actions (list of E5Action) | |
| 159 </dd> | |
| 160 </dl><a NAME="BookmarksProjectHelper.initActions" ID="BookmarksProjectHelper.initActions"></a> | |
| 161 <h4>BookmarksProjectHelper.initActions</h4> | |
| 162 <b>initActions</b>(<i></i>) | |
| 163 <p> | |
| 164 Public method to generate the action objects. | |
| 165 </p><a NAME="BookmarksProjectHelper.initMenu" ID="BookmarksProjectHelper.initMenu"></a> | |
| 166 <h4>BookmarksProjectHelper.initMenu</h4> | |
| 167 <b>initMenu</b>(<i>mainMenu</i>) | |
| 168 <p> | |
| 169 Public method to generate the VCS menu. | |
| 170 </p><dl> | |
| 171 <dt><i>mainMenu</i></dt> | |
| 172 <dd> | |
| 173 reference to the main menu (QMenu) | |
| 174 </dd> | |
| 175 </dl><dl> | |
| 176 <dt>Returns:</dt> | |
| 177 <dd> | |
| 178 populated menu (QMenu) | |
| 179 </dd> | |
| 180 </dl><a NAME="BookmarksProjectHelper.setObjects" ID="BookmarksProjectHelper.setObjects"></a> | |
| 181 <h4>BookmarksProjectHelper.setObjects</h4> | |
| 182 <b>setObjects</b>(<i>vcsObject, projectObject</i>) | |
| 183 <p> | |
| 184 Public method to set references to the vcs and project objects. | |
| 185 </p><dl> | |
| 186 <dt><i>vcsObject</i></dt> | |
| 187 <dd> | |
| 188 reference to the vcs object | |
| 189 </dd><dt><i>projectObject</i></dt> | |
| 190 <dd> | |
| 191 reference to the project object | |
| 192 </dd> | |
| 193 </dl> | |
| 194 <div align="right"><a href="#top">Up</a></div> | |
| 195 <hr /> | |
| 196 </body></html> |
