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.vcsGit.GitSubmodulesStatusDialog</h1> |
23 <h1>eric6.Plugins.VcsPlugins.vcsGit.GitSubmodulesStatusDialog</h1> |
|
24 |
23 <p> |
25 <p> |
24 Module implementing a dialog to show the status of the submodules of the |
26 Module implementing a dialog to show the status of the submodules of the |
25 project. |
27 project. |
26 </p> |
28 </p> |
27 <h3>Global Attributes</h3> |
29 <h3>Global Attributes</h3> |
|
30 |
28 <table> |
31 <table> |
29 <tr><td>None</td></tr> |
32 <tr><td>None</td></tr> |
30 </table> |
33 </table> |
31 <h3>Classes</h3> |
34 <h3>Classes</h3> |
32 <table> |
35 |
|
36 <table> |
|
37 |
33 <tr> |
38 <tr> |
34 <td><a href="#GitSubmodulesStatusDialog">GitSubmodulesStatusDialog</a></td> |
39 <td><a href="#GitSubmodulesStatusDialog">GitSubmodulesStatusDialog</a></td> |
35 <td>Class implementing a dialog to show the status of the submodules of the project.</td> |
40 <td>Class implementing a dialog to show the status of the submodules of the project.</td> |
36 </tr> |
41 </tr> |
37 </table> |
42 </table> |
38 <h3>Functions</h3> |
43 <h3>Functions</h3> |
39 <table> |
44 |
40 <tr><td>None</td></tr> |
45 <table> |
41 </table> |
46 <tr><td>None</td></tr> |
42 <hr /><hr /> |
47 </table> |
|
48 <hr /> |
|
49 <hr /> |
43 <a NAME="GitSubmodulesStatusDialog" ID="GitSubmodulesStatusDialog"></a> |
50 <a NAME="GitSubmodulesStatusDialog" ID="GitSubmodulesStatusDialog"></a> |
44 <h2>GitSubmodulesStatusDialog</h2> |
51 <h2>GitSubmodulesStatusDialog</h2> |
|
52 |
45 <p> |
53 <p> |
46 Class implementing a dialog to show the status of the submodules of the |
54 Class implementing a dialog to show the status of the submodules of the |
47 project. |
55 project. |
48 </p> |
56 </p> |
49 <h3>Derived from</h3> |
57 <h3>Derived from</h3> |
50 QDialog, Ui_GitSubmodulesStatusDialog |
58 QDialog, Ui_GitSubmodulesStatusDialog |
51 <h3>Class Attributes</h3> |
59 <h3>Class Attributes</h3> |
|
60 |
52 <table> |
61 <table> |
53 <tr><td>None</td></tr> |
62 <tr><td>None</td></tr> |
54 </table> |
63 </table> |
55 <h3>Class Methods</h3> |
64 <h3>Class Methods</h3> |
|
65 |
56 <table> |
66 <table> |
57 <tr><td>None</td></tr> |
67 <tr><td>None</td></tr> |
58 </table> |
68 </table> |
59 <h3>Methods</h3> |
69 <h3>Methods</h3> |
60 <table> |
70 |
|
71 <table> |
|
72 |
61 <tr> |
73 <tr> |
62 <td><a href="#GitSubmodulesStatusDialog.__init__">GitSubmodulesStatusDialog</a></td> |
74 <td><a href="#GitSubmodulesStatusDialog.__init__">GitSubmodulesStatusDialog</a></td> |
63 <td>Constructor</td> |
75 <td>Constructor</td> |
64 </tr><tr> |
76 </tr> |
|
77 <tr> |
65 <td><a href="#GitSubmodulesStatusDialog.__processOutput">__processOutput</a></td> |
78 <td><a href="#GitSubmodulesStatusDialog.__processOutput">__processOutput</a></td> |
66 <td>Private method to process the output and populate the list.</td> |
79 <td>Private method to process the output and populate the list.</td> |
67 </tr><tr> |
80 </tr> |
|
81 <tr> |
68 <td><a href="#GitSubmodulesStatusDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> |
82 <td><a href="#GitSubmodulesStatusDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> |
69 <td>Private slot called by a button of the button box clicked.</td> |
83 <td>Private slot called by a button of the button box clicked.</td> |
70 </tr><tr> |
84 </tr> |
|
85 <tr> |
71 <td><a href="#GitSubmodulesStatusDialog.on_indexCheckBox_toggled">on_indexCheckBox_toggled</a></td> |
86 <td><a href="#GitSubmodulesStatusDialog.on_indexCheckBox_toggled">on_indexCheckBox_toggled</a></td> |
72 <td>Private slot handling a change of the index check box.</td> |
87 <td>Private slot handling a change of the index check box.</td> |
73 </tr><tr> |
88 </tr> |
|
89 <tr> |
74 <td><a href="#GitSubmodulesStatusDialog.on_recursiveCheckBox_toggled">on_recursiveCheckBox_toggled</a></td> |
90 <td><a href="#GitSubmodulesStatusDialog.on_recursiveCheckBox_toggled">on_recursiveCheckBox_toggled</a></td> |
75 <td>Private slot handling a change of the recursive check box.</td> |
91 <td>Private slot handling a change of the recursive check box.</td> |
76 </tr><tr> |
92 </tr> |
|
93 <tr> |
77 <td><a href="#GitSubmodulesStatusDialog.on_refreshButton_clicked">on_refreshButton_clicked</a></td> |
94 <td><a href="#GitSubmodulesStatusDialog.on_refreshButton_clicked">on_refreshButton_clicked</a></td> |
78 <td>Private slot to refresh the status display.</td> |
95 <td>Private slot to refresh the status display.</td> |
79 </tr><tr> |
96 </tr> |
|
97 <tr> |
80 <td><a href="#GitSubmodulesStatusDialog.start">start</a></td> |
98 <td><a href="#GitSubmodulesStatusDialog.start">start</a></td> |
81 <td>Public method to populate the status list.</td> |
99 <td>Public method to populate the status list.</td> |
82 </tr> |
100 </tr> |
83 </table> |
101 </table> |
84 <h3>Static Methods</h3> |
102 <h3>Static Methods</h3> |
85 <table> |
103 |
86 <tr><td>None</td></tr> |
104 <table> |
87 </table> |
105 <tr><td>None</td></tr> |
|
106 </table> |
|
107 |
88 <a NAME="GitSubmodulesStatusDialog.__init__" ID="GitSubmodulesStatusDialog.__init__"></a> |
108 <a NAME="GitSubmodulesStatusDialog.__init__" ID="GitSubmodulesStatusDialog.__init__"></a> |
89 <h4>GitSubmodulesStatusDialog (Constructor)</h4> |
109 <h4>GitSubmodulesStatusDialog (Constructor)</h4> |
90 <b>GitSubmodulesStatusDialog</b>(<i>vcs, parent=None</i>) |
110 <b>GitSubmodulesStatusDialog</b>(<i>vcs, parent=None</i>) |
|
111 |
91 <p> |
112 <p> |
92 Constructor |
113 Constructor |
93 </p><dl> |
114 </p> |
|
115 <dl> |
|
116 |
94 <dt><i>vcs</i> (Git)</dt> |
117 <dt><i>vcs</i> (Git)</dt> |
95 <dd> |
118 <dd> |
96 reference to the vcs object |
119 reference to the vcs object |
97 </dd><dt><i>parent</i> (QWidget)</dt> |
120 </dd> |
|
121 <dt><i>parent</i> (QWidget)</dt> |
98 <dd> |
122 <dd> |
99 reference to the parent widget |
123 reference to the parent widget |
100 </dd> |
124 </dd> |
101 </dl><a NAME="GitSubmodulesStatusDialog.__processOutput" ID="GitSubmodulesStatusDialog.__processOutput"></a> |
125 </dl> |
|
126 <a NAME="GitSubmodulesStatusDialog.__processOutput" ID="GitSubmodulesStatusDialog.__processOutput"></a> |
102 <h4>GitSubmodulesStatusDialog.__processOutput</h4> |
127 <h4>GitSubmodulesStatusDialog.__processOutput</h4> |
103 <b>__processOutput</b>(<i>output</i>) |
128 <b>__processOutput</b>(<i>output</i>) |
|
129 |
104 <p> |
130 <p> |
105 Private method to process the output and populate the list. |
131 Private method to process the output and populate the list. |
106 </p><dl> |
132 </p> |
|
133 <dl> |
|
134 |
107 <dt><i>output</i> (str)</dt> |
135 <dt><i>output</i> (str)</dt> |
108 <dd> |
136 <dd> |
109 output of the submodule status command |
137 output of the submodule status command |
110 </dd> |
138 </dd> |
111 </dl><a NAME="GitSubmodulesStatusDialog.on_buttonBox_clicked" ID="GitSubmodulesStatusDialog.on_buttonBox_clicked"></a> |
139 </dl> |
|
140 <a NAME="GitSubmodulesStatusDialog.on_buttonBox_clicked" ID="GitSubmodulesStatusDialog.on_buttonBox_clicked"></a> |
112 <h4>GitSubmodulesStatusDialog.on_buttonBox_clicked</h4> |
141 <h4>GitSubmodulesStatusDialog.on_buttonBox_clicked</h4> |
113 <b>on_buttonBox_clicked</b>(<i>button</i>) |
142 <b>on_buttonBox_clicked</b>(<i>button</i>) |
|
143 |
114 <p> |
144 <p> |
115 Private slot called by a button of the button box clicked. |
145 Private slot called by a button of the button box clicked. |
116 </p><dl> |
146 </p> |
|
147 <dl> |
|
148 |
117 <dt><i>button</i></dt> |
149 <dt><i>button</i></dt> |
118 <dd> |
150 <dd> |
119 button that was clicked (QAbstractButton) |
151 button that was clicked (QAbstractButton) |
120 </dd> |
152 </dd> |
121 </dl><a NAME="GitSubmodulesStatusDialog.on_indexCheckBox_toggled" ID="GitSubmodulesStatusDialog.on_indexCheckBox_toggled"></a> |
153 </dl> |
|
154 <a NAME="GitSubmodulesStatusDialog.on_indexCheckBox_toggled" ID="GitSubmodulesStatusDialog.on_indexCheckBox_toggled"></a> |
122 <h4>GitSubmodulesStatusDialog.on_indexCheckBox_toggled</h4> |
155 <h4>GitSubmodulesStatusDialog.on_indexCheckBox_toggled</h4> |
123 <b>on_indexCheckBox_toggled</b>(<i>checked</i>) |
156 <b>on_indexCheckBox_toggled</b>(<i>checked</i>) |
|
157 |
124 <p> |
158 <p> |
125 Private slot handling a change of the index check box. |
159 Private slot handling a change of the index check box. |
126 </p><dl> |
160 </p> |
|
161 <dl> |
|
162 |
127 <dt><i>checked</i> (bool)</dt> |
163 <dt><i>checked</i> (bool)</dt> |
128 <dd> |
164 <dd> |
129 check state of the check box |
165 check state of the check box |
130 </dd> |
166 </dd> |
131 </dl><a NAME="GitSubmodulesStatusDialog.on_recursiveCheckBox_toggled" ID="GitSubmodulesStatusDialog.on_recursiveCheckBox_toggled"></a> |
167 </dl> |
|
168 <a NAME="GitSubmodulesStatusDialog.on_recursiveCheckBox_toggled" ID="GitSubmodulesStatusDialog.on_recursiveCheckBox_toggled"></a> |
132 <h4>GitSubmodulesStatusDialog.on_recursiveCheckBox_toggled</h4> |
169 <h4>GitSubmodulesStatusDialog.on_recursiveCheckBox_toggled</h4> |
133 <b>on_recursiveCheckBox_toggled</b>(<i>checked</i>) |
170 <b>on_recursiveCheckBox_toggled</b>(<i>checked</i>) |
|
171 |
134 <p> |
172 <p> |
135 Private slot handling a change of the recursive check box. |
173 Private slot handling a change of the recursive check box. |
136 </p><dl> |
174 </p> |
|
175 <dl> |
|
176 |
137 <dt><i>checked</i> (bool)</dt> |
177 <dt><i>checked</i> (bool)</dt> |
138 <dd> |
178 <dd> |
139 check state of the check box |
179 check state of the check box |
140 </dd> |
180 </dd> |
141 </dl><a NAME="GitSubmodulesStatusDialog.on_refreshButton_clicked" ID="GitSubmodulesStatusDialog.on_refreshButton_clicked"></a> |
181 </dl> |
|
182 <a NAME="GitSubmodulesStatusDialog.on_refreshButton_clicked" ID="GitSubmodulesStatusDialog.on_refreshButton_clicked"></a> |
142 <h4>GitSubmodulesStatusDialog.on_refreshButton_clicked</h4> |
183 <h4>GitSubmodulesStatusDialog.on_refreshButton_clicked</h4> |
143 <b>on_refreshButton_clicked</b>(<i></i>) |
184 <b>on_refreshButton_clicked</b>(<i></i>) |
|
185 |
144 <p> |
186 <p> |
145 Private slot to refresh the status display. |
187 Private slot to refresh the status display. |
146 </p><a NAME="GitSubmodulesStatusDialog.start" ID="GitSubmodulesStatusDialog.start"></a> |
188 </p> |
|
189 <a NAME="GitSubmodulesStatusDialog.start" ID="GitSubmodulesStatusDialog.start"></a> |
147 <h4>GitSubmodulesStatusDialog.start</h4> |
190 <h4>GitSubmodulesStatusDialog.start</h4> |
148 <b>start</b>(<i>projectDir</i>) |
191 <b>start</b>(<i>projectDir</i>) |
|
192 |
149 <p> |
193 <p> |
150 Public method to populate the status list. |
194 Public method to populate the status list. |
151 </p><dl> |
195 </p> |
|
196 <dl> |
|
197 |
152 <dt><i>projectDir</i> (str)</dt> |
198 <dt><i>projectDir</i> (str)</dt> |
153 <dd> |
199 <dd> |
154 name of the project directory |
200 name of the project directory |
155 </dd> |
201 </dd> |
156 </dl> |
202 </dl> |