From 8623bfb428cb07b928b59d215c5c9fb70d785750 Mon Sep 17 00:00:00 2001
From: William Kendrick <wkendrick@users.sourceforge.net>
Date: Thu, 10 Jul 2008 06:58:32 +0000
Subject: [PATCH] Documenting 'int mode' arg to click() functions in Magic tool
 API docs.

---
 magic/docs/README.txt       | 9 ++++++---
 magic/docs/html/README.html | 5 ++++-
 2 files changed, 10 insertions(+), 4 deletions(-)

diff --git a/magic/docs/README.txt b/magic/docs/README.txt
index 3d58084fa..044817d83 100644
--- a/magic/docs/README.txt
+++ b/magic/docs/README.txt
@@ -313,11 +313,14 @@ Interfaces
              whenever the user picks a new color while such a tool is
              currently active.)
 
-           * void click(magic_api * api, int which, SDL_Surface * snapshot,
-             SDL_Surface * canvas, int x, int y, SDL_Rect * update_rect)
+           * void click(magic_api * api, int which, int mode,
+             SDL_Surface * snapshot, SDL_Surface * canvas, int x, int y,
+             SDL_Rect * update_rect)
              The plugin should apply the appropriate 'Magic' tool on the
              'canvas' surface. The (x,y) coordinates are where the mouse was
-             (within the canvas) when the mouse button was clicked.
+             (within the canvas) when the mouse button was clicked, and you
+             are told which 'mode' your tool is in (i.e., 'MODE_PAINT' or
+             'MODE_FULLSCREEN).
 
              The plugin should report back what part of the canvas was
              affected, by filling in the (x,y) and (w,h) elements of
diff --git a/magic/docs/html/README.html b/magic/docs/html/README.html
index 50445bcfc..98cbe9a87 100644
--- a/magic/docs/html/README.html
+++ b/magic/docs/html/README.html
@@ -401,12 +401,15 @@ then the names of your functions must begin with "<code><b>zoom_</b></code>"
   <br>
 
 <li><code><b>void click(magic_api&nbsp;*&nbsp;api, int&nbsp;which,
+  int&nbsp;mode,
   SDL_Surface&nbsp;*&nbsp;snapshot, SDL_Surface&nbsp;*&nbsp;canvas,
   int&nbsp;x, int&nbsp;y, SDL_Rect&nbsp;*&nbsp;update_rect)
   </b></code><br>
   The plugin should apply the appropriate 'Magic' tool on the
   '<code>canvas</code>' surface.  The (x,y) coordinates are where the
-  mouse was (within the canvas) when the mouse button was clicked.<br>
+  mouse was (within the canvas) when the mouse button was clicked, and
+  you are told which 'mode' your tool is in (i.e.,
+  '<code>MODE_PAINT</code>' or '<code>MODE_FULLSCREEN</code>).<br>
   <br>
   The plugin should report back what part of the canvas was affected, by
   filling in the (x,y) and (w,h) elements of '<code>update_rect</code>'.<br>