PySide2PyQt/Documentation/source/Plugin_Tools_PySide2PyQt.PluginPySide2PyQt.html

changeset 50
5e4b312590ba
parent 43
25977715166f
child 53
52bc3465c1bc
equal deleted inserted replaced
49:406f0965f449 50:5e4b312590ba
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>Plugin_Tools_PySide2PyQt.PluginPySide2PyQt</h1> 23 <h1>Plugin_Tools_PySide2PyQt.PluginPySide2PyQt</h1>
24
23 <p> 25 <p>
24 Module implementing the PySide to PyQt (and vice versa) plug-in. 26 Module implementing the PySide to PyQt (and vice versa) plug-in.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
27 <table> 29
28 <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>longDescription</td></tr><tr><td>name</td></tr><tr><td>needsRestart</td></tr><tr><td>packageName</td></tr><tr><td>pyqtApi</td></tr><tr><td>python2Compatible</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr> 30 <table>
31 <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>longDescription</td></tr><tr><td>name</td></tr><tr><td>needsRestart</td></tr><tr><td>packageName</td></tr><tr><td>pyqtApi</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
31 <table> 34
35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#PySide2PyQtPlugin">PySide2PyQtPlugin</a></td> 38 <td><a href="#PySide2PyQtPlugin">PySide2PyQtPlugin</a></td>
34 <td>Class implementing the PySide to PyQt (and vice versa) plugin.</td> 39 <td>Class implementing the PySide to PyQt (and vice versa) plugin.</td>
35 </tr> 40 </tr>
36 </table> 41 </table>
37 <h3>Functions</h3> 42 <h3>Functions</h3>
38 <table> 43
39 <tr><td>None</td></tr> 44 <table>
40 </table> 45 <tr><td>None</td></tr>
41 <hr /><hr /> 46 </table>
47 <hr />
48 <hr />
42 <a NAME="PySide2PyQtPlugin" ID="PySide2PyQtPlugin"></a> 49 <a NAME="PySide2PyQtPlugin" ID="PySide2PyQtPlugin"></a>
43 <h2>PySide2PyQtPlugin</h2> 50 <h2>PySide2PyQtPlugin</h2>
51
44 <p> 52 <p>
45 Class implementing the PySide to PyQt (and vice versa) plugin. 53 Class implementing the PySide to PyQt (and vice versa) plugin.
46 </p> 54 </p>
47 <h3>Derived from</h3> 55 <h3>Derived from</h3>
48 QObject 56 QObject
49 <h3>Class Attributes</h3> 57 <h3>Class Attributes</h3>
58
50 <table> 59 <table>
51 <tr><td>None</td></tr> 60 <tr><td>None</td></tr>
52 </table> 61 </table>
53 <h3>Class Methods</h3> 62 <h3>Class Methods</h3>
63
54 <table> 64 <table>
55 <tr><td>None</td></tr> 65 <tr><td>None</td></tr>
56 </table> 66 </table>
57 <h3>Methods</h3> 67 <h3>Methods</h3>
58 <table> 68
69 <table>
70
59 <tr> 71 <tr>
60 <td><a href="#PySide2PyQtPlugin.__init__">PySide2PyQtPlugin</a></td> 72 <td><a href="#PySide2PyQtPlugin.__init__">PySide2PyQtPlugin</a></td>
61 <td>Constructor</td> 73 <td>Constructor</td>
62 </tr><tr> 74 </tr>
75 <tr>
63 <td><a href="#PySide2PyQtPlugin.__editorClosed">__editorClosed</a></td> 76 <td><a href="#PySide2PyQtPlugin.__editorClosed">__editorClosed</a></td>
64 <td>Private slot called, when an editor was closed.</td> 77 <td>Private slot called, when an editor was closed.</td>
65 </tr><tr> 78 </tr>
79 <tr>
66 <td><a href="#PySide2PyQtPlugin.__editorOpened">__editorOpened</a></td> 80 <td><a href="#PySide2PyQtPlugin.__editorOpened">__editorOpened</a></td>
67 <td>Private slot called, when a new editor was opened.</td> 81 <td>Private slot called, when a new editor was opened.</td>
68 </tr><tr> 82 </tr>
83 <tr>
69 <td><a href="#PySide2PyQtPlugin.__editorShowMenu">__editorShowMenu</a></td> 84 <td><a href="#PySide2PyQtPlugin.__editorShowMenu">__editorShowMenu</a></td>
70 <td>Private slot called, when the the editor context menu or a submenu is about to be shown.</td> 85 <td>Private slot called, when the the editor context menu or a submenu is about to be shown.</td>
71 </tr><tr> 86 </tr>
87 <tr>
72 <td><a href="#PySide2PyQtPlugin.__initMenu">__initMenu</a></td> 88 <td><a href="#PySide2PyQtPlugin.__initMenu">__initMenu</a></td>
73 <td>Private method to initialize the menu.</td> 89 <td>Private method to initialize the menu.</td>
74 </tr><tr> 90 </tr>
91 <tr>
75 <td><a href="#PySide2PyQtPlugin.__loadTranslator">__loadTranslator</a></td> 92 <td><a href="#PySide2PyQtPlugin.__loadTranslator">__loadTranslator</a></td>
76 <td>Private method to load the translation file.</td> 93 <td>Private method to load the translation file.</td>
77 </tr><tr> 94 </tr>
95 <tr>
78 <td><a href="#PySide2PyQtPlugin.__populateMenu">__populateMenu</a></td> 96 <td><a href="#PySide2PyQtPlugin.__populateMenu">__populateMenu</a></td>
79 <td>Private slot to populate the tools menu with our entries.</td> 97 <td>Private slot to populate the tools menu with our entries.</td>
80 </tr><tr> 98 </tr>
99 <tr>
81 <td><a href="#PySide2PyQtPlugin.__pyqt2Pyside">__pyqt2Pyside</a></td> 100 <td><a href="#PySide2PyQtPlugin.__pyqt2Pyside">__pyqt2Pyside</a></td>
82 <td>Private slot to convert the code of the current editor from PyQt to PySide.</td> 101 <td>Private slot to convert the code of the current editor from PyQt to PySide.</td>
83 </tr><tr> 102 </tr>
103 <tr>
84 <td><a href="#PySide2PyQtPlugin.__pyside2Pyqt">__pyside2Pyqt</a></td> 104 <td><a href="#PySide2PyQtPlugin.__pyside2Pyqt">__pyside2Pyqt</a></td>
85 <td>Private slot to convert the code of the current editor from PySide to PyQt.</td> 105 <td>Private slot to convert the code of the current editor from PySide to PyQt.</td>
86 </tr><tr> 106 </tr>
107 <tr>
87 <td><a href="#PySide2PyQtPlugin.activate">activate</a></td> 108 <td><a href="#PySide2PyQtPlugin.activate">activate</a></td>
88 <td>Public method to activate this plugin.</td> 109 <td>Public method to activate this plugin.</td>
89 </tr><tr> 110 </tr>
111 <tr>
90 <td><a href="#PySide2PyQtPlugin.deactivate">deactivate</a></td> 112 <td><a href="#PySide2PyQtPlugin.deactivate">deactivate</a></td>
91 <td>Public method to deactivate this plugin.</td> 113 <td>Public method to deactivate this plugin.</td>
92 </tr> 114 </tr>
93 </table> 115 </table>
94 <h3>Static Methods</h3> 116 <h3>Static Methods</h3>
95 <table> 117
96 <tr><td>None</td></tr> 118 <table>
97 </table> 119 <tr><td>None</td></tr>
120 </table>
121
98 <a NAME="PySide2PyQtPlugin.__init__" ID="PySide2PyQtPlugin.__init__"></a> 122 <a NAME="PySide2PyQtPlugin.__init__" ID="PySide2PyQtPlugin.__init__"></a>
99 <h4>PySide2PyQtPlugin (Constructor)</h4> 123 <h4>PySide2PyQtPlugin (Constructor)</h4>
100 <b>PySide2PyQtPlugin</b>(<i>ui</i>) 124 <b>PySide2PyQtPlugin</b>(<i>ui</i>)
125
101 <p> 126 <p>
102 Constructor 127 Constructor
103 </p><dl> 128 </p>
129 <dl>
130
104 <dt><i>ui</i></dt> 131 <dt><i>ui</i></dt>
105 <dd> 132 <dd>
106 reference to the user interface object (UI.UserInterface) 133 reference to the user interface object (UI.UserInterface)
107 </dd> 134 </dd>
108 </dl><a NAME="PySide2PyQtPlugin.__editorClosed" ID="PySide2PyQtPlugin.__editorClosed"></a> 135 </dl>
136 <a NAME="PySide2PyQtPlugin.__editorClosed" ID="PySide2PyQtPlugin.__editorClosed"></a>
109 <h4>PySide2PyQtPlugin.__editorClosed</h4> 137 <h4>PySide2PyQtPlugin.__editorClosed</h4>
110 <b>__editorClosed</b>(<i>editor</i>) 138 <b>__editorClosed</b>(<i>editor</i>)
139
111 <p> 140 <p>
112 Private slot called, when an editor was closed. 141 Private slot called, when an editor was closed.
113 </p><dl> 142 </p>
143 <dl>
144
114 <dt><i>editor</i></dt> 145 <dt><i>editor</i></dt>
115 <dd> 146 <dd>
116 reference to the editor (QScintilla.Editor) 147 reference to the editor (QScintilla.Editor)
117 </dd> 148 </dd>
118 </dl><a NAME="PySide2PyQtPlugin.__editorOpened" ID="PySide2PyQtPlugin.__editorOpened"></a> 149 </dl>
150 <a NAME="PySide2PyQtPlugin.__editorOpened" ID="PySide2PyQtPlugin.__editorOpened"></a>
119 <h4>PySide2PyQtPlugin.__editorOpened</h4> 151 <h4>PySide2PyQtPlugin.__editorOpened</h4>
120 <b>__editorOpened</b>(<i>editor</i>) 152 <b>__editorOpened</b>(<i>editor</i>)
153
121 <p> 154 <p>
122 Private slot called, when a new editor was opened. 155 Private slot called, when a new editor was opened.
123 </p><dl> 156 </p>
157 <dl>
158
124 <dt><i>editor</i></dt> 159 <dt><i>editor</i></dt>
125 <dd> 160 <dd>
126 reference to the new editor (QScintilla.Editor) 161 reference to the new editor (QScintilla.Editor)
127 </dd> 162 </dd>
128 </dl><a NAME="PySide2PyQtPlugin.__editorShowMenu" ID="PySide2PyQtPlugin.__editorShowMenu"></a> 163 </dl>
164 <a NAME="PySide2PyQtPlugin.__editorShowMenu" ID="PySide2PyQtPlugin.__editorShowMenu"></a>
129 <h4>PySide2PyQtPlugin.__editorShowMenu</h4> 165 <h4>PySide2PyQtPlugin.__editorShowMenu</h4>
130 <b>__editorShowMenu</b>(<i>menuName, menu, editor</i>) 166 <b>__editorShowMenu</b>(<i>menuName, menu, editor</i>)
167
131 <p> 168 <p>
132 Private slot called, when the the editor context menu or a submenu is 169 Private slot called, when the the editor context menu or a submenu is
133 about to be shown. 170 about to be shown.
134 </p><dl> 171 </p>
172 <dl>
173
135 <dt><i>menuName</i></dt> 174 <dt><i>menuName</i></dt>
136 <dd> 175 <dd>
137 name of the menu to be shown (string) 176 name of the menu to be shown (string)
138 </dd><dt><i>menu</i></dt> 177 </dd>
178 <dt><i>menu</i></dt>
139 <dd> 179 <dd>
140 reference to the menu (QMenu) 180 reference to the menu (QMenu)
141 </dd><dt><i>editor</i></dt> 181 </dd>
182 <dt><i>editor</i></dt>
142 <dd> 183 <dd>
143 reference to the editor 184 reference to the editor
144 </dd> 185 </dd>
145 </dl><a NAME="PySide2PyQtPlugin.__initMenu" ID="PySide2PyQtPlugin.__initMenu"></a> 186 </dl>
187 <a NAME="PySide2PyQtPlugin.__initMenu" ID="PySide2PyQtPlugin.__initMenu"></a>
146 <h4>PySide2PyQtPlugin.__initMenu</h4> 188 <h4>PySide2PyQtPlugin.__initMenu</h4>
147 <b>__initMenu</b>(<i></i>) 189 <b>__initMenu</b>(<i></i>)
190
148 <p> 191 <p>
149 Private method to initialize the menu. 192 Private method to initialize the menu.
150 </p><a NAME="PySide2PyQtPlugin.__loadTranslator" ID="PySide2PyQtPlugin.__loadTranslator"></a> 193 </p>
194 <a NAME="PySide2PyQtPlugin.__loadTranslator" ID="PySide2PyQtPlugin.__loadTranslator"></a>
151 <h4>PySide2PyQtPlugin.__loadTranslator</h4> 195 <h4>PySide2PyQtPlugin.__loadTranslator</h4>
152 <b>__loadTranslator</b>(<i></i>) 196 <b>__loadTranslator</b>(<i></i>)
197
153 <p> 198 <p>
154 Private method to load the translation file. 199 Private method to load the translation file.
155 </p><a NAME="PySide2PyQtPlugin.__populateMenu" ID="PySide2PyQtPlugin.__populateMenu"></a> 200 </p>
201 <a NAME="PySide2PyQtPlugin.__populateMenu" ID="PySide2PyQtPlugin.__populateMenu"></a>
156 <h4>PySide2PyQtPlugin.__populateMenu</h4> 202 <h4>PySide2PyQtPlugin.__populateMenu</h4>
157 <b>__populateMenu</b>(<i>name, menu</i>) 203 <b>__populateMenu</b>(<i>name, menu</i>)
204
158 <p> 205 <p>
159 Private slot to populate the tools menu with our entries. 206 Private slot to populate the tools menu with our entries.
160 </p><dl> 207 </p>
208 <dl>
209
161 <dt><i>name</i></dt> 210 <dt><i>name</i></dt>
162 <dd> 211 <dd>
163 name of the menu (string) 212 name of the menu (string)
164 </dd><dt><i>menu</i></dt> 213 </dd>
214 <dt><i>menu</i></dt>
165 <dd> 215 <dd>
166 reference to the menu to be populated (QMenu) 216 reference to the menu to be populated (QMenu)
167 </dd> 217 </dd>
168 </dl><a NAME="PySide2PyQtPlugin.__pyqt2Pyside" ID="PySide2PyQtPlugin.__pyqt2Pyside"></a> 218 </dl>
219 <a NAME="PySide2PyQtPlugin.__pyqt2Pyside" ID="PySide2PyQtPlugin.__pyqt2Pyside"></a>
169 <h4>PySide2PyQtPlugin.__pyqt2Pyside</h4> 220 <h4>PySide2PyQtPlugin.__pyqt2Pyside</h4>
170 <b>__pyqt2Pyside</b>(<i>pyqt, pyside</i>) 221 <b>__pyqt2Pyside</b>(<i>pyqt, pyside</i>)
222
171 <p> 223 <p>
172 Private slot to convert the code of the current editor from PyQt 224 Private slot to convert the code of the current editor from PyQt
173 to PySide. 225 to PySide.
174 </p><dl> 226 </p>
227 <dl>
228
175 <dt><i>pyqt</i> (str)</dt> 229 <dt><i>pyqt</i> (str)</dt>
176 <dd> 230 <dd>
177 PyQt variant (pyqt4 or pyqt5) 231 PyQt variant (pyqt5)
178 </dd><dt><i>pyside</i> (str)</dt> 232 </dd>
179 <dd> 233 <dt><i>pyside</i> (str)</dt>
180 PySide variant (pyside or pyside2) 234 <dd>
181 </dd> 235 PySide variant (pyside2)
182 </dl><a NAME="PySide2PyQtPlugin.__pyside2Pyqt" ID="PySide2PyQtPlugin.__pyside2Pyqt"></a> 236 </dd>
237 </dl>
238 <a NAME="PySide2PyQtPlugin.__pyside2Pyqt" ID="PySide2PyQtPlugin.__pyside2Pyqt"></a>
183 <h4>PySide2PyQtPlugin.__pyside2Pyqt</h4> 239 <h4>PySide2PyQtPlugin.__pyside2Pyqt</h4>
184 <b>__pyside2Pyqt</b>(<i>pyside, pyqt</i>) 240 <b>__pyside2Pyqt</b>(<i>pyside, pyqt</i>)
241
185 <p> 242 <p>
186 Private slot to convert the code of the current editor from PySide 243 Private slot to convert the code of the current editor from PySide
187 to PyQt. 244 to PyQt.
188 </p><dl> 245 </p>
246 <dl>
247
189 <dt><i>pyside</i> (str)</dt> 248 <dt><i>pyside</i> (str)</dt>
190 <dd> 249 <dd>
191 PySide variant (pyside or pyside2) 250 PySide variant (pyside2)
192 </dd><dt><i>pyqt</i> (str)</dt> 251 </dd>
193 <dd> 252 <dt><i>pyqt</i> (str)</dt>
194 PyQt variant (pyqt4 or pyqt5) 253 <dd>
195 </dd> 254 PyQt variant (pyqt5)
196 </dl><a NAME="PySide2PyQtPlugin.activate" ID="PySide2PyQtPlugin.activate"></a> 255 </dd>
256 </dl>
257 <a NAME="PySide2PyQtPlugin.activate" ID="PySide2PyQtPlugin.activate"></a>
197 <h4>PySide2PyQtPlugin.activate</h4> 258 <h4>PySide2PyQtPlugin.activate</h4>
198 <b>activate</b>(<i></i>) 259 <b>activate</b>(<i></i>)
260
199 <p> 261 <p>
200 Public method to activate this plugin. 262 Public method to activate this plugin.
201 </p><dl> 263 </p>
264 <dl>
202 <dt>Returns:</dt> 265 <dt>Returns:</dt>
203 <dd> 266 <dd>
204 tuple of None and activation status (boolean) 267 tuple of None and activation status (boolean)
205 </dd> 268 </dd>
206 </dl><a NAME="PySide2PyQtPlugin.deactivate" ID="PySide2PyQtPlugin.deactivate"></a> 269 </dl>
270 <a NAME="PySide2PyQtPlugin.deactivate" ID="PySide2PyQtPlugin.deactivate"></a>
207 <h4>PySide2PyQtPlugin.deactivate</h4> 271 <h4>PySide2PyQtPlugin.deactivate</h4>
208 <b>deactivate</b>(<i></i>) 272 <b>deactivate</b>(<i></i>)
273
209 <p> 274 <p>
210 Public method to deactivate this plugin. 275 Public method to deactivate this plugin.
211 </p> 276 </p>
212 <div align="right"><a href="#top">Up</a></div> 277 <div align="right"><a href="#top">Up</a></div>
213 <hr /> 278 <hr />

eric ide

mercurial