diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/README.md | 2 | ||||
| -rw-r--r-- | docs/extensions.md | 12 | ||||
| -rw-r--r-- | docs/plugin.md | 12 |
3 files changed, 13 insertions, 13 deletions
diff --git a/docs/README.md b/docs/README.md index 22fbe0e..b846fb0 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,6 @@ # Documentation for Python Extensions -This is the documentation for the QtCreator Python Extensions plugin. +This is the documentation for the Qt Creator Python Extensions plugin. ## Contents 1. [Writing Python Extensions](./extensions.md) diff --git a/docs/extensions.md b/docs/extensions.md index 4b3689a..378d347 100644 --- a/docs/extensions.md +++ b/docs/extensions.md @@ -1,9 +1,9 @@ # Documentation for Python Extension Authors This document is intended to provide an introduction to writing Python extensions -for the QtCreator. +for Qt Creator. -## Importing QtCreator specific modules +## Importing Qt Creator specific modules Currently, the bindings are available from Python under the following names: ```Python from PythonExtension import QtCreator # Imports the generated module for the typesystem @@ -36,12 +36,12 @@ inst.pythonPackagePath() ``` -# QtCreator bindings -Generally, the parts of QtCreator that are exposed have an interface that is nearly +# Qt Creator bindings +Generally, the parts of Qt Creator that are exposed have an interface that is nearly identical to the C++ interface. ## Working with Menus -You can add new items to the menus of QtCreator. You can either add an action directly, or +You can add new items to the menus of Qt Creator. You can either add an action directly, or add a new action container, that holds a sub-menu. ### Adding a sub menu @@ -78,7 +78,7 @@ menu.menu().addAction("My action", hello) ``` ### Menu Id list -Currently, the following menu ids are available in QtCreator. +Currently, the following menu ids are available in Qt Creator. ```Python "QtCreator.Menu.File" diff --git a/docs/plugin.md b/docs/plugin.md index e94633b..9e2bd93 100644 --- a/docs/plugin.md +++ b/docs/plugin.md @@ -17,7 +17,7 @@ The following files exist as part of the C++ plugin: * `pythonextensionsplugin.[h|cpp]` - Contains the IPlugin class and manages the life-cycle of Python extensions - - This name is the standard for QtCreator plugins + - This name is the standard for Qt Creator plugins * `pythonextensions_global.h` - standard plugin file * `typesystem_qtcreator.xml` @@ -38,7 +38,7 @@ tested on Linux. * `pythonextensions.pro` - QMake project file - - The projects dependencies on the QtCreator side are handled in + - The projects dependencies on the Qt Creator side are handled in the file `pythonextensions_dependencies.pri` - The current build system emerged in part from the standard plugin build setup, combined with some .pro code from the 'scriptableapplication' and @@ -58,7 +58,7 @@ The buildsystem aims to achieve two things 1. Build the C++ plugin, linking against any relevant libraries 2. Install the generated shared object, as well as copy the - `/python` directory into the QtCreator plugin directory. This + `/python` directory into the Qt Creator plugin directory. This directory contains the included extension manager, which is implemented as a Python extension @@ -76,7 +76,7 @@ During initialization, the plugin does several things: 2. Run the `setup.py` script for every extension that provides it (this happens during the `delayedInitialize` call) - - This is run here to not block the QtCreator ui while loading the extensions + - This is run here to not block the Qt Creator ui while loading the extensions - It is separated from the main extension runtime, to provide a facility to extensions that depend on Python modules that are not part of the standard Python library (for an example, see `examples/numpysetup` or the extension @@ -87,7 +87,7 @@ During initialization, the plugin does several things: - Note that the extension manager attempts to run an extensions `main.py` script after installing it, but does not consider the `setup.py` script. If `main.py` than fails to run, the extension manager advises the user to - restart QtCreator + restart Qt Creator - There is currently no facility for scripts to detect if they have loaded before their setup was called - Because the setup is run every time, the setup script needs to detect if @@ -136,7 +136,7 @@ have to be amended with several special cases for different platforms / versions In the `PyUtil.cpp` file, the macros `signals` and `slots` are undefined due to compatibility reasons with the CPython headers. Due to this incompatibility, any -QtCreator code and Shiboken code needs to be well separated. (These symbols need +Qt Creator code and Shiboken code needs to be well separated. (These symbols need to be undefined **BEFORE** including anything Python related.) The glue code for the MacroExpander functions `registerVariable()` and `registerPrefix()` |