From: Martin v. Löwis <martin@v.loewis.de>
Date: Tue, 5 Nov 2002 22:11:50 +0000 (+0000)
Subject: Document that images go away when they go away. Fixes #632323.
X-Git-Tag: v2.3c1~3561
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=a288a234ec5c11a0c077c818cc945001f51bbc48;p=thirdparty%2FPython%2Fcpython.git

Document that images go away when they go away. Fixes #632323.
---

diff --git a/Doc/lib/tkinter.tex b/Doc/lib/tkinter.tex
index 8bb59d5d7c28..e577b28a6c18 100644
--- a/Doc/lib/tkinter.tex
+++ b/Doc/lib/tkinter.tex
@@ -881,6 +881,24 @@ that matches for menu items labelled \code{last}, \code{active}, or
 \end{itemize}
 \end{description}
 
+\subsubsection{Images}
+
+Bitmap/Pixelmap images can be created through the subclasses of
+\class{Tkinter.Image}:
+
+\begin{itemize}
+\item  \class{BitmapImage} can be used for X11 bitmap data.
+\item  \class{PhotoImage} can be used for GIF and PPM/PGM color bitmaps.
+\end{itemize}
+
+Either type of image is created through either the \code{file} or the
+\code{data} option (other options are available as well).
+
+The image object can then be used whereever an \code{image} option is
+supported by some widget (e.g. labels, buttons, menus). In these
+cases, Tk will not keep a reference to the image. When the last Python
+reference to the image object is deleted, the image data is deleted as
+well, and Tk will display an empty box wheerever the image was used.
 
 \section{\module{Tix} ---
          Extension widgets for Tk}