From: Fred Drake <fdrake@acm.org>
Date: Fri, 8 Mar 2002 03:15:49 +0000 (+0000)
Subject: I started writing more documentation on the Scrap module at one point, but
X-Git-Tag: v2.3c1~6560
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=f3e6f06a457f90fc9645a15bfdbd8b34f026ac05;p=python

I started writing more documentation on the Scrap module at one point, but
it is difficult to do without a Mac box to try things out on.  This expands
on what was there only a little bit; hopefully someone with a Mac can work
on this as well!
---

diff --git a/Doc/mac/libscrap.tex b/Doc/mac/libscrap.tex
new file mode 100644
index 0000000000..059c57ccfa
--- /dev/null
+++ b/Doc/mac/libscrap.tex
@@ -0,0 +1,42 @@
+\section{\module{Carbon.Scrap} --- Scrap Manager}
+\declaremodule{standard}{Carbon.Scrap}
+  \platform{Mac}
+\modulesynopsis{The Scrap Manager provides basic services for
+                implementing cut \&\ paste and clipboard operations.}
+
+
+This module is only fully available on MacOS9 and earlier under
+classic PPC MacPython.  Very limited functionality is available under
+Carbon MacPython.
+
+The Scrap\index{Scrap Manager} Manager supports the simplest form of
+cut \&\ paste operations on the Macintosh.  It can be use for both
+inter- and intra-application clipboard operations.
+
+The \module{Scrap} module provides low-level access to the functions
+of the Scrap Manager.  It contains the following functions:
+
+
+\begin{funcdesc}{InfoScrap}{}
+  Return current information about the scrap.  The information is
+  encoded as a tuple containing the fields \code{(\var{size},
+  \var{handle}, \var{count}, \var{state}, \var{path})}.
+
+  \begin{tableii}{l|l}{var}{Field}{Meaning}
+    \lineii{size}{Size of the scrap in bytes.}
+    \lineii{handle}{Resource object representing the scrap.}
+    \lineii{count}{Serial number of the scrap contents.}
+    \lineii{state}{Integer; positive if in memory, \code{0} if on
+                   disk, negative if uninitialized.}
+    \lineii{path}{Filename of the scrap when stored on disk.}
+  \end{tableii}
+\end{funcdesc}
+
+
+
+\begin{seealso}
+  \seetitle[http://developer.apple.com/techpubs/mac/MoreToolbox/MoreToolbox-109.html]
+           {Scrap Manager}{Apple's documentation for the Scrap Manager
+            gives a lot of useful information about using the Scrap
+            Manager in applications.}
+\end{seealso}
diff --git a/Doc/mac/toolbox.tex b/Doc/mac/toolbox.tex
index ea9a685101..ea98529886 100644
--- a/Doc/mac/toolbox.tex
+++ b/Doc/mac/toolbox.tex
@@ -133,21 +133,7 @@ classic PPC MacPython.
 \modulesynopsis{Interface to the Resource Manager and Handles.}
 
 
-\section{\module{Carbon.Scrap} --- Scrap Manager}
-\declaremodule{standard}{Carbon.Scrap}
-  \platform{Mac}
-\modulesynopsis{The Scrap Manager provides basic services for
-                implementing cut \&\ paste and clipboard operations.}
-
-This module is only fully available on MacOS9 and earlier under classic PPC
-MacPython. Very limited functionality is available under Carbon MacPython.
-
-\begin{seealso}
-  \seetitle[http://developer.apple.com/techpubs/mac/MoreToolbox/MoreToolbox-109.html]{Scrap
-            Manager}{Apple's documentation for the Scrap Manager gives
-            a lot of useful information about using the Scrap Manager
-            in applications.}
-\end{seealso}
+\input{libscrap}
 
 
 \section{\module{Carbon.Snd} --- Sound Manager}