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