inc/FUiCtrlIFormMenuEventListener.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                FUiCtrlIFormMenuEventListener.h
  19  * @brief               This is the header file for the %IFormMenuventListener interface.
  20  *
  21  * This header file contains the declarations of the %IFormMenuventListener interface.
  22  */
  23 #ifndef _FUI_CTRL_IFORM_MENU_EVENT_LISTENER_H_
  24 #define _FUI_CTRL_IFORM_MENU_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   IFormMenuEventListener
  37  * @brief               This interface implements the listener for Form-related events.
  38  *
  39  * @since               2.2
  40  *
  41  * The %IFormMenuEventListener interface is the listener interface for receiving Form-related 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 IFormMenuEventListener
  46         : virtual public Tizen::Base::Runtime::IEventListener
  47 {
  48 public:
  49         /**
  50          * This is the destructor for this class.
  51          *
  52          * @since       2.2
  53          */
  54         virtual ~IFormMenuEventListener(void) {}
  55
  56 public:
  57         /**
  58          * Called when the current Form control needs to control the Menu button.
  59          *
  60          * @since       2.2
  61          *
  62          * @param[in]   source          The source of the event
  63          * @remarks             This event is fired when the user clicks on the software 'menu' button on the Footer control, or the hardware menu button on the device.
  64          */
  65         virtual void OnFormMenuRequested(Tizen::Ui::Controls::Form& source) = 0;
  66
  67 protected:
  68         //
  69         //This method is for internal use only. Using this method can cause behavioral, security-related,
  70         //and consistency-related issues in the application.
  71         //
  72         // This method is reserved and may change its name at any time without
  73         // prior notice.
  74         //
  75         // @since 2.2
  76         //
  77         virtual void IFormMenuEventListener_Reserved1(void) { }
  78
  79         //
  80         //This method is for internal use only. Using this method can cause behavioral, security-related,
  81         //and consistency-related issues in the application.
  82         //
  83         // This method is reserved and may change its name at any time without
  84         // prior notice.
  85         //
  86         // @since 2.2
  87         //
  88         virtual void IFormMenuEventListener_Reserved2(void) { }
  89
  90         //
  91         //This method is for internal use only. Using this method can cause behavioral, security-related,
  92         //and consistency-related issues in the application.
  93         //
  94         // This method is reserved and may change its name at any time without
  95         // prior notice.
  96         //
  97         // @since 2.2
  98         //
  99         virtual void IFormMenuEventListener_Reserved3(void) { }
 100 }; // IFormMenuEventListener
 101
 102 }}} // Tizen::Ui::Controls
 103
 104 #endif // _FUI_CTRL_IFORM_MENU_EVENT_LISTENER_H_