blob: 6faaa04e596c4b2617aa1a2f13f48c8d93972557 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
|
#ifndef IErrorNotifier_h__
#define IErrorNotifier_h__ 1
// =================================================================================================
// Copyright Adobe
// Copyright 2014 Adobe
// All Rights Reserved
//
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance with the terms
// of the Adobe license agreement accompanying it.
// =================================================================================================
#include "XMPCommon/XMPCommonFwdDeclarations.h"
namespace AdobeXMPCommon {
//!
//! \brief Version1 of the interface that represents an interface to be implemented by client
//! in case he is interested in getting notifications with respect to errors/warnings encountered
//! by library.
//! \details In case client is interested in error notifications he can implement this interface
//! and register the same with the \#AdobeXMPCommon::IConfigurationManager. For every warning or error
//! encountered the NotifyError function will be called by the library. In case of warnings ( indicated
//! by the severity of the error ) the client has the option to continue ignoring the warning by returning
//! true else he can return false and the warning will be thrown aborting the current operation.
//!
class XMP_PUBLIC IErrorNotifier_v1
{
public:
//!
//! @brief Called by the library to notify the client about the warning/error.
//! \param[in] error const pointer to a \#AdobeXMPCommon::IError. Client can use the information
//! in the error to decide what should be the future course of action.
//! \return A value of bool type that will indicate the future course of action.
//!
virtual bool APICALL Notify( const spcIError & error ) = 0;
virtual ~IErrorNotifier_v1() {}
protected:
//! \cond XMP_INTERNAL_DOCUMENTATION
virtual uint32 APICALL notify( pcIError_base error, uint32 & exceptionThrown ) __NOTHROW__;
//! \endcond
#ifdef FRIEND_CLASS_DECLARATION
FRIEND_CLASS_DECLARATION();
#endif
REQ_FRIEND_CLASS_DECLARATION();
//! \endcond
};
}
#endif // IErrorNotifier_h__
|
