added stub of GetEscapeId()

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

diff --git a/include/wx/mediactrl.h b/include/wx/mediactrl.h
index 7ee066d29f3e2e2905ef9fa0f6614b382e1f24f9..9646aeed81d6db9b1da8da320c33264162648334 100644 (file)
--- a/include/wx/mediactrl.h
+++ b/include/wx/mediactrl.h
@@ -26,9 +26,12 @@
 #pragma interface "mediactrl.h"
 #endif
 
 #pragma interface "mediactrl.h"
 #endif
 

+#include "wx/defs.h"
+

 // ----------------------------------------------------------------------------
 // Compilation guard
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // Compilation guard
 // ----------------------------------------------------------------------------

+

 #if wxUSE_MEDIACTRL
 
 // ----------------------------------------------------------------------------
 #if wxUSE_MEDIACTRL
 
 // ----------------------------------------------------------------------------


@@ -58,6 +61,7 @@ enum wxMediaState
 #define wxMEDIABACKEND_DIRECTSHOW   wxT("wxAMMediaBackend")
 #define wxMEDIABACKEND_MCI          wxT("wxMCIMediaBackend")
 #define wxMEDIABACKEND_QUICKTIME    wxT("wxQTMediaBackend")
 #define wxMEDIABACKEND_DIRECTSHOW   wxT("wxAMMediaBackend")
 #define wxMEDIABACKEND_MCI          wxT("wxMCIMediaBackend")
 #define wxMEDIABACKEND_QUICKTIME    wxT("wxQTMediaBackend")

+#define wxMEDIABACKEND_GSTREAMER    wxT("wxGStreamerMediaBackend")

 
 // ----------------------------------------------------------------------------
 //
 
 // ----------------------------------------------------------------------------
 //


@@ -73,8 +77,8 @@ public:
     //
     // Normal constructor, much the same as wxNotifyEvent
     // ------------------------------------------------------------------------
     //
     // 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)

     {                                       }
 
     // ------------------------------------------------------------------------
     {                                       }
 
     // ------------------------------------------------------------------------


@@ -109,55 +113,55 @@ public:
 class WXDLLIMPEXP_MEDIA wxMediaCtrl : public wxControl
 {
 public:
 class WXDLLIMPEXP_MEDIA wxMediaCtrl : public wxControl
 {
 public:

-    wxMediaCtrl() : m_imp(NULL), m_bLoaded(false), m_bLoop(false)
+    wxMediaCtrl() : m_imp(NULL), m_bLoaded(false)

     {                                                                   }
 
     {                                                                   }
 

-    wxMediaCtrl(wxWindow* parent, wxWindowID id,
-                const wxString& fileName = wxT(""),
+    wxMediaCtrl(wxWindow* parent, wxWindowID winid,
+                const wxString& fileName = wxEmptyString,

                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style = 0,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style = 0,

-                const wxString& szBackend = wxT(""),
+                const wxString& szBackend = wxEmptyString,

                 const wxValidator& validator = wxDefaultValidator,
                 const wxString& name = wxT("mediaCtrl"))
                 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,
+                : m_imp(NULL), m_bLoaded(false)
+    {   Create(parent, winid, fileName, pos, size, style,

                szBackend, validator, name);                             }
 
                szBackend, validator, name);                             }
 

-    wxMediaCtrl(wxWindow* parent, wxWindowID id,
+    wxMediaCtrl(wxWindow* parent, wxWindowID winid,

                 const wxURI& location,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style = 0,
                 const wxURI& location,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style = 0,

-                const wxString& szBackend = wxT(""),
+                const wxString& szBackend = wxEmptyString,

                 const wxValidator& validator = wxDefaultValidator,
                 const wxString& name = wxT("mediaCtrl"))
                 const wxValidator& validator = wxDefaultValidator,
                 const wxString& name = wxT("mediaCtrl"))

-                : m_imp(NULL), m_bLoop(false)
-    {   Create(parent, id, location, pos, size, style,
+                : m_imp(NULL), m_bLoaded(false)
+    {   Create(parent, winid, location, pos, size, style,

                szBackend, validator, name);                             }
 
     ~wxMediaCtrl();
 
                szBackend, validator, name);                             }
 
     ~wxMediaCtrl();
 

-    bool Create(wxWindow* parent, wxWindowID id,
-                const wxString& fileName = wxT(""),
+    bool Create(wxWindow* parent, wxWindowID winid,
+                const wxString& fileName = wxEmptyString,

                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style = 0,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style = 0,

-                const wxString& szBackend = wxT(""),
+                const wxString& szBackend = wxEmptyString,

                 const wxValidator& validator = wxDefaultValidator,
                 const wxString& name = wxT("mediaCtrl"));
 
                 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 wxURI& location,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style = 0,

-                const wxString& szBackend = wxT(""),
+                const wxString& szBackend = wxEmptyString,

                 const wxValidator& validator = wxDefaultValidator,
                 const wxString& name = wxT("mediaCtrl")); //DirectShow only
 
     bool DoCreate(wxClassInfo* instance,
                 const wxValidator& validator = wxDefaultValidator,
                 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,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style = 0,


@@ -169,20 +173,26 @@ public:
     bool Stop();
 
     bool Load(const wxString& fileName);
     bool Stop();
 
     bool Load(const wxString& fileName);

-    bool Load(const wxURI& location); //DirectShow only

 
 

-    void Loop(bool bLoop = true);
-    bool IsLooped();

 
     wxMediaState GetState();
 
 
     wxMediaState GetState();
 

-    double GetPlaybackRate();           //All but MCI
-    bool SetPlaybackRate(double dRate); //All but MCI
-

     wxFileOffset Seek(wxFileOffset where, wxSeekMode mode = wxFromStart);
     wxFileOffset Tell(); //FIXME: This should be const
     wxFileOffset Length(); //FIXME: This should be const
 
     wxFileOffset Seek(wxFileOffset where, wxSeekMode mode = wxFromStart);
     wxFileOffset Tell(); //FIXME: This should be const
     wxFileOffset Length(); //FIXME: This should be const
 

+    //
+    // Unofficial parts of API
+    //
+    //DirectShow/GStreamer only.  Quicktime too, but somewhat buggy...
+    bool Load(const wxURI& location);
+
+    double GetPlaybackRate();           //All but MCI & GStreamer
+    bool SetPlaybackRate(double dRate); //All but MCI & GStreamer
+
+    double GetVolume();                 //DirectShow only
+    bool   SetVolume(double dVolume);   //DirectShow only
+

 protected:
     static wxClassInfo* NextBackend();
 
 protected:
     static wxClassInfo* NextBackend();
 


@@ -190,11 +200,18 @@ protected:
     virtual void DoMoveWindow(int x, int y, int w, int h);
     wxSize DoGetBestSize() const;
 
     virtual void DoMoveWindow(int x, int y, int w, int h);
     wxSize DoGetBestSize() const;
 

+    //FIXME:  This is nasty... find a better way to work around
+    //inheritance issues
+#ifdef __WXMAC__
+    friend class wxQTMediaBackend;
+#endif
+#ifdef __WXCOCOA__
+    friend class wxQTMediaBackend;
+#endif

     class wxMediaBackend* m_imp;
     bool m_bLoaded;
     class wxMediaBackend* m_imp;
     bool m_bLoaded;

-    bool m_bLoop;

 
 

-    DECLARE_DYNAMIC_CLASS(wxMediaCtrl);
+    DECLARE_DYNAMIC_CLASS(wxMediaCtrl)

 };
 
 // ----------------------------------------------------------------------------
 };
 
 // ----------------------------------------------------------------------------


@@ -215,7 +232,7 @@ public:
 
     virtual bool CreateControl(wxControl* WXUNUSED(ctrl),
                                wxWindow* WXUNUSED(parent),
 
     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),
                                const wxPoint& WXUNUSED(pos),
                                const wxSize& WXUNUSED(size),
                                long WXUNUSED(style),


@@ -256,7 +273,20 @@ public:
     virtual wxMediaState GetState()
     {   return wxMEDIASTATE_STOPPED;    }
 
     virtual wxMediaState GetState()
     {   return wxMEDIASTATE_STOPPED;    }
 

-    DECLARE_CLASS(wxMediaBackend)
+    virtual double GetVolume()
+    {   return 0.0;                     }
+    virtual bool SetVolume(double WXUNUSED(dVolume))
+    {   return false;                   }
+
+    virtual void RESERVED3() {}
+    virtual void RESERVED4() {}
+    virtual void RESERVED5() {}
+    virtual void RESERVED6() {}
+    virtual void RESERVED7() {}
+    virtual void RESERVED8() {}
+    virtual void RESERVED9() {}
+
+    DECLARE_DYNAMIC_CLASS(wxMediaBackend)

 };
 
 //Event ID to give to our events
 };
 
 //Event ID to give to our events


@@ -270,9 +300,12 @@ DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_MEDIA, wxEVT_MEDIA_STOP,     wxMEDIA_STO
 //Function type(s) our events need
 typedef void (wxEvtHandler::*wxMediaEventFunction)(wxMediaEvent&);
 
 //Function type(s) our events need
 typedef void (wxEvtHandler::*wxMediaEventFunction)(wxMediaEvent&);
 

+#define wxMediaEventHandler(func) \
+    (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxMediaEventFunction, &func)
+

 //Macro for usage with message maps
 //Macro for usage with message maps

-#define EVT_MEDIA_FINISHED(winid, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_MEDIA_FINISHED, winid, wxID_ANY, (wxObjectEventFunction) (wxEventFunction) (wxMediaEventFunction) & fn, (wxObject *) NULL ),
-#define EVT_MEDIA_STOP(winid, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_MEDIA_STOP, winid, wxID_ANY, (wxObjectEventFunction) (wxEventFunction) (wxMediaEventFunction) & fn, (wxObject *) NULL ),
+#define EVT_MEDIA_FINISHED(winid, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_MEDIA_FINISHED, winid, wxID_ANY, wxMediaEventHandler(fn), (wxObject *) NULL ),
+#define EVT_MEDIA_STOP(winid, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_MEDIA_STOP, winid, wxID_ANY, wxMediaEventHandler(fn), (wxObject *) NULL ),

 
 // ----------------------------------------------------------------------------
 // End compilation gaurd
 
 // ----------------------------------------------------------------------------
 // End compilation gaurd