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