diff options
Diffstat (limited to 'sphinx')
| -rw-r--r-- | sphinx/build_system.rst | 28 | ||||
| -rw-r--r-- | sphinx/c_api.rst | 2 | ||||
| -rw-r--r-- | sphinx/command_line.rst | 4 | ||||
| -rw-r--r-- | sphinx/incompatibilities.rst | 4 | ||||
| -rw-r--r-- | sphinx/introduction.rst | 12 | ||||
| -rw-r--r-- | sphinx/specification_files.rst | 22 | ||||
| -rw-r--r-- | sphinx/using.rst | 16 |
7 files changed, 44 insertions, 44 deletions
diff --git a/sphinx/build_system.rst b/sphinx/build_system.rst index fda9172..3b95af5 100644 --- a/sphinx/build_system.rst +++ b/sphinx/build_system.rst @@ -12,7 +12,7 @@ supports over 50 different platform/compiler combinations. The build system is implemented as a pure Python module called :mod:`sipconfig` that contains a number of classes and functions. Using this module you can -write bespoke configuration scripts (e.g. PyQt's ``configure.py``) or use it +write bespoke configuration scripts (e.g. PyTQt's ``configure.py``) or use it with other Python based build systems (e.g. `Distutils <http://www.python.org/sigs/distutils-sig/distutils.html>`_ and `SCons <http://www.scons.org>`_). @@ -20,17 +20,17 @@ with other Python based build systems (e.g. An important feature of SIP is the ability to generate bindings that are built on top of existing bindings. For example, both `PyKDE <http://www.riverbankcomputing.com/software/pytde/>`_ and -`PyQwt <http://pyqwt.sourceforge.net/>`_ are built on top of PyQt but all three -packages are maintained by different developers. To make this easier PyQt -includes its own configuration module, ``pyqtconfig``, that contains additional +`PyQwt <http://pyqwt.sourceforge.net/>`_ are built on top of PyTQt but all three +packages are maintained by different developers. To make this easier PyTQt +includes its own configuration module, ``pytqtconfig``, that contains additional classes intended to be used by the configuration scripts of bindings built on -top of PyQt. The SIP build system includes facilities that do a lot of the +top of PyTQt. The SIP build system includes facilities that do a lot of the work of creating these additional configuration modules. .. function:: create_config_module(module, template, content[, macros=None]) - This creates a configuration module (e.g. ``pyqtconfig``) from a template + This creates a configuration module (e.g. ``pytqtconfig``) from a template file and a string. :param module: @@ -377,7 +377,7 @@ work of creating these additional configuration modules. A string that will remove a file. - .. method:: __init__(configuration[, console=0[, qt=0[, opengl=0[, python=0[, threaded=0[, warnings=None[, debug=0[, dir=None[, makefile="Makefile"[, installs=None[, universal=None[, arch=None]]]]]]]]]]]]) + .. method:: __init__(configuration[, console=0[, tqt=0[, opengl=0[, python=0[, threaded=0[, warnings=None[, debug=0[, dir=None[, makefile="Makefile"[, installs=None[, universal=None[, arch=None]]]]]]]]]]]]) :param configuration: the current configuration and is an instance of the @@ -385,8 +385,8 @@ work of creating these additional configuration modules. :param console: is set if the target is a console (rather than GUI) target. This only affects Windows and is ignored on other platforms. - :param qt: - is set if the target uses Qt. For Qt v4 a list of Qt libraries may + :param tqt: + is set if the target uses TQt. For Qt v4 a list of Qt libraries may be specified and a simple non-zero value implies QtCore and QtGui. :param opengl: is set if the target uses OpenGL. @@ -394,7 +394,7 @@ work of creating these additional configuration modules. is set if the target uses Python.h. :param threaded: is set if the target requires thread support. It is set - automatically if the target uses Qt and Qt has thread support + automatically if the target uses TQt and TQt has thread support enabled. :param warnings: is set if compiler warning messages should be enabled. The default @@ -572,7 +572,7 @@ work of creating these additional configuration modules. :ref:`ref-builtin`). :param console: see :meth:`sipconfig.Makefile.__init__`. - :param qt: + :param tqt: see :meth:`sipconfig.Makefile.__init__`. :param opengl: see :meth:`sipconfig.Makefile.__init__`. @@ -686,7 +686,7 @@ work of creating these additional configuration modules. This class encapsulates a Makefile to build an executable program. - .. method:: __init__(configuration[, build_file=None[, install_dir=None[, console=0[, qt=0[, opengl=0[, python=0[, threaded=0[, warnings=None[, debug=0[, dir=None[, makefile="Makefile"[, installs=None[, universal=None[, arch=None]]]]]]]]]]]]]]) + .. method:: __init__(configuration[, build_file=None[, install_dir=None[, console=0[, tqt=0[, opengl=0[, python=0[, threaded=0[, warnings=None[, debug=0[, dir=None[, makefile="Makefile"[, installs=None[, universal=None[, arch=None]]]]]]]]]]]]]]) :param configuration: see :meth:`sipconfig.Makefile.__init__`. @@ -698,7 +698,7 @@ work of creating these additional configuration modules. optionally installed. :param console: see :meth:`sipconfig.Makefile.__init__`. - :param qt: + :param tqt: see :meth:`sipconfig.Makefile.__init__`. :param opengl: see :meth:`sipconfig.Makefile.__init__`. @@ -810,7 +810,7 @@ work of creating these additional configuration modules. see :meth:`sipconfig.ModuleMakefile.__init__`. :param console: see :meth:`sipconfig.Makefile.__init__`. - :param qt: + :param tqt: see :meth:`sipconfig.Makefile.__init__`. :param opengl: see :meth:`sipconfig.Makefile.__init__`. diff --git a/sphinx/c_api.rst b/sphinx/c_api.rst index 66e0af2..c1cb25a 100644 --- a/sphinx/c_api.rst +++ b/sphinx/c_api.rst @@ -1696,7 +1696,7 @@ name prefixed by ``sip``. For example, the derived class for class ``Klass`` is ``sipKlass``. If a C++ class doesn't have any virtual or protected methods in it or any of -it's super-class hierarchy, or does not emit any Qt Q_SIGNALS, then a derived +it's super-class hierarchy, or does not emit any TQt Q_SIGNALS, then a derived class is not generated. Most of the time handwritten code should ignore the derived classes. The only diff --git a/sphinx/command_line.rst b/sphinx/command_line.rst index 9c50cf4..8a1db23 100644 --- a/sphinx/command_line.rst +++ b/sphinx/command_line.rst @@ -24,8 +24,8 @@ The full set of command line options is: .. cmdoption:: -a <FILE> - The name of the QScintilla API file to generate. This file contains a - description of the module API in a form that the QScintilla editor + The name of the TQScintilla API file to generate. This file contains a + description of the module API in a form that the TQScintilla editor component can use for auto-completion and call tips. (The file may also be used by the SciTE editor but must be sorted first.) By default the file is not generated. diff --git a/sphinx/incompatibilities.rst b/sphinx/incompatibilities.rst index a006e4f..df5c2c4 100644 --- a/sphinx/incompatibilities.rst +++ b/sphinx/incompatibilities.rst @@ -70,10 +70,10 @@ In addition the :option:`-a` command line option to :file:`configure.py` has been removed. -Removal of PyQt-specific Features +Removal of PyTQt-specific Features ********************************* -The following PyQt-specific support functions have been removed. +The following PyTQt-specific support functions have been removed. - :cfunc:`sipConnectRx()` diff --git a/sphinx/introduction.rst b/sphinx/introduction.rst index 8488b6f..bdb4681 100644 --- a/sphinx/introduction.rst +++ b/sphinx/introduction.rst @@ -4,8 +4,8 @@ Introduction This is the reference guide for SIP 4.10.5. SIP is a tool for automatically generating `Python <http://www.python.org>`__ bindings for C and C++ libraries. SIP was originally developed in 1998 for -`PyQt <http://www.riverbankcomputing.com/software/pyqt>`__ - the Python -bindings for the Qt GUI toolkit - but is suitable for generating bindings for +`PyTQt <http://www.riverbankcomputing.com/software/pytqt>`__ - the Python +bindings for the TQt GUI toolkit - but is suitable for generating bindings for any C or C++ library. This version of SIP generates bindings for Python v2.3 or later, including @@ -156,14 +156,14 @@ SIP comprises a number of different components. :ref:`ref-distutils`. -Qt Support ----------- +TQt Support +----------- SIP has specific support for the creation of bindings based on Nokia's Qt toolkit. The SIP code generator understands the signal/slot type safe callback mechanism -that Qt uses to connect objects together. This allows applications to define +that TQt uses to connect objects together. This allows applications to define new Python Q_SIGNALS, and allows any Python callable object to be used as a slot. -SIP itself does not require Qt to be installed. +SIP itself does not require TQt to be installed. diff --git a/sphinx/specification_files.rst b/sphinx/specification_files.rst index ff352f4..baa18f5 100644 --- a/sphinx/specification_files.rst +++ b/sphinx/specification_files.rst @@ -268,7 +268,7 @@ file. *argument* ::= [ *type* [*name*] [*argument-annotations*] [*default-value*] | :stype:`SIP_ANYSLOT` [*default-value*] | - :stype:`SIP_QOBJECT` | + :stype:`SIP_TQOBJECT` | :stype:`SIP_RXOBJ_CON` | :stype:`SIP_RXOBJ_DIS` | :stype:`SIP_SIGNAL` [*default-value*] | @@ -422,24 +422,24 @@ This is a ``PyObject *`` that is a Python tuple object. This is a ``PyObject *`` that is a Python type object. -.. sip-type:: SIP_QOBJECT +.. sip-type:: SIP_TQOBJECT -This is a ``QObject *`` that is a C++ instance of a class derived from Qt's -``QObject`` class. +This is a ``TQObject *`` that is a C++ instance of a class derived from TQt's +``TQObject`` class. .. sip-type:: SIP_RXOBJ_CON -This is a ``QObject *`` that is a C++ instance of a class derived from Qt's -``QObject`` class. It is used as the type of the receiver instead of ``const -QObject *`` in functions that implement a connection to a slot. +This is a ``TQObject *`` that is a C++ instance of a class derived from TQt's +``TQObject`` class. It is used as the type of the receiver instead of ``const +TQObject *`` in functions that implement a connection to a slot. .. sip-type:: SIP_RXOBJ_DIS -This is a ``QObject *`` that is a C++ instance of a class derived from Qt's -``QObject`` class. It is used as the type of the receiver instead of ``const -QObject *`` in functions that implement a disconnection from a slot. +This is a ``TQObject *`` that is a C++ instance of a class derived from TQt's +``TQObject`` class. It is used as the type of the receiver instead of ``const +TQObject *`` in functions that implement a disconnection from a slot. .. sip-type:: SIP_SIGNAL @@ -468,7 +468,7 @@ signal to a slot. The signal is emitted when the keyboard accelerator is activated and it has a single integer argument that is the ID of the accelerator. The C++ signature is:: - bool connectItem(int id, const QObject *receiver, const char *member); + bool connectItem(int id, const TQObject *receiver, const char *member); The corresponding SIP specification is:: diff --git a/sphinx/using.rst b/sphinx/using.rst index ff121ce..f703e8c 100644 --- a/sphinx/using.rst +++ b/sphinx/using.rst @@ -193,7 +193,7 @@ A More Complex C++ Example -------------------------- In this last example we will wrap a fictional C++ library that contains a class -that is derived from a Qt class. This will demonstrate how SIP allows a class +that is derived from a TQt class. This will demonstrate how SIP allows a class hierarchy to be split across multiple Python extension modules, and will introduce SIP's versioning system. @@ -263,11 +263,11 @@ previous examples. - The :directive:`%Import` directive has been added to specify that we are extending the class hierarchy defined in the file ``QtGui/QtGuimod.sip``. - This file is part of PyQt. The build system will take care of finding + This file is part of PyTQt. The build system will take care of finding the file's exact location. - The :directive:`%If` directive has been added to specify that everything - [#]_ up to the matching :directive:`%End` directive only applies to Qt + [#]_ up to the matching :directive:`%End` directive only applies to TQt v4.2 and later. ``Qt_4_2_0`` is a *tag* defined in ``QtCoremod.sip`` [#]_ using the :directive:`%Timeline` directive. :directive:`%Timeline` is used to define a tag for each version of a library's API you are @@ -282,7 +282,7 @@ previous examples. - The :aanno:`TransferThis` annotation has been added to the constructor's argument. It specifies that if the argument is not 0 (i.e. the ``Hello`` instance being constructed has a parent) then ownership of the instance - is transferred from Python to C++. It is needed because Qt maintains + is transferred from Python to C++. It is needed because TQt maintains objects (i.e. instances derived from the ``QObject`` class) in a hierachy. When an object is destroyed all of its children are also automatically destroyed. It is important, therefore, that the Python @@ -297,7 +297,7 @@ previous examples. - The :directive:`%If` directive has been added to specify that everything up to the matching :directive:`%End` directive does not apply to Windows. - ``WS_WIN`` is another tag defined by PyQt, this time using the + ``WS_WIN`` is another tag defined by PyTQt, this time using the :directive:`%Platforms` directive. Tags defined by the :directive:`%Platforms` directive are mutually exclusive, i.e. only one may be valid at a time [#]_. @@ -309,9 +309,9 @@ prevent the automatic generation of a public copy constructor. We now look at the ``configure.py`` script. This is a little different to the script in the previous examples for two related reasons. -Firstly, PyQt includes a pure Python module called ``pyqtconfig`` that extends -the SIP build system for modules, like our example, that build on top of PyQt. -It deals with the details of which version of Qt is being used (i.e. it +Firstly, PyTQt includes a pure Python module called ``pytqtconfig`` that extends +the SIP build system for modules, like our example, that build on top of PyTQt. +It deals with the details of which version of TQt is being used (i.e. it determines what the correct tags are) and where it is installed. This is called a module's configuration module. |