Add OSX prefix, and be clear that this is OS X only API to avoid any expectation...

[wxWidgets.git] / include / wx / cocoa / sound.h

diff --git a/include/wx/cocoa/sound.h b/include/wx/cocoa/sound.h
index 03655103f9d8c4f2c01e7af3340d6bb7a6f7a66e..63355c870d96112f906ac23fcdf22e33e1b162c7 100644 (file)
--- a/include/wx/cocoa/sound.h
+++ b/include/wx/cocoa/sound.h
@@ -2,51 +2,51 @@
 // Name:        sound.h
 // Purpose:     wxSound class (loads and plays short Windows .wav files).
 //              Optional on non-Windows platforms.
-// Author:      Ryan Norton
+// Authors:     David Elliott, Ryan Norton
 // Modified by:
 // Created:     2004-10-02
 // RCS-ID:      $Id$
-// Copyright:   (c) Ryan Norton
+// Copyright:   (c) 2004 David Elliott, Ryan Norton
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_COCOA_SOUND_H_
 #define _WX_COCOA_SOUND_H_
 
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-#pragma interface "sound.h"
-#endif
-
-#if wxUSE_SOUND
-
 #include "wx/object.h"
+#include "wx/cocoa/ObjcRef.h"
 
-class WXDLLEXPORT wxSound : public wxSoundBase
+class WXDLLIMPEXP_ADV wxSound : public wxSoundBase
 {
 public:
-  wxSound();
-  wxSound(const wxString& fileName, bool isResource = FALSE);
-  wxSound(int size, const wxByte* data);
-  ~wxSound();
+    wxSound()
+    :   m_cocoaNSSound(NULL)
+    {}
+    wxSound(const wxString& fileName, bool isResource = false)
+    :   m_cocoaNSSound(NULL)
+    {   Create(fileName, isResource); }
+    wxSound(int size, const wxByte* data)
+    :   m_cocoaNSSound(NULL)
+    {   LoadWAV(data,size,true); }
+    wxSound(const wxSound& sound); // why not?
+    virtual ~wxSound();
 
 public:
-  bool  Create(const wxString& fileName, bool isResource = FALSE);
-  bool  IsOk() const { return m_hSnd != NULL; }
-  static void  Stop();
-  static bool IsPlaying();
-
-  inline WX_NSSound GetNSSound()
-  {            return m_hSnd;  }
-protected:  
-  bool  DoPlay(unsigned flags) const;
-
+    bool Create(const wxString& fileName, bool isResource = false);
+    bool IsOk() const
+    {   return m_cocoaNSSound; }
+    static void Stop();
+    static bool IsPlaying();
+
+    void SetNSSound(WX_NSSound cocoaNSSound);
+    inline WX_NSSound GetNSSound()
+    {   return m_cocoaNSSound; }
+protected:
+    bool DoPlay(unsigned flags) const;
+    bool LoadWAV(const wxUint8 *data, size_t length, bool copyData);
 private:
-    WX_NSSound m_hSnd; //NSSound handle
-    wxString m_sndname; //file path
-    int m_waveLength; //size of file in memory mode    
-    struct objc_object * m_cocoaSoundDelegate;
+    WX_NSSound m_cocoaNSSound;
+    static const wxObjcAutoRefFromAlloc<struct objc_object *> sm_cocoaDelegate;
 };
 
-#endif
-#endif
-    // _WX_COCOA_SOUND_H_
+#endif //ndef _WX_COCOA_SOUND_H_