Don't document wxSysColourChangedEvent as being MSW-only

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

View File

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

View File

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