Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.LargefilesExtension.ProjectBrowserHelper.html

changeset 3673
e26d7d0c1088
equal deleted inserted replaced
3670:f0cb7579c0b4 3673:e26d7d0c1088
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Plugins.VcsPlugins.vcsMercurial.LargefilesExtension.ProjectBrowserHelper</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body><a NAME="top" ID="top"></a>
22 <h1>eric6.Plugins.VcsPlugins.vcsMercurial.LargefilesExtension.ProjectBrowserHelper</h1>
23 <p>
24 Module implementing the largefiles extension project browser helper.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#LargefilesProjectBrowserHelper">LargefilesProjectBrowserHelper</a></td>
34 <td>Class implementing the largefiles extension project browser helper.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="LargefilesProjectBrowserHelper" ID="LargefilesProjectBrowserHelper"></a>
43 <h2>LargefilesProjectBrowserHelper</h2>
44 <p>
45 Class implementing the largefiles extension project browser helper.
46 </p>
47 <h3>Derived from</h3>
48 HgExtensionProjectBrowserHelper
49 <h3>Class Attributes</h3>
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Class Methods</h3>
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Methods</h3>
58 <table>
59 <tr>
60 <td><a href="#LargefilesProjectBrowserHelper.__init__">LargefilesProjectBrowserHelper</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#LargefilesProjectBrowserHelper.__hgAddLargefiles">__hgAddLargefiles</a></td>
64 <td>Private slot to add the selected files as large files.</td>
65 </tr><tr>
66 <td><a href="#LargefilesProjectBrowserHelper.initMenus">initMenus</a></td>
67 <td>Public method to generate the extension menus.</td>
68 </tr><tr>
69 <td><a href="#LargefilesProjectBrowserHelper.menuTitle">menuTitle</a></td>
70 <td>Public method to get the menu title.</td>
71 </tr><tr>
72 <td><a href="#LargefilesProjectBrowserHelper.showExtensionMenu">showExtensionMenu</a></td>
73 <td>Public method to prepare the extension menu for display.</td>
74 </tr>
75 </table>
76 <h3>Static Methods</h3>
77 <table>
78 <tr><td>None</td></tr>
79 </table>
80 <a NAME="LargefilesProjectBrowserHelper.__init__" ID="LargefilesProjectBrowserHelper.__init__"></a>
81 <h4>LargefilesProjectBrowserHelper (Constructor)</h4>
82 <b>LargefilesProjectBrowserHelper</b>(<i>vcsObject, browserObject, projectObject</i>)
83 <p>
84 Constructor
85 </p><dl>
86 <dt><i>vcsObject</i></dt>
87 <dd>
88 reference to the vcs object
89 </dd><dt><i>browserObject</i></dt>
90 <dd>
91 reference to the project browser object
92 </dd><dt><i>projectObject</i></dt>
93 <dd>
94 reference to the project object
95 </dd>
96 </dl><a NAME="LargefilesProjectBrowserHelper.__hgAddLargefiles" ID="LargefilesProjectBrowserHelper.__hgAddLargefiles"></a>
97 <h4>LargefilesProjectBrowserHelper.__hgAddLargefiles</h4>
98 <b>__hgAddLargefiles</b>(<i>mode</i>)
99 <p>
100 Private slot to add the selected files as large files.
101 </p><dl>
102 <dt><i>mode</i></dt>
103 <dd>
104 add mode (string one of 'normal' or 'large')
105 </dd>
106 </dl><a NAME="LargefilesProjectBrowserHelper.initMenus" ID="LargefilesProjectBrowserHelper.initMenus"></a>
107 <h4>LargefilesProjectBrowserHelper.initMenus</h4>
108 <b>initMenus</b>(<i></i>)
109 <p>
110 Public method to generate the extension menus.
111 </p><p>
112 Note: Derived class must implement this method.
113 </p><dl>
114 <dt>Returns:</dt>
115 <dd>
116 dictionary of populated menu (dict of QMenu). The dict
117 must have the keys 'mainMenu', 'multiMenu', 'backMenu', 'dirMenu'
118 and 'dirMultiMenu'.
119 </dd>
120 </dl><a NAME="LargefilesProjectBrowserHelper.menuTitle" ID="LargefilesProjectBrowserHelper.menuTitle"></a>
121 <h4>LargefilesProjectBrowserHelper.menuTitle</h4>
122 <b>menuTitle</b>(<i></i>)
123 <p>
124 Public method to get the menu title.
125 </p><p>
126 Note: Derived class must implement this method.
127 </p><dl>
128 <dt>Returns:</dt>
129 <dd>
130 title of the menu (string)
131 </dd>
132 </dl><a NAME="LargefilesProjectBrowserHelper.showExtensionMenu" ID="LargefilesProjectBrowserHelper.showExtensionMenu"></a>
133 <h4>LargefilesProjectBrowserHelper.showExtensionMenu</h4>
134 <b>showExtensionMenu</b>(<i>key, controlled</i>)
135 <p>
136 Public method to prepare the extension menu for display.
137 </p><dl>
138 <dt><i>key</i></dt>
139 <dd>
140 menu key (string, one of 'mainMenu', 'multiMenu',
141 'backMenu', 'dirMenu' or 'dirMultiMenu')
142 </dd><dt><i>controlled</i></dt>
143 <dd>
144 flag indicating to prepare the menu for a
145 version controlled entry or a non-version controlled entry
146 (boolean)
147 </dd>
148 </dl>
149 <div align="right"><a href="#top">Up</a></div>
150 <hr />
151 </body></html>

eric ide

mercurial