Merge reviewed doxygen.
[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 state of the SIM card.
36  *
37  * @since       2.1
38  *
39  * The %ITelephonySimEventListener interface checks for the change in state of the SIM card.
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. This way, the destructors of the derived classes are called when the destructor of this interface is called.
48      *
49      * @since   2.1
50      */
51         virtual ~ITelephonySimEventListener(void) {}
52
53         /**
54      * Called when the state of SIM is changed.
55      *
56      * @since   2.1
57          *
58      * @param[in]   state       The new SIM state
59      */
60         virtual void OnTelephonySimStateChanged(SimState state) = 0;
61
62 protected:
63         //
64         // This method is for internal use only. Using this method can cause behavioral, security-related,
65         // and consistency-related issues in the application.
66         //
67         // This method is reserved and may change its name at any time without prior notice.
68         //
69         // @since 2.1
70         //
71         virtual void ITelephonySimEventListener_Reserved1(void) {};
72
73         //
74         // This method is for internal use only. Using this method can cause behavioral, security-related,
75         // and consistency-related issues in the application.
76         //
77         // This method is reserved and may change its name at any time without prior notice.
78         //
79         // @since 2.1
80         //
81         virtual void ITelephonySimEventListener_Reserved2(void) {};
82
83         //
84         // This method is for internal use only. Using this method can cause behavioral, security-related,
85         // and consistency-related issues in the application.
86         //
87         // This method is reserved and may change its name at any time without prior notice.
88         //
89         // @since 2.1
90         //
91         virtual void ITelephonySimEventListener_Reserved3(void) {};
92
93 }; // ITelephonySimEventListener
94
95 }} // Tizen::Telephony
96 #endif // _FTEL_ITELEPHONY_SIM_EVENT_LISTENER_H_