Table of Contents

Wwise SDK 2018.1.11
ISourceControlOperationProgress.h
Go to the documentation of this file.
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 operation progress dialog interface, used to display progress during source control operations
30 
31 #ifndef _AK_WWISE_ISOURCECONTROLOPERATIONPROGRESS_H
32 #define _AK_WWISE_ISOURCECONTROLOPERATIONPROGRESS_H
33 
35 
36 // Audiokinetic namespace
37 namespace AK
38 {
39  // Audiokinetic Wwise namespace
40  namespace Wwise
41  {
42  /// Wwise progress dialog interface. This interface is given by AK::Wwise::ISourceControlUtilities.
43  /// You can use this interface to display a simple progress dialog while performing operations.
44  /// \warning The functions in this interface are not thread-safe, unless stated otherwise.
45  /// \sa
46  /// - \ref source_control_dll_creation_progress
48  {
49  public:
50 
51  /// Creates and displays the progress dialog.
52  virtual void ShowProgress () = 0;
53 
54  /// Adds a new text line in the log message list. Note that escape characters (such as '\n') are not effective
55  /// in this message list.
56  virtual void AddLogMessage (
57  LPCWSTR in_pszMessage ///< The text line to add to the list.
58  ) = 0;
59 
60  /// This function is used to know if the user clicked the 'Cancel' button.
61  /// \return True if the user clicked 'Cancel', False otherwise
62  virtual bool IsCanceled() const = 0;
63 
64  /// Manually cancels the operation. This result is the same as if the user pressed 'Cancel'. When using
65  /// this function, AK:Wwise::ISourceControlOperationProgress::OperationCompleted() must be called to
66  /// close the dialog.
67  virtual void Cancel() = 0;
68 
69  /// Call this function when the operation is completed.
70  /// When in_bWaitForOK is true, the function will not return until the
71  /// user clicks the 'OK' button.
72  /// The progress dialog will be destroyed.
73  virtual void OperationCompleted( bool in_bWaitForOK = true ) = 0;
74  };
75  }
76 }
77 
78 #endif // _AK_WWISE_ISOURCECONTROLOPERATIONPROGRESS_H
virtual void OperationCompleted(bool in_bWaitForOK=true)=0
Audiokinetic namespace.
virtual void ShowProgress()=0
Creates and displays the progress dialog.
virtual void AddLogMessage(LPCWSTR in_pszMessage)=0
virtual bool IsCanceled() const =0