Table of Contents

Wwise SDK 2019.2.3
ISourceControlDialogBase.h
1 /*******************************************************************************
2 The content of this file includes portions of the AUDIOKINETIC Wwise Technology
3 released in source code form as part of the SDK installer package.
4 
5 Commercial License Usage
6 
7 Licensees holding valid commercial licenses to the AUDIOKINETIC Wwise Technology
8 may use this file in accordance with the end user license agreement provided
9 with the software or, alternatively, in accordance with the terms contained in a
10 written agreement between you and Audiokinetic Inc.
11 
12 Apache License Usage
13 
14 Alternatively, this file may be used under the Apache License, Version 2.0 (the
15 "Apache License"); you may not use this file except in compliance with the
16 Apache License. You may obtain a copy of the Apache License at
17 http://www.apache.org/licenses/LICENSE-2.0.
18 
19 Unless required by applicable law or agreed to in writing, software distributed
20 under the Apache License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
21 OR CONDITIONS OF ANY KIND, either express or implied. See the Apache License for
22 the specific language governing permissions and limitations under the License.
23 
24  Version: <VERSION> Build: <BUILDNUMBER>
25  Copyright (c) <COPYRIGHTYEAR> Audiokinetic Inc.
26 *******************************************************************************/
27 
28 /// \file
29 /// Wwise source control plug-in dialog interface, used to implement custom dialogs that have the Wwise look and feel.
30 
31 #ifndef _AK_WWISE_ISOURCECONTROLDIALOGBASE_H
32 #define _AK_WWISE_ISOURCECONTROLDIALOGBASE_H
33 
34 #include <AK/SoundEngine/Common/AkTypes.h>
35 
36 // Audiokinetic namespace
37 namespace AK
38 {
39  // Audiokinetic Wwise namespace
40  namespace Wwise
41  {
42  /// Wwise dialog base interface. This must be implemented for each dialog that
43  /// needs to be displayed with the Wwise look and feel.
44  /// \akwarning
45  /// The functions in this interface are not thread-safe, unless stated otherwise.
46  /// \endakwarning
47  /// \sa
48  /// - \ref source_control_dll_creation_dialog_implement
50  {
51  public:
52 
53  /// This function is called by Wwise to get the HINSTANCE used for loading resources.
54  /// \return The HINSTANCE of the plug-in DLL resource.
55  virtual HINSTANCE GetResourceHandle() const = 0;
56 
57  /// This function is called by Wwise to get the plug-in dialog's ID.
58  virtual void GetDialog(
59  UINT & out_uiDialogID ///< The returned resource ID of the dialog
60  ) const = 0;
61 
62  /// Asks the dialog if it has Help associated with it.
63  /// \return True if the '?' Help button should be shown on the dialog, False otherwise
64  virtual bool HasHelp() const = 0;
65 
66  /// Called when the user clicks the '?' Help icon.
67  /// \return True if the plug-in handled the Help request, False otherwise
68  virtual bool Help(
69  HWND in_hWnd ///< The window handle of the dialog
70  ) const = 0;
71 
72  /// Window message handler for the dialog. This is very similar to a standard WIN32 window procedure.
73  /// \return True if the message has been processed by the plug-in, False otherwise
74  virtual bool WindowProc(
75  HWND in_hWnd, ///< The window handle of the dialog
76  UINT in_message, ///< The incoming message. This is a standard Windows message ID (e.g. WM_PAINT)
77  WPARAM in_wParam, ///< The WPARAM of the message (see MSDN)
78  LPARAM in_lParam, ///< The LPARAM of the message (see MSDN)
79  LRESULT & out_lResult ///< The returned value if the message has been processed. It is only considered if the method also returns True
80  ) = 0;
81  };
82  }
83 }
84 
85 #endif // _AK_WWISE_ISOURCECONTROLDIALOGBASE_H
Audiokinetic namespace.
virtual HINSTANCE GetResourceHandle() const =0
virtual bool HasHelp() const =0
virtual bool WindowProc(HWND in_hWnd, UINT in_message, WPARAM in_wParam, LPARAM in_lParam, LRESULT &out_lResult)=0
virtual bool Help(HWND in_hWnd) const =0
virtual void GetDialog(UINT &out_uiDialogID) const =0
This function is called by Wwise to get the plug-in dialog's ID.