diff options
author | Christoph Reiter <reiter.christoph@gmail.com> | 2019-02-13 19:15:54 +0100 |
---|---|---|
committer | Christoph Reiter <reiter.christoph@gmail.com> | 2019-02-13 19:15:54 +0100 |
commit | 5423678ea6a06bec187c173dccc9763307478ffd (patch) | |
tree | de9505970a608600968d3d598e64b08e63ebe308 /docs | |
parent | 0b0fe8cef03db692edd2574900d5cbfa0d70da28 (diff) | |
download | pygobject-5423678ea6a06bec187c173dccc9763307478ffd.tar.gz |
GTK+ -> GTK
Diffstat (limited to 'docs')
-rw-r--r-- | docs/further.rst | 4 | ||||
-rw-r--r-- | docs/getting_started.rst | 10 | ||||
-rw-r--r-- | docs/guide/debug_profile.rst | 2 | ||||
-rw-r--r-- | docs/guide/porting.rst | 16 | ||||
-rw-r--r-- | docs/guide/testing.rst | 6 | ||||
-rw-r--r-- | docs/guide/threading.rst | 18 | ||||
-rw-r--r-- | docs/images/LICENSE | 2 | ||||
-rw-r--r-- | docs/index.rst | 4 | ||||
-rw-r--r-- | docs/packagingguide.rst | 2 |
9 files changed, 32 insertions, 32 deletions
diff --git a/docs/further.rst b/docs/further.rst index 832cf45e..69223f50 100644 --- a/docs/further.rst +++ b/docs/further.rst @@ -2,8 +2,8 @@ Further Resources ================= -`Python GTK+ 3 Tutorial <https://python-gtk-3-tutorial.readthedocs.io>`__ - Many examples showing how to build an application using PyGObject and GTK+. +`Python GTK 3 Tutorial <https://python-gtk-3-tutorial.readthedocs.io>`__ + Many examples showing how to build an application using PyGObject and GTK. `Python GI API Reference <https://lazka.github.io/pgi-docs>`__ Auto generated API documentation for many libraries accessible through diff --git a/docs/getting_started.rst b/docs/getting_started.rst index 63584a6a..5e153f46 100644 --- a/docs/getting_started.rst +++ b/docs/getting_started.rst @@ -6,7 +6,7 @@ Getting Started =============== -To get things started we will try to run a very simple `GTK+ +To get things started we will try to run a very simple `GTK <https://www.gtk.org/>`_ based GUI application using the :doc:`PyGObject <index>` provided Python bindings. First create a small Python script called ``hello.py`` with the following content and save it somewhere: @@ -22,7 +22,7 @@ the following content and save it somewhere: window.connect("destroy", Gtk.main_quit) Gtk.main() -Before we can run the example application we need to install PyGObject, GTK+ +Before we can run the example application we need to install PyGObject, GTK and their dependencies. Follow the instructions for your platform below. ======================================================= ==================================================== ========================================================== @@ -30,9 +30,9 @@ and their dependencies. Follow the instructions for your platform below. |windows-logo| :ref:`Windows <windows-getting-started>` |macosx-logo| :ref:`macOS <macosx-getting-started>` |opensuse-logo| :ref:`openSUSE <opensuse-getting-started>` ======================================================= ==================================================== ========================================================== -After running the example application have a look at the "`Python GTK+ 3 +After running the example application have a look at the "`Python GTK 3 Tutorial <https://python-gtk-3-tutorial.readthedocs.io>`__" for more examples -on how to create GTK+ apps and the "`PyGObject API Reference +on how to create GTK apps and the "`PyGObject API Reference <https://lazka.github.io/pgi-docs>`__" for API documentation for all supported libraries. @@ -46,7 +46,7 @@ libraries. #) Run ``C:\msys64\mingw32.exe`` - a terminal window should pop up #) Execute ``pacman -Suy`` #) Execute ``pacman -S mingw-w64-i686-gtk3 mingw-w64-i686-python3-gobject`` -#) To test that GTK+3 is working you can run ``gtk3-demo`` +#) To test that GTK 3 is working you can run ``gtk3-demo`` #) Copy the ``hello.py`` script you created to ``C:\msys64\home\<username>`` #) In the mingw32 terminal execute ``python3 hello.py`` - a window should appear. diff --git a/docs/guide/debug_profile.rst b/docs/guide/debug_profile.rst index 628bab17..6b43a80b 100644 --- a/docs/guide/debug_profile.rst +++ b/docs/guide/debug_profile.rst @@ -17,7 +17,7 @@ recommended. jhbuild shell GOBJECT_DEBUG=instance-count GTK_DEBUG=interactive ./quodlibet.py -* In the GTK+ Inspector switch to the "Statistics" tab +* In the GTK Inspector switch to the "Statistics" tab * Sort by "Cumulative" and do the action which you suspect does leak or where you want to make sure it doesn't repeatedly. Like for example opening and closing a window or switching between media files to present. diff --git a/docs/guide/porting.rst b/docs/guide/porting.rst index 462ed856..59107bfa 100644 --- a/docs/guide/porting.rst +++ b/docs/guide/porting.rst @@ -17,12 +17,12 @@ have to switch everything at once. Static Bindings Library Differences ----------------------------------- -**pygtk** supported GTK+ 2.0 and Python 2 only. PyGObject supports GTK+ >=3.0 -and Python 2/3. If you port away from pygtk you also have to move to GTK+ 3.0 +**pygtk** supported GTK 2.0 and Python 2 only. PyGObject supports GTK >=3.0 +and Python 2/3. If you port away from pygtk you also have to move to GTK 3.0 at the same time. **pygtkcompat** described below can help you with that transition. -**pygst** supports GStreamer 0.10 and Python 2 only. Like with GTK+ you have +**pygst** supports GStreamer 0.10 and Python 2 only. Like with GTK you have to move to PyGObject and GStreamer 1.0 at the same time. **pygobject 2** supports glib 2.0 and Python 2. The new bindings also support @@ -50,13 +50,13 @@ you have to make in the beginning, but nothing more. 4) Continue to the next module... -Porting Tips for GTK+ ---------------------- +Porting Tips for GTK +-------------------- -While PyGObject theoretically supports GTK+ 2.0 it is not really usable. It -will be easier to port to GTK+ 3.0 right away. +While PyGObject theoretically supports GTK 2.0 it is not really usable. It +will be easier to port to GTK 3.0 right away. -For some general advice regarding the migration from GTK+ 2.0 to 3.0 see the +For some general advice regarding the migration from GTK 2.0 to 3.0 see the `offical migration guide <https://developer.gnome.org/gtk3/stable/gtk-migrating-2-to-3.html>`__. If you need to know how a C symbol is exposed in Python have a look at the `symbol diff --git a/docs/guide/testing.rst b/docs/guide/testing.rst index 6a7c6632..b4493e86 100644 --- a/docs/guide/testing.rst +++ b/docs/guide/testing.rst @@ -4,7 +4,7 @@ Testing and Continuous Integration ================================== -To get automated tests of GTK+ code running on a headless server use Xvfb +To get automated tests of GTK code running on a headless server use Xvfb (virtual framebuffer X server). It provides the ``xvfb-run -a`` command which creates a temporary X server without the need for any real display hardware. @@ -16,7 +16,7 @@ creates a temporary X server without the need for any real display hardware. Continuous Integration using Travis CI / CircleCI ------------------------------------------------- -Travis CI uses a rather old Ubuntu and thus the supported GTK+ is at 3.10 and +Travis CI uses a rather old Ubuntu and thus the supported GTK is at 3.10 and PyGObject is at 3.12. If that's enough for you then have a look at our Travis CI example project: @@ -25,7 +25,7 @@ CI example project: .. image:: https://travis-ci.org/pygobject/pygobject-travis-ci-examples.svg?branch=master :target: https://travis-ci.org/pygobject/pygobject-travis-ci-examples -To get newer PyGObject, GTK+, etc. working on `Travis CI +To get newer PyGObject, GTK, etc. working on `Travis CI <https://travis-ci.org>`__ or `CircleCI <https://circleci.com>`__ you can use Docker with an image of your choosing. Have a look at our Docker example project which runs tests on various Debian, Ubuntu and Fedora versions: diff --git a/docs/guide/threading.rst b/docs/guide/threading.rst index c1bac32f..fea26d18 100644 --- a/docs/guide/threading.rst +++ b/docs/guide/threading.rst @@ -17,7 +17,7 @@ Such an operation might be: The following examples show -* how Python threads, running in parallel to GTK+, can interact with the UI +* how Python threads, running in parallel to GTK, can interact with the UI * how to use and control asynchronous I/O operations in glib @@ -66,7 +66,7 @@ while still showing feedback on the progress in a window. The example shows a simple window containing a progress bar. After everything is set up it constructs a Python thread, passes it a function to execute, -starts the thread and the GTK+ main loop. After the main loop is started it is +starts the thread and the GTK main loop. After the main loop is started it is possible to see the window and interact with it. In the background ``example_target()`` gets executed and calls @@ -74,14 +74,14 @@ In the background ``example_target()`` gets executed and calls :func:`time.sleep` represents the blocking operation. :func:`GLib.idle_add` takes the ``update_progess()`` function and arguments that will get passed to the function and asks the main loop to schedule its execution in the main -thread. This is needed because GTK+ isn't thread safe; only one thread, the -main thread, is allowed to call GTK+ code at all times. +thread. This is needed because GTK isn't thread safe; only one thread, the +main thread, is allowed to call GTK code at all times. Threads: FAQ ------------ -* I'm porting code from pygtk (GTK+ 2) to PyGObject (GTK+ 3). Has anything +* I'm porting code from pygtk (GTK 2) to PyGObject (GTK 3). Has anything changed regarding threads? Short answer: No. @@ -96,7 +96,7 @@ Threads: FAQ * Remove any :func:`Gdk.threads_init()`, :func:`Gdk.threads_enter` and :func:`Gdk.threads_leave` calls. In case they get executed in a thread, - move the GTK+ code into its own function and schedule it using + move the GTK code into its own function and schedule it using :func:`GLib.idle_add`. Be aware that the newly created function will be executed some time later, so other stuff can happen in between. @@ -110,12 +110,12 @@ Threads: FAQ In GStreamer, for example, some signals can be called from a different thread, see the respective signal documentation for when this is the case. In case you connect to such a signal you have to make sure to not call any - GTK+ code or use :func:`GLib.idle_add` accordingly. + GTK code or use :func:`GLib.idle_add` accordingly. -* What if I need to call GTK+ code in signal handlers emitted from a thread? +* What if I need to call GTK code in signal handlers emitted from a thread? In case you have a signal that is emitted from another thread and you need - to call GTK+ code during and not after signal handling, you can push the + to call GTK code during and not after signal handling, you can push the operation with an :class:`threading.Event` object to the main loop and wait in the signal handler until the operation gets scheduled and the result is available. Be aware that if the signal is emitted from the main loop this diff --git a/docs/images/LICENSE b/docs/images/LICENSE index 0fbbdbf7..7572a310 100644 --- a/docs/images/LICENSE +++ b/docs/images/LICENSE @@ -1,3 +1,3 @@ -pygobject.svg and pygobject-small.svg are based on the GTK+ logo, created by +pygobject.svg and pygobject-small.svg are based on the GTK logo, created by Andreas Nilsson, licensed under CC BY-SA 3.0. For more info see https://commons.wikimedia.org/wiki/File:GTK%2B_logo.svg diff --git a/docs/index.rst b/docs/index.rst index 7b383c1c..e0005903 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -29,9 +29,9 @@ :end-before: ---- If you want to write a Python application for `GNOME -<https://www.gnome.org/>`__ or a Python GUI application using GTK+, then +<https://www.gnome.org/>`__ or a Python GUI application using GTK, then PyGObject is the way to go. For more information on specific libraries check -out the "`Python GTK+ 3 Tutorial +out the "`Python GTK 3 Tutorial <https://python-gtk-3-tutorial.readthedocs.io>`__" and the "`Python GI API Reference <https://lazka.github.io/pgi-docs>`__". diff --git a/docs/packagingguide.rst b/docs/packagingguide.rst index 7d6fafa9..eae5d752 100644 --- a/docs/packagingguide.rst +++ b/docs/packagingguide.rst @@ -40,6 +40,6 @@ Build dependencies: Test Suite dependencies: * The runtime dependencies - * GTK+ 3 (optional) + * GTK 3 (optional) * pango (optional) * pycairo (optional) |