Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update wxMenu::UpdateUI() parameter comment and documentation

Browse Source 
The argument to this method should basically just never be used, so while we
still keep it for compatibility (because it doesn't cost anything to do it),
make it clear that it should never be specified in the new code and, also,
that this function is actually only used inside wxWidgets and shouldn't be
normally called from outside of the library at all.
This commit is contained in:
Vadim Zeitlin
2016-01-30 21:39:09 +01:00
parent c618c0b620
commit bc8293a9e5
3 changed files with 12 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
include/wx/menu.h
View File

@@ -275,9 +275,11 @@ public:
// implementation helpers // implementation helpers
// ---------------------- // ----------------------
// Updates the UI for a menu and all submenus recursively. source is the // Updates the UI for a menu and all submenus recursively by generating
// object that has the update event handlers defined for it. If NULL, the // wxEVT_UPDATE_UI for all the items.
// menu or associated window will be used. //
// Do not use the "source" argument, it allows to override the event
// handler to use for these events, but this should never be needed.
void UpdateUI(wxEvtHandler* source = NULL); void UpdateUI(wxEvtHandler* source = NULL);
// get the menu bar this menu is attached to (may be NULL, always NULL for // get the menu bar this menu is attached to (may be NULL, always NULL for

10
interface/wx/menu.h
View File

@@ -1036,11 +1036,13 @@ public:
virtual void SetTitle(const wxString& title); virtual void SetTitle(const wxString& title);
/** /**
Sends events to @a source (or owning window if @NULL) to update the Update the state of all menu items, recursively, by generating @c
menu UI. wxEVT_UPDATE_UI events for them.
This is called just before the menu is popped up with wxWindow::PopupMenu, This is an internal wxWidgets function and shouldn't normally be called
but the application may call it at other times if required. from outside of the library. If it is called, @a source argument should
not be used, it is deprecated and exists only for backwards
compatibility.
*/ */
void UpdateUI(wxEvtHandler* source = NULL); void UpdateUI(wxEvtHandler* source = NULL);

5
src/common/menucmn.cpp
View File

@@ -593,9 +593,6 @@ wxMenuItem* wxMenuBase::FindItemByPosition(size_t position) const
// wxMenu helpers used by derived classes // wxMenu helpers used by derived classes
// ---------------------------------------------------------------------------- // ----------------------------------------------------------------------------
// Update a menu and all submenus recursively. source is the object that has
// the update event handlers defined for it. If NULL, the menu or associated
// window will be used.
void wxMenuBase::UpdateUI(wxEvtHandler* source) void wxMenuBase::UpdateUI(wxEvtHandler* source)
{ {
wxWindow * const win = GetWindow(); wxWindow * const win = GetWindow();
@@ -1095,7 +1092,7 @@ void wxMenuBarBase::UpdateMenus()
{ {
menu = GetMenu( n ); menu = GetMenu( n );
if (menu != NULL) if (menu != NULL)
menu->UpdateUI( NULL ); menu->UpdateUI();
} }
} }