RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.PluginRefactoringRope.html

changeset 17
a0fac63ef73f
child 31
0389d4a924cc
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.PluginRefactoringRope</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.PluginRefactoringRope</h1>
24 <p>
25 Module implementing the Rope refactoring plugin.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <tr><td>author</td></tr><tr><td>autoactivate</td></tr><tr><td>className</td></tr><tr><td>deactivateable</td></tr><tr><td>error</td></tr><tr><td>internalPackages</td></tr><tr><td>longDescription</td></tr><tr><td>name</td></tr><tr><td>packageName</td></tr><tr><td>pyqtApi</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#RefactoringRopePlugin">RefactoringRopePlugin</a></td>
35 <td>Class implementing the Rope refactoring plugin.</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="RefactoringRopePlugin" ID="RefactoringRopePlugin"></a>
44 <h2>RefactoringRopePlugin</h2>
45 <p>
46 Class implementing the Rope refactoring plugin.
47 </p>
48 <h3>Derived from</h3>
49 QObject
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="#RefactoringRopePlugin.__init__">RefactoringRopePlugin</a></td>
58 <td>Constructor</td>
59 </tr><tr>
60 <td><a href="#RefactoringRopePlugin.__initialize">__initialize</a></td>
61 <td>Private slot to (re)initialize the plugin.</td>
62 </tr><tr>
63 <td><a href="#RefactoringRopePlugin.__loadTranslator">__loadTranslator</a></td>
64 <td>Private method to load the translation file.</td>
65 </tr><tr>
66 <td><a href="#RefactoringRopePlugin.__projectClosed">__projectClosed</a></td>
67 <td>Public slot to handle the projectClosed signal.</td>
68 </tr><tr>
69 <td><a href="#RefactoringRopePlugin.__projectOpened">__projectOpened</a></td>
70 <td>Public slot to handle the projectOpened signal.</td>
71 </tr><tr>
72 <td><a href="#RefactoringRopePlugin.activate">activate</a></td>
73 <td>Public method to activate this plugin.</td>
74 </tr><tr>
75 <td><a href="#RefactoringRopePlugin.deactivate">deactivate</a></td>
76 <td>Public method to deactivate this plugin.</td>
77 </tr>
78 </table>
79 <a NAME="RefactoringRopePlugin.__init__" ID="RefactoringRopePlugin.__init__"></a>
80 <h4>RefactoringRopePlugin (Constructor)</h4>
81 <b>RefactoringRopePlugin</b>(<i>ui</i>)
82 <p>
83 Constructor
84 </p><dl>
85 <dt><i>ui</i></dt>
86 <dd>
87 reference to the user interface object (UI.UserInterface)
88 </dd>
89 </dl><a NAME="RefactoringRopePlugin.__initialize" ID="RefactoringRopePlugin.__initialize"></a>
90 <h4>RefactoringRopePlugin.__initialize</h4>
91 <b>__initialize</b>(<i></i>)
92 <p>
93 Private slot to (re)initialize the plugin.
94 </p><a NAME="RefactoringRopePlugin.__loadTranslator" ID="RefactoringRopePlugin.__loadTranslator"></a>
95 <h4>RefactoringRopePlugin.__loadTranslator</h4>
96 <b>__loadTranslator</b>(<i></i>)
97 <p>
98 Private method to load the translation file.
99 </p><a NAME="RefactoringRopePlugin.__projectClosed" ID="RefactoringRopePlugin.__projectClosed"></a>
100 <h4>RefactoringRopePlugin.__projectClosed</h4>
101 <b>__projectClosed</b>(<i></i>)
102 <p>
103 Public slot to handle the projectClosed signal.
104 </p><a NAME="RefactoringRopePlugin.__projectOpened" ID="RefactoringRopePlugin.__projectOpened"></a>
105 <h4>RefactoringRopePlugin.__projectOpened</h4>
106 <b>__projectOpened</b>(<i></i>)
107 <p>
108 Public slot to handle the projectOpened signal.
109 </p><a NAME="RefactoringRopePlugin.activate" ID="RefactoringRopePlugin.activate"></a>
110 <h4>RefactoringRopePlugin.activate</h4>
111 <b>activate</b>(<i></i>)
112 <p>
113 Public method to activate this plugin.
114 </p><dl>
115 <dt>Returns:</dt>
116 <dd>
117 tuple of None and activation status (boolean)
118 </dd>
119 </dl><a NAME="RefactoringRopePlugin.deactivate" ID="RefactoringRopePlugin.deactivate"></a>
120 <h4>RefactoringRopePlugin.deactivate</h4>
121 <b>deactivate</b>(<i></i>)
122 <p>
123 Public method to deactivate this plugin.
124 </p>
125 <div align="right"><a href="#top">Up</a></div>
126 <hr />
127 </body></html>

eric ide

mercurial