|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric7.Plugins.VcsPlugins.vcsGit.GitSubmodulesSummaryOptionsDialog</title> |
|
4 <meta charset="UTF-8"> |
|
5 <link rel="stylesheet" href="styles.css"> |
|
6 </head> |
|
7 <body> |
|
8 <a NAME="top" ID="top"></a> |
|
9 <h1>eric7.Plugins.VcsPlugins.vcsGit.GitSubmodulesSummaryOptionsDialog</h1> |
|
10 |
|
11 <p> |
|
12 Module implementing a dialog to enter submodule summary options. |
|
13 </p> |
|
14 <h3>Global Attributes</h3> |
|
15 |
|
16 <table> |
|
17 <tr><td>None</td></tr> |
|
18 </table> |
|
19 <h3>Classes</h3> |
|
20 |
|
21 <table> |
|
22 |
|
23 <tr> |
|
24 <td><a href="#GitSubmodulesSummaryOptionsDialog">GitSubmodulesSummaryOptionsDialog</a></td> |
|
25 <td>Class implementing a dialog to enter submodule summary options.</td> |
|
26 </tr> |
|
27 </table> |
|
28 <h3>Functions</h3> |
|
29 |
|
30 <table> |
|
31 <tr><td>None</td></tr> |
|
32 </table> |
|
33 <hr /> |
|
34 <hr /> |
|
35 <a NAME="GitSubmodulesSummaryOptionsDialog" ID="GitSubmodulesSummaryOptionsDialog"></a> |
|
36 <h2>GitSubmodulesSummaryOptionsDialog</h2> |
|
37 |
|
38 <p> |
|
39 Class implementing a dialog to enter submodule summary options. |
|
40 </p> |
|
41 <h3>Derived from</h3> |
|
42 QDialog, Ui_GitSubmodulesSummaryOptionsDialog |
|
43 <h3>Class Attributes</h3> |
|
44 |
|
45 <table> |
|
46 <tr><td>None</td></tr> |
|
47 </table> |
|
48 <h3>Class Methods</h3> |
|
49 |
|
50 <table> |
|
51 <tr><td>None</td></tr> |
|
52 </table> |
|
53 <h3>Methods</h3> |
|
54 |
|
55 <table> |
|
56 |
|
57 <tr> |
|
58 <td><a href="#GitSubmodulesSummaryOptionsDialog.__init__">GitSubmodulesSummaryOptionsDialog</a></td> |
|
59 <td>Constructor</td> |
|
60 </tr> |
|
61 <tr> |
|
62 <td><a href="#GitSubmodulesSummaryOptionsDialog.getData">getData</a></td> |
|
63 <td>Public method to get the entered data.</td> |
|
64 </tr> |
|
65 </table> |
|
66 <h3>Static Methods</h3> |
|
67 |
|
68 <table> |
|
69 <tr><td>None</td></tr> |
|
70 </table> |
|
71 |
|
72 <a NAME="GitSubmodulesSummaryOptionsDialog.__init__" ID="GitSubmodulesSummaryOptionsDialog.__init__"></a> |
|
73 <h4>GitSubmodulesSummaryOptionsDialog (Constructor)</h4> |
|
74 <b>GitSubmodulesSummaryOptionsDialog</b>(<i>submodulePaths, parent=None</i>) |
|
75 |
|
76 <p> |
|
77 Constructor |
|
78 </p> |
|
79 <dl> |
|
80 |
|
81 <dt><i>submodulePaths</i> (list of str)</dt> |
|
82 <dd> |
|
83 list of submodule paths |
|
84 </dd> |
|
85 <dt><i>parent</i> (QWidget)</dt> |
|
86 <dd> |
|
87 reference to the parent widget |
|
88 </dd> |
|
89 </dl> |
|
90 <a NAME="GitSubmodulesSummaryOptionsDialog.getData" ID="GitSubmodulesSummaryOptionsDialog.getData"></a> |
|
91 <h4>GitSubmodulesSummaryOptionsDialog.getData</h4> |
|
92 <b>getData</b>(<i></i>) |
|
93 |
|
94 <p> |
|
95 Public method to get the entered data. |
|
96 </p> |
|
97 <dl> |
|
98 <dt>Return:</dt> |
|
99 <dd> |
|
100 tuple containing a list of selected submodules, a flag |
|
101 indicating to show summary for the superproject index, a flag |
|
102 indicating to show summary for the submodules index, an optional |
|
103 commit ID and a value for the number of entries to be shown |
|
104 </dd> |
|
105 </dl> |
|
106 <dl> |
|
107 <dt>Return Type:</dt> |
|
108 <dd> |
|
109 tuple of (list of str, bool, bool, str, int) |
|
110 </dd> |
|
111 </dl> |
|
112 <div align="right"><a href="#top">Up</a></div> |
|
113 <hr /> |
|
114 </body></html> |