Ticket #948: 948_ButtonSoundAttribute.patch

binaries/data/mods/public/gui/common/styles.xml

@@ -21 +21 @@
         multiline="false"
     />
 
-    <!--
+  <!--
     ==========================================
+    - DEFAULT BUTTON STYLE: The style with the name 'default_button' is special, it will
+    - be called by every button object before any other style is loaded, except 'default'.
+    ==========================================
+    -->
+
+  <style name="default_button"
+    button_sound="audio/interface/ui/ui_button_click.ogg"
+    />
+
+  <!--
+    ==========================================
     - STYLE - GLOBAL - PANES - WHEAT SKIN
     ==========================================
     -->

source/gui/CButton.cpp

@@ -32 +32 @@
 CButton::CButton()
 {
     AddSetting(GUIST_float,                 "buffer_zone");
+    AddSetting(GUIST_CStr,                  "button_sound");
     AddSetting(GUIST_CGUIString,            "caption");
     AddSetting(GUIST_int,                   "cell_id");
     AddSetting(GUIST_CStrW,                 "font");

source/gui/CGUI.cpp

@@ -1169 +1169 @@
     if (m_Styles.count("default") == 1)
         object->LoadStyle(*this, "default");
 
+    if (type.Find("button") != -1 && m_Styles.count("default_button") == 1)
+        object->LoadStyle(*this, "default_button");
+
     if (! argStyle.empty())
     {
         // additional check

source/gui/IGUIButtonBehavior.cpp

@@ -21 +21 @@
 
 #include "precompiled.h"
 #include "GUI.h"
+#include "lib/res/sound/snd_mgr.h"
+#include "ps/Filesystem.h"
+#include "ps/CLogger.h"
 
-
 //-------------------------------------------------------------------
 //  Constructor / Destructor
 //-------------------------------------------------------------------
@@ -78 +80 @@
             }
         }
     }   break;
+    
+    case GUIM_PRESSED:
+    {
+        // Play button sound if available
+        CStr button_sound;
+        if (PSRETURN_OK == GUI<CStr>::GetSetting(this, "button_sound", button_sound))
+        {
+            Handle hvs = snd_open(g_VFS, button_sound.c_str());
+            if (hvs > 0)
+            {
+                snd_set_pos(hvs, 0,0,0, true);
+                snd_play(hvs);
+            }
+            else
+            {
+                LOGWARNING(L"Unable to snd_open button_sound %hs in IGUIButtonBehavior", button_sound.c_str());
+            }
+        }       
+        // else no button_sound to play
 
+    }   break;
+
     default:
         break;
     }