// This is the SIP file for organising the PyQt documentation.
//
// Copyright (c) 2003
// 	Riverbank Computing Limited <info@riverbankcomputing.co.uk>
// 
// This file is part of PyQt.
// 
// This copy of PyQt is free software; you can redistribute it and/or modify it
// under the terms of the GNU General Public License as published by the Free
// Software Foundation; either version 2, or (at your option) any later
// version.
// 
// PyQt is supplied in the hope that it will be useful, but WITHOUT ANY
// WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
// FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
// details.
// 
// You should have received a copy of the GNU General Public License along with
// PyQt; see the file LICENSE.  If not, write to the Free Software Foundation,
// Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.


%Module Dummy


%Include versions.sip


%Doc
<!DOCTYPE Article PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
<Article>
<ArtHeader>
	<Title>Python Bindings for Qt (3.7)</Title>
	<Author>
		<FirstName>Phil</FirstName>
		<Surname>Thompson</Surname>
	</Author>
	<Abstract>
	<Para>
	This document describes a set of Python bindings for the Qt widget set.
	Contact the author at <Email>phil@riverbankcomputing.co.uk</Email>.
	</Para>
	</Abstract>
</ArtHeader>


<Sect1><Title>Introduction</Title>
<Para>
PyQt is a set of Python bindings for the Qt toolkit and available for all
platforms supported by Qt, including Windows, Linux, UNIX and embedded systems
such as the Sharp Zaurus and the Compaq iPAQ.  They have been tested against Qt
versions 1.43 to 3.1.2, Qt Non-commercial, Qtopia 1.5.0, and Python versions
1.5 to 2.3b2.
</Para>

<Para>
PyQt is available under the GPL license for use with the GPL version of Qt, a
a commercial license for use with the commercial version of Qt, and an
educational license for use with the educational version of Qt.
</Para>

<Para>
The bindings are implemented as a number of Python modules
</Para>

<ItemizedList>
<ListItem>
<Para>
<Literal>qt</Literal> is the main module and contains the core classes and most
user interface widgets.
</Para>
</ListItem>

<ListItem>
<Para>
<Literal>qtcanvas</Literal> contains the classes implemented in Qt's Canvas
module.
</Para>
</ListItem>

<ListItem>
<Para>
<Literal>qtgl</Literal> contains the classes implemented in Qt's OpenGL module.
</Para>
</ListItem>

<ListItem>
<Para>
<Literal>qtnetwork</Literal> contains the classes implemented in Qt's Network
module.
</Para>
</ListItem>

<ListItem>
<Para>
<Literal>qtpe</Literal> contains the classes implemented in Qtopia (originally
called the Qt Palmtop Environment).  It is only supported with Qt/Embedded.
</Para>
</ListItem>

<ListItem>
<Para>
<Literal>qtsql</Literal> contains the classes implemented in Qt's SQL module.
</Para>
</ListItem>

<ListItem>
<Para>
<Literal>qttable</Literal> contains the classes implemented in Qt's Table
module.
</Para>
</ListItem>

<ListItem>
<Para>
<Literal>qtui</Literal> contains the classes implemented in Qt's qui library.
These allow GUIs to be created directly from Qt Designer's
<Literal>.ui</Literal> files.
</Para>
</ListItem>

<ListItem>
<Para>
<Literal>qtxml</Literal> contains the classes implemented in Qt's XML module.
</Para>
</ListItem>

<ListItem>
<Para>
<Literal>qtext</Literal> contains useful third-party classes that are not part
of Qt.  At the moment it contains bindings for QScintilla, the port to Qt of
the Scintilla programmer's editor class.
</Para>
</ListItem>
</ItemizedList>

<Para>
PyQt also includes the <Literal>pyuic</Literal> and
<Literal>pylupdate</Literal> utilities which correspond to the Qt
<Literal>uic</Literal> and <Literal>lupdate</Literal> utilities.
<Literal>pyuic</Literal> converts the GUI designs created with Qt Designer to
executable Python code.  <Literal>pylupdate</Literal> scans Python code,
extracts all strings that are candidates for internationalisation, and creates
an XML file for use by Qt Linguist.
</Para>

<Sect2><Title>Changes</Title>
<Para>
The changes visible to the Python programmer in this release are as follows.
</Para>
<ItemizedList>

<ListItem>
<Para>
SIP 3.7 is required.  Starting with SIP 3.1 the run-time support
library is implemented as a Python module and so is installed in a different
place to earlier versions.  You should manually remove any versions of the SIP
run-time support library and header files earlier than 3.1.
</Para>
</ListItem>

<ListItem>
<Para>
<Literal>dir()</Literal> of a PyQt class now returns all attributes of the
class (rather than just the "non-lazy" attributes).
</Para>
</ListItem>

<ListItem>
<Para>
The
<Literal>QSignalMapper</Literal> and
<Literal>QWindowsXPStyle</Literal> (Windows XP only)
classes have been added to the <Literal>qt</Literal> module.
</Para>
</ListItem>

<ListItem>
<Para>
The
<Literal>QextScintillaLexerHTML</Literal> and
<Literal>QextScintillaLexerSQL</Literal>
classes have been added to the <Literal>qtext</Literal> module.
</Para>
</ListItem>

<ListItem>
<Para>
The
<Literal>__add__()</Literal>,
<Literal>__iadd__()</Literal>,
<Literal>__mul__()</Literal>,
<Literal>__imul__()</Literal>,
<Literal>__eq__()</Literal>,
<Literal>__ne__()</Literal>,
<Literal>__setitem__()</Literal> and
<Literal>__delitem__()</Literal>
operators have been added to the <Literal>QStringList</Literal> class.
</Para>
</ListItem>

<ListItem>
<Para>
The
<Literal>bits()</Literal>,
<Literal>colorTable()</Literal>,
<Literal>jumpTable()</Literal> and
<Literal>scanLine()</Literal>
methods have been added to the <Literal>QImage</Literal> class.
</Para>
</ListItem>

<ListItem>
<Para>
The
<Literal>toDouble()</Literal>,
<Literal>toFloat()</Literal>,
<Literal>toInt()</Literal>,
<Literal>toLong()</Literal>,
<Literal>toShort()</Literal>,
<Literal>toUInt()</Literal>,
<Literal>toULong()</Literal> and
<Literal>toUShort()</Literal>
methods have been added to the <Literal>QCString</Literal> and
<Literal>QString</Literal> classes.
</Para>
</ListItem>

<ListItem>
<Para>
The
<Literal>modificationAttempted()</Literal>
signal has been added to the <Literal>QextScintilla</Literal> class.
</Para>
</ListItem>

<ListItem>
<Para>
<Literal>pyuic</Literal> for Qt v3 now supports a <Literal>-test</Literal>
command line flag which generates code that will run to completion without
displaying the form or needing interaction with the user.
</Para>
</ListItem>

<ListItem>
<Para>
Several new example scripts have been added (thanks to Jorge Arroyo).
</Para>
</ListItem>

</ItemizedList>
</Sect2>
</Sect1>


<Sect1><Title>Other PyQt Goodies</Title>
<Sect2><Title>Using Qt Designer</Title>
<Para>
Qt Designer is a GPL'ed GUI design editor provided by Trolltech as part of Qt.
It generates an XML description of a GUI design. Qt includes
<Literal>uic</Literal> which generates C++ code from that XML.
</Para>

<Para>
PyQt includes <Literal>pyuic</Literal> which generates Python code from the
same XML. The Python code is self contained and can be executed immediately.
</Para>

<Para>
It is sometimes useful to be able to include some specific Python code in the
output generated by <Literal>pyuic</Literal>. For example, if you are using
custom widgets, <Literal>pyuic</Literal> has no way of knowing the name of the
Python module containing the widget and so cannot generate the required
<Literal>import</Literal> statement. To help get around this,
<Literal>pyuic</Literal> will extract any lines entered in the
<Literal>Comment</Literal> field of Qt Designer's
<Literal>Form Settings</Literal> dialog that begin with
<Literal>Python:</Literal> and copies them to the generated output.
</Para>

<Para>
Here's a simple example showing the contents of the <Literal>Comment</Literal>
field.
</Para>

<ProgramListing>
This comment will be ignored by pyuic.
Python:
Python:# Import our custom widget.
Python:from foo import bar
</ProgramListing>

<Para>
Here's the corresponding output from <Literal>pyuic</Literal>.
</Para>

<ProgramListing>
from qt import *

# Import our custom widget.
from foo import bar
</ProgramListing>

<Para>
Thanks to Christian Bird, <Literal>pyuic</Literal> will extract Python code
entered using Qt Designer to implement slots. In Qt Designer, when you need to
edit a slot and the source editor appears, enter Python code between the curly
braces. Don't worry about the correct starting indent level, each line is
prepended with a correct indentation.
</Para>

<Para>
Make sure that the <Literal>ui.h</Literal> file is in the same directory as the
<Literal>.ui</Literal> file when using <Literal>pyuic</Literal>. The
<Literal>.ui</Literal> file implies the name of the <Literal>.ui.h</Literal>
file so there is no need to specify it on the command line.
</Para>

<Para>
Here's an example of a simple slot.  
</Para>

<ProgramListing>
void DebMainWindowFrm::browsePushButtonClicked()
{
if self.debugging:
    QMessageBox.critical(self, "Event", "browse pushbutton was clicked!")
}
</ProgramListing>

<Para>
Here is the resulting code when <Literal>pyuic</Literal> is run.
</Para>

<ProgramListing>
class DebMainWindowFrm(QMainWindow):
    ...stuff...
    def browsePushButtonClicked(self):
        if self.debugging:
            QMessageBox.critical(self, "Event", "browse pushbutton was clicked!")
</ProgramListing>

<Para>
Note that indenting is as normal and that <Literal>self</Literal> and all other
parameters passed to the slot are available.
</Para>

<Para>
If you use this, you will need to turn off all of the fancy options for the C++ 
editor in Designer as it tries to force C++ syntax and that's naturally
annoying when trying to code in Python.
</Para>
</Sect2>

<Sect2><Title>Using Qt Linguist</Title>
<Para>
Qt includes the <Literal>lupdate</Literal> program which parses C++ source
files converting calls to the <Literal>QT_TR_NOOP()</Literal> and
<Literal>QT_TRANSLATE_NOOP()</Literal> macros to <Literal>.ts</Literal>
language source files.  The <Literal>lrelease</Literal> program is then used to
generate <Literal>.qm</Literal> binary language files that are distributed with
your application.
</Para>

<Para>
Thanks to Detlev Offenbach, PyQt includes the <Literal>pylupdate</Literal>
program.  This generates the same <Literal>.ts</Literal> language source files
from your PyQt source files.
</Para>
</Sect2>
</Sect1>
%End


%ExportedDoc
<Sect1><Title>Things to be Aware Of</Title>
<Sect2><Title>Python Strings, Qt Strings and Unicode</Title>
<Para>
Unicode support was added to Qt in v2.0 and to Python in v1.6.  In Qt, Unicode
support is implemented using the <Literal>QString</Literal> class.  It is
important to understand that <Literal>QString</Literal>s, Python string objects
and Python Unicode objects are all different but conversions between them are
automatic in many cases and easy to achieve manually when needed.
</Para>

<Para>
Whenever PyQt expects a <Literal>QString</Literal> as a function argument, a
Python string object or a Python Unicode object can be provided instead, and
PyQt will do the necessary conversion automatically.
</Para>

<Para>
You may also manually convert Python string and Unicode objects to
<Literal>QString</Literal>s by using the <Literal>QString</Literal> constructor
as demonstrated in the following code fragment.
</Para>

<ProgramListing>
qs1 = QString('Converted Python string object')
qs2 = QString(u'Converted Python Unicode object')
</ProgramListing>

<Para>
In order to convert a <Literal>QString</Literal> to a Python string object use
the Python <Literal>str()</Literal> function.  Applying
<Literal>str()</Literal> to a null <Literal>QString</Literal> and an empty
<Literal>QString</Literal> both result in an empty Python string object.
</Para>

<Para>
In order to convert a <Literal>QString</Literal> to a Python Unicode object use
the Python <Literal>unicode()</Literal> function.  Applying
<Literal>unicode()</Literal> to a null <Literal>QString</Literal> and an empty
<Literal>QString</Literal> both result in an empty Python Unicode object.
</Para>
</Sect2>

<Sect2><Title>Access to Protected Member Functions</Title>
<Para>
When an instance of a C++ class is not created from Python it is not possible
to access the protected member functions, or emit the signals, of that
instance.  Attempts to do so will raise a Python exception.  Also, any Python
methods corresponding to the instance's virtual member functions will never be
called.
</Para>
</Sect2>

<Sect2><Title><Literal>None</Literal> and <Literal>NULL</Literal></Title>
<Para>
Throughout the bindings, the <Literal>None</Literal> value can be specified
wherever <Literal>NULL</Literal> is acceptable to the underlying C++ code.
</Para>

<Para>
Equally, <Literal>NULL</Literal> is converted to <Literal>None</Literal>
whenever it is returned by the underlying C++ code.
</Para>
</Sect2>


<Sect2><Title>Support for C++ <Literal>void *</Literal> Data Types</Title>
<Para>
PyQt represents <Literal>void *</Literal> values as objects of type
<Literal>sip.voidptr</Literal>. Such values are often used to pass the
addresses of external objects between different Python modules. To make this
easier, a Python integer (or anything that Python can convert to an integer)
can be used whenever a <Literal>sip.voidptr</Literal> is expected. Also a
<Literal>sip.voidptr</Literal> may be converted to an integer by using the
<Literal>int()</Literal> builtin function.
</Para>
</Sect2>


<Sect2><Title>Support for Threads</Title>
<Para>
PyQt implements the full set of Qt's thread classes.  Python, of course, also
has its own thread extension modules.  It is possible to use either of the
APIs so long as you follow some simple rules.
</Para>
<ItemizedList>
<ListItem>
<Para>
If you use the Qt API then the very first <Literal>import</Literal> of one of
the PyQt modules must be done from the main thread.
</Para>
</ListItem>
<ListItem>
<Para>
If you use the Python API then all calls to PyQt (including any
<Literal>import</Literal>s) must be done from one thread only.  Therefore, if
you want to make calls to PyQt from several threads then you must use the Qt
API.
</Para>
</ListItem>
<ListItem>
<Para>
If you want to use both APIs in the same application then all calls to PyQt
must be done from threads created using the Qt API.
</Para>
</ListItem>
</ItemizedList>
<Para>
The above comments actually apply to any SIP generated module, not just PyQt.
</Para>
</Sect2>

<Sect2><Title>Garbage Collection</Title>
<Para>
C++ does not garbage collect unreferenced class instances, whereas Python does.
In the following C++ fragment both colours exist even though the first can no
longer be referenced from within the program:
</Para>

<ProgramListing>
c = QColor();
c = QColor();
</ProgramListing>

<Para>
In the corresponding Python fragment, the first colour is destroyed when
the second is assigned to <Literal>c</Literal>:
</Para>

<ProgramListing>
c = QColor()
c = QColor()
</ProgramListing>

<Para>
In Python, each colour must be assigned to different names.  Typically this
is done within class definitions, so the code fragment would be something like:
</Para>

<ProgramListing>
self.c1 = QColor()
self.c2 = QColor()
</ProgramListing>

<Para>
Sometimes a Qt class instance will maintain a pointer to another instance and
will eventually call the destructor of that second instance. The most common
example is that a <Literal>QObject</Literal> (and any of its sub-classes) keeps
pointers to its children and will automatically call their destructors. In
these cases, the corresponding Python object will also keep a reference to the
corresponding child objects.
</Para>

<Para>
So, in the following Python fragment, the first <Literal>QLabel</Literal> is
not destroyed when the second is assigned to <Literal>l</Literal> because the
parent <Literal>QWidget</Literal> still has a reference to it.
</Para>

<ProgramListing>
p = QWidget()
l = QLabel('First label',p)
l = QLabel('Second label',p)
</ProgramListing>
</Sect2>

<Sect2><Title>C++ Variables</Title>
<Para>
Access to C++ variables is supported.  They are accessed as Python instance
variables.  For example:
</Para>

<ProgramListing>
tab = QTab()
tab.label = "First Tab"
tab.r = QRect(10,10,75,30)
</ProgramListing>

<Para>
Global variables and static class variables are effectively read-only.  They
can be assigned to, but the underlying C++ variable will not be changed.  This
may change in the future.
</Para>

<Para>
Access to protected C++ class variables is not supported.  This may change in
the future.
</Para>
</Sect2>

<Sect2><Title>Multiple Inheritance</Title>
<Para>
It is not possible to define a new Python class that sub-classes from more than
one Qt class.
</Para>
</Sect2>

<Sect2><Title>i18n Support</Title>
<Para>
Qt implements i18n support through the Qt Linguist application, the
<Literal>QTranslator</Literal> class, and the
<Literal>QApplication::translate()</Literal>, <Literal>QObject::tr()</Literal>
and <Literal>QObject::trUtf8()</Literal> methods.  Usually the
<Literal>tr()</Literal> method is used to obtain the correct translation of a
message.  The translation process uses a message context to allow the same
message to be translated differently.  <Literal>tr()</Literal> is actually
generated by <Literal>moc</Literal> and uses the hardcoded class name as the
context.  On the other hand, <Literal>QApplication::translate()</Literal>
allows to context to be explicitly stated.
</Para>

<Para>
Unfortunately, because of the way Qt implents <Literal>tr()</Literal> (and
<Literal>trUtf8()</Literal>) it is not possible for PyQt to exactly reproduce
its behavour.  The PyQt implementation of <Literal>tr()</Literal> (and
<Literal>trUtf8()</Literal>) uses the class name of the instance as the
context.  The key difference, and the source of potential problems, is that the
context is determined dynamically in PyQt, but is hardcoded in Qt. In other
words, the context of a translation may change depending on an instance's class
hierarchy.
</Para>

<ProgramListing>
class A(QObject):
    def __init__(self):
        QObject.__init__(self)

    def hello(self):
        return self.tr("Hello")

class B(A):
    def __init__(self):
        A.__init__(self)

a = A()
a.hello()

b = B()
b.hello()
</ProgramListing>

<Para>
In the above the message is translated by <Literal>a.hello()</Literal> using a
context of <Literal>A</Literal>, and by <Literal>b.hello()</Literal> using a
context of <Literal>B</Literal>.  In the equivalent C++ version the context
would be <Literal>A</Literal> in both cases.
</Para>

<Para>
The PyQt behaviour is unsatisfactory and may be changed in the future.  It is
recommended that <Literal>QApplication.translate()</Literal> be used in
preference to <Literal>tr()</Literal> (and <Literal>trUtf8()</Literal>).  This
is guaranteed to work with current and future versions of PyQt and makes it
much easier to share message files between Python and C++ code.  Below is the
alternative implementation of <Literal>A</Literal> that uses
<Literal>QApplication.translate()</Literal>.
</Para>

<ProgramListing>
class A(QObject):
    def __init__(self):
        QObject.__init__(self)

    def hello(self):
        return qApp.translate("A","Hello")
</ProgramListing>

<Para>
Note that the code generated by <Literal>pyuic</Literal> uses
<Literal>QApplication.translate()</Literal>.
</Para>
</Sect2>
</Sect1>


<Sect1><Title>Signal and Slot Support</Title>
<Para>
A signal may be either a Qt signal (specified using
<Literal>SIGNAL()</Literal>) or a Python signal (specified using
<Literal>PYSIGNAL()</Literal>).
</Para>

<Para>
A slot can be either a Python callable object, a Qt signal (specified using
<Literal>SIGNAL()</Literal>), a Python signal (specified using
<Literal>PYSIGNAL()</Literal>), or a Qt slot (specified using
<Literal>SLOT()</Literal>).
</Para>

<Para>
You connect signals to slots (and other signals) as you would from C++.  For
example:
</Para>

<ProgramListing>
QObject.connect(a,SIGNAL("QtSig()"),pyFunction)
QObject.connect(a,SIGNAL("QtSig()"),pyClass.pyMethod)
QObject.connect(a,SIGNAL("QtSig()"),PYSIGNAL("PySig"))
QObject.connect(a,SIGNAL("QtSig()"),SLOT("QtSlot()"))
QObject.connect(a,PYSIGNAL("PySig"),pyFunction)
QObject.connect(a,PYSIGNAL("PySig"),pyClass.pyMethod)
QObject.connect(a,PYSIGNAL("PySig"),SIGNAL("QtSig()"))
QObject.connect(a,PYSIGNAL("PySig"),SLOT("QtSlot()"))
</ProgramListing>

<Para>
When a slot is a Python method that corresponds to a Qt slot then a signal can
be connected to either the Python method or the Qt slot.  The following
connections achieve the same effect.
</Para>

<ProgramListing>
sbar = QScrollBar()
lcd = QLCDNumber()

QObject.connect(sbar,SIGNAL("valueChanged(int)"),lcd.display)
QObject.connect(sbar,SIGNAL("valueChanged(int)"),lcd,SLOT("display(int)"))
</ProgramListing>

<Para>
The difference is that the second connection is made at the C++ level and is
more efficient.
</Para>

<Para>
Disconnecting signals works in exactly the same way.
</Para>

<Para>
Any instance of a class that is derived from the <Literal>QObject</Literal>
class can emit a signal using the <Literal>emit</Literal> method.  This takes
two arguments.  The first is the Python or Qt signal, the second is a Python
tuple which are the arguments to the signal.  For example:
</Para>

<ProgramListing>
a.emit(SIGNAL("clicked()"),())
a.emit(PYSIGNAL("pySig"),("Hello","World"))
</ProgramListing>

<Para>
Note that when a slot is a Python callable object it's reference count is not
increased.  This means that a class instance can be deleted without having to
explicitly disconnect any signals connected to its methods.  However, it also
means that using lambda expressions as slots will not work unless you keep a
separate reference to the expression to prevent it from being immediately
garbage collected.
</Para>

<Para>
Qt allows a signal to be connected to a slot that requires fewer arguments than
the signal passes.  The extra arguments are quietly discarded.  Python slots
can be used in the same way. 
</Para>
</Sect1>


<Sect1><Title>Static Member Functions</Title>
<Para>
Static member functions are implemented as Python class functions.
For example the C++ static member function
<Literal>QObject::connect()</Literal> is called from Python as
<Literal>QObject.connect()</Literal> or <Literal>self.connect()</Literal> if
called from a sub-class of <Literal>QObject</Literal>.
</Para>
</Sect1>


<Sect1><Title>Enumerated Types</Title>
<Para>
Enumerated types are implemented as a set of simple variables corresponding to
the separate enumerated values.
</Para>

<Para>
When using an enumerated value the name of the class (or a sub-class) in which
the enumerated type was defined in must be included.  For example:
</Para>

<ProgramListing>
Qt.SolidPattern
QWidget.TabFocus
QFrame.TabFocus
</ProgramListing>
</Sect1>


<Sect1><Title>Module Reference Documentation</Title>
<Para>
The following sections should be used in conjunction with the normal class
documentation - only the differences specific to the Python bindings are
documented here.
</Para>

<Para>
In these sections, <Emphasis>Not yet implemented</Emphasis>
implies that the feature can be easily implemented if needed.  <Emphasis>Not
implemented</Emphasis> implies that the feature will not be implemented, either
because it cannot be or because it is not appropriate.
</Para>

<Para>
If a class is described as being <Emphasis>fully implemented</Emphasis> then
all non-private member functions and all public class variables have been
implemented.  If an operator has been implemented it is stated explicitly.
</Para>

<Para>
Classes that are not mentioned have not yet been implemented.
</Para>
</Sect1>


<Sect1><Title><Literal>qt</Literal> Module Reference</Title>
%End

%Include qglobal.sip
%Include qwindowdefs.sip
%Include qnamespace.sip

%Include qaccel.sip
%Include qaction.sip
%Include qapplication.sip
%Include qassistantclient.sip
%Include qbitmap.sip
%Include qbrush.sip
%Include qbutton.sip
%Include qbuttongroup.sip
%Include qbytearray.sip
%Include qcdestyle.sip
%Include qcheckbox.sip
%Include qclipboard.sip
%Include qcolor.sip
%Include qcolordialog.sip
%Include qcolorgroup.sip
%Include qcombobox.sip
%Include qcommonstyle.sip
%Include qcstring.sip
%Include qcursor.sip
%Include qdatastream.sip
%Include qdatetime.sip
%Include qdatetimeedit.sip
%Include qdesktopwidget.sip
%Include qdial.sip
%Include qdialog.sip
%Include qdir.sip
%Include qdockarea.sip
%Include qdockwindow.sip
%Include qdragobject.sip
%Include qdrawutil.sip
%Include qdropsite.sip
%Include qerrormessage.sip
%Include qevent.sip
%Include qeventloop.sip
%Include qfile.sip
%Include qfiledialog.sip
%Include qfileinfo.sip
%Include qfont.sip
%Include qfontdatabase.sip
%Include qfontdialog.sip
%Include qfontinfo.sip
%Include qfontmetrics.sip
%Include qframe.sip
%Include qgmanager.sip
%Include qgrid.sip
%Include qgridview.sip
%Include qgroupbox.sip
%Include qhbox.sip
%Include qhbuttongroup.sip
%Include qheader.sip
%Include qhgroupbox.sip
%Include qiconset.sip
%Include qiconview.sip
%Include qimage.sip
%Include qinputdialog.sip
%Include qinterlacestyle.sip
%Include qiodevice.sip
%Include qkeycode.sip
%Include qkeysequence.sip
%Include qlabel.sip
%Include qlayout.sip
%Include qlcdnumber.sip
%Include qlibrary.sip
%Include qlineedit.sip
%Include qlist.sip
%Include qlistbox.sip
%Include qlistview.sip
%Include qmainwindow.sip
%Include qmemarray.sip
%Include qmenubar.sip
%Include qmenudata.sip
%Include qmessagebox.sip
%Include qmime.sip
%Include qmotifplusstyle.sip
%Include qmotifstyle.sip
%Include qmovie.sip
%Include qmultilinedit.sip
%Include qmutex.sip
%Include qnetworkprotocol.sip
%Include qobject.sip
%Include qobjectcleanuphandler.sip
%Include qobjectlist.sip
%Include qpaintdevicemetrics.sip
%Include qpaintdevice.sip
%Include qpainter.sip
%Include qpalette.sip
%Include qpixmap.sip
%Include qpixmapcache.sip
%Include qpair.sip
%Include qpen.sip
%Include qpicture.sip
%Include qplatinumstyle.sip
%Include qpoint.sip
%Include qpointarray.sip
%Include qpopupmenu.sip
%Include qprintdialog.sip
%Include qprinter.sip
%Include qprocess.sip
%Include qprogressbar.sip
%Include qprogressdialog.sip
%Include qptrlist.sip
%Include qpushbutton.sip
%Include qradiobutton.sip
%Include qrangecontrol.sip
%Include qrect.sip
%Include qregexp.sip
%Include qregion.sip
%Include qscrollbar.sip
%Include qscrollview.sip
%Include qsemaphore.sip
%Include qsemimodal.sip
%Include qsessionmanager.sip
%Include qsettings.sip
%Include qsgistyle.sip
%Include qsignalmapper.sip
%Include qsimplerichtext.sip
%Include qsize.sip
%Include qsizegrip.sip
%Include qsizepolicy.sip
%Include qslider.sip
%Include qsocketnotifier.sip
%Include qsound.sip
%Include qspinbox.sip
%Include qsplitter.sip
%Include qstatusbar.sip
%Include qstring.sip
%Include qstringlist.sip
%Include qstrlist.sip
%Include qstyle.sip
%Include qstylesheet.sip
%Include qsyntaxhighlighter.sip
%Include qtabbar.sip
%Include qtabdialog.sip
%Include qtableview.sip
%Include qtabwidget.sip
%Include qtextbrowser.sip
%Include qtextcodec.sip
%Include qtextedit.sip
%Include qtextstream.sip
%Include qtextview.sip
%Include qthread.sip
%Include qtimer.sip
%Include qtoolbar.sip
%Include qtoolbutton.sip
%Include qtooltip.sip
%Include qtranslator.sip
%Include qurl.sip
%Include qurlinfo.sip
%Include qurloperator.sip
%Include qvalidator.sip
%Include qvaluelist.sip
%Include qvariant.sip
%Include qvbox.sip
%Include qvbuttongroup.sip
%Include qvgroupbox.sip
%Include qwaitcondition.sip
%Include qwhatsthis.sip
%Include qwidget.sip
%Include qwidgetlist.sip
%Include qwidgetstack.sip
%Include qwindow.sip
%Include qwindowsstyle.sip
%Include qwindowsxpstyle.sip
%Include qwizard.sip
%Include qwmatrix.sip
%Include qworkspace.sip

%ExportedDoc
</Sect1>
%End


%ExportedDoc
<Sect1><Title><Literal>qtcanvas</Literal> Module Reference</Title>
%End

%Include qcanvas.sip

%ExportedDoc
</Sect1>
%End


%ExportedDoc
<Sect1><Title><Literal>qtext</Literal> Module Reference</Title>

<Sect2><Title>QextScintilla</Title>
<FuncSynopsis>
	<FuncDef>void <Function>getCursorPosition</Function></FuncDef>
	<ParamDef>int *<Parameter>line</Parameter></ParamDef>
	<ParamDef>int *<Parameter>index</Parameter></ParamDef>
</FuncSynopsis>
<Para>
This takes no parameters and returns a tuple of the values returned by the
<Literal>line</Literal> and <Literal>index</Literal> pointers.
</Para>

<FuncSynopsis>
	<FuncDef>void <Function>getSelection</Function></FuncDef>
	<ParamDef>int *<Parameter>lineFrom</Parameter></ParamDef>
	<ParamDef>int *<Parameter>indexFrom</Parameter></ParamDef>
	<ParamDef>int *<Parameter>lineTo</Parameter></ParamDef>
	<ParamDef>int *<Parameter>indexTo</Parameter></ParamDef>
</FuncSynopsis>
<Para>
This takes no parameters and returns a tuple of the values returned by the
<Literal>lineFrom</Literal>, <Literal>indexFrom</Literal>,
<Literal>lineTo</Literal> and <Literal>indexTo</Literal> pointers.
</Para>
</Sect2>

<Sect2><Title>QextScintillaAPIs</Title>
<Para>
<Literal>QextScintillaAPIs</Literal> is fully implemented.
</Para>
</Sect2>

<Sect2><Title>QextScintillaBase</Title>
<Para>
<Literal>QextScintillaBase</Literal> is fully implemented.
</Para>
</Sect2>

<Sect2><Title>QextScintillaCommand</Title>
<Para>
<Literal>QextScintillaCommand</Literal> is fully implemented.
</Para>
</Sect2>

<Sect2><Title>QextScintillaCommandSet</Title>
<Para>
<Literal>QextScintillaCommandSet</Literal> is fully implemented.
</Para>
</Sect2>

<Sect2><Title>QextScintillaLexer</Title>
<Para>
<Literal>QextScintillaLexer</Literal> is fully implemented.
</Para>
</Sect2>

<Sect2><Title>QextScintillaLexerCPP</Title>
<Para>
<Literal>QextScintillaLexerCPP</Literal> is fully implemented.
</Para>
</Sect2>

<Sect2><Title>QextScintillaLexerCSharp</Title>
<Para>
<Literal>QextScintillaLexerCSharp</Literal> is fully implemented.
</Para>
</Sect2>

<Sect2><Title>QextScintillaLexerHTML (QScintilla v1.1+)</Title>
<Para>
<Literal>QextScintillaLexerHTML</Literal> is fully implemented.
</Para>
</Sect2>

<Sect2><Title>QextScintillaLexerIDL</Title>
<Para>
<Literal>QextScintillaLexerIDL</Literal> is fully implemented.
</Para>
</Sect2>

<Sect2><Title>QextScintillaLexerJava</Title>
<Para>
<Literal>QextScintillaLexerJava</Literal> is fully implemented.
</Para>
</Sect2>

<Sect2><Title>QextScintillaLexerJavaScript</Title>
<Para>
<Literal>QextScintillaLexerJavaScript</Literal> is fully implemented.
</Para>
</Sect2>

<Sect2><Title>QextScintillaLexerPython</Title>
<Para>
<Literal>QextScintillaLexerPython</Literal> is fully implemented.
</Para>
</Sect2>

<Sect2><Title>QextScintillaLexerSQL (QScintilla v1.1+)</Title>
<Para>
<Literal>QextScintillaLexerSQL</Literal> is fully implemented.
</Para>
</Sect2>

<Sect2><Title>QextScintillaMacro</Title>
<Para>
<Literal>QextScintillaMacro</Literal> is fully implemented.
</Para>
</Sect2>

<Sect2><Title>QextScintillaPrinter</Title>
<Para>
<Literal>QextScintillaPrinter</Literal> is fully implemented.
</Para>
</Sect2>
%End


%ExportedDoc
</Sect1>
%End


%ExportedDoc
<Sect1><Title><Literal>qtgl</Literal> Module Reference</Title>
%End

%Include qgl.sip
%Include qglcolormap.sip

%ExportedDoc
</Sect1>
%End


%ExportedDoc
<Sect1><Title><Literal>qtnetwork</Literal> Module Reference</Title>
%End

%Include qdns.sip
%Include qhostaddress.sip
%Include qnetwork.sip
%Include qserversocket.sip
%Include qsocket.sip

%ExportedDoc
</Sect1>
%End


%ExportedDoc
<Sect1><Title><Literal>qtpe</Literal> Module Reference</Title>

<Sect2><Title>QPEApplication</Title>
<FuncSynopsis>
	<FuncDef><Function>QApplication</Function></FuncDef>
	<ParamDef>int& <Parameter>argc</Parameter></ParamDef>
	<ParamDef>char **<Parameter>argv</Parameter></ParamDef>
	<ParamDef>Type <Parameter>type</Parameter></ParamDef>
</FuncSynopsis>
<Para>
This takes two parameters, the first of which is a list of argument strings.
Arguments used by Qt are removed from the list.
</Para>

<FuncSynopsis>
	<FuncDef>int <Function>exec</Function></FuncDef>
	<ParamDef></ParamDef>
</FuncSynopsis>
<Para>
This has been renamed to <Literal>exec_loop</Literal> in Python.
</Para>
</Sect2>

<Sect2><Title>AppLnk</Title>
<FuncSynopsis>
	<FuncDef>virtual QString <Function>exec</Function> const</FuncDef>
	<ParamDef></ParamDef>
</FuncSynopsis>
<Para>
This has been renamed to <Literal>exec_property</Literal> in Python.
</Para>
</Sect2>

<Sect2><Title>AppLnkSet</Title>
<Para>
<Literal>AppLnkSet</Literal> is fully implemented.
</Para>
</Sect2>

<Sect2><Title>Config</Title>
<Para>
<Literal>Config</Literal> is fully implemented.
</Para>
</Sect2>

<Sect2><Title>DateFormat</Title>
<Para>
<Literal>DateFormat</Literal> is fully implemented.
</Para>
</Sect2>

<Sect2><Title>DocLnk</Title>
<FuncSynopsis>
	<FuncDef>QString <Function>exec</Function> const</FuncDef>
	<ParamDef></ParamDef>
</FuncSynopsis>
<Para>
This has been renamed to <Literal>exec_property</Literal> in Python.
</Para>
</Sect2>

<Sect2><Title>DocLnkSet</Title>
<Para>
<Literal>DocLnkSet</Literal> is fully implemented.
</Para>
</Sect2>

<Sect2><Title>FileManager</Title>
<Para>
<Literal>FileManager</Literal> is fully implemented.
</Para>
</Sect2>

<Sect2><Title>FileSelector</Title>
<Para>
<Literal>FileSelector</Literal> is fully implemented.
</Para>
</Sect2>

<Sect2><Title>FileSelectorItem</Title>
<Para>
<Literal>FileSelectorItem</Literal> is fully implemented.
</Para>
</Sect2>

<Sect2><Title>FontDatabase</Title>
<Para>
<Literal>FontDatabase</Literal> is fully implemented.
</Para>
</Sect2>

<Sect2><Title>Global</Title>
<FuncSynopsis>
	<FuncDef>static void <Function>setBuiltinCommands</Function></FuncDef>
	<ParamDef>Command *</ParamDef>
</FuncSynopsis>
<Para>
Not implemented.
</Para>
</Sect2>

<Sect2><Title>MenuButton</Title>
<Para>
<Literal>MenuButton</Literal> is fully implemented.
</Para>
</Sect2>

<Sect2><Title>QCopEnvelope</Title>
<Para>
<Literal>QCopEnvelope</Literal> is fully implemented.
</Para>
</Sect2>

<Sect2><Title>QDawg</Title>
<Para>
<Literal>QDawg</Literal> is fully implemented.
</Para>
</Sect2>

<Sect2><Title>QPEMenuBar</Title>
<Para>
<Literal>QPEMenuBar</Literal> is fully implemented.
</Para>
</Sect2>

<Sect2><Title>QPEToolBar</Title>
<Para>
<Literal>QPEToolBar</Literal> is fully implemented.
</Para>
</Sect2>

<Sect2><Title>Resource</Title>
<Para>
<Literal>Resource</Literal> is fully implemented.
</Para>
</Sect2>

</Sect1>
%End


%ExportedDoc
<Sect1><Title><Literal>qtsql</Literal> Module Reference</Title>
%End

%Include qdatabrowser.sip
%Include qdatatable.sip
%Include qdataview.sip
%Include qeditorfactory.sip
%Include qsql.sip
%Include qsqlcursor.sip
%Include qsqldatabase.sip
%Include qsqldriver.sip
%Include qsqleditorfactory.sip
%Include qsqlerror.sip
%Include qsqlfield.sip
%Include qsqlform.sip
%Include qsqlindex.sip
%Include qsqlpropertymap.sip
%Include qsqlquery.sip
%Include qsqlrecord.sip
%Include qsqlresult.sip

%ExportedDoc
</Sect1>
%End


%ExportedDoc
<Sect1><Title><Literal>qttable</Literal> Module Reference</Title>
%End

%Include qtable.sip

%ExportedDoc
</Sect1>
%End


%ExportedDoc
<Sect1><Title><Literal>qtxml</Literal> Module Reference</Title>
%End

%Include qdom.sip

%ExportedDoc
</Sect1>
%End


%Doc
</Article>
%End