src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgTagDialog.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10438
4cd7e5a8b3cf
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Plugins.VcsPlugins.vcsMercurial.HgTagDialog</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.HgTagDialog</h1>
10
11 <p>
12 Module implementing a dialog to enter the data for a tagging operation.
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="#HgTagDialog">HgTagDialog</a></td>
25 <td>Class implementing a dialog to enter the data for a tagging operation.</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="HgTagDialog" ID="HgTagDialog"></a>
36 <h2>HgTagDialog</h2>
37
38 <p>
39 Class implementing a dialog to enter the data for a tagging operation.
40 </p>
41 <h3>Derived from</h3>
42 QDialog, Ui_HgTagDialog
43 <h3>Class Attributes</h3>
44
45 <table>
46 <tr><td>CreateGlobalTag</td></tr><tr><td>CreateLocalTag</td></tr><tr><td>DeleteGlobalTag</td></tr><tr><td>DeleteLocalTag</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="#HgTagDialog.__init__">HgTagDialog</a></td>
59 <td>Constructor</td>
60 </tr>
61 <tr>
62 <td><a href="#HgTagDialog.getParameters">getParameters</a></td>
63 <td>Public method to retrieve the tag data.</td>
64 </tr>
65 <tr>
66 <td><a href="#HgTagDialog.on_tagCombo_currentIndexChanged">on_tagCombo_currentIndexChanged</a></td>
67 <td>Private slot setting the local status of the selected entry.</td>
68 </tr>
69 <tr>
70 <td><a href="#HgTagDialog.on_tagCombo_editTextChanged">on_tagCombo_editTextChanged</a></td>
71 <td>Private method used to enable/disable the OK-button.</td>
72 </tr>
73 </table>
74 <h3>Static Methods</h3>
75
76 <table>
77 <tr><td>None</td></tr>
78 </table>
79
80 <a NAME="HgTagDialog.__init__" ID="HgTagDialog.__init__"></a>
81 <h4>HgTagDialog (Constructor)</h4>
82 <b>HgTagDialog</b>(<i>taglist, revision=None, tagName=None, parent=None</i>)
83
84 <p>
85 Constructor
86 </p>
87 <dl>
88
89 <dt><i>taglist</i></dt>
90 <dd>
91 list of previously entered tags (list of strings)
92 </dd>
93 <dt><i>revision</i></dt>
94 <dd>
95 revision to set tag for (string)
96 </dd>
97 <dt><i>tagName</i></dt>
98 <dd>
99 name of the tag (string)
100 </dd>
101 <dt><i>parent</i></dt>
102 <dd>
103 parent widget (QWidget)
104 </dd>
105 </dl>
106 <a NAME="HgTagDialog.getParameters" ID="HgTagDialog.getParameters"></a>
107 <h4>HgTagDialog.getParameters</h4>
108 <b>getParameters</b>(<i></i>)
109
110 <p>
111 Public method to retrieve the tag data.
112 </p>
113 <dl>
114 <dt>Return:</dt>
115 <dd>
116 tuple containing the tag, revision, tag operation and a flag
117 indicating to enforce the operation
118 </dd>
119 </dl>
120 <dl>
121 <dt>Return Type:</dt>
122 <dd>
123 tuple of str, str, int,bool
124 </dd>
125 </dl>
126 <a NAME="HgTagDialog.on_tagCombo_currentIndexChanged" ID="HgTagDialog.on_tagCombo_currentIndexChanged"></a>
127 <h4>HgTagDialog.on_tagCombo_currentIndexChanged</h4>
128 <b>on_tagCombo_currentIndexChanged</b>(<i>index</i>)
129
130 <p>
131 Private slot setting the local status of the selected entry.
132 </p>
133 <dl>
134
135 <dt><i>index</i></dt>
136 <dd>
137 index of the selected entrie (integer)
138 </dd>
139 </dl>
140 <a NAME="HgTagDialog.on_tagCombo_editTextChanged" ID="HgTagDialog.on_tagCombo_editTextChanged"></a>
141 <h4>HgTagDialog.on_tagCombo_editTextChanged</h4>
142 <b>on_tagCombo_editTextChanged</b>(<i>text</i>)
143
144 <p>
145 Private method used to enable/disable the OK-button.
146 </p>
147 <dl>
148
149 <dt><i>text</i></dt>
150 <dd>
151 tag name entered in the combo (string)
152 </dd>
153 </dl>
154 <div align="right"><a href="#top">Up</a></div>
155 <hr />
156 </body></html>

eric ide

mercurial