From: Tony Cook <tony@develop-help.com>
Date: Mon, 7 Apr 2008 13:37:15 +0000 (+0000)
Subject: document the widget parameter
X-Git-Tag: v0.008~9
X-Git-Url: http://git.imager.perl.org/imager-screenshot.git/commitdiff_plain/9d2a775ad4ebf55173691ba2cdb25626bef55762

document the widget parameter
---

diff --git a/Changes b/Changes
index f8fcf13..28e9d91 100755
--- a/Changes
+++ b/Changes
@@ -13,6 +13,9 @@
 - added --incpath and --libpath options to Makefile.PL and also look
   in $ENV{IM_INCPATH} and $ENV{IM_LIBPATH} like Imager.
 
+- document the widget parameter
+  https://rt.cpan.org/Ticket/Display.html?id=32855
+
 0.005 12 Mar 2007
 	- 0.005 release
 	- added a TODO section to the POD
diff --git a/Screenshot.pm b/Screenshot.pm
index 826f430..215eb70 100644
--- a/Screenshot.pm
+++ b/Screenshot.pm
@@ -182,9 +182,22 @@ the display specified by $ENV{DISPLAY}.
 
 Note: taking a screenshot of a remote display is slow.
 
+=item screenshot widget => I<widget>
+
+=item screenshot widget => I<widget>, display => I<display>
+
+=item screenshot widget => I<widget>, decor => I<capture decorations>
+
+Retrieve a screenshot of a Tk widget, under Win32 or X11, depending on
+how Tk has been built.
+
+If Tk was built for X11 then the display parameter applies.
+
+If Tk was built for Win32 then the decor parameter applies.
+
 =item screenshot
 
-If no C<id> or C<hwnd> parameter is supplied:
+If no C<id>, C<hwnd> or C<widget> parameter is supplied:
 
 =over