src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitSubmodulesStatusDialog.html

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

eric ide

mercurial