Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.GitSubmodulesStatusDialog.html

changeset 6020
baf6da1ae288
equal deleted inserted replaced
6019:58ecdaf0b789 6020:baf6da1ae288
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Plugins.VcsPlugins.vcsGit.GitSubmodulesStatusDialog</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.vcsGit.GitSubmodulesStatusDialog</h1>
23 <p>
24 Module implementing a dialog to show the status of the submodules of the
25 project.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#GitSubmodulesStatusDialog">GitSubmodulesStatusDialog</a></td>
35 <td>Class implementing a dialog to show the status of the submodules of the project.</td>
36 </tr>
37 </table>
38 <h3>Functions</h3>
39 <table>
40 <tr><td>None</td></tr>
41 </table>
42 <hr /><hr />
43 <a NAME="GitSubmodulesStatusDialog" ID="GitSubmodulesStatusDialog"></a>
44 <h2>GitSubmodulesStatusDialog</h2>
45 <p>
46 Class implementing a dialog to show the status of the submodules of the
47 project.
48 </p>
49 <h3>Derived from</h3>
50 QDialog, Ui_GitSubmodulesStatusDialog
51 <h3>Class Attributes</h3>
52 <table>
53 <tr><td>None</td></tr>
54 </table>
55 <h3>Class Methods</h3>
56 <table>
57 <tr><td>None</td></tr>
58 </table>
59 <h3>Methods</h3>
60 <table>
61 <tr>
62 <td><a href="#GitSubmodulesStatusDialog.__init__">GitSubmodulesStatusDialog</a></td>
63 <td>Constructor</td>
64 </tr><tr>
65 <td><a href="#GitSubmodulesStatusDialog.__processOutput">__processOutput</a></td>
66 <td>Private method to process the output and populate the list.</td>
67 </tr><tr>
68 <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>
70 </tr><tr>
71 <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>
73 </tr><tr>
74 <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>
76 </tr><tr>
77 <td><a href="#GitSubmodulesStatusDialog.on_refreshButton_clicked">on_refreshButton_clicked</a></td>
78 <td>Private slot to refresh the status display.</td>
79 </tr><tr>
80 <td><a href="#GitSubmodulesStatusDialog.start">start</a></td>
81 <td>Public method to populate the status list.</td>
82 </tr>
83 </table>
84 <h3>Static Methods</h3>
85 <table>
86 <tr><td>None</td></tr>
87 </table>
88 <a NAME="GitSubmodulesStatusDialog.__init__" ID="GitSubmodulesStatusDialog.__init__"></a>
89 <h4>GitSubmodulesStatusDialog (Constructor)</h4>
90 <b>GitSubmodulesStatusDialog</b>(<i>vcs, parent=None</i>)
91 <p>
92 Constructor
93 </p><dl>
94 <dt><i>vcs</i> (Git)</dt>
95 <dd>
96 reference to the vcs object
97 </dd><dt><i>parent</i> (QWidget)</dt>
98 <dd>
99 reference to the parent widget
100 </dd>
101 </dl><a NAME="GitSubmodulesStatusDialog.__processOutput" ID="GitSubmodulesStatusDialog.__processOutput"></a>
102 <h4>GitSubmodulesStatusDialog.__processOutput</h4>
103 <b>__processOutput</b>(<i>output</i>)
104 <p>
105 Private method to process the output and populate the list.
106 </p><dl>
107 <dt><i>output</i> (str)</dt>
108 <dd>
109 output of the submodule status command
110 </dd>
111 </dl><a NAME="GitSubmodulesStatusDialog.on_buttonBox_clicked" ID="GitSubmodulesStatusDialog.on_buttonBox_clicked"></a>
112 <h4>GitSubmodulesStatusDialog.on_buttonBox_clicked</h4>
113 <b>on_buttonBox_clicked</b>(<i>button</i>)
114 <p>
115 Private slot called by a button of the button box clicked.
116 </p><dl>
117 <dt><i>button</i></dt>
118 <dd>
119 button that was clicked (QAbstractButton)
120 </dd>
121 </dl><a NAME="GitSubmodulesStatusDialog.on_indexCheckBox_toggled" ID="GitSubmodulesStatusDialog.on_indexCheckBox_toggled"></a>
122 <h4>GitSubmodulesStatusDialog.on_indexCheckBox_toggled</h4>
123 <b>on_indexCheckBox_toggled</b>(<i>checked</i>)
124 <p>
125 Private slot handling a change of the index check box.
126 </p><dl>
127 <dt><i>checked</i> (bool)</dt>
128 <dd>
129 check state of the check box
130 </dd>
131 </dl><a NAME="GitSubmodulesStatusDialog.on_recursiveCheckBox_toggled" ID="GitSubmodulesStatusDialog.on_recursiveCheckBox_toggled"></a>
132 <h4>GitSubmodulesStatusDialog.on_recursiveCheckBox_toggled</h4>
133 <b>on_recursiveCheckBox_toggled</b>(<i>checked</i>)
134 <p>
135 Private slot handling a change of the recursive check box.
136 </p><dl>
137 <dt><i>checked</i> (bool)</dt>
138 <dd>
139 check state of the check box
140 </dd>
141 </dl><a NAME="GitSubmodulesStatusDialog.on_refreshButton_clicked" ID="GitSubmodulesStatusDialog.on_refreshButton_clicked"></a>
142 <h4>GitSubmodulesStatusDialog.on_refreshButton_clicked</h4>
143 <b>on_refreshButton_clicked</b>(<i></i>)
144 <p>
145 Private slot to refresh the status display.
146 </p><a NAME="GitSubmodulesStatusDialog.start" ID="GitSubmodulesStatusDialog.start"></a>
147 <h4>GitSubmodulesStatusDialog.start</h4>
148 <b>start</b>(<i>projectDir</i>)
149 <p>
150 Public method to populate the status list.
151 </p><dl>
152 <dt><i>projectDir</i> (str)</dt>
153 <dd>
154 name of the project directory
155 </dd>
156 </dl>
157 <div align="right"><a href="#top">Up</a></div>
158 <hr />
159 </body></html>

eric ide

mercurial