Doc fixes A-M edition. Thanks to Arnout for pointing these out. Also I fixed some...

[wxWidgets.git] / include / wx / mediactrl.h

diff --git a/include/wx/mediactrl.h b/include/wx/mediactrl.h
index 7994c83ea210f96c417bfeaf0f2c3492a453af91..1e6ece736ca07668b019126e1d0f2bb24f3c5db7 100644 (file)
--- a/include/wx/mediactrl.h
+++ b/include/wx/mediactrl.h
@@ -55,11 +55,6 @@ enum wxMediaState
     wxMEDIASTATE_PLAYING
 };
 
-enum wxMediaTimeFormat
-{
-    wxMEDIATIMEFORMAT_TIME
-};
-
 #define wxMEDIABACKEND_DIRECTSHOW   wxT("wxAMMediaBackend")
 #define wxMEDIABACKEND_MCI          wxT("wxMCIMediaBackend")
 #define wxMEDIABACKEND_QUICKTIME    wxT("wxQTMediaBackend")
@@ -78,8 +73,8 @@ public:
     //
     // Normal constructor, much the same as wxNotifyEvent
     // ------------------------------------------------------------------------
-    wxMediaEvent(wxEventType commandType = wxEVT_NULL, int id = 0)
-        : wxNotifyEvent(commandType, id)
+    wxMediaEvent(wxEventType commandType = wxEVT_NULL, int winid = 0)
+        : wxNotifyEvent(commandType, winid)
     {                                       }
 
     // ------------------------------------------------------------------------
@@ -117,7 +112,7 @@ public:
     wxMediaCtrl() : m_imp(NULL), m_bLoaded(false), m_bLoop(false)
     {                                                                   }
 
-    wxMediaCtrl(wxWindow* parent, wxWindowID id,
+    wxMediaCtrl(wxWindow* parent, wxWindowID winid,
                 const wxString& fileName = wxT(""),
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
@@ -126,10 +121,10 @@ public:
                 const wxValidator& validator = wxDefaultValidator,
                 const wxString& name = wxT("mediaCtrl"))
                 : m_imp(NULL), m_bLoaded(false), m_bLoop(false)
-    {   Create(parent, id, fileName, pos, size, style,
+    {   Create(parent, winid, fileName, pos, size, style,
                szBackend, validator, name);                             }
 
-    wxMediaCtrl(wxWindow* parent, wxWindowID id,
+    wxMediaCtrl(wxWindow* parent, wxWindowID winid,
                 const wxURI& location,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
@@ -138,12 +133,12 @@ public:
                 const wxValidator& validator = wxDefaultValidator,
                 const wxString& name = wxT("mediaCtrl"))
                 : m_imp(NULL), m_bLoop(false)
-    {   Create(parent, id, location, pos, size, style,
+    {   Create(parent, winid, location, pos, size, style,
                szBackend, validator, name);                             }
 
     ~wxMediaCtrl();
 
-    bool Create(wxWindow* parent, wxWindowID id,
+    bool Create(wxWindow* parent, wxWindowID winid,
                 const wxString& fileName = wxT(""),
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
@@ -152,17 +147,17 @@ public:
                 const wxValidator& validator = wxDefaultValidator,
                 const wxString& name = wxT("mediaCtrl"));
 
-    bool Create(wxWindow* parent, wxWindowID id,
+    bool Create(wxWindow* parent, wxWindowID winid,
                 const wxURI& location,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style = 0,
                 const wxString& szBackend = wxT(""),
                 const wxValidator& validator = wxDefaultValidator,
-                const wxString& name = wxT("mediaCtrl"));
+                const wxString& name = wxT("mediaCtrl")); //DirectShow only
 
     bool DoCreate(wxClassInfo* instance,
-                wxWindow* parent, wxWindowID id,
+                wxWindow* parent, wxWindowID winid,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style = 0,
@@ -174,26 +169,19 @@ public:
     bool Stop();
 
     bool Load(const wxString& fileName);
-    bool Load(const wxURI& location);
+    bool Load(const wxURI& location); //DirectShow only
 
     void Loop(bool bLoop = true);
     bool IsLooped();
 
     wxMediaState GetState();
 
-    double GetPlaybackRate();
-    bool SetPlaybackRate(double dRate);
+    double GetPlaybackRate();           //All but MCI
+    bool SetPlaybackRate(double dRate); //All but MCI
 
-    bool SetPosition(wxLongLong where);
-    wxLongLong GetPosition();
-    wxLongLong GetDuration();
-
-    //The following two prevent function hiding
-    void GetPosition(int* x, int* y) const
-    {       wxControl::GetPosition(x, y);           }
-
-    wxPoint GetPosition() const
-    {       return wxControl::GetPosition();        }  
+    wxFileOffset Seek(wxFileOffset where, wxSeekMode mode = wxFromStart);
+    wxFileOffset Tell(); //FIXME: This should be const
+    wxFileOffset Length(); //FIXME: This should be const
 
 protected:
     static wxClassInfo* NextBackend();
@@ -202,18 +190,24 @@ protected:
     virtual void DoMoveWindow(int x, int y, int w, int h);
     wxSize DoGetBestSize() const;
 
+#ifdef __WXMAC__
+    friend class wxQTMediaBackend;
+#endif
+#ifdef __WXCOCOA__
+    friend class wxQTMediaBackend;
+#endif
     class wxMediaBackend* m_imp;
     bool m_bLoaded;
     bool m_bLoop;
 
-    DECLARE_DYNAMIC_CLASS(wxMediaCtrl);
+    DECLARE_DYNAMIC_CLASS(wxMediaCtrl)
 };
 
 // ----------------------------------------------------------------------------
 //
 // wxMediaBackend
 //
-// Currently an internal class - API stability not gauranteed.
+// Currently an internal class - API stability not guaranteed.
 //
 // ----------------------------------------------------------------------------
 
@@ -227,7 +221,7 @@ public:
 
     virtual bool CreateControl(wxControl* WXUNUSED(ctrl),
                                wxWindow* WXUNUSED(parent),
-                               wxWindowID WXUNUSED(id),
+                               wxWindowID WXUNUSED(winid),
                                const wxPoint& WXUNUSED(pos),
                                const wxSize& WXUNUSED(size),
                                long WXUNUSED(style),
@@ -268,7 +262,7 @@ public:
     virtual wxMediaState GetState()
     {   return wxMEDIASTATE_STOPPED;    }
 
-    DECLARE_CLASS(wxMediaBackend)
+    DECLARE_DYNAMIC_CLASS(wxMediaBackend)
 };
 
 //Event ID to give to our events