Source

pygame / docs / ref / scrap.html

Full commit

<html>
<title>scrap - Pygame Documentation</title>
<body bgcolor=#aaeebb text=#000000 link=#331111 vlink=#331111>


<table cellpadding=0 cellspacing=0 border=0 style='border: 3px solid black;' width='100%'>
<tr>
<td bgcolor='#c2fc20' style='padding: 6px;' align=center valign=center><a href='http://www.pygame.org/'><img src='../pygame_tiny.gif' border=0 width=200 height=60></a><br><b>pygame documentation</b></td>
<td bgcolor='#6aee28' style='border-left: 3px solid black; padding: 6px;' align=center valign=center>
	||&nbsp;
	<a href=http://www.pygame.org>Pygame Home</a> &nbsp;||&nbsp;
	<a href=../index.html>Help Contents</a> &nbsp;||
	<a href=index.html>Reference Index</a> &nbsp;||
	<br>&nbsp;<br>
	
<a href=cdrom.html>Cdrom</a>&nbsp;||&nbsp;
<a href=cursors.html>Cursors</a>&nbsp;||&nbsp;
<a href=display.html>Display</a>&nbsp;||&nbsp;
<a href=draw.html>Draw</a>&nbsp;||&nbsp;
<a href=event.html>Event</a>&nbsp;||&nbsp;
<a href=font.html>Font</a>&nbsp;||&nbsp;
<a href=image.html>Image</a>&nbsp;||&nbsp;
<a href=joystick.html>Joystick</a>&nbsp;||&nbsp;
<a href=key.html>Key</a>&nbsp;||&nbsp;
<a href=mixer.html>Mixer</a>&nbsp;||&nbsp;
<a href=mouse.html>Mouse</a>&nbsp;||&nbsp;
<a href=movie.html>Movie</a>&nbsp;||&nbsp;
<a href=music.html>Music</a>&nbsp;||&nbsp;
<a href=overlay.html>Overlay</a>&nbsp;||&nbsp;
<a href=pygame.html>Pygame</a>&nbsp;||&nbsp;
<a href=rect.html>Rect</a>&nbsp;||&nbsp;
<a href=scrap.html>Scrap</a>&nbsp;||&nbsp;
<a href=sndarray.html>Sndarray</a>&nbsp;||&nbsp;
<a href=sprite.html>Sprite</a>&nbsp;||&nbsp;
<a href=surface.html>Surface</a>&nbsp;||&nbsp;
<a href=surfarray.html>Surfarray</a>&nbsp;||&nbsp;
<a href=time.html>Time</a>&nbsp;||&nbsp;
<a href=transform.html>Transform</a>
</td></tr></table>
<br>


<a name="pygame.scrap">
<big><b>pygame.scrap</big></b><br><ul>
<ul><small><table>
  <tr><td><a href="scrap.html#pygame.scrap.init">pygame.scrap.init</a> - <font size=-1>raises an error if it can not initialise.</font></td><td>raises an error if it can not initialise.</td></tr>
  <tr><td><a href="scrap.html#pygame.scrap.get">pygame.scrap.get</a> - <font size=-1>Gets stuff from the clipboard.</font></td><td>Gets stuff from the clipboard.</td></tr>
  <tr><td><a href="scrap.html#pygame.scrap.put">pygame.scrap.put</a> - <font size=-1>Puts stuff into the clipboard.</font></td><td>Puts stuff into the clipboard.</td></tr>
  <tr><td><a href="scrap.html#pygame.scrap.lost">pygame.scrap.lost</a> - <font size=-1>Has the clipboard contents been lost.</font></td><td>Has the clipboard contents been lost.</td></tr>
</table></small></ul>
<p>The scrap module is for getting and putting stuff from the clipboard. So you can copy and paste things between pygame, and other application types. </p>
<p>New in pygame <tt>1.8</tt>. Only works for windows, <tt>X11</tt>, <tt>QNX</tt>, Mac <tt>OS</tt> <tt>X</tt> so far. <tt>EXPERIMENTAL:</tt> note, this module is experimental, and will be changing in </p>
<pre> the next release of pygame.
</pre>
<!--COMMENTS:pygame.scrap--> &nbsp;<br> 


<a name="pygame.scrap.init">
<big><b>pygame.scrap.init</big></b><br><ul>
  <i>raises an error if it can not initialise.</i><br>
 &nbsp;<br> 
<!--COMMENTS:pygame.scrap.init--> &nbsp;<br> 
<br></ul>


<a name="pygame.scrap.get">
<big><b>pygame.scrap.get</big></b><br><ul>
  <i>Gets stuff from the clipboard.</i><br>
  <tt>pygame.scrap.get(pygame.locals.SCRAP_TEXT): return text.</tt><br>
  <tt>pygame.scrap.get(pygame.locals.SCRAP_BMP): return image data.</tt><br>
<p>Return the data from the clipboard. <tt>SCRAP_BMP</tt> is only supported by pygame window instances. </p>
<!--COMMENTS:pygame.scrap.get--> &nbsp;<br> 
<br></ul>


<a name="pygame.scrap.put">
<big><b>pygame.scrap.put</big></b><br><ul>
  <i>Puts stuff into the clipboard.</i><br>
  <tt>pygame.scrap.put(pygame.locals.SCRAP_TEXT, 'hello clipboard'): return None.</tt><br>
  <tt>pygame.scrap.put(pygame.locals.SCRAP_BMP, Surface): return None.</tt><br>
<p>Puts the stuff into the clipboard. The content must be a string, but has no limitations in its size. Thus it is possible to put <tt>e.g</tt>. serialized pygame objects into the clipboard and deserialize them when they are retrieved again. </p>
<p>Raises an error, if the content could not be placed into the clipboard. </p>
<!--COMMENTS:pygame.scrap.put--> &nbsp;<br> 
<br></ul>


<a name="pygame.scrap.lost">
<big><b>pygame.scrap.lost</big></b><br><ul>
  <i>Has the clipboard contents been lost.</i><br>
  <tt>pygame.scrap.lost() returns True or False.</tt><br>
<p>Returns True if the contents of the clipboard has been lost. If it has not been lost it returns False. </p>
<!--COMMENTS:pygame.scrap.lost--> &nbsp;<br> 
<br></ul>
<br></ul>

</body></html>