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

changeset 6020
baf6da1ae288
equal deleted inserted replaced
6019:58ecdaf0b789 6020:baf6da1ae288
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Plugins.VcsPlugins.vcsGit.GitSubmodulesUpdateOptionsDialog</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.GitSubmodulesUpdateOptionsDialog</h1>
23 <p>
24 Module implementing a dialog to enter options for a submodule update command.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#GitSubmodulesUpdateOptionsDialog">GitSubmodulesUpdateOptionsDialog</a></td>
34 <td>Class implementing a dialog to enter options for a submodule update command.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="GitSubmodulesUpdateOptionsDialog" ID="GitSubmodulesUpdateOptionsDialog"></a>
43 <h2>GitSubmodulesUpdateOptionsDialog</h2>
44 <p>
45 Class implementing a dialog to enter options for a submodule update
46 command.
47 </p>
48 <h3>Derived from</h3>
49 QDialog, Ui_GitSubmodulesUpdateOptionsDialog
50 <h3>Class Attributes</h3>
51 <table>
52 <tr><td>None</td></tr>
53 </table>
54 <h3>Class Methods</h3>
55 <table>
56 <tr><td>None</td></tr>
57 </table>
58 <h3>Methods</h3>
59 <table>
60 <tr>
61 <td><a href="#GitSubmodulesUpdateOptionsDialog.__init__">GitSubmodulesUpdateOptionsDialog</a></td>
62 <td>Constructor</td>
63 </tr><tr>
64 <td><a href="#GitSubmodulesUpdateOptionsDialog.getData">getData</a></td>
65 <td>Public method to get the entered data.</td>
66 </tr>
67 </table>
68 <h3>Static Methods</h3>
69 <table>
70 <tr><td>None</td></tr>
71 </table>
72 <a NAME="GitSubmodulesUpdateOptionsDialog.__init__" ID="GitSubmodulesUpdateOptionsDialog.__init__"></a>
73 <h4>GitSubmodulesUpdateOptionsDialog (Constructor)</h4>
74 <b>GitSubmodulesUpdateOptionsDialog</b>(<i>submodulePaths, parent=None</i>)
75 <p>
76 Constructor
77 </p><dl>
78 <dt><i>submodulePaths</i> (list of str)</dt>
79 <dd>
80 list of submodule paths
81 </dd><dt><i>parent</i> (QWidget)</dt>
82 <dd>
83 reference to the parent widget
84 </dd>
85 </dl><a NAME="GitSubmodulesUpdateOptionsDialog.getData" ID="GitSubmodulesUpdateOptionsDialog.getData"></a>
86 <h4>GitSubmodulesUpdateOptionsDialog.getData</h4>
87 <b>getData</b>(<i></i>)
88 <p>
89 Public method to get the entered data.
90 </p><dl>
91 <dt>Returns:</dt>
92 <dd>
93 tuple containing the update procedure, a flag indicating an
94 init, a flag indicating an update with remote, a flag indicating
95 not to fetch the remote, a flag indicating an enforced operation
96 and a list of selected submodules.
97 </dd>
98 </dl><dl>
99 <dt>Return Type:</dt>
100 <dd>
101 tuple of (int, bool, bool, bool, bool, list of str)
102 </dd>
103 </dl>
104 <div align="right"><a href="#top">Up</a></div>
105 <hr />
106 </body></html>

eric ide

mercurial