summaryrefslogtreecommitdiff
path: root/public
diff options
context:
space:
mode:
authortsepez <tsepez@chromium.org>2016-08-03 14:03:35 -0700
committerCommit bot <commit-bot@chromium.org>2016-08-03 14:03:35 -0700
commit8e12029407cf1cca95b7f79bf5e5a5fec5bea9cb (patch)
treeb1329865ce4aeae51a71abdcacdf6bc6514e3822 /public
parent8d0cc67cdf3ef45ee7268d3e00a21c0a99843a84 (diff)
downloadpdfium-8e12029407cf1cca95b7f79bf5e5a5fec5bea9cb.tar.xz
Add test for bug 620428 (setinterval cancellation)
While we're at it, beef up existing test for non-cancellation. In turn, fix test harness to implement intervals properly. In turn, fix public documentation to be clearer about timers. Also rename a few identifiers that sounded "off". Review-Url: https://codereview.chromium.org/2211513002
Diffstat (limited to 'public')
-rw-r--r--public/fpdf_formfill.h29
1 files changed, 14 insertions, 15 deletions
diff --git a/public/fpdf_formfill.h b/public/fpdf_formfill.h
index 79e9c26961..248bcd2b02 100644
--- a/public/fpdf_formfill.h
+++ b/public/fpdf_formfill.h
@@ -316,8 +316,8 @@ typedef struct _IPDF_JsPlatform {
#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:
@@ -490,19 +490,18 @@ typedef struct _FPDF_FORMFILLINFO {
/**
* 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.
@@ -513,16 +512,16 @@ typedef struct _FPDF_FORMFILLINFO {
/**
* 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);