wxUpdateUIEvent

This class is used for pseudo-events which are called by wxWidgets to give an application the chance to update various user interface elements.

Derived from

wxCommandEvent
wxEvent
wxObject

Include files

<wx/event.h>

Event table macros

To process an update event, use these event handler macros to direct input to member functions that take a wxUpdateUIEvent argument.

EVT_UPDATE_UI(id, func)	Process a wxEVT_UPDATE_UI event for the command with the given id.
EVT_UPDATE_UI_RANGE(id1, id2, func)	Process a wxEVT_UPDATE_UI event for any command with id included in the given range.

Remarks

Without update UI events, an application has to work hard to check/uncheck, enable/disable, and set the text for elements such as menu items and toolbar buttons. The code for doing this has to be mixed up with the code that is invoked when an action is invoked for a menu item or button.

With update UI events, you define an event handler to look at the state of the application and change UI elements accordingly. wxWidgets will call your member functions in idle time, so you don't have to worry where to call this code. In addition to being a clearer and more declarative method, it also means you don't have to worry whether you're updating a toolbar or menubar identifier. The same handler can update a menu item and toolbar button, if the identifier is the same.

Instead of directly manipulating the menu or button, you call functions in the event object, such as wxUpdateUIEvent::Check. wxWidgets will determine whether such a call has been made, and which UI element to update.

These events will work for popup menus as well as menubars. Just before a menu is popped up, wxMenu::UpdateUI is called to process any UI events for the window that owns the menu.

If you find that the overhead of UI update processing is affecting your application, you can do one or both of the following:

1. Call wxUpdateUIEvent::SetMode with a value of wxUPDATE_UI_PROCESS_SPECIFIED, and set the extra style wxWS_EX_PROCESS_UPDATE_EVENTS for every window that should receive update events. No other windows will receive update events.
2. Call wxUpdateUIEvent::SetUpdateInterval with a millisecond value to set the delay between updates. You may need to call wxWindow::UpdateWindowUI at critical points, for example when a dialog is about to be shown, in case the user sees a slight delay before windows are updated.

Note that although events are sent in idle time, defining a wxIdleEvent handler for a window does not affect this because the events are sent from wxWindow::OnInternalIdle which is always called in idle time.

wxWidgets tries to optimize update events on some platforms. On Windows and GTK+, events for menubar items are only sent when the menu is about to be shown, and not in idle time.

See also

Event handling overview

Members

wxUpdateUIEvent::wxUpdateUIEvent
wxUpdateUIEvent::m_checked
wxUpdateUIEvent::m_enabled
wxUpdateUIEvent::m_setChecked
wxUpdateUIEvent::m_setEnabled
wxUpdateUIEvent::m_setText
wxUpdateUIEvent::m_text
wxUpdateUIEvent::CanUpdate
wxUpdateUIEvent::Check
wxUpdateUIEvent::Enable
wxUpdateUIEvent::GetChecked
wxUpdateUIEvent::GetEnabled
wxUpdateUIEvent::GetSetChecked
wxUpdateUIEvent::GetSetEnabled
wxUpdateUIEvent::GetSetText
wxUpdateUIEvent::GetText
wxUpdateUIEvent::GetMode
wxUpdateUIEvent::GetUpdateInterval
wxUpdateUIEvent::ResetUpdateTime
wxUpdateUIEvent::SetMode
wxUpdateUIEvent::SetText
wxUpdateUIEvent::SetUpdateInterval

wxUpdateUIEvent::wxUpdateUIEvent

wxUpdateUIEvent(wxWindowID commandId = 0)

Constructor.

wxUpdateUIEvent::m_checked

bool m_checked

true if the element should be checked, false otherwise.

wxUpdateUIEvent::m_enabled

bool m_checked

true if the element should be enabled, false otherwise.

wxUpdateUIEvent::m_setChecked

bool m_setChecked

true if the application has set the m_checked member.

wxUpdateUIEvent::m_setEnabled

bool m_setEnabled

true if the application has set the m_enabled member.

wxUpdateUIEvent::m_setText

bool m_setText

true if the application has set the m_text member.

wxUpdateUIEvent::m_text

wxString m_text

Holds the text with which the the application wishes to update the UI element.

wxUpdateUIEvent::CanUpdate

static bool CanUpdate(wxWindow* window)

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

This function looks at the mode used (see wxUpdateUIEvent::SetMode), 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.

See also

wxUpdateUIEvent::ResetUpdateTime, wxUpdateUIEvent::SetUpdateInterval, wxUpdateUIEvent::SetMode

wxUpdateUIEvent::Check

void Check(bool check)

Check or uncheck the UI element.

wxUpdateUIEvent::Enable

void Enable(bool enable)

Enable or disable the UI element.

wxUpdateUIEvent::GetChecked

bool GetChecked() const

Returns true if the UI element should be checked.

wxUpdateUIEvent::GetEnabled

bool GetEnabled() const

Returns true if the UI element should be enabled.

wxUpdateUIEvent::GetSetChecked

bool GetSetChecked() const

Returns true if the application has called SetChecked. For wxWidgets internal use only.

wxUpdateUIEvent::GetSetEnabled

bool GetSetEnabled() const

Returns true if the application has called SetEnabled. For wxWidgets internal use only.

wxUpdateUIEvent::GetSetText

bool GetSetText() const

Returns true if the application has called SetText. For wxWidgets internal use only.

wxUpdateUIEvent::GetText

wxString GetText() const

Returns the text that should be set for the UI element.

wxUpdateUIEvent::GetMode

static wxUpdateUIMode GetMode()

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.

See wxUpdateUIEvent::SetMode.

wxUpdateUIEvent::GetUpdateInterval

static long GetUpdateInterval()

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

See wxUpdateUIEvent::SetUpdateInterval.

wxUpdateUIEvent::ResetUpdateTime

static void ResetUpdateTime()

Used internally to reset the last-updated time to the current time. It is assumed that update events are normally sent in idle time, so this is called at the end of idle processing.

See also

wxUpdateUIEvent::CanUpdate, wxUpdateUIEvent::SetUpdateInterval, wxUpdateUIEvent::SetMode

wxUpdateUIEvent::SetMode

static void SetMode(wxIdleMode mode)

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.

enum wxUpdateUIMode
{
        // Send UI update events to all windows
    wxUPDATE_UI_PROCESS_ALL,

        // Send UI update events to windows that have
        // the wxWS_EX_PROCESS_UI_UPDATES flag specified
    wxUPDATE_UI_PROCESS_SPECIFIED
};

wxUpdateUIEvent::SetText

void SetText(const wxString& text)

Sets the text for this UI element.

wxUpdateUIEvent::SetUpdateInterval

static void SetUpdateInterval(long updateInterval)

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.