wxUpdateUIEvent

wxUpdateUIEvent
Functions/Procedures
Supertopics

wxUpdateUIEvent

[func]
can_update
( atom window )

Category: wxUpdateUIEvent

Returns true if it is appropriate to update (send UI update events to) this window.

This function looks at the mode used, the wxWS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update events were last sent in idle time, and the update interval, to determine whether events should be sent to this window now. By default this will always return true because the update mode is initially wxUPDATE_UI_PROCESS_ALL and the interval is set to 0; so update events will be sent as often as possible. You can reduce the frequency that events are sent by changing the mode and/or setting an update interval.


wxUpdateUIEvent

[proc]
check_ui
( atom update_event, atom check )

Category: wxUpdateUIEvent

Check or uncheck the UI element.


wxUpdateUIEvent

[proc]
enable_ui
( atom update_event, atom enable )

Category: wxUpdateUIEvent

Enable or disable the UI element.


wxUpdateUIEvent

[func]
get_checked_ui
( atom update_event )

Category: wxUpdateUIEvent

Returns true if the UI element should be checked.


wxUpdateUIEvent

[func]
get_enabled_ui
( atom update_event )

Category: wxUpdateUIEvent

Returns true if the UI element should be enabled.


wxUpdateUIEvent

[func]
get_mode_ui
( atom update_event )

Category: wxUpdateUIEvent

Static function returning a value specifying how wxWidgets will send update events: to all windows, or only to those which specify that they will process the events.


wxUpdateUIEvent

[func]
get_shown_ui
( atom update_event )

Category: wxUpdateUIEvent

Returns true if the UI element should be shown.


wxUpdateUIEvent

[func]
get_text_ui
( atom update_event )

Category: wxUpdateUIEvent


wxUpdateUIEvent

[func]
get_update_interval_ui
( )

Category: wxUpdateUIEvent

Returns the current interval between updates in milliseconds. -1 disables updates, 0 updates as frequently as possible.


wxUpdateUIEvent

[proc]
set_text_ui
( atom update_event, sequence text )

Category: wxUpdateUIEvent

Sets the text for this UI element.


wxUpdateUIEvent

[proc]
set_ui_update_interval
( atom updateInterval )

Category: wxUpdateUIEvent

Sets the interval between updates in milliseconds. Set to -1 to disable updates, or to 0 to update as frequently as possible. The default is 0.

Use this to reduce the overhead of UI update events if your application has a lot of windows. If you set the value to -1 or greater than 0, you may also need to call wxWindow::UpdateWindowUI at appropriate points in your application, such as when a dialog is about to be shown.


wxUpdateUIEvent

[proc]
set_ui_update_mode
( atom mode )

Category: wxUpdateUIEvent

Specify how wxWidgets will send update events: to all windows, or only to those which specify that they will process the events.

mode may be one of the following values. The default is wxUPDATE_UI_PROCESS_ALL.


wxUpdateUIEvent

[proc]
show_ui
( atom update_event, atom show )

Category: wxUpdateUIEvent

Show or hide the UI element.