src/eric7/Documentation/Source/eric7.EricWidgets.EricProgressDialog.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 9236
db53a9efe7ef
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.EricWidgets.EricProgressDialog</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.EricWidgets.EricProgressDialog</h1>
10
11 <p>
12 Module implementing a progress dialog allowing a customized progress bar label.
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="#EricProgressDialog">EricProgressDialog</a></td>
25 <td>Class implementing a progress dialog allowing a customized progress bar label.</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="EricProgressDialog" ID="EricProgressDialog"></a>
36 <h2>EricProgressDialog</h2>
37
38 <p>
39 Class implementing a progress dialog allowing a customized progress bar
40 label.
41 </p>
42 <h3>Derived from</h3>
43 QProgressDialog
44 <h3>Class Attributes</h3>
45
46 <table>
47 <tr><td>None</td></tr>
48 </table>
49 <h3>Class Methods</h3>
50
51 <table>
52 <tr><td>None</td></tr>
53 </table>
54 <h3>Methods</h3>
55
56 <table>
57
58 <tr>
59 <td><a href="#EricProgressDialog.__init__">EricProgressDialog</a></td>
60 <td>Constructor</td>
61 </tr>
62 <tr>
63 <td><a href="#EricProgressDialog.format">format</a></td>
64 <td>Public method to get the progress bar format.</td>
65 </tr>
66 <tr>
67 <td><a href="#EricProgressDialog.setFormat">setFormat</a></td>
68 <td>Public method to set the progress bar format.</td>
69 </tr>
70 </table>
71 <h3>Static Methods</h3>
72
73 <table>
74 <tr><td>None</td></tr>
75 </table>
76
77 <a NAME="EricProgressDialog.__init__" ID="EricProgressDialog.__init__"></a>
78 <h4>EricProgressDialog (Constructor)</h4>
79 <b>EricProgressDialog</b>(<i>labelText, cancelButtonText, minimum, maximum, labelFormat=None, parent=None, flags=None</i>)
80
81 <p>
82 Constructor
83 </p>
84 <dl>
85
86 <dt><i>labelText</i></dt>
87 <dd>
88 text of the dialog label (string)
89 </dd>
90 <dt><i>cancelButtonText</i></dt>
91 <dd>
92 text of the cancel button (string)
93 </dd>
94 <dt><i>minimum</i></dt>
95 <dd>
96 minimum value (integer)
97 </dd>
98 <dt><i>maximum</i></dt>
99 <dd>
100 maximum value (integer)
101 </dd>
102 <dt><i>labelFormat</i></dt>
103 <dd>
104 label format of the progress bar (string)
105 </dd>
106 <dt><i>parent</i></dt>
107 <dd>
108 reference to the parent widget (QWidget)
109 </dd>
110 <dt><i>flags</i></dt>
111 <dd>
112 window flags of the dialog (Qt.WindowFlags)
113 </dd>
114 </dl>
115 <a NAME="EricProgressDialog.format" ID="EricProgressDialog.format"></a>
116 <h4>EricProgressDialog.format</h4>
117 <b>format</b>(<i></i>)
118
119 <p>
120 Public method to get the progress bar format.
121 </p>
122 <dl>
123 <dt>Return:</dt>
124 <dd>
125 progress bar format (string)
126 </dd>
127 </dl>
128 <a NAME="EricProgressDialog.setFormat" ID="EricProgressDialog.setFormat"></a>
129 <h4>EricProgressDialog.setFormat</h4>
130 <b>setFormat</b>(<i>labelFormat</i>)
131
132 <p>
133 Public method to set the progress bar format.
134 </p>
135 <dl>
136
137 <dt><i>labelFormat</i></dt>
138 <dd>
139 progress bar format (string)
140 </dd>
141 </dl>
142 <div align="right"><a href="#top">Up</a></div>
143 <hr />
144 </body></html>

eric ide

mercurial