Erlang logo
User's Guide
Reference Manual
Release Notes
PDF
Top

wxErlang
Reference Manual
Version 0.98.5


Expand All
Contract All

Table of Contents

wxIdleEvent

MODULE

wxIdleEvent

MODULE SUMMARY

See external documentation: wxIdleEvent.

DESCRIPTION

See external documentation: wxIdleEvent.

Use wxEvtHandler:connect/3 with EventType:

idle

See also the message variant #wxIdle{} event record type.

This class is derived (and can use functions) from:
wxEvent

DATA TYPES

wxIdleEvent()

An object reference, The representation is internal and can be changed without notice. It can't be used for comparsion stored on disc or distributed for use on other nodes.

EXPORTS

canSend(Win::wxWindow() (see module wxWindow)) -> bool()

getMode() -> WxIdleMode

Types:

WxIdleMode = integer()

See external documentation.
WxIdleMode is one of ?wxIDLE_PROCESS_ALL | ?wxIDLE_PROCESS_SPECIFIED

requestMore(This::wxIdleEvent()) -> ok

Equivalent to requestMore(This, []).

requestMore(This::wxIdleEvent(), Options::[Option]) -> ok

Types:

Option = {needMore, bool()}

moreRequested(This::wxIdleEvent()) -> bool()

setMode(Mode::WxIdleMode) -> ok

Types:

WxIdleMode = integer()

See external documentation.
WxIdleMode is one of ?wxIDLE_PROCESS_ALL | ?wxIDLE_PROCESS_SPECIFIED