From 03903c1e459f108e0c464db24064e4cde84f174a Mon Sep 17 00:00:00 2001

From: Vadim Zeitlin <vadim@wxwidgets.org>

Date: Fri, 20 Dec 2013 17:50:27 +0000

Subject: [PATCH] Document wxEVT_MEDIA_XXX event types.

See #15768.

(cherry picked from commit 5c1f95bc71028e4562f847af56b815b2f13370a9 on master)

---

 interface/wx/mediactrl.h | 12 ++++++++++++

 1 file changed, 12 insertions(+)

diff --git a/interface/wx/mediactrl.h b/interface/wx/mediactrl.h

index e425fa0..8bcfada 100644

--- a/interface/wx/mediactrl.h

+++ b/interface/wx/mediactrl.h

@@ -48,6 +48,7 @@ enum wxMediaCtrlPlayerControls

     @beginEventTable{wxMediaEvent}

     @event{EVT_MEDIA_LOADED(id\, func)}

            Sent when a media has loaded enough data that it can start playing.

+           Processes a @c wxEVT_MEDIA_LOADED event type.

     @event{EVT_MEDIA_STOP(id\, func)}

            Sent when a media has switched to the @c wxMEDIASTATE_STOPPED state.

            You may be able to Veto this event to prevent it from stopping,

@@ -55,14 +56,19 @@ enum wxMediaCtrlPlayerControls

            the media (note that this may not have the desired effect - if you

            want to loop the media, for example, catch the @c EVT_MEDIA_FINISHED

            and play there instead).

+           Processes a @c wxEVT_MEDIA_STOP event type.

     @event{EVT_MEDIA_FINISHED(id\, func)}

            Sent when a media has finished playing in a wxMediaCtrl.

+           Processes a @c wxEVT_MEDIA_FINISHED event type.

     @event{EVT_MEDIA_STATECHANGED(id\, func)}

            Sent when a media has switched its state (from any media state).

+           Processes a @c wxEVT_MEDIA_STATECHANGED event type.

     @event{EVT_MEDIA_PLAY(id\, func)}

            Sent when a media has switched to the @c wxMEDIASTATE_PLAYING state.

+           Processes a @c wxEVT_MEDIA_PLAY event type.

     @event{EVT_MEDIA_PAUSE(id\, func)}

            Sent when a media has switched to the @c wxMEDIASTATE_PAUSED state.

+           Processes a @c wxEVT_MEDIA_PAUSE event type.

     @endEventTable

     @library{wxmedia}

@@ -442,3 +448,9 @@ class wxMediaCtrl : public wxControl

     wxFileOffset Tell();

 };

+wxEventType wxEVT_MEDIA_LOADED;

+wxEventType wxEVT_MEDIA_STOP;

+wxEventType wxEVT_MEDIA_FINISHED;

+wxEventType wxEVT_MEDIA_STATECHANGED;

+wxEventType wxEVT_MEDIA_PLAY;

+wxEventType wxEVT_MEDIA_PAUSE;