inc/FUiCtrlIProgressPopupEventListener.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                FUiCtrlIProgressPopupEventListener.h
  19  * @brief       This is the header file for the %IProgressPopupEventListener interface.
  20  *
  21  * This header file contains the declarations of the %IProgressPopupEventListener interface. @n
  22  * If a ProgressPopup event is generated, a method of this interface is called. @n
  23  * So, for tasks related to the ProgressPopup event, use the methods of this interface.
  24  *
  25  */
  26 #ifndef _FUI_CTRL_IPROGRESS_POPUP_EVENT_LISTENER_H_
  27 #define _FUI_CTRL_IPROGRESS_POPUP_EVENT_LISTENER_H_
  28
  29 #include "FBaseRtIEventListener.h"
  30
  31
  32 namespace Tizen { namespace Ui
  33 {
  34 class Control;
  35 }} // Tizen::Ui
  36
  37
  38 namespace Tizen { namespace Ui
  39 {
  40 /**
  41  * @interface               IProgressPopupEventListener
  42  * @brief                    This interface implements the listener for ProgressPopup event.
  43  * @since 2.0
  44  *
  45  * The %IProgressPopupEventListener interface is the listener interface for receiving an event for closing the ProgressPopup.
  46  * The class that processes a ProgressPopup event
  47  * implements this interface, and the instance created with that class is registered with a UI control, using the control's
  48  * AddProgressPopupEventListener() method. When the ProgressPopup event occurs, the OnProgressPopupCanceled() method of that instance is invoked.
  49  *
  50  * For more information on the class features, see in individual control topics under <a href="../org.tizen.native.appprogramming/html/guide/ui/controls.htm">UI Controls</a>.
  51  */
  52 class _OSP_EXPORT_ IProgressPopupEventListener
  53         : virtual public Tizen::Base::Runtime::IEventListener
  54 {
  55 public:
  56         /**
  57          * 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.
  58          *
  59          * @since 2.0
  60          */
  61         virtual ~IProgressPopupEventListener(void) {}
  62
  63         /**
  64          * Called when a ProgressPopup event occurs.
  65          *
  66          * @since 2.0
  67          */
  68         virtual void OnProgressPopupCanceled(void) = 0;
  69
  70 protected:
  71         //
  72         // This method is for internal use only. Using this method can cause behavioral, security-related,
  73         // and consistency-related issues in the application.
  74         //
  75         // The following methods are reserved and may change its name at any time without
  76         // prior notice.
  77         //
  78         // @since 2.0
  79         //
  80         virtual void IProgressPopupEventListener_Reserved1(void) {}
  81         virtual void IProgressPopupEventListener_Reserved2(void) {}
  82         virtual void IProgressPopupEventListener_Reserved3(void) {}
  83 }; // IProgressPopupEventListener
  84
  85 }} // Tizen::Ui
  86
  87 #endif // _FUI_CTRL_IPROGRESS_POPUP_EVENT_LISTENER_H_