RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.ProgressHandle.html

changeset 17
a0fac63ef73f
child 44
8aa985c8dee5
equal deleted inserted replaced
16:65b340b40844 17:a0fac63ef73f
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
4 <html><head>
5 <title>Plugin_Refactoring_Rope.RefactoringRope.ProgressHandle</title>
6 <style>
7 body {
8 background: #EDECE6;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #85774A; }
14 h2 { color: white; background: #85774A; }
15 h3 { color: white; background: #9D936E; }
16 h4 { color: white; background: #9D936E; }
17
18 a { color: #BA6D36; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>Plugin_Refactoring_Rope.RefactoringRope.ProgressHandle</h1>
24 <p>
25 Module implementing a TaskHandle class with a progress dialog.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#ProgressHandle">ProgressHandle</a></td>
35 <td>Class implementing TaskHandle with a progress dialog.</td>
36 </tr>
37 </table>
38 <h3>Functions</h3>
39 <table>
40 <tr><td>None</td></tr>
41 </table>
42 <hr /><hr />
43 <a NAME="ProgressHandle" ID="ProgressHandle"></a>
44 <h2>ProgressHandle</h2>
45 <p>
46 Class implementing TaskHandle with a progress dialog.
47 </p>
48 <h3>Derived from</h3>
49 rope.base.taskhandle.TaskHandle
50 <h3>Class Attributes</h3>
51 <table>
52 <tr><td>None</td></tr>
53 </table>
54 <h3>Methods</h3>
55 <table>
56 <tr>
57 <td><a href="#ProgressHandle.__init__">ProgressHandle</a></td>
58 <td>Constructor</td>
59 </tr><tr>
60 <td><a href="#ProgressHandle.__updateProgress">__updateProgress</a></td>
61 <td>Private slot to handle the task progress.</td>
62 </tr><tr>
63 <td><a href="#ProgressHandle.reset">reset</a></td>
64 <td>Public slot to reset the progress dialog.</td>
65 </tr><tr>
66 <td><a href="#ProgressHandle.show">show</a></td>
67 <td>Public slot to show the progress dialog.</td>
68 </tr>
69 </table>
70 <a NAME="ProgressHandle.__init__" ID="ProgressHandle.__init__"></a>
71 <h4>ProgressHandle (Constructor)</h4>
72 <b>ProgressHandle</b>(<i>title, interruptable=True, parent=None</i>)
73 <p>
74 Constructor
75 </p><dl>
76 <dt><i>title</i></dt>
77 <dd>
78 title for the taskhandle (string)
79 </dd><dt><i>interruptable</i></dt>
80 <dd>
81 flag indicating, that the task may be
82 interrupted (boolean)
83 </dd><dt><i>parent</i></dt>
84 <dd>
85 reference to the parent widget (QWidget)
86 </dd>
87 </dl><a NAME="ProgressHandle.__updateProgress" ID="ProgressHandle.__updateProgress"></a>
88 <h4>ProgressHandle.__updateProgress</h4>
89 <b>__updateProgress</b>(<i></i>)
90 <p>
91 Private slot to handle the task progress.
92 </p><a NAME="ProgressHandle.reset" ID="ProgressHandle.reset"></a>
93 <h4>ProgressHandle.reset</h4>
94 <b>reset</b>(<i></i>)
95 <p>
96 Public slot to reset the progress dialog.
97 </p><a NAME="ProgressHandle.show" ID="ProgressHandle.show"></a>
98 <h4>ProgressHandle.show</h4>
99 <b>show</b>(<i></i>)
100 <p>
101 Public slot to show the progress dialog.
102 </p>
103 <div align="right"><a href="#top">Up</a></div>
104 <hr />
105 </body></html>

eric ide

mercurial