Version
menu_open
Wwise SDK 2023.1.5
ISourceControlProgress.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  Copyright (c) 2024 Audiokinetic Inc.
25 *******************************************************************************/
26 
27 /// \file
28 /// Wwise source control plug-in operation progress dialog interface, used to display progress during source control operations
29 
30 #ifndef _AK_WWISE_ISOURCECONTROLOPERATIONPROGRESS_H
31 #define _AK_WWISE_ISOURCECONTROLOPERATIONPROGRESS_H
32 
34 
35 // Audiokinetic namespace
36 namespace AK
37 {
38  // Audiokinetic Wwise namespace
39  namespace Wwise
40  {
41  /// Wwise progress dialog interface. This interface is given by AK::Wwise::ISourceControlUtilities.
42  /// You can use this interface to display a simple progress dialog while performing operations.
43  /// \akwarning
44  /// The functions in this interface are not thread-safe, unless stated otherwise.
45  /// \endakwarning
46  /// \sa
47  /// - \ref source_control_dll_creation_progress
49  {
50  public:
51  enum Severity
52  {
56  };
57 
58  /// Creates and displays the progress dialog.
59  virtual void BeginOperation() = 0;
60 
61  /// Adds a new text line in the log message list. Note that escape characters (such as '\n') are not effective
62  /// in this message list.
63  virtual void AddLogMessage (
64  Severity in_severity, ///< The severity of the text line to log.
65  LPCWSTR in_pszMessage ///< The text line to add to the list.
66  ) = 0;
67 
68  /// This function is used to know if the user clicked the 'Cancel' button.
69  /// \return True if the user clicked 'Cancel', False otherwise
70  virtual bool IsCanceled() const = 0;
71 
72  /// Manually cancels the operation. This result is the same as if the user pressed 'Cancel'. When using
73  /// this function, AK:Wwise::ISourceControlProgress::EndOperation() must be called to
74  /// close the dialog.
75  virtual void Cancel() = 0;
76 
77  /// Call this function when the operation is completed.
78  /// When in_bWaitForOK is true, the function will not return until the
79  /// user clicks the 'OK' button.
80  /// The progress dialog will be destroyed.
81  virtual void EndOperation( bool in_bWaitForOK = true ) = 0;
82 
83  virtual bool IsSilent() const = 0;
84 
85  virtual bool IsAutoCheckout() const = 0;
86 
87  virtual bool IsAutoAdd() const = 0;
88 
89  virtual LPCWSTR GetCommitMessage() const = 0;
90  };
91  }
92 }
93 
94 #endif // _AK_WWISE_ISOURCECONTROLOPERATIONPROGRESS_H
virtual void AddLogMessage(Severity in_severity, LPCWSTR in_pszMessage)=0
virtual bool IsAutoCheckout() const =0
Audiokinetic namespace.
virtual LPCWSTR GetCommitMessage() const =0
virtual void EndOperation(bool in_bWaitForOK=true)=0
virtual void BeginOperation()=0
Creates and displays the progress dialog.
virtual bool IsSilent() const =0
virtual bool IsCanceled() const =0
virtual bool IsAutoAdd() const =0

Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise