From 09bdd20bb7fffc12864ce09e9814bc35bee82aa6 Mon Sep 17 00:00:00 2001
From: Vadim Zeitlin <vadim@wxwidgets.org>
Date: Wed, 18 Dec 2013 16:00:06 +0000
Subject: [PATCH] Document wxMediaState enum.

Closes #15760.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/WX_3_0_BRANCH@75393 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---
 interface/wx/mediactrl.h | 18 +++++++++++++++++-
 1 file changed, 17 insertions(+), 1 deletion(-)

diff --git a/interface/wx/mediactrl.h b/interface/wx/mediactrl.h
index b2e7042e6e..e425fa099a 100644
--- a/interface/wx/mediactrl.h
+++ b/interface/wx/mediactrl.h
@@ -5,6 +5,22 @@
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
+/**
+    Describes the current state of the media.
+
+    @see wxMediaCtrl::GetState()
+ */
+enum wxMediaState
+{
+    /** No media is being currently played. */
+    wxMEDIASTATE_STOPPED,
+
+    /** Current media is paused. */
+    wxMEDIASTATE_PAUSED,
+
+    /** There is media currently playing. */
+    wxMEDIASTATE_PLAYING
+};
 
 enum wxMediaCtrlPlayerControls
 {
@@ -306,7 +322,7 @@ public:
     double GetPlaybackRate();
 
     /**
-        Obtains the state the playback of the media is in -
+        Obtains the state the playback of the media is in.
 
         @beginTable
         @row2col{wxMEDIASTATE_STOPPED, The movie has stopped.}