]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/wx/mediactrl.h
Document wxMessageQueueError.
[wxWidgets.git] / interface / wx / mediactrl.h
index e572a1361e0e626ba49035c37f46f931ec036a42..f11e896cf5191ad062ccc2d1dd1a42d639c456a1 100644 (file)
@@ -1,9 +1,9 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        mediactrl.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        mediactrl.h
-// Purpose:     interface of wxMediaEvent
+// Purpose:     interface of wxMediaEvent, wxMediaCtrl
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 
 /////////////////////////////////////////////////////////////////////////////
 
 
@@ -250,11 +250,11 @@ public:
         @param name
             Window name.
     */
         @param name
             Window name.
     */
-    wxMediaCtrl(wxWindow* parent, wxWindowID id, const wxString& fileName = wxT(""),
+    wxMediaCtrl(wxWindow* parent, wxWindowID id, const wxString& fileName = wxEmptyString,
                 const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize,
                 const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize,
-                long style = 0, const wxString& szBackend = wxT(""),
+                long style = 0, const wxString& szBackend = wxEmptyString,
                 const wxValidator& validator = wxDefaultValidator,
                 const wxValidator& validator = wxDefaultValidator,
-                const wxString& name = wxPanelNameStr);
+                const wxString& name = "mediaCtrl");
 
     /**
         Creates this control.
 
     /**
         Creates this control.
@@ -284,18 +284,18 @@ public:
         @param name
             Window name.
     */
         @param name
             Window name.
     */
-    bool Create(wxWindow* parent, wxWindowID id, const wxString& fileName = wxT(""),
+    bool Create(wxWindow* parent, wxWindowID id, const wxString& fileName = wxEmptyString,
                 const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize,
                 const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize,
-                long style = 0, const wxString& szBackend = wxT(""),
+                long style = 0, const wxString& szBackend = wxEmptyString,
                 const wxValidator& validator = wxDefaultValidator,
                 const wxValidator& validator = wxDefaultValidator,
-                const wxString& name = wxPanelNameStr);
+                const wxString& name = "mediaCtrl");
 
     /**
         Obtains the best size relative to the original/natural size of the
         video, if there is any.
         See @ref mediactrl_video_size for more information.
     */
 
     /**
         Obtains the best size relative to the original/natural size of the
         video, if there is any.
         See @ref mediactrl_video_size for more information.
     */
-    wxSize GetBestSize();
+    wxSize GetBestSize() const;
 
     /**
         Obtains the playback rate, or speed of the media. @c 1.0 represents normal
 
     /**
         Obtains the playback rate, or speed of the media. @c 1.0 represents normal
@@ -315,7 +315,7 @@ public:
         @row2col{wxMEDIASTATE_PLAYING, The movie is currently playing.}
         @endTable
     */
         @row2col{wxMEDIASTATE_PLAYING, The movie is currently playing.}
         @endTable
     */
-    wxMediaCtrlState GetState();
+    wxMediaState GetState();
 
     /**
         Gets the volume of the media from a 0.0 to 1.0 range.
 
     /**
         Gets the volume of the media from a 0.0 to 1.0 range.
@@ -352,13 +352,13 @@ public:
     /**
         Same as Load(const wxURI& uri). Kept for wxPython compatibility.
     */
     /**
         Same as Load(const wxURI& uri). Kept for wxPython compatibility.
     */
-    bool LoadURI(const wxURI& uri);
+    bool LoadURI(const wxString& fileName);
 
     /**
         Same as Load(const wxURI& uri, const wxURI& proxy).
         Kept for wxPython compatibility.
     */
 
     /**
         Same as Load(const wxURI& uri, const wxURI& proxy).
         Kept for wxPython compatibility.
     */
-    bool LoadURIWithProxy(const wxURI& uri, const wxURI& proxy);
+    bool LoadURIWithProxy(const wxString& fileName, const wxString& proxy);
 
     /**
         Pauses playback of the movie.
 
     /**
         Pauses playback of the movie.
@@ -376,7 +376,7 @@ public:
         @todo Document the wxSeekMode parameter @a mode, and perhaps also the
               wxFileOffset and wxSeekMode themselves.
     */
         @todo Document the wxSeekMode parameter @a mode, and perhaps also the
               wxFileOffset and wxSeekMode themselves.
     */
-    wxFileOffset Seek(wxFileOffset where, wxSeekMode mode);
+    wxFileOffset Seek(wxFileOffset where, wxSeekMode mode = wxFromStart);
 
     /**
         Sets the playback rate, or speed of the media, to that referred by @a dRate.
 
     /**
         Sets the playback rate, or speed of the media, to that referred by @a dRate.
@@ -407,7 +407,7 @@ public:
         default controls provided by the toolkit. The function takes a
         wxMediaCtrlPlayerControls enumeration, please see available show modes there.
 
         default controls provided by the toolkit. The function takes a
         wxMediaCtrlPlayerControls enumeration, please see available show modes there.
 
-        For more see @ref mediactrl_player_controls.
+        For more info see @ref mediactrl_player_controls.
 
         Currently only implemented on the QuickTime and DirectShow backends.
         The function returns @true on success.
 
         Currently only implemented on the QuickTime and DirectShow backends.
         The function returns @true on success.