src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.GpgExtension.HgGpgSignDialog.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 9029
14efd8fa5d8f
child 10479
856476537696
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Plugins.VcsPlugins.vcsMercurial.GpgExtension.HgGpgSignDialog</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.vcsMercurial.GpgExtension.HgGpgSignDialog</h1>
10
11 <p>
12 Module implementing a dialog to enter data for signing a revision.
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="#HgGpgSignDialog">HgGpgSignDialog</a></td>
25 <td>Class implementing a dialog to enter data for signing a revision.</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="HgGpgSignDialog" ID="HgGpgSignDialog"></a>
36 <h2>HgGpgSignDialog</h2>
37
38 <p>
39 Class implementing a dialog to enter data for signing a revision.
40 </p>
41 <h3>Derived from</h3>
42 QDialog, Ui_HgGpgSignDialog
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="#HgGpgSignDialog.__init__">HgGpgSignDialog</a></td>
59 <td>Constructor</td>
60 </tr>
61 <tr>
62 <td><a href="#HgGpgSignDialog.__updateOK">__updateOK</a></td>
63 <td>Private slot to update the OK button.</td>
64 </tr>
65 <tr>
66 <td><a href="#HgGpgSignDialog.getData">getData</a></td>
67 <td>Public method to retrieve the entered data.</td>
68 </tr>
69 </table>
70 <h3>Static Methods</h3>
71
72 <table>
73 <tr><td>None</td></tr>
74 </table>
75
76 <a NAME="HgGpgSignDialog.__init__" ID="HgGpgSignDialog.__init__"></a>
77 <h4>HgGpgSignDialog (Constructor)</h4>
78 <b>HgGpgSignDialog</b>(<i>tagsList, branchesList, bookmarksList=None, parent=None</i>)
79
80 <p>
81 Constructor
82 </p>
83 <dl>
84
85 <dt><i>tagsList</i> (list of str)</dt>
86 <dd>
87 list of tags
88 </dd>
89 <dt><i>branchesList</i> (list of str)</dt>
90 <dd>
91 list of branches
92 </dd>
93 <dt><i>bookmarksList</i> (list of str)</dt>
94 <dd>
95 list of bookmarks
96 </dd>
97 <dt><i>parent</i> (QWidget)</dt>
98 <dd>
99 parent widget
100 </dd>
101 </dl>
102 <a NAME="HgGpgSignDialog.__updateOK" ID="HgGpgSignDialog.__updateOK"></a>
103 <h4>HgGpgSignDialog.__updateOK</h4>
104 <b>__updateOK</b>(<i></i>)
105
106 <p>
107 Private slot to update the OK button.
108 </p>
109 <a NAME="HgGpgSignDialog.getData" ID="HgGpgSignDialog.getData"></a>
110 <h4>HgGpgSignDialog.getData</h4>
111 <b>getData</b>(<i></i>)
112
113 <p>
114 Public method to retrieve the entered data.
115 </p>
116 <dl>
117 <dt>Return:</dt>
118 <dd>
119 tuple giving the revision, a flag indicating not to commit
120 the signature, a commit message, an ID of the key to be used,
121 a flag indicating a local signature and a flag indicating a forced
122 signature
123 </dd>
124 </dl>
125 <dl>
126 <dt>Return Type:</dt>
127 <dd>
128 tuple of (str, bool, str, str, bool, bool)
129 </dd>
130 </dl>
131 <div align="right"><a href="#top">Up</a></div>
132 <hr />
133 </body></html>

eric ide

mercurial