inc/FUiCtrlIFormBackEventListener.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                FUiCtrlIFormBackEventListener.h
  19  * @brief               This is the header file for the %IFormBackEventListener interface.
  20  *
  21  * This header file contains the declarations of the %IFormBackEventListener interface.
  22  */
  23 #ifndef _FUI_CTRL_IFORM_BACK_EVENT_LISTENER_H_
  24 #define _FUI_CTRL_IFORM_BACK_EVENT_LISTENER_H_
  25
  26 // includes
  27 #include <FBaseRtIEventListener.h>
  28
  29 // namespace declaration
  30 namespace Tizen { namespace Ui { namespace Controls
  31 {
  32
  33 class Form;
  34
  35 /**
  36  * @interface   IFormBackEventListener
  37  * @brief               This interface implements the listener for Form-related events.
  38  *
  39  * @since               2.0
  40  *
  41  * The %IFormBackEventListener interface is the listener interface for receiving Form-related back button events.
  42  *
  43  * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/ui/implementing_form.htm">Form</a>.
  44  */
  45 class IFormBackEventListener
  46         : virtual public Tizen::Base::Runtime::IEventListener
  47 {
  48 // Lifecycle
  49 public:
  50         /**
  51          * This is the destructor for this class.
  52          *
  53          * @since       2.0
  54          */
  55         virtual ~IFormBackEventListener(void) {}
  56
  57 // Operation
  58 public:
  59         /**
  60          * Called when the current Form control needs to be closed to revert back to the previous %Form control.
  61          *
  62          * @since       2.0
  63          *
  64          * @param[in]   source          The source of the event
  65          * @remarks             This event is fired when the user clicks on the software 'back' button on the Footer control, or the hardware back button on the
  66          *                              device.
  67          */
  68         virtual void OnFormBackRequested(Tizen::Ui::Controls::Form& source) = 0;
  69
  70 // Reserves
  71 protected:
  72         //
  73         //This method is for internal use only. Using this method can cause behavioral, security-related,
  74         //and consistency-related issues in the application.
  75         //
  76         // This method is reserved and may change its name at any time without
  77         // prior notice.
  78         //
  79         // @since 2.0
  80         //
  81         virtual void IFormBackEventListener_Reserved1(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
  88         // prior notice.
  89         //
  90         // @since 2.0
  91         //
  92         virtual void IFormBackEventListener_Reserved2(void) { }
  93
  94         //
  95         //This method is for internal use only. Using this method can cause behavioral, security-related,
  96         //and consistency-related issues in the application.
  97         //
  98         // This method is reserved and may change its name at any time without
  99         // prior notice.
 100         //
 101         // @since 2.0
 102         //
 103         virtual void IFormBackEventListener_Reserved3(void) { }
 104 }; // IFormBackEventListener
 105
 106 }}} // Tizen::Ui::Controls
 107
 108 #endif // _FUI_CTRL_IFORM_BACK_EVENT_LISTENER_H_