00001 /******************************************************************************* 00002 The content of this file includes portions of the AUDIOKINETIC Wwise Technology 00003 released in source code form as part of the SDK installer package. 00004 00005 Commercial License Usage 00006 00007 Licensees holding valid commercial licenses to the AUDIOKINETIC Wwise Technology 00008 may use this file in accordance with the end user license agreement provided 00009 with the software or, alternatively, in accordance with the terms contained in a 00010 written agreement between you and Audiokinetic Inc. 00011 00012 Apache License Usage 00013 00014 Alternatively, this file may be used under the Apache License, Version 2.0 (the 00015 "Apache License"); you may not use this file except in compliance with the 00016 Apache License. You may obtain a copy of the Apache License at 00017 http://www.apache.org/licenses/LICENSE-2.0. 00018 00019 Unless required by applicable law or agreed to in writing, software distributed 00020 under the Apache License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES 00021 OR CONDITIONS OF ANY KIND, either express or implied. See the Apache License for 00022 the specific language governing permissions and limitations under the License. 00023 00024 Version: <VERSION> Build: <BUILDNUMBER> 00025 Copyright (c) <COPYRIGHTYEAR> Audiokinetic Inc. 00026 *******************************************************************************/ 00027 00028 /// \file 00029 /// Wwise source control plug-in dialog interface, used to implement custom dialogs that have the Wwise look and feel. 00030 00031 #ifndef _AK_WWISE_ISOURCECONTROLDIALOGBASE_H 00032 #define _AK_WWISE_ISOURCECONTROLDIALOGBASE_H 00033 00034 #include <AK/SoundEngine/Common/AkTypes.h> 00035 00036 // Audiokinetic namespace 00037 namespace AK 00038 { 00039 // Audiokinetic Wwise namespace 00040 namespace Wwise 00041 { 00042 /// Wwise dialog base interface. This must be implemented for each dialog that 00043 /// needs to be displayed with the Wwise look and feel. 00044 /// \warning The functions in this interface are not thread-safe, unless stated otherwise. 00045 /// \sa 00046 /// - \ref source_control_dll_creation_dialog_implement 00047 class ISourceControlDialogBase 00048 { 00049 public: 00050 00051 /// This function is called by Wwise to get the HINSTANCE used for loading resources. 00052 /// \return The HINSTANCE of the plug-in DLL resource. 00053 virtual HINSTANCE GetResourceHandle() const = 0; 00054 00055 /// This function is called by Wwise to get the plug-in dialog's ID. 00056 virtual void GetDialog( 00057 UINT & out_uiDialogID ///< The returned resource ID of the dialog 00058 ) const = 0; 00059 00060 /// Asks the dialog if it has Help associated with it. 00061 /// \return True if the '?' Help button should be shown on the dialog, False otherwise 00062 virtual bool HasHelp() const = 0; 00063 00064 /// Called when the user clicks the '?' Help icon. 00065 /// \return True if the plug-in handled the Help request, False otherwise 00066 virtual bool Help( 00067 HWND in_hWnd ///< The window handle of the dialog 00068 ) const = 0; 00069 00070 /// Window message handler for the dialog. This is very similar to a standard WIN32 window procedure. 00071 /// \return True if the message has been processed by the plug-in, False otherwise 00072 virtual bool WindowProc( 00073 HWND in_hWnd, ///< The window handle of the dialog 00074 UINT in_message, ///< The incoming message. This is a standard Windows message ID (e.g. WM_PAINT) 00075 WPARAM in_wParam, ///< The WPARAM of the message (see MSDN) 00076 LPARAM in_lParam, ///< The LPARAM of the message (see MSDN) 00077 LRESULT & out_lResult ///< The returned value if the message has been processed. It is only considered if the method also returns True 00078 ) = 0; 00079 }; 00080 } 00081 } 00082 00083 #endif // _AK_WWISE_ISOURCECONTROLDIALOGBASE_H