Merge from 2.2
[platform/framework/native/telephony.git] / inc / FTelITelephonySimEventListener.h
1 //
2 // Open Service Platform
3 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
4 //
5 // Licensed under the Apache License, Version 2.0 (the License);
6 // you may not use this file except in compliance with the License.
7 // You may obtain a copy of the License at
8 //
9 //     http://www.apache.org/licenses/LICENSE-2.0
10 //
11 // Unless required by applicable law or agreed to in writing, software
12 // distributed under the License is distributed on an "AS IS" BASIS,
13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 // See the License for the specific language governing permissions and
15 // limitations under the License.
16 //
17 /**
18  * @file        FTelITelephonySimEventListener.h
19  * @brief       This is the header file for the %ITelephonySimEventListener interface.
20  *
21  * This header file contains the declarations of the %ITelephonySimEventListener interface.
22  */
23 #ifndef _FTEL_ITELEPHONY_SIM_EVENT_LISTENER_H_
24 #define _FTEL_ITELEPHONY_SIM_EVENT_LISTENER_H_
25
26 #include <FBaseRtIEventListener.h>
27 #include <FTelTypes.h>
28
29
30 namespace Tizen { namespace Telephony
31 {
32
33 /**
34  * @interface   ITelephonySimEventListener
35  * @brief       This interface provides methods to listen to the change in the SIM card state.
36  *
37  * @since       2.1
38  *
39  * The %ITelephonySimEventListener interface checks for the change in the SIM card state.
40  *
41  */
42 class _OSP_EXPORT_ ITelephonySimEventListener
43         : virtual public Tizen::Base::Runtime::IEventListener
44 {
45 public:
46         /**
47      * This polymorphic destructor should be overridden if required. @n
48          * This way, the destructors of the derived classes are called when the destructor of this interface is called.
49      *
50      * @since   2.1
51      */
52         virtual ~ITelephonySimEventListener(void) {}
53
54         /**
55      * Called when the SIM state is changed.
56      *
57      * @since   2.1
58          *
59      * @param[in]   state       The changed SIM state
60      */
61         virtual void OnTelephonySimStateChanged(SimState state) = 0;
62
63 protected:
64         //
65         // This method is for internal use only. Using this method can cause behavioral, security-related,
66         // and consistency-related issues in the application.
67         //
68         // This method is reserved and may change its name at any time without prior notice.
69         //
70         // @since 2.1
71         //
72         virtual void ITelephonySimEventListener_Reserved1(void) {};
73
74         //
75         // This method is for internal use only. Using this method can cause behavioral, security-related,
76         // and consistency-related issues in the application.
77         //
78         // This method is reserved and may change its name at any time without prior notice.
79         //
80         // @since 2.1
81         //
82         virtual void ITelephonySimEventListener_Reserved2(void) {};
83
84         //
85         // This method is for internal use only. Using this method can cause behavioral, security-related,
86         // and consistency-related issues in the application.
87         //
88         // This method is reserved and may change its name at any time without prior notice.
89         //
90         // @since 2.1
91         //
92         virtual void ITelephonySimEventListener_Reserved3(void) {};
93
94 }; // ITelephonySimEventListener
95
96 }} // Tizen::Telephony
97 #endif // _FTEL_ITELEPHONY_SIM_EVENT_LISTENER_H_