Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.Plugins.PluginWizardQFileDialog.html

eric6/Documentation/Source/eric6.Plugins.PluginWizardQFileDialog.html

changeset 7273
391d6b7b1eff
parent 7232
0b840f7ed593
child 7635
0cdead130a81
equal deleted inserted replaced
7272:1779dc278077 7273:391d6b7b1eff
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>eric6.Plugins.PluginWizardQFileDialog</h1> 23 <h1>eric6.Plugins.PluginWizardQFileDialog</h1>
24
23 <p> 25 <p>
24 Module implementing the QFileDialog wizard plugin. 26 Module implementing the QFileDialog wizard plugin.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
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>packageName</td></tr><tr><td>pyqtApi</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr> 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>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="#FileDialogWizard">FileDialogWizard</a></td> 38 <td><a href="#FileDialogWizard">FileDialogWizard</a></td>
34 <td>Class implementing the QFileDialog wizard plugin.</td> 39 <td>Class implementing the QFileDialog wizard 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="FileDialogWizard" ID="FileDialogWizard"></a> 49 <a NAME="FileDialogWizard" ID="FileDialogWizard"></a>
43 <h2>FileDialogWizard</h2> 50 <h2>FileDialogWizard</h2>
51
44 <p> 52 <p>
45 Class implementing the QFileDialog wizard plugin. 53 Class implementing the QFileDialog wizard 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="#FileDialogWizard.__init__">FileDialogWizard</a></td> 72 <td><a href="#FileDialogWizard.__init__">FileDialogWizard</a></td>
61 <td>Constructor</td> 73 <td>Constructor</td>
62 </tr><tr> 74 </tr>
75 <tr>
63 <td><a href="#FileDialogWizard.__callForm">__callForm</a></td> 76 <td><a href="#FileDialogWizard.__callForm">__callForm</a></td>
64 <td>Private method to display a dialog and get the code.</td> 77 <td>Private method to display a dialog and get the code.</td>
65 </tr><tr> 78 </tr>
79 <tr>
66 <td><a href="#FileDialogWizard.__handle">__handle</a></td> 80 <td><a href="#FileDialogWizard.__handle">__handle</a></td>
67 <td>Private method to handle the wizards action.</td> 81 <td>Private method to handle the wizards action.</td>
68 </tr><tr> 82 </tr>
83 <tr>
69 <td><a href="#FileDialogWizard.__handleE5FileDialog">__handleE5FileDialog</a></td> 84 <td><a href="#FileDialogWizard.__handleE5FileDialog">__handleE5FileDialog</a></td>
70 <td>Private slot to handle the wizard E5FileDialog action.</td> 85 <td>Private slot to handle the wizard E5FileDialog action.</td>
71 </tr><tr> 86 </tr>
87 <tr>
72 <td><a href="#FileDialogWizard.__handleQFileDialog">__handleQFileDialog</a></td> 88 <td><a href="#FileDialogWizard.__handleQFileDialog">__handleQFileDialog</a></td>
73 <td>Private slot to handle the wizard QFileDialog action.</td> 89 <td>Private slot to handle the wizard QFileDialog action.</td>
74 </tr><tr> 90 </tr>
91 <tr>
75 <td><a href="#FileDialogWizard.__initActions">__initActions</a></td> 92 <td><a href="#FileDialogWizard.__initActions">__initActions</a></td>
76 <td>Private method to initialize the actions.</td> 93 <td>Private method to initialize the actions.</td>
77 </tr><tr> 94 </tr>
95 <tr>
78 <td><a href="#FileDialogWizard.__initMenu">__initMenu</a></td> 96 <td><a href="#FileDialogWizard.__initMenu">__initMenu</a></td>
79 <td>Private method to add the actions to the right menu.</td> 97 <td>Private method to add the actions to the right menu.</td>
80 </tr><tr> 98 </tr>
99 <tr>
81 <td><a href="#FileDialogWizard.activate">activate</a></td> 100 <td><a href="#FileDialogWizard.activate">activate</a></td>
82 <td>Public method to activate this plugin.</td> 101 <td>Public method to activate this plugin.</td>
83 </tr><tr> 102 </tr>
103 <tr>
84 <td><a href="#FileDialogWizard.deactivate">deactivate</a></td> 104 <td><a href="#FileDialogWizard.deactivate">deactivate</a></td>
85 <td>Public method to deactivate this plugin.</td> 105 <td>Public method to deactivate this plugin.</td>
86 </tr> 106 </tr>
87 </table> 107 </table>
88 <h3>Static Methods</h3> 108 <h3>Static Methods</h3>
89 <table> 109
90 <tr><td>None</td></tr> 110 <table>
91 </table> 111 <tr><td>None</td></tr>
112 </table>
113
92 <a NAME="FileDialogWizard.__init__" ID="FileDialogWizard.__init__"></a> 114 <a NAME="FileDialogWizard.__init__" ID="FileDialogWizard.__init__"></a>
93 <h4>FileDialogWizard (Constructor)</h4> 115 <h4>FileDialogWizard (Constructor)</h4>
94 <b>FileDialogWizard</b>(<i>ui</i>) 116 <b>FileDialogWizard</b>(<i>ui</i>)
117
95 <p> 118 <p>
96 Constructor 119 Constructor
97 </p><dl> 120 </p>
121 <dl>
122
98 <dt><i>ui</i></dt> 123 <dt><i>ui</i></dt>
99 <dd> 124 <dd>
100 reference to the user interface object (UI.UserInterface) 125 reference to the user interface object (UI.UserInterface)
101 </dd> 126 </dd>
102 </dl><a NAME="FileDialogWizard.__callForm" ID="FileDialogWizard.__callForm"></a> 127 </dl>
128 <a NAME="FileDialogWizard.__callForm" ID="FileDialogWizard.__callForm"></a>
103 <h4>FileDialogWizard.__callForm</h4> 129 <h4>FileDialogWizard.__callForm</h4>
104 <b>__callForm</b>(<i>editor, variant</i>) 130 <b>__callForm</b>(<i>editor, variant</i>)
131
105 <p> 132 <p>
106 Private method to display a dialog and get the code. 133 Private method to display a dialog and get the code.
107 </p><dl> 134 </p>
135 <dl>
136
108 <dt><i>editor</i> (Editor)</dt> 137 <dt><i>editor</i> (Editor)</dt>
109 <dd> 138 <dd>
110 reference to the current editor 139 reference to the current editor
111 </dd><dt><i>variant</i> (int)</dt> 140 </dd>
141 <dt><i>variant</i> (int)</dt>
112 <dd> 142 <dd>
113 variant of code to be generated 143 variant of code to be generated
114 (-1 = E5FileDialog, 0 = unknown, 4 = PyQt4, 5 = PyQt5) 144 (-1 = E5FileDialog, 0 = unknown, 4 = PyQt4, 5 = PyQt5)
115 </dd> 145 </dd>
116 </dl><dl> 146 </dl>
147 <dl>
117 <dt>Returns:</dt> 148 <dt>Returns:</dt>
118 <dd> 149 <dd>
119 the generated code (string) 150 the generated code (string)
120 </dd> 151 </dd>
121 </dl><a NAME="FileDialogWizard.__handle" ID="FileDialogWizard.__handle"></a> 152 </dl>
153 <a NAME="FileDialogWizard.__handle" ID="FileDialogWizard.__handle"></a>
122 <h4>FileDialogWizard.__handle</h4> 154 <h4>FileDialogWizard.__handle</h4>
123 <b>__handle</b>(<i>variant</i>) 155 <b>__handle</b>(<i>variant</i>)
156
124 <p> 157 <p>
125 Private method to handle the wizards action. 158 Private method to handle the wizards action.
126 </p><dl> 159 </p>
160 <dl>
161
127 <dt><i>variant</i> (str)</dt> 162 <dt><i>variant</i> (str)</dt>
128 <dd> 163 <dd>
129 dialog variant to be generated 164 dialog variant to be generated
130 (E5FileDialog or QFileDialog) 165 (E5FileDialog or QFileDialog)
131 </dd> 166 </dd>
132 </dl><dl> 167 </dl>
168 <dl>
169
133 <dt>Raises <b>ValueError</b>:</dt> 170 <dt>Raises <b>ValueError</b>:</dt>
134 <dd> 171 <dd>
135 raised to indicate an illegal file dialog variant 172 raised to indicate an illegal file dialog variant
136 </dd> 173 </dd>
137 </dl><a NAME="FileDialogWizard.__handleE5FileDialog" ID="FileDialogWizard.__handleE5FileDialog"></a> 174 </dl>
175 <a NAME="FileDialogWizard.__handleE5FileDialog" ID="FileDialogWizard.__handleE5FileDialog"></a>
138 <h4>FileDialogWizard.__handleE5FileDialog</h4> 176 <h4>FileDialogWizard.__handleE5FileDialog</h4>
139 <b>__handleE5FileDialog</b>(<i></i>) 177 <b>__handleE5FileDialog</b>(<i></i>)
178
140 <p> 179 <p>
141 Private slot to handle the wizard E5FileDialog action. 180 Private slot to handle the wizard E5FileDialog action.
142 </p><a NAME="FileDialogWizard.__handleQFileDialog" ID="FileDialogWizard.__handleQFileDialog"></a> 181 </p>
182 <a NAME="FileDialogWizard.__handleQFileDialog" ID="FileDialogWizard.__handleQFileDialog"></a>
143 <h4>FileDialogWizard.__handleQFileDialog</h4> 183 <h4>FileDialogWizard.__handleQFileDialog</h4>
144 <b>__handleQFileDialog</b>(<i></i>) 184 <b>__handleQFileDialog</b>(<i></i>)
185
145 <p> 186 <p>
146 Private slot to handle the wizard QFileDialog action. 187 Private slot to handle the wizard QFileDialog action.
147 </p><a NAME="FileDialogWizard.__initActions" ID="FileDialogWizard.__initActions"></a> 188 </p>
189 <a NAME="FileDialogWizard.__initActions" ID="FileDialogWizard.__initActions"></a>
148 <h4>FileDialogWizard.__initActions</h4> 190 <h4>FileDialogWizard.__initActions</h4>
149 <b>__initActions</b>(<i></i>) 191 <b>__initActions</b>(<i></i>)
192
150 <p> 193 <p>
151 Private method to initialize the actions. 194 Private method to initialize the actions.
152 </p><a NAME="FileDialogWizard.__initMenu" ID="FileDialogWizard.__initMenu"></a> 195 </p>
196 <a NAME="FileDialogWizard.__initMenu" ID="FileDialogWizard.__initMenu"></a>
153 <h4>FileDialogWizard.__initMenu</h4> 197 <h4>FileDialogWizard.__initMenu</h4>
154 <b>__initMenu</b>(<i></i>) 198 <b>__initMenu</b>(<i></i>)
199
155 <p> 200 <p>
156 Private method to add the actions to the right menu. 201 Private method to add the actions to the right menu.
157 </p><a NAME="FileDialogWizard.activate" ID="FileDialogWizard.activate"></a> 202 </p>
203 <a NAME="FileDialogWizard.activate" ID="FileDialogWizard.activate"></a>
158 <h4>FileDialogWizard.activate</h4> 204 <h4>FileDialogWizard.activate</h4>
159 <b>activate</b>(<i></i>) 205 <b>activate</b>(<i></i>)
206
160 <p> 207 <p>
161 Public method to activate this plugin. 208 Public method to activate this plugin.
162 </p><dl> 209 </p>
210 <dl>
163 <dt>Returns:</dt> 211 <dt>Returns:</dt>
164 <dd> 212 <dd>
165 tuple of None and activation status (boolean) 213 tuple of None and activation status (boolean)
166 </dd> 214 </dd>
167 </dl><a NAME="FileDialogWizard.deactivate" ID="FileDialogWizard.deactivate"></a> 215 </dl>
216 <a NAME="FileDialogWizard.deactivate" ID="FileDialogWizard.deactivate"></a>
168 <h4>FileDialogWizard.deactivate</h4> 217 <h4>FileDialogWizard.deactivate</h4>
169 <b>deactivate</b>(<i></i>) 218 <b>deactivate</b>(<i></i>)
219
170 <p> 220 <p>
171 Public method to deactivate this plugin. 221 Public method to deactivate this plugin.
172 </p> 222 </p>
173 <div align="right"><a href="#top">Up</a></div> 223 <div align="right"><a href="#top">Up</a></div>
174 <hr /> 224 <hr />

Mercurial Repository: eric

eric ide

mercurial