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

Don't document wxSysColourChangedEvent as being MSW-only

Browse Source 
The docs mentioned this event as being Windows only, but it is also
generated on macOS and GTK now.

Closes https://github.com/wxWidgets/wxWidgets/pull/2296
This commit is contained in:
Ian McInerney
2021-03-28 00:07:28 +00:00
committed by Vadim Zeitlin
parent e180baa6df
commit da8c851949
2 changed files with 15 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
interface/wx/event.h
View File

@@ -1876,14 +1876,18 @@ public:
@class wxSysColourChangedEvent @class wxSysColourChangedEvent
This class is used for system colour change events, which are generated This class is used for system colour change events, which are generated
when the user changes the colour settings using the control panel. when the user changes the colour settings or when the system theme changes
This is only appropriate under Windows. (e.g. automatic dark mode switching on macOS).
Event handlers for this event can access the new system colour settings through
wxSystemSettings::GetColour().
@remarks @remarks
The default event handler for this event propagates the event to child windows, The default event handler for this event propagates the event to child windows,
since Windows only sends the events to top-level windows. since the system events are only sent to top-level windows.
If intercepting this event for a top-level window, remember to call the base If intercepting this event for a top-level window, remember to either call
class handler, or to pass the event on to the window's children explicitly. wxEvent::Skip() on the event, call the base class handler, or pass the event
on to the window's children explicitly.
@beginEventTable{wxSysColourChangedEvent} @beginEventTable{wxSysColourChangedEvent}
@event{EVT_SYS_COLOUR_CHANGED(func)} @event{EVT_SYS_COLOUR_CHANGED(func)}

12
interface/wx/panel.h
View File

@@ -111,12 +111,12 @@ public:
@param event @param event
The colour change event. The colour change event.
@remarks Changes the panel's colour to conform to the current settings @remarks Changes the panel's colour to conform to the current settings.
(Windows only). Add an event table entry for your panel Add an event table entry for your panel class if you wish the
class if you wish the behaviour to be different (such behaviour to be different (such as keeping a user-defined
as keeping a user-defined background colour). If you do background colour). If you do override this function, call
override this function, call wxEvent::Skip() to propagate wxEvent::Skip() to propagate the notification to child windows
the notification to child windows and controls. and controls.
@see wxSysColourChangedEvent @see wxSysColourChangedEvent
*/ */