src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.LargefilesExtension.ProjectBrowserHelper.html

branch
eric7
changeset 10479
856476537696
parent 10438
4cd7e5a8b3cf
child 11068
15f0385e0471
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Plugins.VcsPlugins.vcsMercurial.LargefilesExtension.ProjectBrowserHelper</h1> 9 <h1>eric7.Plugins.VcsPlugins.vcsMercurial.LargefilesExtension.ProjectBrowserHelper</h1>
10
11 <p> 10 <p>
12 Module implementing the largefiles extension project browser helper. 11 Module implementing the largefiles extension project browser helper.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15
16 <table> 15 <table>
17 <tr><td>None</td></tr> 16 <tr><td>None</td></tr>
18 </table> 17 </table>
18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20
21 <table> 20 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#LargefilesProjectBrowserHelper">LargefilesProjectBrowserHelper</a></td> 22 <td><a href="#LargefilesProjectBrowserHelper">LargefilesProjectBrowserHelper</a></td>
25 <td>Class implementing the largefiles extension project browser helper.</td> 23 <td>Class implementing the largefiles extension project browser helper.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29
30 <table> 28 <table>
31 <tr><td>None</td></tr> 29 <tr><td>None</td></tr>
32 </table> 30 </table>
31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="LargefilesProjectBrowserHelper" ID="LargefilesProjectBrowserHelper"></a> 34 <a NAME="LargefilesProjectBrowserHelper" ID="LargefilesProjectBrowserHelper"></a>
36 <h2>LargefilesProjectBrowserHelper</h2> 35 <h2>LargefilesProjectBrowserHelper</h2>
37
38 <p> 36 <p>
39 Class implementing the largefiles extension project browser helper. 37 Class implementing the largefiles extension project browser helper.
40 </p> 38 </p>
39
41 <h3>Derived from</h3> 40 <h3>Derived from</h3>
42 HgExtensionProjectBrowserHelper 41 HgExtensionProjectBrowserHelper
43 <h3>Class Attributes</h3> 42 <h3>Class Attributes</h3>
44
45 <table> 43 <table>
46 <tr><td>None</td></tr> 44 <tr><td>None</td></tr>
47 </table> 45 </table>
46
48 <h3>Class Methods</h3> 47 <h3>Class Methods</h3>
49
50 <table> 48 <table>
51 <tr><td>None</td></tr> 49 <tr><td>None</td></tr>
52 </table> 50 </table>
51
53 <h3>Methods</h3> 52 <h3>Methods</h3>
54
55 <table> 53 <table>
56
57 <tr> 54 <tr>
58 <td><a href="#LargefilesProjectBrowserHelper.__init__">LargefilesProjectBrowserHelper</a></td> 55 <td><a href="#LargefilesProjectBrowserHelper.__init__">LargefilesProjectBrowserHelper</a></td>
59 <td>Constructor</td> 56 <td>Constructor</td>
60 </tr> 57 </tr>
61 <tr> 58 <tr>
73 <tr> 70 <tr>
74 <td><a href="#LargefilesProjectBrowserHelper.showExtensionMenu">showExtensionMenu</a></td> 71 <td><a href="#LargefilesProjectBrowserHelper.showExtensionMenu">showExtensionMenu</a></td>
75 <td>Public method to prepare the extension menu for display.</td> 72 <td>Public method to prepare the extension menu for display.</td>
76 </tr> 73 </tr>
77 </table> 74 </table>
75
78 <h3>Static Methods</h3> 76 <h3>Static Methods</h3>
79
80 <table> 77 <table>
81 <tr><td>None</td></tr> 78 <tr><td>None</td></tr>
82 </table> 79 </table>
83 80
81
84 <a NAME="LargefilesProjectBrowserHelper.__init__" ID="LargefilesProjectBrowserHelper.__init__"></a> 82 <a NAME="LargefilesProjectBrowserHelper.__init__" ID="LargefilesProjectBrowserHelper.__init__"></a>
85 <h4>LargefilesProjectBrowserHelper (Constructor)</h4> 83 <h4>LargefilesProjectBrowserHelper (Constructor)</h4>
86 <b>LargefilesProjectBrowserHelper</b>(<i>vcsObject, browserObject, projectObject</i>) 84 <b>LargefilesProjectBrowserHelper</b>(<i>vcsObject, browserObject, projectObject</i>)
87
88 <p> 85 <p>
89 Constructor 86 Constructor
90 </p> 87 </p>
88
91 <dl> 89 <dl>
92 90
93 <dt><i>vcsObject</i> (Hg)</dt> 91 <dt><i>vcsObject</i> (Hg)</dt>
94 <dd> 92 <dd>
95 reference to the vcs object 93 reference to the vcs object
104 </dd> 102 </dd>
105 </dl> 103 </dl>
106 <a NAME="LargefilesProjectBrowserHelper.__hgAddLargefiles" ID="LargefilesProjectBrowserHelper.__hgAddLargefiles"></a> 104 <a NAME="LargefilesProjectBrowserHelper.__hgAddLargefiles" ID="LargefilesProjectBrowserHelper.__hgAddLargefiles"></a>
107 <h4>LargefilesProjectBrowserHelper.__hgAddLargefiles</h4> 105 <h4>LargefilesProjectBrowserHelper.__hgAddLargefiles</h4>
108 <b>__hgAddLargefiles</b>(<i>mode</i>) 106 <b>__hgAddLargefiles</b>(<i>mode</i>)
109
110 <p> 107 <p>
111 Private slot to add the selected files as large files. 108 Private slot to add the selected files as large files.
112 </p> 109 </p>
110
113 <dl> 111 <dl>
114 112
115 <dt><i>mode</i> (str)</dt> 113 <dt><i>mode</i> (str)</dt>
116 <dd> 114 <dd>
117 add mode (string ne of 'normal' or 'large') 115 add mode (string ne of 'normal' or 'large')
118 </dd> 116 </dd>
119 </dl> 117 </dl>
120 <a NAME="LargefilesProjectBrowserHelper.initMenus" ID="LargefilesProjectBrowserHelper.initMenus"></a> 118 <a NAME="LargefilesProjectBrowserHelper.initMenus" ID="LargefilesProjectBrowserHelper.initMenus"></a>
121 <h4>LargefilesProjectBrowserHelper.initMenus</h4> 119 <h4>LargefilesProjectBrowserHelper.initMenus</h4>
122 <b>initMenus</b>(<i></i>) 120 <b>initMenus</b>(<i></i>)
123
124 <p> 121 <p>
125 Public method to generate the extension menus. 122 Public method to generate the extension menus.
126 </p> 123 </p>
127 <p> 124 <p>
128 Note: Derived class must implement this method. 125 Note: Derived class must implement this method.
129 </p> 126 </p>
127
130 <dl> 128 <dl>
131 <dt>Return:</dt> 129 <dt>Return:</dt>
132 <dd> 130 <dd>
133 dictionary of populated menu. The dict must have the keys 131 dictionary of populated menu. The dict must have the keys
134 'mainMenu', 'multiMenu', 'backMenu', 'dirMenu' and 'dirMultiMenu'. 132 'mainMenu', 'multiMenu', 'backMenu', 'dirMenu' and 'dirMultiMenu'.
141 </dd> 139 </dd>
142 </dl> 140 </dl>
143 <a NAME="LargefilesProjectBrowserHelper.menuTitle" ID="LargefilesProjectBrowserHelper.menuTitle"></a> 141 <a NAME="LargefilesProjectBrowserHelper.menuTitle" ID="LargefilesProjectBrowserHelper.menuTitle"></a>
144 <h4>LargefilesProjectBrowserHelper.menuTitle</h4> 142 <h4>LargefilesProjectBrowserHelper.menuTitle</h4>
145 <b>menuTitle</b>(<i></i>) 143 <b>menuTitle</b>(<i></i>)
146
147 <p> 144 <p>
148 Public method to get the menu title. 145 Public method to get the menu title.
149 </p> 146 </p>
150 <p> 147 <p>
151 Note: Derived class must implement this method. 148 Note: Derived class must implement this method.
152 </p> 149 </p>
150
153 <dl> 151 <dl>
154 <dt>Return:</dt> 152 <dt>Return:</dt>
155 <dd> 153 <dd>
156 title of the menu 154 title of the menu
157 </dd> 155 </dd>
163 </dd> 161 </dd>
164 </dl> 162 </dl>
165 <a NAME="LargefilesProjectBrowserHelper.showExtensionMenu" ID="LargefilesProjectBrowserHelper.showExtensionMenu"></a> 163 <a NAME="LargefilesProjectBrowserHelper.showExtensionMenu" ID="LargefilesProjectBrowserHelper.showExtensionMenu"></a>
166 <h4>LargefilesProjectBrowserHelper.showExtensionMenu</h4> 164 <h4>LargefilesProjectBrowserHelper.showExtensionMenu</h4>
167 <b>showExtensionMenu</b>(<i>key, controlled</i>) 165 <b>showExtensionMenu</b>(<i>key, controlled</i>)
168
169 <p> 166 <p>
170 Public method to prepare the extension menu for display. 167 Public method to prepare the extension menu for display.
171 </p> 168 </p>
169
172 <dl> 170 <dl>
173 171
174 <dt><i>key</i> (str)</dt> 172 <dt><i>key</i> (str)</dt>
175 <dd> 173 <dd>
176 menu key (one of 'mainMenu', 'multiMenu', 'backMenu', 'dirMenu' 174 menu key (one of 'mainMenu', 'multiMenu', 'backMenu', 'dirMenu'

eric ide

mercurial