@@ -1,509 +1,509 | |||
|
1 | 1 | #ifndef _PYTHONQTDOC_H |
|
2 | 2 | #define _PYTHONQTDOC_H |
|
3 | 3 | |
|
4 | 4 | /* |
|
5 | 5 | * |
|
6 | 6 | * Copyright (C) 2010 MeVis Medical Solutions AG All Rights Reserved. |
|
7 | 7 | * |
|
8 | 8 | * This library is free software; you can redistribute it and/or |
|
9 | 9 | * modify it under the terms of the GNU Lesser General Public |
|
10 | 10 | * License as published by the Free Software Foundation; either |
|
11 | 11 | * version 2.1 of the License, or (at your option) any later version. |
|
12 | 12 | * |
|
13 | 13 | * This library is distributed in the hope that it will be useful, |
|
14 | 14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
15 | 15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
|
16 | 16 | * Lesser General Public License for more details. |
|
17 | 17 | * |
|
18 | 18 | * Further, this software is distributed without any warranty that it is |
|
19 | 19 | * free of the rightful claim of any third person regarding infringement |
|
20 | 20 | * or the like. Any license provided herein, whether implied or |
|
21 | 21 | * otherwise, applies only to this software file. Patent licenses, if |
|
22 | 22 | * any, provided herein do not apply to combinations of this program with |
|
23 | 23 | * other software, or any other product whatsoever. |
|
24 | 24 | * |
|
25 | 25 | * You should have received a copy of the GNU Lesser General Public |
|
26 | 26 | * License along with this library; if not, write to the Free Software |
|
27 | 27 | * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
|
28 | 28 | * |
|
29 | 29 | * Contact information: MeVis Medical Solutions AG, Universitaetsallee 29, |
|
30 | 30 | * 28359 Bremen, Germany or: |
|
31 | 31 | * |
|
32 | 32 | * http://www.mevis.de |
|
33 | 33 | * |
|
34 | 34 | */ |
|
35 | 35 | |
|
36 | 36 | //---------------------------------------------------------------------------------- |
|
37 | 37 | /*! |
|
38 | 38 | // \file PythonQtDoc.h |
|
39 | 39 | // \author Florian Link |
|
40 | 40 | // \author Last changed by $Author: florian $ |
|
41 | 41 | // \date 2006-10 |
|
42 | 42 | */ |
|
43 | 43 | //---------------------------------------------------------------------------------- |
|
44 | 44 | |
|
45 | 45 | /*! |
|
46 | 46 | \if USE_GLOBAL_DOXYGEN_DOC |
|
47 | 47 | \page PythonQtPage PythonQt Overview |
|
48 | 48 | \else |
|
49 | 49 | \mainpage PythonQt Overview |
|
50 | 50 | \endif |
|
51 | 51 | |
|
52 | 52 | \section Introduction |
|
53 | 53 | |
|
54 | 54 | \b PythonQt is a dynamic Python (http://www.python.org) binding for the Qt framework (http://qt.nokia.com). |
|
55 | 55 | It offers an easy way to embed the Python scripting language into |
|
56 | your C++ Qt applications. It makes heavy use of the QMetaObject system and thus requires Qt4.x. | |
|
56 | your C++ Qt applications. It makes heavy use of the QMetaObject system and thus requires Qt 4.x. | |
|
57 | 57 | |
|
58 | 58 | The focus of PythonQt is on embedding Python into an existing C++ application, not on writing the whole |
|
59 | 59 | application completely in Python. If you want to write your whole application in Python, |
|
60 | 60 | you should use <a href="http://www.riverbankcomputing.co.uk/pyqt/">PyQt</a> or <a href="http://www.pyside.org">PySide</a> instead. |
|
61 | 61 | |
|
62 | 62 | If you are looking for a simple way to embed Python objects into your C++/Qt Application |
|
63 | 63 | and to script parts of your application via Python, PythonQt is the way to go! |
|
64 | 64 | |
|
65 | 65 | PythonQt is a stable library that was developed to make the |
|
66 | 66 | Image Processing and Visualization platform MeVisLab (http://www.mevislab.de) |
|
67 | 67 | scriptable from Python. |
|
68 | 68 | |
|
69 | 69 | \section Download |
|
70 | 70 | |
|
71 | 71 | PythonQt is hosted on SourceForge at http://sourceforge.net/projects/pythonqt , you can access it via SVN |
|
72 | 72 | or download a tarball. |
|
73 | 73 | |
|
74 | 74 | \section Licensing |
|
75 | 75 | |
|
76 | 76 | PythonQt is distributed under the LGPL license, so it pairs well with the LGPL of the Qt 4.5 release and allows |
|
77 | 77 | to be used in commercial applications when following the LGPL 2.1 obligations. |
|
78 | 78 | |
|
79 | 79 | \section LicensingWrapper Licensing of Wrapper Generator |
|
80 | 80 | |
|
81 | 81 | The build system of PythonQt makes use of a modified version of the LGPL'ed QtScript generator, |
|
82 | 82 | located in the "generator" directory. |
|
83 | 83 | |
|
84 | 84 | See http://qt.gitorious.org/qt-labs/qtscriptgenerator for details on the original project. |
|
85 | 85 | Thanks a lot to the QtJambi guys and the QtScript Generator project for the C++ parser and |
|
86 | 86 | Qt typesystem files! |
|
87 | 87 | |
|
88 | 88 | The PythonQt wrappers generated by the generator located in the "generated_cpp" directory are free to be used without any licensing restrictions. |
|
89 | 89 | |
|
90 | 90 | The generated wrappers are pre-generated and checked-in for Qt 4.6.1, so you only need to build and run the |
|
91 | 91 | generator when you want to build additional wrappers or you want to upgrade/downgrade to another Qt version. |
|
92 | 92 | You may use the generator to generate C++ bindings for your own C++ classes (e.g., to make them inheritable in Python), |
|
93 | 93 | , but this is currently not documented and involves creating your own typesystem files (although the Qt Jambi examples might help you). |
|
94 | 94 | |
|
95 | 95 | \section Features |
|
96 | 96 | |
|
97 | 97 | The following are the built-in features of the PythonQt library: |
|
98 | 98 | |
|
99 | 99 | - Access all \b slots, \b properties, children and registered enums of any QObject derived class from Python |
|
100 | 100 | - Connecting Qt Signals to Python functions (both from within Python and from C++) |
|
101 | 101 | - Easy wrapping of Python objects from C++ with smart, reference-counting PythonQtObjectPtr. |
|
102 | 102 | - Convenient conversions to/from QVariant for PythonQtObjectPtr. |
|
103 | 103 | - Wrapping of C++ objects (which are not derived from QObject) via PythonQtCppWrapperFactory |
|
104 | 104 | - Extending C++ and QObject derived classes with additional slots, static methods and constructors (see Decorators) |
|
105 | 105 | - StdOut/Err redirection to Qt signals instead of cout |
|
106 | 106 | - Interface for creating your own \c import replacement, so that Python scripts can be e.g. signed/verified before they are executed (PythonQtImportFileInterface) |
|
107 | 107 | - Mapping of plain-old-datatypes and ALL QVariant types to and from Python |
|
108 | 108 | - Support for wrapping of user QVariant types which are registerd via QMetaType |
|
109 | 109 | - Support for Qt namespace (with all enumerators) |
|
110 | 110 | - All PythonQt wrapped objects support the dir() statement, so that you can see easily which attributes a QObject, CPP object or QVariant has |
|
111 | 111 | - No preprocessing/wrapping tool needs to be started, PythonQt can script any QObject without prior knowledge about it (except for the MetaObject information from the \b moc) |
|
112 | 112 | - Multiple inheritance for C++ objects (e.g. a QWidget is derived from QObject and QPaintDevice, PythonQt will automatically cast a QWidget to a QPaintDevice when needed) |
|
113 | 113 | - Polymorphic downcasting (if e.g. PythonQt sees a QEvent, it can downcast it depending on the type(), so the Python e.g. sees a QPaintEvent instead of a plain QEvent) |
|
114 | 114 | - Deriving C++ objects from Python and overwriting virtual method with a Python implementation (requires usage of wrapper generator or manual work!) |
|
115 | 115 | - Extensible handler for Python/C++ conversion of complex types, e.g. mapping of QVector<SomeObject> to/from a Python array |
|
116 | 116 | |
|
117 | 117 | \section FeaturesQtAll Features (with PythonQt_QtAll linked in) |
|
118 | 118 | |
|
119 | 119 | Thanks to the new wrapper generator, PythonQt now offers the additional PythonQt_QtAll library which wraps the complete Qt API, including all C++ classes and all non-slots on QObject derived classes. |
|
120 | 120 | This offers the following features: |
|
121 | 121 | |
|
122 | 122 | - Complete Qt API wrapped and accessible |
|
123 | 123 | - The following modules are available as submodules of the PythonQt module: |
|
124 | 124 | - QtCore |
|
125 | 125 | - QtGui |
|
126 | 126 | - QtNetwork |
|
127 | 127 | - QtOpenGL |
|
128 | 128 | - QtSql |
|
129 | 129 | - QtSvg |
|
130 | 130 | - QtUiTools |
|
131 | 131 | - QtWebKit |
|
132 | 132 | - QtXml |
|
133 | 133 | - QtXmlPatterns |
|
134 | 134 | - (phonon, QtHelp, assistant, designer are currently not supported, this would require some additional effort on the code generator) |
|
135 | 135 | - For convenience, all classes are also available in the PythonQt.Qt module, for people who do not care in which module a class is located |
|
136 | 136 | - Any Qt class that has virtual methods can be easily derived from Python and the virtual methods can be reimplemented in Python |
|
137 | 137 | - Polymorphic downcasting on QEvent, QGraphicsItem, QStyleOption, ... |
|
138 | 138 | - Multiple inheritance support (e.g., QGraphicsTextItem is a QObject AND a QGraphicsItem, PythonQt will handle this well) |
|
139 | 139 | |
|
140 | 140 | \section Comparision Comparision with PyQt/PySide |
|
141 | 141 | |
|
142 | 142 | - PythonQt is not as Pythonic as PyQt in many details (e.g. buffer protocol, pickling, translation support, ...) and it is mainly thought for embedding and intercommunication between Qt/Cpp and Python |
|
143 | 143 | - PythonQt allows to communicate in both directions, e.g., calling a Python object from C++ AND calling a C++ method from Python, while PyQt only handles the Python->C++ direction |
|
144 | 144 | - PythonQt offers properties as Python attributes, while PyQt offers them as setter/getter methods (e.g. QWidget.width is a property in PythonQt and a method in PyQt) |
|
145 | 145 | - PythonQt does not support instanceof checks for Qt classes, except for the exact match and derived Python classes |
|
146 | 146 | - QObject.emit to emit Qt signals from Python is not yet implemented but PythonQt allows to just emit a signal by calling it |
|
147 | 147 | - PythonQt does not (yet) offer to add new signals to Python/C++ objects |
|
148 | 148 | - Ownership of objects is a bit different in PythonQt, currently Python classes derived from a C++ class need to be manually referenced in Python to not get deleted too early (this will be fixed) |
|
149 | 149 | - QStrings are always converted to unicode Python objects (PyQt returns QString instead), we prefered to return Python strings. |
|
150 | 150 | - Probably there are lots of details that differ, I do not know PyQt that well to list them all. |
|
151 | 151 | |
|
152 | 152 | \section Interface |
|
153 | 153 | |
|
154 | 154 | The main interface to PythonQt is the PythonQt singleton. |
|
155 | 155 | PythonQt needs to be initialized via PythonQt::init() once. |
|
156 | 156 | Afterwards you communicate with the singleton via PythonQt::self(). |
|
157 | 157 | PythonQt offers a complete Qt binding, which |
|
158 | 158 | needs to be enabled via PythonQt_QtAll::init(). |
|
159 | 159 | |
|
160 | 160 | |
|
161 | 161 | \section Datatype Datatype Mapping |
|
162 | 162 | |
|
163 | 163 | The following table shows the mapping between Python and Qt objects: |
|
164 | 164 | <table> |
|
165 | 165 | <tr><th>Qt/C++</th><th>Python</th></tr> |
|
166 | 166 | <tr><td>bool</td><td>bool</td></tr> |
|
167 | 167 | <tr><td>double</td><td>float</td></tr> |
|
168 | 168 | <tr><td>float</td><td>float</td></tr> |
|
169 | 169 | <tr><td>char/uchar,int/uint,short,ushort,QChar</td><td>integer</td></tr> |
|
170 | 170 | <tr><td>long</td><td>integer</td></tr> |
|
171 | 171 | <tr><td>ulong,longlong,ulonglong</td><td>long</td></tr> |
|
172 | 172 | <tr><td>QString</td><td>unicode string</td></tr> |
|
173 | 173 | <tr><td>QByteArray</td><td>str</td></tr> |
|
174 | 174 | <tr><td>char*</td><td>str</td></tr> |
|
175 | 175 | <tr><td>QStringList</td><td>tuple of unicode strings</td></tr> |
|
176 | 176 | <tr><td>QVariantList</td><td>tuple of objects</td></tr> |
|
177 | 177 | <tr><td>QVariantMap</td><td>dict of objects</td></tr> |
|
178 | 178 | <tr><td>QVariant</td><td>depends on type, see below</td></tr> |
|
179 | 179 | <tr><td>QSize, QRect and all other standard Qt QVariants</td><td>variant wrapper that supports complete API of the respective Qt classes</td></tr> |
|
180 | 180 | <tr><td>OwnRegisteredMetaType</td><td>C++ wrapper, optionally with additional information/wrapping provided by registerCPPClass()</td></tr> |
|
181 | 181 | <tr><td>QList<AnyObject*></td><td>converts to a list of CPP wrappers</td></tr> |
|
182 | 182 | <tr><td>EnumType</td><td>integer (all enums that are known via the moc and the Qt namespace are supported)</td></tr> |
|
183 | 183 | <tr><td>QObject (and derived classes)</td><td>QObject wrapper</td></tr> |
|
184 | 184 | <tr><td>C++ object</td><td>CPP wrapper, either wrapped via PythonQtCppWrapperFactory or just decorated with decorators</td></tr> |
|
185 | 185 | <tr><td>PyObject</td><td>PyObject</td></tr> |
|
186 | 186 | </table> |
|
187 | 187 | |
|
188 | 188 | PyObject is passed as simple pointer, which allows to pass/return any Python Object directly to/from |
|
189 | 189 | a Qt slot. |
|
190 | 190 | QVariants are mapped recursively as given above, e.g. a dictionary can |
|
191 | 191 | contain lists of dictionaries of doubles. |
|
192 | 192 | For example a QVariant of type "String" is mapped to a python unicode string. |
|
193 | 193 | All Qt QVariant types are implemented, PythonQt supports the complete Qt API for these object. |
|
194 | 194 | |
|
195 | 195 | \section QObject QObject Wrapping |
|
196 | 196 | |
|
197 | 197 | All classes derived from QObject are automatically wrapped with a python wrapper class |
|
198 | 198 | when they become visible to the Python interpreter. This can happen via |
|
199 | 199 | - the PythonQt::addObject() method |
|
200 | 200 | - when a Qt \b slot returns a QObject derived object to python |
|
201 | 201 | - when a Qt \b signal contains a QObject and is connected to a python function |
|
202 | 202 | |
|
203 | 203 | It is important that you call PythonQt::registerClass() for any QObject derived class |
|
204 | 204 | that may become visible to Python, except when you add it via PythonQt::addObject(). |
|
205 | 205 | This will register the complete parent hierachy of the registered class, so that |
|
206 | 206 | when you register e.g. a QPushButton, QWidget will be registered as well (and all intermediate |
|
207 | 207 | parents). |
|
208 | 208 | |
|
209 | 209 | From Python, you can talk to the returned QObjects in a natural way by calling |
|
210 | 210 | their slots and receiving the return values. You can also read/write all |
|
211 | 211 | properties of the objects as if they where normal python properties. |
|
212 | 212 | |
|
213 | 213 | In addition to this, the wrapped objects support |
|
214 | 214 | - className() - returns a string that reprents the classname of the QObject |
|
215 | 215 | - help() - shows all properties, slots, enums, decorator slots and constructors of the object, in a printable form |
|
216 | 216 | - delete() - deletes the object (use with care, especially if you passed the ownership to C++) |
|
217 | 217 | - connect(signal, function) - connect the signal of the given object to a python function |
|
218 | 218 | - connect(signal, qobject, slot) - connect the signal of the given object to a slot of another QObject |
|
219 | 219 | - disconnect(signal, function) - disconnect the signal of the given object from a python function |
|
220 | 220 | - disconnect(signal, qobject, slot) - disconnect the signal of the given object from a slot of another QObject |
|
221 | 221 | - children() - returns the children of the object |
|
222 | 222 | - setParent(QObject) - set the parent |
|
223 | 223 | - QObject* parent() - get the parent |
|
224 | 224 | |
|
225 | 225 | The below example shows how to connect signals in Python: |
|
226 | 226 | |
|
227 | 227 | \code |
|
228 | 228 | # define a signal handler function |
|
229 | 229 | def someFunction(flag): |
|
230 | 230 | print flag |
|
231 | 231 | |
|
232 | 232 | # button1 is a QPushButton that has been added to Python via addObject() |
|
233 | 233 | # connect the clicked signal to a python function: |
|
234 | 234 | button1.connect("clicked(bool)", someFunction) |
|
235 | 235 | |
|
236 | 236 | \endcode |
|
237 | 237 | |
|
238 | 238 | \section CPP CPP Wrapping |
|
239 | 239 | |
|
240 | 240 | You can create dedicated wrapper QObjects for any C++ class. This is done by deriving from PythonQtCppWrapperFactory |
|
241 | 241 | and adding your factory via addWrapperFactory(). |
|
242 | 242 | Whenever PythonQt encounters a CPP pointer (e.g. on a slot or signal) |
|
243 | 243 | and it does not known it as a QObject derived class, it will create a generic CPP wrapper. So even unknown C++ objects |
|
244 | 244 | can be passed through Python. If the wrapper factory supports the CPP class, a QObject wrapper will be created for each |
|
245 | 245 | instance that enters Python. An alternative to a complete wrapper via the wrapper factory are decorators, see \ref Decorators |
|
246 | 246 | |
|
247 | 247 | \section MetaObject Meta Object/Class access |
|
248 | 248 | |
|
249 | 249 | For each known C++ class, PythonQt provides a Python class. These classes are visible |
|
250 | 250 | inside of the "PythonQt" python module or in subpackages if a package is given when the class is registered. |
|
251 | 251 | |
|
252 | 252 | A Meta class supports: |
|
253 | 253 | |
|
254 | 254 | - access to all declared enum values |
|
255 | 255 | - constructors |
|
256 | 256 | - static methods |
|
257 | 257 | - unbound non-static methods |
|
258 | 258 | - help() and className() |
|
259 | 259 | |
|
260 | 260 | From within Python, you can import the module "PythonQt" to access these classes and the Qt namespace. |
|
261 | 261 | |
|
262 | 262 | \code |
|
263 | 263 | from PythonQt import QtCore |
|
264 | 264 | |
|
265 | 265 | # namespace access: |
|
266 | 266 | print QtCore.Qt.AlignLeft |
|
267 | 267 | |
|
268 | 268 | # constructors |
|
269 | 269 | a = QtCore.QSize(12,13) |
|
270 | 270 | b = QtCore.QFont() |
|
271 | 271 | |
|
272 | 272 | # static method |
|
273 | 273 | QtCore.QDate.currentDate() |
|
274 | 274 | |
|
275 | 275 | # enum value |
|
276 | 276 | QtCore.QFont.UltraCondensed |
|
277 | 277 | |
|
278 | 278 | \endcode |
|
279 | 279 | |
|
280 | 280 | \section Decorators Decorator slots |
|
281 | 281 | |
|
282 | 282 | PythonQt introduces a new generic approach to extend any wrapped QObject or CPP object with |
|
283 | 283 | |
|
284 | 284 | - constructors |
|
285 | 285 | - destructors (for CPP objects) |
|
286 | 286 | - additional slots |
|
287 | 287 | - static slots (callable on both the Meta object and the instances) |
|
288 | 288 | |
|
289 | 289 | The idea behind decorators is that we wanted to make it as easy as possible to extend |
|
290 | 290 | wrapped objects. Since we already have an implementation for invoking any Qt Slot from |
|
291 | 291 | Python, it looked promising to use this approach for the extension of wrapped objects as well. |
|
292 | 292 | This avoids that the PythonQt user needs to care about how Python arguments are mapped from/to |
|
293 | 293 | Qt when he wants to create static methods, constructors and additional member functions. |
|
294 | 294 | |
|
295 | 295 | The basic idea about decorators is to create a QObject derived class that implements slots |
|
296 | 296 | which take one of the above roles (e.g. constructor, destructor etc.) via a naming convention. |
|
297 | 297 | These slots are then assigned to other classes via the naming convention. |
|
298 | 298 | |
|
299 | 299 | - SomeClassName* new_SomeClassName(...) - defines a constructor for "SomeClassName" that returns a new object of type SomeClassName (where SomeClassName can be any CPP class, not just QObject classes) |
|
300 | 300 | - void delete_SomeClassName(SomeClassName* o) - defines a destructor, which should delete the passed in object o |
|
301 | 301 | - anything static_SomeClassName_someMethodName(...) - defines a static method that is callable on instances and the meta class |
|
302 | 302 | - anything someMethodName(SomeClassName* o, ...) - defines a slot that will be available on SomeClassName instances (and derived instances). When such a slot is called the first argument is the pointer to the instance and the rest of the arguments can be used to make a call on the instance. |
|
303 | 303 | |
|
304 | 304 | The below example shows all kinds of decorators in action: |
|
305 | 305 | |
|
306 | 306 | \code |
|
307 | 307 | |
|
308 | 308 | // an example CPP object |
|
309 | 309 | class YourCPPObject { |
|
310 | 310 | public: |
|
311 | 311 | YourCPPObject(int arg1, float arg2) { a = arg1; b = arg2; } |
|
312 | 312 | |
|
313 | 313 | float doSomething(int arg1) { return arg1*a*b; }; |
|
314 | 314 | |
|
315 | 315 | private: |
|
316 | 316 | |
|
317 | 317 | int a; |
|
318 | 318 | float b; |
|
319 | 319 | }; |
|
320 | 320 | |
|
321 | 321 | // an example decorator |
|
322 | 322 | class ExampleDecorator : public QObject |
|
323 | 323 | { |
|
324 | 324 | Q_OBJECT |
|
325 | 325 | |
|
326 | 326 | public slots: |
|
327 | 327 | // add a constructor to QSize that takes a QPoint |
|
328 | 328 | QSize* new_QSize(const QPoint& p) { return new QSize(p.x(), p.y()); } |
|
329 | 329 | |
|
330 | 330 | // add a constructor for QPushButton that takes a text and a parent widget |
|
331 | 331 | QPushButton* new_QPushButton(const QString& text, QWidget* parent=NULL) { return new QPushButton(text, parent); } |
|
332 | 332 | |
|
333 | 333 | // add a constructor for a CPP object |
|
334 | 334 | YourCPPObject* new_YourCPPObject(int arg1, float arg2) { return new YourCPPObject(arg1, arg2); } |
|
335 | 335 | |
|
336 | 336 | // add a destructor for a CPP object |
|
337 | 337 | void delete_YourCPPObject(YourCPPObject* obj) { delete obj; } |
|
338 | 338 | |
|
339 | 339 | // add a static method to QWidget |
|
340 | 340 | QWidget* static_QWidget_mouseGrabber() { return QWidget::mouseGrabber(); } |
|
341 | 341 | |
|
342 | 342 | // add an additional slot to QWidget (make move() callable, which is not declared as a slot in QWidget) |
|
343 | 343 | void move(QWidget* w, const QPoint& p) { w->move(p); } |
|
344 | 344 | |
|
345 | 345 | // add an additional slot to QWidget, overloading the above move method |
|
346 | 346 | void move(QWidget* w, int x, int y) { w->move(x,y); } |
|
347 | 347 | |
|
348 | 348 | // add a method to your own CPP object |
|
349 | 349 | int doSomething(YourCPPObject* obj, int arg1) { return obj->doSomething(arg1); } |
|
350 | 350 | }; |
|
351 | 351 | |
|
352 | 352 | ... |
|
353 | 353 | |
|
354 | 354 | PythonQt::self()->addDecorators(new ExampleDecorator()); |
|
355 | 355 | PythonQt::self()->registerCPPClass("YourCPPObject"); |
|
356 | 356 | |
|
357 | 357 | \endcode |
|
358 | 358 | |
|
359 | 359 | After you have registered an instance of the above ExampleDecorator, you can do the following from Python |
|
360 | 360 | (all these calls are mapped to the above decorator slots): |
|
361 | 361 | |
|
362 | 362 | \code |
|
363 | 363 | from PythonQt import QtCore, QtGui, YourCPPObject |
|
364 | 364 | |
|
365 | 365 | # call our new constructor of QSize |
|
366 | 366 | size = QtCore.QSize(QPoint(1,2)); |
|
367 | 367 | |
|
368 | 368 | # call our new QPushButton constructor |
|
369 | 369 | button = QtGui.QPushButton("sometext"); |
|
370 | 370 | |
|
371 | 371 | # call the move slot (overload1) |
|
372 | 372 | button.move(QPoint(0,0)) |
|
373 | 373 | |
|
374 | 374 | # call the move slot (overload2) |
|
375 | 375 | button.move(0,0) |
|
376 | 376 | |
|
377 | 377 | # call the static method |
|
378 | 378 | grabber = QtGui.QWidget.mouseWrapper(); |
|
379 | 379 | |
|
380 | 380 | # create a CPP object via constructor |
|
381 | 381 | yourCpp = YourCPPObject(1,11.5) |
|
382 | 382 | |
|
383 | 383 | # call the wrapped method on CPP object |
|
384 | 384 | print yourCpp.doSomething(1); |
|
385 | 385 | |
|
386 | 386 | # destructor will be called: |
|
387 | 387 | yourCpp = None |
|
388 | 388 | |
|
389 | 389 | \endcode |
|
390 | 390 | |
|
391 | 391 | \section Building |
|
392 | 392 | |
|
393 |
PythonQt requires Qt 4.6.1 ( |
|
|
393 | PythonQt requires at least Qt 4.6.1 (for earlier Qt versions, you will need to run the pythonqt_gerenator, Qt 4.3 is the absolute minimum) and Python 2.5.x or 2.6.x on Windows, Linux and MacOS X. It has not yet been tested with Python 3.x, but it should only require minor changes. | |
|
394 | 394 | To compile PythonQt, you will need a python developer installation which includes Python's header files and |
|
395 | 395 | the python2x.[lib | dll | so | dynlib]. |
|
396 |
The build scripts a currently set to use Python 2. |
|
|
396 | The build scripts a currently set to use Python 2.6. | |
|
397 | 397 | You may need to tweak the \b build/python.prf file to set the correct Python includes and libs on your system. |
|
398 | 398 | |
|
399 | 399 | \subsection Windows |
|
400 | 400 | |
|
401 | 401 | On Windows, the (non-source) Python Windows installer can be used. |
|
402 | 402 | Make sure that you use the same compiler, the current Python distribution is built |
|
403 | 403 | with Visual Studio 2003. If you want to use another compiler, you will need to build |
|
404 | 404 | Python yourself, using your compiler. |
|
405 | 405 | |
|
406 | 406 | To build PythonQt, you need to set the environment variable \b PYTHON_PATH to point to the root |
|
407 | 407 | dir of the python installation and \b PYTHON_LIB to point to |
|
408 | 408 | the directory where the python lib file is located. |
|
409 | 409 | |
|
410 | 410 | When using the prebuild Python installer, this will be: |
|
411 | 411 | |
|
412 | 412 | \code |
|
413 | 413 | > set PYTHON_PATH = c:\Python25 |
|
414 | 414 | > set PYTHON_LIB = c:\Python25\libs |
|
415 | 415 | \endcode |
|
416 | 416 | |
|
417 | 417 | When using the python sources, this will be something like: |
|
418 | 418 | |
|
419 | 419 | \code |
|
420 | 420 | > set PYTHON_PATH = c:\yourDir\Python-2.5.1\ |
|
421 | 421 | > set PYTHON_LIB = c:\yourDir\Python-2.5.1\PCbuild8\Win32 |
|
422 | 422 | \endcode |
|
423 | 423 | |
|
424 | 424 | To build all, do the following (after setting the above variables): |
|
425 | 425 | |
|
426 | 426 | \code |
|
427 | 427 | > cd PythonQtRoot |
|
428 | 428 | > vcvars32 |
|
429 | 429 | > qmake |
|
430 | 430 | > nmake |
|
431 | 431 | \endcode |
|
432 | 432 | |
|
433 | 433 | This should build everything. If Python can not be linked or include files can not be found, |
|
434 | 434 | you probably need to tweak \b build/python.prf |
|
435 | 435 | |
|
436 | 436 | The tests and examples are located in PythonQt/lib. |
|
437 | 437 | |
|
438 | 438 | \subsection Linux |
|
439 | 439 | |
|
440 | 440 | On Linux, you need to install a Python-dev package. |
|
441 | 441 | If Python can not be linked or include files can not be found, |
|
442 | 442 | you probably need to tweak \b build/python.prf |
|
443 | 443 | |
|
444 | 444 | To build PythonQt, just do a: |
|
445 | 445 | |
|
446 | 446 | \code |
|
447 | 447 | > cd PythonQtRoot |
|
448 | 448 | > qmake |
|
449 | 449 | > make all |
|
450 | 450 | \endcode |
|
451 | 451 | |
|
452 | 452 | The tests and examples are located in PythonQt/lib. |
|
453 | 453 | You should add PythonQt/lib to your LD_LIBRARY_PATH so that the runtime |
|
454 | 454 | linker can find the *.so files. |
|
455 | 455 | |
|
456 | 456 | \subsection MacOsX |
|
457 | 457 | |
|
458 | 458 | On Mac, Python is installed as a Framework, so you should not need to install it. |
|
459 | 459 | To build PythonQt, just do a: |
|
460 | 460 | |
|
461 | 461 | \code |
|
462 | 462 | > cd PythonQtRoot |
|
463 | 463 | > qmake |
|
464 | 464 | > make all |
|
465 | 465 | \endcode |
|
466 | 466 | |
|
467 | 467 | \section Tests |
|
468 | 468 | |
|
469 | 469 | There is a unit test that tests most features of PythonQt, see the \b tests subdirectory for details. |
|
470 | 470 | |
|
471 | 471 | \section Examples |
|
472 | 472 | |
|
473 | 473 | Examples are available in the \b examples directory. The PyScriptingConsole implements a simple |
|
474 | 474 | interactive scripting console that shows how to script a simple application. |
|
475 | 475 | |
|
476 | 476 | The following shows how to integrate PythonQt into you Qt application: |
|
477 | 477 | |
|
478 | 478 | \code |
|
479 | 479 | #include "PythonQt.h" |
|
480 | 480 | #include <QApplication> |
|
481 | 481 | ... |
|
482 | 482 | |
|
483 | 483 | int main( int argc, char **argv ) |
|
484 | 484 | { |
|
485 | 485 | |
|
486 | 486 | QApplication qapp(argc, argv); |
|
487 | 487 | |
|
488 | 488 | // init PythonQt and Python itself |
|
489 | 489 | PythonQt::init(PythonQt::IgnoreSiteModule | PythonQt::RedirectStdOut); |
|
490 | 490 | |
|
491 | 491 | |
|
492 | 492 | // get a smart pointer to the __main__ module of the Python interpreter |
|
493 | 493 | PythonQtObjectPtr mainContext = PythonQt::self()->getMainModule(); |
|
494 | 494 | |
|
495 | 495 | // add a QObject as variable of name "example" to the namespace of the __main__ module |
|
496 | 496 | PyExampleObject example; |
|
497 | 497 | PythonQt::self()->addObject(mainContext, "example", &example); |
|
498 | 498 | |
|
499 | 499 | // do something |
|
500 | 500 | PythonQt::self()->runScript(mainContext, "print example\n"); |
|
501 | 501 | PythonQt::self()->runScript(mainContext, "def multiply(a,b):\n return a*b;\n"); |
|
502 | 502 | QVariantList args; |
|
503 | 503 | args << 42 << 47; |
|
504 | 504 | QVariant result = PythonQt::self()->call(mainContext,"multiply", args); |
|
505 | 505 | ... |
|
506 | 506 | \endcode |
|
507 | 507 | |
|
508 | 508 | |
|
509 | 509 | */ |
General Comments 0
You need to be logged in to leave comments.
Login now