popup-menu-force-popdown

popup-menu-force-popdown Function

Summary

Cancels a popup menu.

Package

capi

Signature

popup-menu-force-popdown popup-menu => result

Arguments

popup-menu⇩

A menu displayed using display-popup-menu.

Values

result⇩

A boolean.

Description

The function popup-menu-force-popdown cancels the menu popup-menu if it is currently displayed.

popup-menu should be a popup menu, that is a menu that is displayed using display-popup-menu. popup-menu-force-popdown pops it down, in the same way that pressing Cancel would normally do.

popup-menu-force-popdown can be called from any process. In particular, it can be called from a timer without worrying on which process it is actually executed. For examples of using timers in CAPI, see 20.4 Examples using timers to implement "animation".

If popup-menu is not displayed, popup-menu-force-popdown has no effect.

The result is t if the menu is displayed when popup-menu-force-popdown is called. Otherwise result is nil.

Notes

popup-menu-force-popdown can be called from any process.