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 operation progress dialog interface, used to display progress during source control operations 00030 00031 #ifndef _AK_WWISE_ISOURCECONTROLOPERATIONPROGRESS_H 00032 #define _AK_WWISE_ISOURCECONTROLOPERATIONPROGRESS_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 progress dialog interface. This interface is given by AK::Wwise::ISourceControlUtilities. 00043 /// You can use this interface to display a simple progress dialog while performing operations. 00044 /// \warning The functions in this interface are not thread-safe, unless stated otherwise. 00045 /// \sa 00046 /// - \ref source_control_dll_creation_progress 00047 class ISourceControlOperationProgress 00048 { 00049 public: 00050 00051 /// Creates and displays the progress dialog. 00052 virtual void ShowProgress () = 0; 00053 00054 /// Adds a new text line in the log message list. Note that escape characters (such as '\n') are not effective 00055 /// in this message list. 00056 virtual void AddLogMessage ( 00057 LPCWSTR in_pszMessage ///< The text line to add to the list. 00058 ) = 0; 00059 00060 /// This function is used to know if the user clicked the 'Cancel' button. 00061 /// \return True if the user clicked 'Cancel', False otherwise 00062 virtual bool IsCanceled() const = 0; 00063 00064 /// Manually cancels the operation. This result is the same as if the user pressed 'Cancel'. When using 00065 /// this function, AK:Wwise::ISourceControlOperationProgress::OperationCompleted() must be called to 00066 /// close the dialog. 00067 virtual void Cancel() = 0; 00068 00069 /// Call this function when the operation is completed. 00070 /// When in_bWaitForOK is true, the function will not return until the 00071 /// user clicks the 'OK' button. 00072 /// The progress dialog will be destroyed. 00073 virtual void OperationCompleted( bool in_bWaitForOK = true ) = 0; 00074 }; 00075 } 00076 } 00077 00078 #endif // _AK_WWISE_ISOURCECONTROLOPERATIONPROGRESS_H