Add test for bug 620428 (setinterval cancellation)

public/fpdf_formfill.h

 // Copyright 2014 PDFium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 // Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com
 
 #ifndef PUBLIC_FPDF_FORMFILL_H_
 #define PUBLIC_FPDF_FORMFILL_H_
 
 #include "fpdfview.h"
@@ skipping 298 matching lines @@
 
 // Flags for Cursor type
 #define FXCT_ARROW 0
 #define FXCT_NESW 1
 #define FXCT_NWSE 2
 #define FXCT_VBEAM 3
 #define FXCT_HBEAM 4
 #define FXCT_HAND 5
 
 /**
- * Declares of a pointer type to the callback function for the FFI_SetTimer
- *method.
+ * Function signature for the callback function passed to the FFI_SetTimer
+ * method.
  * Parameters:
  *          idEvent     -   Identifier of the timer.
  * Return value:
  *          None.
  **/
 typedef void (*TimerCallback)(int idEvent);
 
 /**
  * Declares of a struct type to the local system time.
 **/
@@ skipping 152 matching lines @@
   *       pThis       -   Pointer to the interface structure itself.
   *       nCursorType -   Cursor type. see Flags for Cursor type for the
   * details.
   *   Return value:
   *       None.
   * */
   void (*FFI_SetCursor)(struct _FPDF_FORMFILLINFO* pThis, int nCursorType);
 
   /**
   * Method: FFI_SetTimer
-  *           This method installs a system timer. A time-out value is
-  * specified,
-  *           and every time a time-out occurs, the system passes a message to
-  *           the TimerProc callback function.
+  *       This method installs a system timer. An interval value is specified,
+  *       and every time that interval elapses, the system must call into the
+  *       callback function with the timer ID as returned by this function.
   * Interface Version:
-  *           1
+  *       1
   * Implementation Required:
-  *           yes
+  *       yes
   * Parameters:
   *       pThis       -   Pointer to the interface structure itself.
   *       uElapse     -   Specifies the time-out value, in milliseconds.
   *       lpTimerFunc -   A pointer to the callback function-TimerCallback.
-  *   Return value:
+  * Return value:
   *       The timer identifier of the new timer if the function is successful.
   *       An application passes this value to the FFI_KillTimer method to kill
   *       the timer. Nonzero if it is successful; otherwise, it is zero.
   * */
   int (*FFI_SetTimer)(struct _FPDF_FORMFILLINFO* pThis,
                       int uElapse,
                       TimerCallback lpTimerFunc);
 
   /**
   * Method: FFI_KillTimer
-  *           This method kills the timer event identified by nIDEvent, set by
-  * an earlier call to FFI_SetTimer.
+  *       This method uninstalls a system timer identified by nIDEvent, as
+  *       set by an earlier call to FFI_SetTimer.
   * Interface Version:
-  *           1
+  *       1
   * Implementation Required:
-  *           yes
+  *       yes
   * Parameters:
   *       pThis       -   Pointer to the interface structure itself.
-  *       nTimerID    -   The timer ID return by FFI_SetTimer function.
-  *   Return value:
+  *       nTimerID    -   The timer ID returned by FFI_SetTimer function.
+  * Return value:
   *       None.
   * */
   void (*FFI_KillTimer)(struct _FPDF_FORMFILLINFO* pThis, int nTimerID);
 
   /**
   * Method: FFI_GetLocalTime
   *           This method receives the current local time on the system.
   * Interface Version:
   *           1
   * Implementation Required:
@@ skipping 1216 matching lines @@
 FPDF_StringHandleAddString(FPDF_STRINGHANDLE stringHandle,
                            FPDF_BYTESTRING bsText,
                            FPDF_DWORD size);
 #endif  // PDF_ENABLE_XFA
 
 #ifdef __cplusplus
 }
 #endif
 
 #endif  // PUBLIC_FPDF_FORMFILL_H_