Kaydet (Commit) c21cd7e7 authored tarafından Georg Brandl's avatar Georg Brandl

Doc changes for the big Tkinter rename.

üst cd174da8
...@@ -10,11 +10,11 @@ IDLE ...@@ -10,11 +10,11 @@ IDLE
single: Python Editor single: Python Editor
single: Integrated Development Environment single: Integrated Development Environment
IDLE is the Python IDE built with the :mod:`Tkinter` GUI toolkit. IDLE is the Python IDE built with the :mod:`tkinter` GUI toolkit.
IDLE has the following features: IDLE has the following features:
* coded in 100% pure Python, using the :mod:`Tkinter` GUI toolkit * coded in 100% pure Python, using the :mod:`tkinter` GUI toolkit
* cross-platform: works on Windows and Unix (on Mac OS, there are currently * cross-platform: works on Windows and Unix (on Mac OS, there are currently
problems with Tcl/Tk) problems with Tcl/Tk)
......
...@@ -3,13 +3,13 @@ ...@@ -3,13 +3,13 @@
Other Graphical User Interface Packages Other Graphical User Interface Packages
======================================= =======================================
There are an number of extension widget sets to :mod:`Tkinter`. There are an number of extension widget sets to :mod:`tkinter`.
.. seealso:: .. seealso::
`Python megawidgets <http://pmw.sourceforge.net/>`_ `Python megawidgets <http://pmw.sourceforge.net/>`_
is a toolkit for building high-level compound widgets in Python using the is a toolkit for building high-level compound widgets in Python using the
:mod:`Tkinter` module. It consists of a set of base classes and a library of :mod:`tkinter` package. It consists of a set of base classes and a library of
flexible and extensible megawidgets built on this foundation. These megawidgets flexible and extensible megawidgets built on this foundation. These megawidgets
include notebooks, comboboxes, selection widgets, paned widgets, scrolled include notebooks, comboboxes, selection widgets, paned widgets, scrolled
widgets, dialog windows, etc. Also, with the Pmw.Blt interface to BLT, the widgets, dialog windows, etc. Also, with the Pmw.Blt interface to BLT, the
......
...@@ -12,19 +12,20 @@ Graphical User Interfaces with Tk ...@@ -12,19 +12,20 @@ Graphical User Interfaces with Tk
Tk/Tcl has long been an integral part of Python. It provides a robust and Tk/Tcl has long been an integral part of Python. It provides a robust and
platform independent windowing toolkit, that is available to Python programmers platform independent windowing toolkit, that is available to Python programmers
using the :mod:`Tkinter` module, and its extension, the :mod:`Tix` module. using the :mod:`tkinter` package, and its extension, the :mod:`tkinter.tix`
module.
The :mod:`Tkinter` module is a thin object-oriented layer on top of Tcl/Tk. To The :mod:`tkinter` package is a thin object-oriented layer on top of Tcl/Tk. To
use :mod:`Tkinter`, you don't need to write Tcl code, but you will need to use :mod:`tkinter`, you don't need to write Tcl code, but you will need to
consult the Tk documentation, and occasionally the Tcl documentation. consult the Tk documentation, and occasionally the Tcl documentation.
:mod:`Tkinter` is a set of wrappers that implement the Tk widgets as Python :mod:`tkinter` is a set of wrappers that implement the Tk widgets as Python
classes. In addition, the internal module :mod:`_tkinter` provides a threadsafe classes. In addition, the internal module :mod:`_tkinter` provides a threadsafe
mechanism which allows Python and Tcl to interact. mechanism which allows Python and Tcl to interact.
:mod:`Tkinter`'s chief virtues are that it is fast, and that it usually comes :mod:`tkinter`'s chief virtues are that it is fast, and that it usually comes
bundled with Python. Although its standard documentation is weak, good bundled with Python. Although its standard documentation is weak, good
material is available, which includes: references, tutorials, a book and material is available, which includes: references, tutorials, a book and
others. :mod:`Tkinter` is also famous for having an outdated look and feel, others. :mod:`tkinter` is also famous for having an outdated look and feel,
which has been vastly improved in Tk 8.5. Nevertheless, there are many other which has been vastly improved in Tk 8.5. Nevertheless, there are many other
GUI libraries that you could be interested in. For more information about GUI libraries that you could be interested in. For more information about
alternatives, see the :ref:`other-gui-packages` section. alternatives, see the :ref:`other-gui-packages` section.
...@@ -32,9 +33,9 @@ alternatives, see the :ref:`other-gui-packages` section. ...@@ -32,9 +33,9 @@ alternatives, see the :ref:`other-gui-packages` section.
.. toctree:: .. toctree::
tkinter.rst tkinter.rst
tix.rst tkinter.tix.rst
scrolledtext.rst tkinter.scrolledtext.rst
turtle.rst tkinter.turtle.rst
idle.rst idle.rst
othergui.rst othergui.rst
......
This diff is collapsed.
:mod:`ScrolledText` --- Scrolled Text Widget :mod:`tkinter.scrolledtext` --- Scrolled Text Widget
============================================ ====================================================
.. module:: ScrolledText .. module:: ScrolledText
:synopsis: Old name for the tkinter.scrolledtext module.
.. module:: tkinter.scrolledtext
:platform: Tk :platform: Tk
:synopsis: Text widget with a vertical scroll bar. :synopsis: Text widget with a vertical scroll bar.
.. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org> .. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org>
.. note::
The :mod:`ScrolledText` module has been renamed to
:mod:`tkinter.scrolledtext` in Python 3.0. It is importable under both names
in Python 2.6 and the rest of the 2.x series.
The :mod:`ScrolledText` module provides a class of the same name which The :mod:`tkinter.scrolledtext` module provides a class of the same name which
implements a basic text widget which has a vertical scroll bar configured to do implements a basic text widget which has a vertical scroll bar configured to do
the "right thing." Using the :class:`ScrolledText` class is a lot easier than the "right thing." Using the :class:`ScrolledText` class is a lot easier than
setting up a text widget and scroll bar directly. The constructor is the same setting up a text widget and scroll bar directly. The constructor is the same
as that of the :class:`Tkinter.Text` class. as that of the :class:`tkinter.Text` class.
.. versionchanged:: 2.6
Renamed from ``ScrolledText``.
The text widget and scrollbar are packed together in a :class:`Frame`, and the The text widget and scrollbar are packed together in a :class:`Frame`, and the
methods of the :class:`Grid` and :class:`Pack` geometry managers are acquired methods of the :class:`Grid` and :class:`Pack` geometry managers are acquired
......
:mod:`Tix` --- Extension widgets for Tk :mod:`tkinter.tix` --- Extension widgets for Tk
======================================= ===============================================
.. module:: Tix .. module:: Tix
:synopsis: Old name for the tkinter.tix module.
.. module:: tkinter.tix
:synopsis: Tk Extension Widgets for Tkinter :synopsis: Tk Extension Widgets for Tkinter
.. sectionauthor:: Mike Clarkson <mikeclarkson@users.sourceforge.net> .. sectionauthor:: Mike Clarkson <mikeclarkson@users.sourceforge.net>
.. note::
The :mod:`Tix` module has been renamed to :mod:`tkinter.tix` in Python 3.0.
It is importable under both names in Python 2.6 and the rest of the 2.x
series.
.. index:: single: Tix .. index:: single: Tix
The :mod:`Tix` (Tk Interface Extension) module provides an additional rich set The :mod:`tkinter.tix` (Tk Interface Extension) module provides an additional
of widgets. Although the standard Tk library has many useful widgets, they are rich set of widgets. Although the standard Tk library has many useful widgets,
far from complete. The :mod:`Tix` library provides most of the commonly needed they are far from complete. The :mod:`tkinter.tix` library provides most of the
widgets that are missing from standard Tk: :class:`HList`, :class:`ComboBox`, commonly needed widgets that are missing from standard Tk: :class:`HList`,
:class:`Control` (a.k.a. SpinBox) and an assortment of scrollable widgets. :class:`ComboBox`, :class:`Control` (a.k.a. SpinBox) and an assortment of
:mod:`Tix` also includes many more widgets that are generally useful in a wide scrollable widgets.
range of applications: :class:`NoteBook`, :class:`FileEntry`, :mod:`tkinter.tix` also includes many more widgets that are generally useful in
a wide range of applications: :class:`NoteBook`, :class:`FileEntry`,
:class:`PanedWindow`, etc; there are more than 40 of them. :class:`PanedWindow`, etc; there are more than 40 of them.
With all these new widgets, you can introduce new interaction techniques into With all these new widgets, you can introduce new interaction techniques into
...@@ -22,7 +30,6 @@ applications, creating more useful and more intuitive user interfaces. You can ...@@ -22,7 +30,6 @@ applications, creating more useful and more intuitive user interfaces. You can
design your application by choosing the most appropriate widgets to match the design your application by choosing the most appropriate widgets to match the
special needs of your application and users. special needs of your application and users.
.. seealso:: .. seealso::
`Tix Homepage <http://tix.sourceforge.net/>`_ `Tix Homepage <http://tix.sourceforge.net/>`_
...@@ -50,27 +57,27 @@ Using Tix ...@@ -50,27 +57,27 @@ Using Tix
Toplevel widget of Tix which represents mostly the main window of an Toplevel widget of Tix which represents mostly the main window of an
application. It has an associated Tcl interpreter. application. It has an associated Tcl interpreter.
Classes in the :mod:`Tix` module subclasses the classes in the :mod:`Tkinter` Classes in the :mod:`tkinter.tix` module subclasses the classes in the
module. The former imports the latter, so to use :mod:`Tix` with Tkinter, all :mod:`tkinter`. The former imports the latter, so to use :mod:`tkinter.tix`
you need to do is to import one module. In general, you can just import with Tkinter, all you need to do is to import one module. In general, you
:mod:`Tix`, and replace the toplevel call to :class:`Tkinter.Tk` with can just import :mod:`tkinter.tix`, and replace the toplevel call to
:class:`Tix.Tk`:: :class:`tkinter.Tk` with :class:`tix.Tk`::
import Tix from tkinter import tix
from Tkconstants import * from tkinter.constants import *
root = Tix.Tk() root = tix.Tk()
To use :mod:`Tix`, you must have the :mod:`Tix` widgets installed, usually To use :mod:`tkinter.tix`, you must have the Tix widgets installed, usually
alongside your installation of the Tk widgets. To test your installation, try alongside your installation of the Tk widgets. To test your installation, try
the following:: the following::
import Tix from tkinter import tix
root = Tix.Tk() root = tix.Tk()
root.tk.eval('package require Tix') root.tk.eval('package require Tix')
If this fails, you have a Tk installation problem which must be resolved before If this fails, you have a Tk installation problem which must be resolved before
proceeding. Use the environment variable :envvar:`TIX_LIBRARY` to point to the proceeding. Use the environment variable :envvar:`TIX_LIBRARY` to point to the
installed :mod:`Tix` library directory, and make sure you have the dynamic installed Tix library directory, and make sure you have the dynamic
object library (:file:`tix8183.dll` or :file:`libtix8183.so`) in the same object library (:file:`tix8183.dll` or :file:`libtix8183.so`) in the same
directory that contains your Tk dynamic object library (:file:`tk8183.dll` or directory that contains your Tk dynamic object library (:file:`tk8183.dll` or
:file:`libtk8183.so`). The directory with the dynamic object library should also :file:`libtk8183.so`). The directory with the dynamic object library should also
...@@ -85,8 +92,8 @@ Tix Widgets ...@@ -85,8 +92,8 @@ Tix Widgets
`Tix <http://tix.sourceforge.net/dist/current/man/html/TixCmd/TixIntro.htm>`_ `Tix <http://tix.sourceforge.net/dist/current/man/html/TixCmd/TixIntro.htm>`_
introduces over 40 widget classes to the :mod:`Tkinter` repertoire. There is a introduces over 40 widget classes to the :mod:`Tkinter` repertoire. There is a
demo of all the :mod:`Tix` widgets in the :file:`Demo/tix` directory of the demo of all the :mod:`tkinter.tix` widgets in the :file:`Demo/tix` directory of
standard distribution. the standard distribution.
.. The Python sample code is still being added to Python, hence commented out .. The Python sample code is still being added to Python, hence commented out
...@@ -434,11 +441,11 @@ Manager Widgets ...@@ -434,11 +441,11 @@ Manager Widgets
Image Types Image Types
^^^^^^^^^^^ ^^^^^^^^^^^
The :mod:`Tix` module adds: The :mod:`tkinter.tix` module adds:
* `pixmap <http://tix.sourceforge.net/dist/current/man/html/TixCmd/pixmap.htm>`_ * `pixmap <http://tix.sourceforge.net/dist/current/man/html/TixCmd/pixmap.htm>`_
capabilities to all :mod:`Tix` and :mod:`Tkinter` widgets to create color images capabilities to all :mod:`tkinter.tix` and :mod:`tkinter` widgets to create
from XPM files. color images from XPM files.
.. Python Demo of: .. Python Demo of:
.. \ulink{XPM Image In Button}{http://tix.sourceforge.net/dist/current/demos/samples/Xpm.tcl} .. \ulink{XPM Image In Button}{http://tix.sourceforge.net/dist/current/demos/samples/Xpm.tcl}
...@@ -478,7 +485,7 @@ Miscellaneous Widgets ...@@ -478,7 +485,7 @@ Miscellaneous Widgets
Form Geometry Manager Form Geometry Manager
^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^
In addition, :mod:`Tix` augments :mod:`Tkinter` by providing: In addition, :mod:`tkinter.tix` augments :mod:`tkinter` by providing:
.. class:: Form() .. class:: Form()
......
:mod:`tkinter.turtle` --- Turtle graphics for Tk
:mod:`turtle` --- Turtle graphics for Tk ================================================
========================================
.. module:: turtle .. module:: turtle
:synopsis: Old name for the tkinter.turtle module.
.. module:: tkinter.turtle
:platform: Tk :platform: Tk
:synopsis: An environment for turtle graphics. :synopsis: An environment for turtle graphics.
.. moduleauthor:: Guido van Rossum <guido@python.org> .. moduleauthor:: Guido van Rossum <guido@python.org>
.. note::
The :mod:`turtle` module has been renamed to :mod:`tkinter.turtle` in Python
3.0. It is importable under both names in Python 2.6 and the rest of the 2.x
series.
.. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il> .. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il>
The :mod:`turtle` module provides turtle graphics primitives, in both an The :mod:`tkinter.turtle` module provides turtle graphics primitives, in both an
object-oriented and procedure-oriented ways. Because it uses :mod:`Tkinter` for object-oriented and procedure-oriented ways. Because it uses :mod:`tkinter` for
the underlying graphics, it needs a version of python installed with Tk support. the underlying graphics, it needs a version of python installed with Tk support.
.. versionchanged:: 2.6
Renamed from ``turtle``.
The procedural interface uses a pen and a canvas which are automagically created The procedural interface uses a pen and a canvas which are automagically created
when any of the functions are called. when any of the functions are called.
The :mod:`turtle` module defines the following functions: The :mod:`tkinter.turtle` module defines the following functions:
.. function:: degrees() .. function:: degrees()
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment