Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.LargefilesExtension.ProjectBrowserHelper.html
eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.LargefilesExtension.ProjectBrowserHelper.html
- changeset 7273
- 391d6b7b1eff
- parent 6942
- 2602857055c5
- child 7989
- a21d673a8f99
equal
deleted
inserted
replaced
| 7272:1779dc278077 | 7273:391d6b7b1eff |
|---|---|
| 16 | 16 |
| 17 a { color: #BA6D36; } | 17 a { color: #BA6D36; } |
| 18 | 18 |
| 19 </style> | 19 </style> |
| 20 </head> | 20 </head> |
| 21 <body><a NAME="top" ID="top"></a> | 21 <body> |
| 22 <a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.Plugins.VcsPlugins.vcsMercurial.LargefilesExtension.ProjectBrowserHelper</h1> | 23 <h1>eric6.Plugins.VcsPlugins.vcsMercurial.LargefilesExtension.ProjectBrowserHelper</h1> |
| 24 | |
| 23 <p> | 25 <p> |
| 24 Module implementing the largefiles extension project browser helper. | 26 Module implementing the largefiles extension project browser helper. |
| 25 </p> | 27 </p> |
| 26 <h3>Global Attributes</h3> | 28 <h3>Global Attributes</h3> |
| 29 | |
| 27 <table> | 30 <table> |
| 28 <tr><td>None</td></tr> | 31 <tr><td>None</td></tr> |
| 29 </table> | 32 </table> |
| 30 <h3>Classes</h3> | 33 <h3>Classes</h3> |
| 34 | |
| 31 <table> | 35 <table> |
| 36 | |
| 32 <tr> | 37 <tr> |
| 33 <td><a href="#LargefilesProjectBrowserHelper">LargefilesProjectBrowserHelper</a></td> | 38 <td><a href="#LargefilesProjectBrowserHelper">LargefilesProjectBrowserHelper</a></td> |
| 34 <td>Class implementing the largefiles extension project browser helper.</td> | 39 <td>Class implementing the largefiles extension project browser helper.</td> |
| 35 </tr> | 40 </tr> |
| 36 </table> | 41 </table> |
| 37 <h3>Functions</h3> | 42 <h3>Functions</h3> |
| 43 | |
| 38 <table> | 44 <table> |
| 39 <tr><td>None</td></tr> | 45 <tr><td>None</td></tr> |
| 40 </table> | 46 </table> |
| 41 <hr /><hr /> | 47 <hr /> |
| 48 <hr /> | |
| 42 <a NAME="LargefilesProjectBrowserHelper" ID="LargefilesProjectBrowserHelper"></a> | 49 <a NAME="LargefilesProjectBrowserHelper" ID="LargefilesProjectBrowserHelper"></a> |
| 43 <h2>LargefilesProjectBrowserHelper</h2> | 50 <h2>LargefilesProjectBrowserHelper</h2> |
| 51 | |
| 44 <p> | 52 <p> |
| 45 Class implementing the largefiles extension project browser helper. | 53 Class implementing the largefiles extension project browser helper. |
| 46 </p> | 54 </p> |
| 47 <h3>Derived from</h3> | 55 <h3>Derived from</h3> |
| 48 HgExtensionProjectBrowserHelper | 56 HgExtensionProjectBrowserHelper |
| 49 <h3>Class Attributes</h3> | 57 <h3>Class Attributes</h3> |
| 58 | |
| 50 <table> | 59 <table> |
| 51 <tr><td>None</td></tr> | 60 <tr><td>None</td></tr> |
| 52 </table> | 61 </table> |
| 53 <h3>Class Methods</h3> | 62 <h3>Class Methods</h3> |
| 63 | |
| 54 <table> | 64 <table> |
| 55 <tr><td>None</td></tr> | 65 <tr><td>None</td></tr> |
| 56 </table> | 66 </table> |
| 57 <h3>Methods</h3> | 67 <h3>Methods</h3> |
| 68 | |
| 58 <table> | 69 <table> |
| 70 | |
| 59 <tr> | 71 <tr> |
| 60 <td><a href="#LargefilesProjectBrowserHelper.__init__">LargefilesProjectBrowserHelper</a></td> | 72 <td><a href="#LargefilesProjectBrowserHelper.__init__">LargefilesProjectBrowserHelper</a></td> |
| 61 <td>Constructor</td> | 73 <td>Constructor</td> |
| 62 </tr><tr> | 74 </tr> |
| 75 <tr> | |
| 63 <td><a href="#LargefilesProjectBrowserHelper.__hgAddLargefiles">__hgAddLargefiles</a></td> | 76 <td><a href="#LargefilesProjectBrowserHelper.__hgAddLargefiles">__hgAddLargefiles</a></td> |
| 64 <td>Private slot to add the selected files as large files.</td> | 77 <td>Private slot to add the selected files as large files.</td> |
| 65 </tr><tr> | 78 </tr> |
| 79 <tr> | |
| 66 <td><a href="#LargefilesProjectBrowserHelper.initMenus">initMenus</a></td> | 80 <td><a href="#LargefilesProjectBrowserHelper.initMenus">initMenus</a></td> |
| 67 <td>Public method to generate the extension menus.</td> | 81 <td>Public method to generate the extension menus.</td> |
| 68 </tr><tr> | 82 </tr> |
| 83 <tr> | |
| 69 <td><a href="#LargefilesProjectBrowserHelper.menuTitle">menuTitle</a></td> | 84 <td><a href="#LargefilesProjectBrowserHelper.menuTitle">menuTitle</a></td> |
| 70 <td>Public method to get the menu title.</td> | 85 <td>Public method to get the menu title.</td> |
| 71 </tr><tr> | 86 </tr> |
| 87 <tr> | |
| 72 <td><a href="#LargefilesProjectBrowserHelper.showExtensionMenu">showExtensionMenu</a></td> | 88 <td><a href="#LargefilesProjectBrowserHelper.showExtensionMenu">showExtensionMenu</a></td> |
| 73 <td>Public method to prepare the extension menu for display.</td> | 89 <td>Public method to prepare the extension menu for display.</td> |
| 74 </tr> | 90 </tr> |
| 75 </table> | 91 </table> |
| 76 <h3>Static Methods</h3> | 92 <h3>Static Methods</h3> |
| 93 | |
| 77 <table> | 94 <table> |
| 78 <tr><td>None</td></tr> | 95 <tr><td>None</td></tr> |
| 79 </table> | 96 </table> |
| 97 | |
| 80 <a NAME="LargefilesProjectBrowserHelper.__init__" ID="LargefilesProjectBrowserHelper.__init__"></a> | 98 <a NAME="LargefilesProjectBrowserHelper.__init__" ID="LargefilesProjectBrowserHelper.__init__"></a> |
| 81 <h4>LargefilesProjectBrowserHelper (Constructor)</h4> | 99 <h4>LargefilesProjectBrowserHelper (Constructor)</h4> |
| 82 <b>LargefilesProjectBrowserHelper</b>(<i>vcsObject, browserObject, projectObject</i>) | 100 <b>LargefilesProjectBrowserHelper</b>(<i>vcsObject, browserObject, projectObject</i>) |
| 101 | |
| 83 <p> | 102 <p> |
| 84 Constructor | 103 Constructor |
| 85 </p><dl> | 104 </p> |
| 105 <dl> | |
| 106 | |
| 86 <dt><i>vcsObject</i></dt> | 107 <dt><i>vcsObject</i></dt> |
| 87 <dd> | 108 <dd> |
| 88 reference to the vcs object | 109 reference to the vcs object |
| 89 </dd><dt><i>browserObject</i></dt> | 110 </dd> |
| 111 <dt><i>browserObject</i></dt> | |
| 90 <dd> | 112 <dd> |
| 91 reference to the project browser object | 113 reference to the project browser object |
| 92 </dd><dt><i>projectObject</i></dt> | 114 </dd> |
| 115 <dt><i>projectObject</i></dt> | |
| 93 <dd> | 116 <dd> |
| 94 reference to the project object | 117 reference to the project object |
| 95 </dd> | 118 </dd> |
| 96 </dl><a NAME="LargefilesProjectBrowserHelper.__hgAddLargefiles" ID="LargefilesProjectBrowserHelper.__hgAddLargefiles"></a> | 119 </dl> |
| 120 <a NAME="LargefilesProjectBrowserHelper.__hgAddLargefiles" ID="LargefilesProjectBrowserHelper.__hgAddLargefiles"></a> | |
| 97 <h4>LargefilesProjectBrowserHelper.__hgAddLargefiles</h4> | 121 <h4>LargefilesProjectBrowserHelper.__hgAddLargefiles</h4> |
| 98 <b>__hgAddLargefiles</b>(<i>mode</i>) | 122 <b>__hgAddLargefiles</b>(<i>mode</i>) |
| 123 | |
| 99 <p> | 124 <p> |
| 100 Private slot to add the selected files as large files. | 125 Private slot to add the selected files as large files. |
| 101 </p><dl> | 126 </p> |
| 127 <dl> | |
| 128 | |
| 102 <dt><i>mode</i></dt> | 129 <dt><i>mode</i></dt> |
| 103 <dd> | 130 <dd> |
| 104 add mode (string one of 'normal' or 'large') | 131 add mode (string one of 'normal' or 'large') |
| 105 </dd> | 132 </dd> |
| 106 </dl><a NAME="LargefilesProjectBrowserHelper.initMenus" ID="LargefilesProjectBrowserHelper.initMenus"></a> | 133 </dl> |
| 134 <a NAME="LargefilesProjectBrowserHelper.initMenus" ID="LargefilesProjectBrowserHelper.initMenus"></a> | |
| 107 <h4>LargefilesProjectBrowserHelper.initMenus</h4> | 135 <h4>LargefilesProjectBrowserHelper.initMenus</h4> |
| 108 <b>initMenus</b>(<i></i>) | 136 <b>initMenus</b>(<i></i>) |
| 137 | |
| 109 <p> | 138 <p> |
| 110 Public method to generate the extension menus. | 139 Public method to generate the extension menus. |
| 111 </p><p> | 140 </p> |
| 141 <p> | |
| 112 Note: Derived class must implement this method. | 142 Note: Derived class must implement this method. |
| 113 </p><dl> | 143 </p> |
| 144 <dl> | |
| 114 <dt>Returns:</dt> | 145 <dt>Returns:</dt> |
| 115 <dd> | 146 <dd> |
| 116 dictionary of populated menu (dict of QMenu). The dict | 147 dictionary of populated menu (dict of QMenu). The dict |
| 117 must have the keys 'mainMenu', 'multiMenu', 'backMenu', 'dirMenu' | 148 must have the keys 'mainMenu', 'multiMenu', 'backMenu', 'dirMenu' |
| 118 and 'dirMultiMenu'. | 149 and 'dirMultiMenu'. |
| 119 </dd> | 150 </dd> |
| 120 </dl><a NAME="LargefilesProjectBrowserHelper.menuTitle" ID="LargefilesProjectBrowserHelper.menuTitle"></a> | 151 </dl> |
| 152 <a NAME="LargefilesProjectBrowserHelper.menuTitle" ID="LargefilesProjectBrowserHelper.menuTitle"></a> | |
| 121 <h4>LargefilesProjectBrowserHelper.menuTitle</h4> | 153 <h4>LargefilesProjectBrowserHelper.menuTitle</h4> |
| 122 <b>menuTitle</b>(<i></i>) | 154 <b>menuTitle</b>(<i></i>) |
| 155 | |
| 123 <p> | 156 <p> |
| 124 Public method to get the menu title. | 157 Public method to get the menu title. |
| 125 </p><p> | 158 </p> |
| 159 <p> | |
| 126 Note: Derived class must implement this method. | 160 Note: Derived class must implement this method. |
| 127 </p><dl> | 161 </p> |
| 162 <dl> | |
| 128 <dt>Returns:</dt> | 163 <dt>Returns:</dt> |
| 129 <dd> | 164 <dd> |
| 130 title of the menu (string) | 165 title of the menu (string) |
| 131 </dd> | 166 </dd> |
| 132 </dl><a NAME="LargefilesProjectBrowserHelper.showExtensionMenu" ID="LargefilesProjectBrowserHelper.showExtensionMenu"></a> | 167 </dl> |
| 168 <a NAME="LargefilesProjectBrowserHelper.showExtensionMenu" ID="LargefilesProjectBrowserHelper.showExtensionMenu"></a> | |
| 133 <h4>LargefilesProjectBrowserHelper.showExtensionMenu</h4> | 169 <h4>LargefilesProjectBrowserHelper.showExtensionMenu</h4> |
| 134 <b>showExtensionMenu</b>(<i>key, controlled</i>) | 170 <b>showExtensionMenu</b>(<i>key, controlled</i>) |
| 171 | |
| 135 <p> | 172 <p> |
| 136 Public method to prepare the extension menu for display. | 173 Public method to prepare the extension menu for display. |
| 137 </p><dl> | 174 </p> |
| 175 <dl> | |
| 176 | |
| 138 <dt><i>key</i></dt> | 177 <dt><i>key</i></dt> |
| 139 <dd> | 178 <dd> |
| 140 menu key (string, one of 'mainMenu', 'multiMenu', | 179 menu key (string, one of 'mainMenu', 'multiMenu', |
| 141 'backMenu', 'dirMenu' or 'dirMultiMenu') | 180 'backMenu', 'dirMenu' or 'dirMultiMenu') |
| 142 </dd><dt><i>controlled</i></dt> | 181 </dd> |
| 182 <dt><i>controlled</i></dt> | |
| 143 <dd> | 183 <dd> |
| 144 flag indicating to prepare the menu for a | 184 flag indicating to prepare the menu for a |
| 145 version controlled entry or a non-version controlled entry | 185 version controlled entry or a non-version controlled entry |
| 146 (boolean) | 186 (boolean) |
| 147 </dd> | 187 </dd> |
