summaryrefslogtreecommitdiff
path: root/doc/source/library
diff options
context:
space:
mode:
authorJulian Andres Klode <jak@debian.org>2015-06-10 15:34:56 +0200
committerJulian Andres Klode <jak@debian.org>2015-06-10 15:34:56 +0200
commitb263b8d1a6a84bd34290a1ae52d3c1ee33124d1b (patch)
treed293502e5eea862eb856c75e94523f3b58bb9b3d /doc/source/library
parent4f34ca7de1defc09b119565a35b71e4cca919346 (diff)
downloadpython-apt-b263b8d1a6a84bd34290a1ae52d3c1ee33124d1b.tar.gz
Remove apt.progress.gtk2
Diffstat (limited to 'doc/source/library')
-rw-r--r--doc/source/library/apt.progress.gtk2.rst131
-rw-r--r--doc/source/library/apt_pkg.rst3
-rw-r--r--doc/source/library/index.rst3
3 files changed, 2 insertions, 135 deletions
diff --git a/doc/source/library/apt.progress.gtk2.rst b/doc/source/library/apt.progress.gtk2.rst
deleted file mode 100644
index 0d53ad41..00000000
--- a/doc/source/library/apt.progress.gtk2.rst
+++ /dev/null
@@ -1,131 +0,0 @@
-:mod:`apt.progress.gtk2` --- Progress reporting for GTK+ interfaces
-===================================================================
-.. module:: apt.progress.gtk2
-
-The :mod:`apt.progress.gtk2` module provides classes with GObject signals and
-a class with a GTK+ widget for progress handling.
-
-
-GObject progress classes
--------------------------
-.. class:: GInstallProgress
-
- An implementation of :class:`apt.progress.base.InstallProgress` supporting
- GObject signals. The class emits the following signals:
-
- .. describe:: status-changed(status: str, percent: int)
-
- Emitted when the status of an operation changed.
-
- .. describe:: status-started()
-
- Emitted when the installation started.
-
- .. describe:: status-finished()
-
- Emitted when the installation finished.
-
- .. describe:: status-timeout()
-
- Emitted when a timeout happens
-
- .. describe:: status-error()
-
- Emitted in case of an error.
-
- .. describe:: status-conffile()
-
- Emitted when a conffile update is happening.
-
-
-.. class:: GAcquireProgress
-
- An implementation of :class:`apt.progress.base.AcquireProgress` supporting
- GObject signals. The class emits the following signals:
-
- .. describe:: status-changed(description: str, percent: int)
-
- Emitted when the status of the fetcher changed, e.g. when the
- percentage increased.
-
- .. describe:: status-started()
-
- Emitted when the fetcher starts to fetch.
-
- .. describe:: status-finished()
-
- Emitted when the fetcher finished.
-
-
-.. class:: GDpkgInstallProgress
-
- An implementation of :class:`apt.progress.base.InstallProgress` supporting
- GObject signals. This is the same as :class:`GInstallProgress` and is thus
- completely deprecated.
-
-.. class:: GOpProgress
-
- An implementation of :class:`apt.progress.old.FetchProgress` supporting
- GObject signals. The class emits the following signals:
-
- .. describe:: status-changed(operation: str, percent: int)
-
- Emitted when the status of an operation changed.
-
- .. describe:: status-started()
-
- Emitted when it starts - Not implemented yet.
-
- .. describe:: status-finished()
-
- Emitted when all operations have finished.
-
-GTK+ Widget
------------
-.. class:: GtkAptProgress
-
- Graphical progress for installation/fetch/operations, providing
- a progress bar, a terminal and a status bar for showing the progress
- of package manipulation tasks.
-
- .. method:: cancel_download()
-
- Cancel a currently running download.
-
- .. method:: clear()
-
- Reset all status information.
-
- .. attribute:: dpkg_install
-
- Return the install progress handler for dpkg.
-
- .. attribute:: fetch
-
- Return the fetch progress handler.
-
- .. method:: hide_terminal()
-
- Hide the expander with the terminal widget.
-
- .. attribute:: install
-
- Return the install progress handler.
-
- .. attribute:: open
-
- Return the cache opening progress handler.
-
- .. method:: show()
-
- Show the Box
-
- .. method:: show_terminal(expanded=False)
-
- Show an expander with a terminal widget which provides a way to
- interact with dpkg.
-
-
-Example
--------
-.. literalinclude:: ../examples/apt-gtk.py
diff --git a/doc/source/library/apt_pkg.rst b/doc/source/library/apt_pkg.rst
index 15316eea..bdf096a4 100644
--- a/doc/source/library/apt_pkg.rst
+++ b/doc/source/library/apt_pkg.rst
@@ -1541,8 +1541,7 @@ installation.
The constructor takes an optional parameter *progress* which takes an
:class:`apt.progress.base.AcquireProgress` object. This object may then
report progress information (see :mod:`apt.progress.text` for reporting
- progress to a I/O stream and :mod:`apt.progress.gtk2` for GTK+ progress
- reporting).
+ progress to a I/O stream).
Acquire items have two methods to start and stop the fetching:
diff --git a/doc/source/library/index.rst b/doc/source/library/index.rst
index dbd58375..0b048c80 100644
--- a/doc/source/library/index.rst
+++ b/doc/source/library/index.rst
@@ -12,7 +12,7 @@ apt-pkg and apt-inst libraries and the base for the rest of python-apt.
Going forward, the :mod:`apt` package appears. This package is using
:mod:`apt_pkg` and :mod:`apt_inst` to provide easy to use ways to manipulate
the cache, fetch packages, or install new packages. It also provides useful
-progress classes, for text and GTK+ interfaces. The last package is
+progress classes, currently only for text interfaces. The last package is
:mod:`aptsources`. The aptsources package provides classes and functions to
read files like :file:`/etc/apt/sources.list` and to modify them.
@@ -28,7 +28,6 @@ read files like :file:`/etc/apt/sources.list` and to modify them.
apt.package
apt.progress.base
apt.progress.text
- apt.progress.gtk2
aptsources.distinfo
aptsources.distro