wxIdleEvent(3)

MODULE
wxIdleEvent - See external documentation: wxIdleEvent.

DESCRIPTION

See external documentation: wxIdleEvent <http://www.wxwidgets.org/manuals/stable/wx_wxidleevent.html>.

    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()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxidleevent.html#wxidleeventcansend>.

getMode() -> WxIdleMode

    Types
        WxIdleMode = integer()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxidleevent.html#wxidleeventgetmode>.
     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()}

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxidleevent.html#wxidleeventrequestmore>.

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

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxidleevent.html#wxidleeventmorerequested>.

setMode(Mode::WxIdleMode) -> ok

    Types
        WxIdleMode = integer()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxidleevent.html#wxidleeventsetmode>.
     WxIdleMode is one of ?wxIDLE_PROCESS_ALL | ?wxIDLE_PROCESS_SPECIFIED