Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.GitSubmodulesSummaryOptionsDialog.html
Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.GitSubmodulesSummaryOptionsDialog.html
- changeset 6020
- baf6da1ae288
equal
deleted
inserted
replaced
| 6019:58ecdaf0b789 | 6020:baf6da1ae288 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.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><a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.Plugins.VcsPlugins.vcsGit.GitSubmodulesSummaryOptionsDialog</h1> | |
| 23 <p> | |
| 24 Module implementing a dialog to enter submodule summary options. | |
| 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="#GitSubmodulesSummaryOptionsDialog">GitSubmodulesSummaryOptionsDialog</a></td> | |
| 34 <td>Class implementing a dialog to enter submodule summary options.</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="GitSubmodulesSummaryOptionsDialog" ID="GitSubmodulesSummaryOptionsDialog"></a> | |
| 43 <h2>GitSubmodulesSummaryOptionsDialog</h2> | |
| 44 <p> | |
| 45 Class implementing a dialog to enter submodule summary options. | |
| 46 </p> | |
| 47 <h3>Derived from</h3> | |
| 48 QDialog, Ui_GitSubmodulesSummaryOptionsDialog | |
| 49 <h3>Class Attributes</h3> | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Class Methods</h3> | |
| 54 <table> | |
| 55 <tr><td>None</td></tr> | |
| 56 </table> | |
| 57 <h3>Methods</h3> | |
| 58 <table> | |
| 59 <tr> | |
| 60 <td><a href="#GitSubmodulesSummaryOptionsDialog.__init__">GitSubmodulesSummaryOptionsDialog</a></td> | |
| 61 <td>Constructor</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#GitSubmodulesSummaryOptionsDialog.getData">getData</a></td> | |
| 64 <td>Public method to get the entered data.</td> | |
| 65 </tr> | |
| 66 </table> | |
| 67 <h3>Static Methods</h3> | |
| 68 <table> | |
| 69 <tr><td>None</td></tr> | |
| 70 </table> | |
| 71 <a NAME="GitSubmodulesSummaryOptionsDialog.__init__" ID="GitSubmodulesSummaryOptionsDialog.__init__"></a> | |
| 72 <h4>GitSubmodulesSummaryOptionsDialog (Constructor)</h4> | |
| 73 <b>GitSubmodulesSummaryOptionsDialog</b>(<i>submodulePaths, parent=None</i>) | |
| 74 <p> | |
| 75 Constructor | |
| 76 </p><dl> | |
| 77 <dt><i>submodulePaths</i> (list of str)</dt> | |
| 78 <dd> | |
| 79 list of submodule paths | |
| 80 </dd><dt><i>parent</i> (QWidget)</dt> | |
| 81 <dd> | |
| 82 reference to the parent widget | |
| 83 </dd> | |
| 84 </dl><a NAME="GitSubmodulesSummaryOptionsDialog.getData" ID="GitSubmodulesSummaryOptionsDialog.getData"></a> | |
| 85 <h4>GitSubmodulesSummaryOptionsDialog.getData</h4> | |
| 86 <b>getData</b>(<i></i>) | |
| 87 <p> | |
| 88 Public method to get the entered data. | |
| 89 </p><dl> | |
| 90 <dt>Returns:</dt> | |
| 91 <dd> | |
| 92 tuple containing a list of selected submodules, a flag | |
| 93 indicating to show summary for the superproject index, a flag | |
| 94 indicating to show summary for the submodules index, an optional | |
| 95 commit ID and a value for the number of entries to be shown | |
| 96 </dd> | |
| 97 </dl><dl> | |
| 98 <dt>Return Type:</dt> | |
| 99 <dd> | |
| 100 tuple of (list of str, bool, bool, str, int) | |
| 101 </dd> | |
| 102 </dl> | |
| 103 <div align="right"><a href="#top">Up</a></div> | |
| 104 <hr /> | |
| 105 </body></html> |
