From 7be693212c3cfb2434b25a89a3a8c8dc6ea94b95 Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Wed, 2 Sep 2020 19:33:39 +0200 Subject: [PATCH] Improve documentation of wxUpdateUIEvent::IsCheckable() Explain when this method can be useful. --- interface/wx/event.h | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/interface/wx/event.h b/interface/wx/event.h index d2683e5970..061c5de997 100644 --- a/interface/wx/event.h +++ b/interface/wx/event.h @@ -2377,6 +2377,19 @@ public: /** Returns @true if the UI element can be checked. + For the event handlers that can be used for multiple items, not all of + which can be checked, this method can be useful to determine whether + to call Check() on the event object or not, i.e. the main use case for + this method is: + @code + void MyWindow::OnUpdateUI(wxUpdateUIEvent& event) + { + .... + if ( event.IsCheckable() ) + event.Check(...some condition...); + } + @endcode + @since 3.1.5 */ bool IsCheckable() const;