src/FTel_SimEvent.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 /**
  19  * @file    FTel_SimEvent.h
  20  * @brief   This is the header file for the _SimEvent class.
  21  *
  22  * This header file contains declarations of the _SimEvent class.
  23  */
  24
  25 #ifndef _FTEL_INTERNAL_SIM_EVENT_H_
  26 #define _FTEL_INTERNAL_SIM_EVENT_H_
  27
  28 #include <FBaseResult.h>
  29 #include <FBaseRt_Event.h>
  30
  31 namespace Tizen { namespace Base { namespace Runtime
  32 {
  33 class IEventListener;
  34 class IEventArg;
  35 }}}
  36
  37 namespace Tizen { namespace Telephony
  38 {
  39
  40 /**
  41  * @class   _SimEvent
  42  * @brief   This class handles SIM events.
  43  *
  44  * When a SimEvent occurs, the _SimEvent object finds a ITelephonySimEventListener object
  45  * which is registered for the SimStateManager object and calls an appropriate method of the listener.
  46  */
  47
  48 class _SimEvent
  49     : public Tizen::Base::Runtime::_Event
  50 {
  51 public:
  52     _SimEvent();
  53     virtual ~_SimEvent(void);
  54
  55     result Construct(void);
  56
  57 protected:
  58     /**
  59      * Checks the arg and finds out the type of event. After that this method calls appropriate pListener's method.
  60      *
  61      * @return      A result code.
  62      * @param[in]   listener               It is a event listener related to this SIM event.
  63      * @param[in]   arg                     It is an argument-like instance of SIM event retransmitted to the listener's method as an argument.
  64      * @exception   E_SUCCESS               The method is successful.
  65      * @exception   E_INVALID_ARG           The argument passed to a method contains an invalid value.@n
  66      */
  67     void FireImpl(Tizen::Base::Runtime::IEventListener& listener, const Tizen::Base::Runtime::IEventArg& arg);
  68
  69
  70 private:
  71     _SimEvent(const _SimEvent& rhs);
  72     _SimEvent& operator =(const _SimEvent& rhs);
  73
  74 }; // _SimEvent
  75
  76 }} // Tizen::Telephony
  77
  78 #endif // _FTEL_INTERNAL_SIM_EVENT_H_