--- a/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.LargefilesExtension.ProjectBrowserHelper.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.LargefilesExtension.ProjectBrowserHelper.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,128 +18,168 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.Plugins.VcsPlugins.vcsMercurial.LargefilesExtension.ProjectBrowserHelper</h1> + <p> Module implementing the largefiles extension project browser helper. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#LargefilesProjectBrowserHelper">LargefilesProjectBrowserHelper</a></td> <td>Class implementing the largefiles extension project browser helper.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="LargefilesProjectBrowserHelper" ID="LargefilesProjectBrowserHelper"></a> <h2>LargefilesProjectBrowserHelper</h2> + <p> Class implementing the largefiles extension project browser helper. </p> <h3>Derived from</h3> HgExtensionProjectBrowserHelper <h3>Class Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Class Methods</h3> + <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> + <table> + <tr> <td><a href="#LargefilesProjectBrowserHelper.__init__">LargefilesProjectBrowserHelper</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#LargefilesProjectBrowserHelper.__hgAddLargefiles">__hgAddLargefiles</a></td> <td>Private slot to add the selected files as large files.</td> -</tr><tr> +</tr> +<tr> <td><a href="#LargefilesProjectBrowserHelper.initMenus">initMenus</a></td> <td>Public method to generate the extension menus.</td> -</tr><tr> +</tr> +<tr> <td><a href="#LargefilesProjectBrowserHelper.menuTitle">menuTitle</a></td> <td>Public method to get the menu title.</td> -</tr><tr> +</tr> +<tr> <td><a href="#LargefilesProjectBrowserHelper.showExtensionMenu">showExtensionMenu</a></td> <td>Public method to prepare the extension menu for display.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="LargefilesProjectBrowserHelper.__init__" ID="LargefilesProjectBrowserHelper.__init__"></a> <h4>LargefilesProjectBrowserHelper (Constructor)</h4> <b>LargefilesProjectBrowserHelper</b>(<i>vcsObject, browserObject, projectObject</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>vcsObject</i></dt> <dd> reference to the vcs object -</dd><dt><i>browserObject</i></dt> +</dd> +<dt><i>browserObject</i></dt> <dd> reference to the project browser object -</dd><dt><i>projectObject</i></dt> +</dd> +<dt><i>projectObject</i></dt> <dd> reference to the project object </dd> -</dl><a NAME="LargefilesProjectBrowserHelper.__hgAddLargefiles" ID="LargefilesProjectBrowserHelper.__hgAddLargefiles"></a> +</dl> +<a NAME="LargefilesProjectBrowserHelper.__hgAddLargefiles" ID="LargefilesProjectBrowserHelper.__hgAddLargefiles"></a> <h4>LargefilesProjectBrowserHelper.__hgAddLargefiles</h4> <b>__hgAddLargefiles</b>(<i>mode</i>) + <p> Private slot to add the selected files as large files. -</p><dl> +</p> +<dl> + <dt><i>mode</i></dt> <dd> add mode (string one of 'normal' or 'large') </dd> -</dl><a NAME="LargefilesProjectBrowserHelper.initMenus" ID="LargefilesProjectBrowserHelper.initMenus"></a> +</dl> +<a NAME="LargefilesProjectBrowserHelper.initMenus" ID="LargefilesProjectBrowserHelper.initMenus"></a> <h4>LargefilesProjectBrowserHelper.initMenus</h4> <b>initMenus</b>(<i></i>) + <p> Public method to generate the extension menus. -</p><p> +</p> +<p> Note: Derived class must implement this method. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> dictionary of populated menu (dict of QMenu). The dict must have the keys 'mainMenu', 'multiMenu', 'backMenu', 'dirMenu' and 'dirMultiMenu'. </dd> -</dl><a NAME="LargefilesProjectBrowserHelper.menuTitle" ID="LargefilesProjectBrowserHelper.menuTitle"></a> +</dl> +<a NAME="LargefilesProjectBrowserHelper.menuTitle" ID="LargefilesProjectBrowserHelper.menuTitle"></a> <h4>LargefilesProjectBrowserHelper.menuTitle</h4> <b>menuTitle</b>(<i></i>) + <p> Public method to get the menu title. -</p><p> +</p> +<p> Note: Derived class must implement this method. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> title of the menu (string) </dd> -</dl><a NAME="LargefilesProjectBrowserHelper.showExtensionMenu" ID="LargefilesProjectBrowserHelper.showExtensionMenu"></a> +</dl> +<a NAME="LargefilesProjectBrowserHelper.showExtensionMenu" ID="LargefilesProjectBrowserHelper.showExtensionMenu"></a> <h4>LargefilesProjectBrowserHelper.showExtensionMenu</h4> <b>showExtensionMenu</b>(<i>key, controlled</i>) + <p> Public method to prepare the extension menu for display. -</p><dl> +</p> +<dl> + <dt><i>key</i></dt> <dd> menu key (string, one of 'mainMenu', 'multiMenu', 'backMenu', 'dirMenu' or 'dirMultiMenu') -</dd><dt><i>controlled</i></dt> +</dd> +<dt><i>controlled</i></dt> <dd> flag indicating to prepare the menu for a version controlled entry or a non-version controlled entry