flushEvents

Clears pending events from the event queue so they will not trigger handlers.

# Metadata

Platforms: desktop, server OS: mac, windows, linux Introduced: 1.0 Security:

# Syntax

flushEvents(eventType)

# Params

- eventType :

# Examples

put flushEvents("activate") into trashVar

get flushEvents("all")

# Description

Use the flushEvents function to prevent unwanted messages from being sent during a handler execute.

Typically, you use the flushEvents function in a handler to dump user actions that have occurred during the handler. For example, if a button has a mouseUp handler that takes a few seconds to run, the user might click again during that time. To prevent those extra clicks from causing the handler to run again, use the flushEvents function :

on mouseUp -- ...lengthy handler goes here... -- get rid of clicks since the handler started: put flushEvents("mouseUp") into temp

end mouseUp

To clear multiple event types, call the flushEvents function once for each event type you want to clear.

Although some of the eventTypes have the same names as built-in LiveCode messages, there is a distinction. For example, the mouseDown event type is the operating system's response to the user clicking the mouse button. When the operating system sends this event to the application, LiveCode sends a mouseDown message to the target object. The expression flushEvents(mouseDown) prevents the application from responding to any mouseDown events it has received from the operating system, but has not yet processed.

# Tags

ui,

# See

- **message:** suspendStack, appleEvent, mouseUp, mouseDown, resumeStack - **command:** cancel - **glossary:** LiveCode, event, return, handler, mouse button, trigger, execute, message, application, object - **control structure:** function