wxUpdateUIEvent(3)

MODULE
wxUpdateUIEvent - See external documentation: wxUpdateUIEvent.

DESCRIPTION

See external documentation: wxUpdateUIEvent <http://www.wxwidgets.org/manuals/stable/wx_wxupdateuievent.html>.

    Use wxEvtHandler:connect/3 with EventType::
        update_ui

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

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

DATA TYPES

    wxUpdateUIEvent():

        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

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

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

check(This::wxUpdateUIEvent(), Check::bool()) -> ok

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

enable(This::wxUpdateUIEvent(), Enable::bool()) -> ok

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

show(This::wxUpdateUIEvent(), Show::bool()) -> ok

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

getChecked(This::wxUpdateUIEvent()) -> bool()

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

getEnabled(This::wxUpdateUIEvent()) -> bool()

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

getShown(This::wxUpdateUIEvent()) -> bool()

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

getSetChecked(This::wxUpdateUIEvent()) -> bool()

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

getSetEnabled(This::wxUpdateUIEvent()) -> bool()

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

getSetShown(This::wxUpdateUIEvent()) -> bool()

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

getSetText(This::wxUpdateUIEvent()) -> bool()

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

getText(This::wxUpdateUIEvent()) -> string()

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

getMode() -> WxUpdateUIMode

    Types
        WxUpdateUIMode = integer()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxupdateuievent.html#wxupdateuieventgetmode>.
     WxUpdateUIMode is one of ?wxUPDATE_UI_PROCESS_ALL | ?wxUPDATE_UI_PROCESS_SPECIFIED

getUpdateInterval() -> integer()

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

resetUpdateTime() -> ok

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

setMode(Mode::WxUpdateUIMode) -> ok

    Types
        WxUpdateUIMode = integer()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxupdateuievent.html#wxupdateuieventsetmode>.
     WxUpdateUIMode is one of ?wxUPDATE_UI_PROCESS_ALL | ?wxUPDATE_UI_PROCESS_SPECIFIED

setText(This::wxUpdateUIEvent(), Text::string()) -> ok

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

setUpdateInterval(UpdateInterval::integer()) -> ok

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