src/ui/inc/FUiCtrl_IProgressPopupEventListener.h

   1 //
   2 // Open Service Platform
   3 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
   4 //
   5 // Licensed under the Flora License, Version 1.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://floralicense.org/license/
  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                FUiCtrl_IProgressPopupEventListener.h
  19  * @brief       This is the header file for the _IProgressPopupEventListener class.
  20  *
  21  * This header file contains the declarations of the _IProgressPopupEventListener class. @n
  22  * If a closing ProgressPopup event is generated, a method of this class is called.
  23  * So, if the application does some jobs related to the closing ProgressPopup event, use the methods of this class.
  24  *
  25  */
  26 #ifndef _FUI_CTRL_INTERNAL_IPROGRESSPOPUP_EVENT_LISTENER_H_
  27 #define _FUI_CTRL_INTERNAL_IPROGRESSPOPUP_EVENT_LISTENER_H_
  28
  29
  30 #include <FOspConfig.h>
  31 #include <FBaseRtIEventListener.h>
  32
  33
  34 namespace Tizen { namespace Ui
  35 {
  36 class _Control;
  37 } } // Tizen::Ui
  38
  39
  40 namespace Tizen { namespace Ui { namespace Controls
  41 {
  42 /**
  43  * @interface           _IProgressPopupEventListener
  44  * @brief               This interface implements the listener for ProgressPopup event.
  45  * @since 2.0
  46  *
  47  * The listener interface for receiving event to close the ProgressPopup. The class that processes a ProgressPopup event
  48  * implements this interface, and the instance created with that class is registered with a UI control, using the control's
  49  * AddProgressPopupEventListener() method. When the event to close ProgressPopup occurs, the OnCanceled() method of that object is invoked.
  50  */
  51 class _IProgressPopupEventListener
  52         : virtual public Tizen::Base::Runtime::IEventListener
  53 {
  54 public:
  55         /**
  56          * This is the destructor for this class.
  57          *
  58          * @since 2.0
  59          */
  60         virtual ~_IProgressPopupEventListener(void) {}
  61
  62         /**
  63          * Notifies when a ProgressPopup event occurs.
  64          *
  65          * @since 2.0
  66          * @param[in]   source          The source of the event
  67          */
  68         virtual void OnProgressPopupCanceled(void) = 0;
  69
  70 }; // _IProgressPopupEventListener
  71
  72 }}} // Tizen::Ui::Controls
  73
  74 #endif // _FUI_CTRL_INTERNAL_IPROGRESSPOPUP_EVENT_LISTENER_H_